diff options
Diffstat (limited to 'contrib/openpam/doc/man/pam.3')
| -rw-r--r-- | contrib/openpam/doc/man/pam.3 | 61 |
1 files changed, 31 insertions, 30 deletions
diff --git a/contrib/openpam/doc/man/pam.3 b/contrib/openpam/doc/man/pam.3 index 51c7e2ef8fc3..0342120967bf 100644 --- a/contrib/openpam/doc/man/pam.3 +++ b/contrib/openpam/doc/man/pam.3 @@ -33,7 +33,7 @@ .\" .\" $P4$ .\" -.Dd June 1, 2003 +.Dd July 15, 2003 .Dt PAM 3 .Os .Sh NAME @@ -59,42 +59,42 @@ .Lb libpam .Sh SYNOPSIS .In security/pam_appl.h -.Ft int +.Ft "int" .Fn pam_acct_mgmt "pam_handle_t *pamh" "int flags" -.Ft int +.Ft "int" .Fn pam_authenticate "pam_handle_t *pamh" "int flags" -.Ft int +.Ft "int" .Fn pam_chauthtok "pam_handle_t *pamh" "int flags" -.Ft int +.Ft "int" .Fn pam_close_session "pam_handle_t *pamh" "int flags" -.Ft int +.Ft "int" .Fn pam_end "pam_handle_t *pamh" "int status" -.Ft int +.Ft "int" .Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "const void **data" -.Ft int +.Ft "int" .Fn pam_get_item "pam_handle_t *pamh" "int item_type" "const void **item" -.Ft int +.Ft "int" .Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt" -.Ft const char * +.Ft "const char *" .Fn pam_getenv "pam_handle_t *pamh" "const char *name" -.Ft char ** +.Ft "char **" .Fn pam_getenvlist "pam_handle_t *pamh" -.Ft int +.Ft "int" .Fn pam_open_session "pam_handle_t *pamh" "int flags" -.Ft int +.Ft "int" .Fn pam_putenv "pam_handle_t *pamh" "const char *namevalue" -.Ft int +.Ft "int" .Fn pam_set_data "pam_handle_t *pamh" "const char *module_data_name" "void *data" "void (*cleanup)(pam_handle_t *pamh, void *data, int pam_end_status)" -.Ft int +.Ft "int" .Fn pam_set_item "pam_handle_t *pamh" "int item_type" "const void *item" -.Ft int +.Ft "int" .Fn pam_setcred "pam_handle_t *pamh" "int flags" -.Ft int +.Ft "int" .Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh" -.Ft const char * +.Ft "const char *" .Fn pam_strerror "pam_handle_t *pamh" "int error_number" .\" -.\" $P4: //depot/projects/openpam/doc/man/pam.man#1 $ +.\" $P4: //depot/projects/openpam/doc/man/pam.man#2 $ .\" .Sh DESCRIPTION The Pluggable Authentication Modules (PAM) library abstracts a number @@ -108,7 +108,7 @@ service name, which is often (but not necessarily) the program name. .Pp The user requesting authentication is called the applicant, while the user (usually, root) charged with verifying his identity and granting -him the requested credentials is called the arbitrator. +him the requested credentials is called the arbitrator. .Pp The sequence of operations the server goes through to authenticate a user and perform whatever task he requested is a PAM transaction; the @@ -127,7 +127,7 @@ devices. See .Xr pam_conv 3 for details. -.Ss Initialization And Cleanup +.Ss Initialization and Cleanup The .Fn pam_start function initializes the PAM library and returns a handle which must @@ -139,7 +139,7 @@ transactions in parallel. The .Fn pam_end function releases all resources associated with the specified context, -and can be called at any time to terminate a PAM transaction. +and can be called at any time to terminate a PAM transaction. .Ss Storage The .Fn pam_set_item @@ -149,12 +149,12 @@ functions set and retrieve a number of predefined items, including the service name, the names of the requesting and target users, the conversation function, and prompts. .Pp -The +The .Fn pam_set_data and .Fn pam_get_data -manage named chunks of free-form data, generally used by modules to -store state from one invocation to another. +functions manage named chunks of free-form data, generally used by +modules to store state from one invocation to another. .Ss Authentication There are two authentication primitives: .Fn pam_authenticate @@ -179,7 +179,7 @@ The function allows the server to change the user's password, either at the user's request or because the password has expired. .Ss Miscellaneous -The +The .Fn pam_putenv , .Fn pam_getenv and @@ -189,7 +189,7 @@ variables they want the server to export during the session. .Pp The .Fn pam_strerror -function returns a pointer to a string describing a the specified PAM +function returns a pointer to a string describing the specified PAM error code. .Sh RETURN VALUES The following return codes are defined by @@ -257,7 +257,7 @@ Try again. Unknown user. .El .Sh SEE ALSO -.Xr openpam 3 +.Xr openpam 3 , .Xr pam_acct_mgmt 3 , .Xr pam_authenticate 3 , .Xr pam_chauthtok 3 , @@ -283,8 +283,9 @@ Unknown user. .Re .Sh AUTHORS The OpenPAM library and this manual page were developed for the -FreeBSD Project by ThinkSec AS and Network Associates Laboratories, -the Security Research Division of Network Associates, Inc. under +.Fx +Project by ThinkSec AS and Network Associates Laboratories, the +Security Research Division of Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 .Pq Dq CBOSS , as part of the DARPA CHATS research program. |