diff options
Diffstat (limited to 'crypto/heimdal/lib/krb5/krb5_keytab.3')
| -rw-r--r-- | crypto/heimdal/lib/krb5/krb5_keytab.3 | 68 |
1 files changed, 35 insertions, 33 deletions
diff --git a/crypto/heimdal/lib/krb5/krb5_keytab.3 b/crypto/heimdal/lib/krb5/krb5_keytab.3 index 9aa9fff..9c7eacd 100644 --- a/crypto/heimdal/lib/krb5/krb5_keytab.3 +++ b/crypto/heimdal/lib/krb5/krb5_keytab.3 @@ -1,5 +1,5 @@ .\" Copyright (c) 2001 Kungliga Tekniska Högskolan -.\" $Id: krb5_keytab.3,v 1.3 2001/11/09 09:35:45 joda Exp $ +.\" $Id: krb5_keytab.3,v 1.5 2002/08/28 15:30:54 joda Exp $ .Dd February 5, 2001 .Dt KRB5_KEYTAB 3 .Os HEIMDAL @@ -24,6 +24,8 @@ .Nm krb5_kt_resolve , .Nm krb5_kt_start_seq_get .Nd manage keytab (key storage) files +.Sh LIBRARY +Kerberos 5 Library (libkrb5, -lkrb5) .Sh SYNOPSIS .Fd #include <krb5.h> .Pp @@ -142,7 +144,7 @@ the default keytab is used. The current default type is .Nm file . The default value can be changed in the configuration file .Pa /etc/krb5.conf -by setting the variable +by setting the variable .Li [defaults]default_keytab_name . .Pp The keytab types that are implemented in Heimdal @@ -154,7 +156,7 @@ store the keytab in a file, the type's name is The residual part is a filename. .It Nm keyfile store the keytab in a -.Li AFS +.Li AFS keyfile (usually .Pa /usr/afs/etc/KeyFile ) , the type's name is @@ -182,7 +184,7 @@ key-type, key, key-version number, etc. .Nm krb5_kt_cursor holds the current position that is used when iterating through a keytab entry with -.Fn krb5_kt_start_seq_get , +.Fn krb5_kt_start_seq_get , .Fn krb5_kt_next_entry , and .Fn krb5_kt_end_seq_get . @@ -195,19 +197,19 @@ implementation. .Fn krb5_kt_resolve is the equvalent of an .Xr open 2 -on keytab. Resolve the keytab name in +on keytab. Resolve the keytab name in .Fa name -into a keytab in +into a keytab in .Fa id . Returns 0 or an error. The opposite of -.Fn krb5_kt_resolve -is +.Fn krb5_kt_resolve +is .Fn krb5_kt_close . .Fn krb5_kt_close frees all resources allocated to the keytab. .Pp .Fn krb5_kt_default -sets the argument +sets the argument .Fa id to the default keytab. Returns 0 or an error. @@ -215,27 +217,27 @@ Returns 0 or an error. .Fn krb5_kt_default_name copy the name of the default keytab into .Fa name . -Return 0 or KRB5_CONFIG_NOTENUFSPACE if +Return 0 or KRB5_CONFIG_NOTENUFSPACE if .Fa namesize is too short. .Pp .Fn krb5_kt_add_entry Add a new .Fa entry -to the keytab +to the keytab .Fa id . .Li KRB5_KT_NOWRITE is returned if the keytab is a readonly keytab. .Pp .Fn krb5_kt_compare -compares the passed in +compares the passed in .Fa entry against .Fa principal , .Fa vno , and .Fa enctype . -Any of +Any of .Fa principal , .Fa vno or @@ -244,52 +246,52 @@ might be 0 which acts as a wildcard. Return TRUE if they compare the same, FALSE otherwise. .Pp .Fn krb5_kt_copy_entry_contents -copies the contents of +copies the contents of .Fa in -into +into .Fa out . Returns 0 or an error. .Pp .Fn krb5_kt_get_name -retrieves the name of the keytab +retrieves the name of the keytab .Fa keytab -into +into .Fa name , .Fa namesize . Returns 0 or an error. .Pp .Fn krb5_kt_free_entry -frees the contents of +frees the contents of .Fa entry . .Pp .Fn krb5_kt_start_seq_get sets .Fa cursor -to point at the beginning of +to point at the beginning of .Fa id . Returns 0 or an error. .Pp .Fn krb5_kt_next_entry -gets the next entry from +gets the next entry from .Fa id -pointed to by +pointed to by .Fa cursor and advance the .Fa cursor . Returns 0 or an error. .Pp .Fn krb5_kt_end_seq_get -releases all resources associated with +releases all resources associated with .Fa cursor . .Pp .Fn krb5_kt_get_entry -retrieves the keytab entry for +retrieves the keytab entry for .Fa principal , -.Fa kvno, +.Fa kvno, .Fa enctype -into +into .Fa entry -from the keytab +from the keytab .Fa id . Returns 0 or an error. .Pp @@ -298,16 +300,16 @@ reads the key identified by .Ns ( Fa principal , .Fa vno , .Fa enctype ) -from the keytab in +from the keytab in .Fa keyprocarg -(the default if == NULL) into +(the default if == NULL) into .Fa *key . Returns 0 or an error. .Pp .Fn krb5_kt_remove_entry -removes the entry +removes the entry .Fa entry -from the keytab +from the keytab .Fa id . Returns 0 or an error. .Pp @@ -332,14 +334,14 @@ main (int argc, char **argv) if (krb5_init_context (&context) != 0) errx(1, "krb5_context"); - + ret = krb5_kt_default (context, &keytab); if (ret) krb5_err(context, 1, ret, "krb5_kt_default"); ret = krb5_kt_start_seq_get(context, keytab, &cursor); if (ret) - krb5_err(context, 1, ret, "krb5_kt_start_seq_get"); + krb5_err(context, 1, ret, "krb5_kt_start_seq_get"); while((ret = krb5_kt_next_entry(context, keytab, &entry, &cursor)) == 0){ krb5_unparse_name_short(context, entry.principal, &principal); printf("principal: %s\\n", principal); @@ -348,7 +350,7 @@ main (int argc, char **argv) } ret = krb5_kt_end_seq_get(context, keytab, &cursor); if (ret) - krb5_err(context, 1, ret, "krb5_kt_end_seq_get"); + krb5_err(context, 1, ret, "krb5_kt_end_seq_get"); krb5_free_context(context); return 0; } |
