Changeset 115 in openpam


Ignore:
Timestamp:
Apr 14, 2002, 8:22:20 PM (16 years ago)
Author:
Dag-Erling Smørgrav
Message:

More checks & documentation, and fix some markup nits.

Sponsored by: DARPA, NAI Labs

Location:
trunk/lib
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/pam_acct_mgmt.c

    r93 r115  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_acct_mgmt.c#7 $
     34 * $P4: //depot/projects/openpam/lib/pam_acct_mgmt.c#8 $
    3535 */
    3636
     
    6363 *      !PAM_IGNORE
    6464 */
     65
     66/**
     67 * The =pam_acct_mgmt function verifies and enforces account restrictions
     68 * after the user has been authenticated.
     69 *
     70 * The =flags argument is the binary or of zero or more of the following
     71 * values:
     72 *
     73 *      =PAM_SILENT:
     74 *              Do not emit any messages.
     75 *      =PAM_DISALLOW_NULL_AUTHTOK:
     76 *              Fail if the user's authentication token is null.
     77 *
     78 * If any other bits are set, =pam_authenticate will return
     79 * =PAM_SYMBOL_ERR.
     80 */
  • trunk/lib/pam_authenticate.c

    r102 r115  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_authenticate.c#9 $
     34 * $P4: //depot/projects/openpam/lib/pam_authenticate.c#10 $
    3535 */
    3636
     
    6767 *      =pam_sm_authenticate
    6868 *      !PAM_IGNORE
     69 *      PAM_SYMBOL_ERR
    6970 */
    7071
     
    8081 * values:
    8182 *
    82  *      =PAM_SILENT
     83 *      =PAM_SILENT:
    8384 *              Do not emit any messages.
    84  *      =PAM_DISALLOW_NULL_AUTHTOK
     85 *      =PAM_DISALLOW_NULL_AUTHTOK:
    8586 *              Fail if the user's authentication token is null.
     87 *
     88 * If any other bits are set, =pam_authenticate will return
     89 * =PAM_SYMBOL_ERR.
    8690 */
  • trunk/lib/pam_chauthtok.c

    r102 r115  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_chauthtok.c#10 $
     34 * $P4: //depot/projects/openpam/lib/pam_chauthtok.c#11 $
    3535 */
    3636
     
    8383 * values:
    8484 *
    85  *      =PAM_SILENT
     85 *      =PAM_SILENT:
    8686 *              Do not emit any messages.
    87  *      =PAM_CHANGE_EXPIRED_AUTHTOK
     87 *      =PAM_CHANGE_EXPIRED_AUTHTOK:
    8888 *              Change only those authentication tokens that have expired.
     89 *
     90 * If any other bits are set, =pam_chauthtok will return =PAM_SYMBOL_ERR.
    8991 */
  • trunk/lib/pam_close_session.c

    r93 r115  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_close_session.c#7 $
     34 * $P4: //depot/projects/openpam/lib/pam_close_session.c#8 $
    3535 */
    3636
     
    5353{
    5454
     55        if (flags & ~(PAM_SILENT))
     56                return (PAM_SYMBOL_ERR);
    5557        return (openpam_dispatch(pamh, PAM_SM_CLOSE_SESSION, flags));
    5658}
     
    6264 *      =pam_sm_close_session
    6365 *      !PAM_IGNORE
     66 *      PAM_SYMBOL_ERR
    6467 */
     68
     69/**
     70 * The =pam_close_session function tears down the user session previously
     71 * set up by =pam_open_session.
     72 *
     73 * The =flags argument is the binary or of zero or more of the following
     74 * values:
     75 *
     76 *      =PAM_SILENT:
     77 *              Do not emit any messages.
     78 *
     79 * If any other bits are set, =pam_close_session will return
     80 * =PAM_SYMBOL_ERR.
     81 */
  • trunk/lib/pam_open_session.c

    r93 r115  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_open_session.c#7 $
     34 * $P4: //depot/projects/openpam/lib/pam_open_session.c#8 $
    3535 */
    3636
     
    5353{
    5454
     55        if (flags & ~(PAM_SILENT))
     56                return (PAM_SYMBOL_ERR);
    5557        return (openpam_dispatch(pamh, PAM_SM_OPEN_SESSION, flags));
    5658}
     
    6264 *      =pam_sm_open_session
    6365 *      !PAM_IGNORE
     66 *      PAM_SYMBOL_ERR
    6467 */
     68
     69/**
     70 * The =pam_open_session sets up a user session for a previously
     71 * authenticated user.  The session should later be torn down by a call to
     72 * =pam_close_session.
     73 *
     74 * The =flags argument is the binary or of zero or more of the following
     75 * values:
     76 *
     77 *      =PAM_SILENT:
     78 *              Do not emit any messages.
     79 *
     80 * If any other bits are set, =pam_open_session will return
     81 * =PAM_SYMBOL_ERR.
     82 */
  • trunk/lib/pam_setcred.c

    r93 r115  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_setcred.c#8 $
     34 * $P4: //depot/projects/openpam/lib/pam_setcred.c#9 $
    3535 */
    3636
     
    5353{
    5454
     55        if (flags & ~(PAM_SILENT|PAM_ESTABLISH_CRED|PAM_DELETE_CRED|
     56                PAM_REINITIALIZE_CRED|PAM_REFRESH_CRED))
     57                return (PAM_SYMBOL_ERR);
     58        /* XXX enforce exclusivity */
    5559        return (openpam_dispatch(pamh, PAM_SM_SETCRED, flags));
    5660}
     
    6266 *      =pam_sm_setcred
    6367 *      !PAM_IGNORE
     68 *      PAM_SYMBOL_ERR
    6469 */
    6570
    6671/**
    6772 * The =pam_setcred function manages the application's credentials.
    68  * The operation to perform is specified by the =flags argument:
    6973 *
    70  *      PAM_ESTABLISH_CRED:
     74 * The =flags argument is the binary or of zero or more of the following
     75 * values:
     76 *
     77 *      =PAM_SILENT:
     78 *              Do not emit any messages.
     79 *      =PAM_ESTABLISH_CRED:
    7180 *              Establish the credentials of the target user.
    72  *      PAM_DELETE_CRED:
     81 *      =PAM_DELETE_CRED:
    7382 *              Revoke all established credentials.
    74  *      PAM_REINITIALIZE_CRED:
     83 *      =PAM_REINITIALIZE_CRED:
    7584 *              Fully reinitialise credentials.
    76  *      PAM_REFRESH_CRED:
     85 *      =PAM_REFRESH_CRED:
    7786 *              Refresh credentials.
     87 *
     88 * The latter four are mutually exclusive.
     89 *
     90 * If any other bits are set, =pam_setcred will return =PAM_SYMBOL_ERR.
    7891 */
Note: See TracChangeset for help on using the changeset viewer.