Changeset 107 in openpam for trunk/doc/man/pam_get_authtok.3


Ignore:
Timestamp:
Apr 8, 2002, 2:04:56 PM (18 years ago)
Author:
Dag-Erling Smørgrav
Message:

Regenerate.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/man/pam_get_authtok.3

    r93 r107  
    3232.\" SUCH DAMAGE.
    3333.\"
    34 .\" $P4: //depot/projects/openpam/doc/man/pam_get_authtok.3#10 $
     34.\" $P4: //depot/projects/openpam/doc/man/pam_get_authtok.3#11 $
    3535.\"
    36 .Dd March 7, 2002
     36.Dd April 8, 2002
    3737.Dt PAM_GET_AUTHTOK 3
    3838.Os
     
    4545.In security/pam_appl.h
    4646.Ft int
    47 .Fn pam_get_authtok "pam_handle_t *pamh" "const char **authtok" "const char *prompt"
     47.Fn pam_get_authtok "pam_handle_t *pamh" "int item" "const char **authtok" "const char *prompt"
    4848.Sh DESCRIPTION
    49 No description available.
     49The
     50.Nm
     51function returns the cached authentication token,
     52or prompts the user if no token is currently cached.  Either way, a
     53pointer to the authentication token is stored in the location pointed
     54to by the
     55.Va authtok
     56argument.
     57.Pp
     58The
     59.Va item
     60argument must have one of the following values:
     61.Pp
     62.Bd -literal
     63        =PAM_AUTHTOK
     64                Returns the current authentication token, or the new token
     65                when changing authentication tokens.
     66        =PAM_OLDAUTHTOK
     67                Returns the previous authentication token when changing
     68                authentication tokens.
     69
     70.Ed
     71The
     72.Va prompt
     73argument specifies a prompt to use if no token is cached.
     74.Ed
     75If it is
     76.Dv NULL ,
     77the
     78.Dv PAM_AUTHTOK_PROMPT
     79or
     80.Dv PAM_OLDAUTHTOK_PROMPT
     81item,
     82.Ed
     83as appropriate, will be used.  If that item is also
     84.Dv NULL ,
     85a hardcoded
     86.Ed
     87default prompt will be used.
     88
     89.Ed
     90If
     91.Va item
     92is set to
     93.Dv PAM_AUTHTOK
     94and there is a non-null
     95.Dv PAM_OLDAUTHTOK
     96.Ed
     97item,
     98.Nm
     99will ask the user to confirm the new token by
     100.Ed
     101retyping it.  If there is a mismatch,
     102.Nm
     103will return
     104.Ed
     105.Dv PAM_TRY_AGAIN .
     106
    50107.Sh RETURN VALUES
    51108The
     
    59116.It Bq Er PAM_SYSTEM_ERR
    60117System error.
     118.It Bq Er PAM_TRY_AGAIN
     119Try again.
    61120.El
    62121.Sh SEE ALSO
    63122.Xr pam 3 ,
     123.Xr pam_get_item 3 ,
     124.Xr pam_get_user 3 ,
    64125.Xr pam_strerror 3
    65126.Sh STANDARDS
Note: See TracChangeset for help on using the changeset viewer.