pam_setcred(3) [opendarwin man page]

PAM_SETCRED(3)						     App. Programmers' Manual						    PAM_SETCRED(3)

NAME

       pam_setcred - set the credentials for the user

SYNOPSIS

       #include <security/pam_appl.h>

       int pam_setcred(pam_handle_t *pamh, int	flags);

DESCRIPTION

       pam_setcred

       This  function is used to establish, maintain and delete the credentials of a user. It should be called after a user has been authenticated
       and before a session is opened for the user (with pam_open_session(3)).

       It should be noted that credentials come in many forms. Examples include: group memberships; ticket-files; and Linux-PAM environment  vari-
       ables.	For  this  reason, it is important that the basic identity of the user is established, by the application, prior to a call to this
       function.  For example, the default Linux-PAM environment variables should be set and also initgroups(2) (or equivalent) should	have  been
       performed.

VALID FLAGS

       PAM_ESTABLISH_CRED
	      initialize the credentials for the user.

       PAM_DELETE_CRED
	      delete the user's credentials.

       PAM_REINITIALIZE_CRED
	      delete and then initialize the user's credentials.

       PAM_REFRESH_CRED
	      extend the lifetime of the existing credentials.

RETURN VALUE

       On success PAM_SUCCESS is returned, all other return values should be treated as errors.

ERRORS

       May be translated to text with pam_strerror(3).

CONFORMING TO

       DCE-RFC 86.0, October 1995.

BUGS

       none known.

SEE ALSO

       pam_authenticate(3), pam_strerror(3) and pam_open_session(3).

       Also, see the three Linux-PAM Guides, for System administrators, module developers, and application developers.

Linux-PAM 0.58							    1997 July 6 						    PAM_SETCRED(3)

PAM_SETCRED(3)                                                   Linux-PAM Manual                                                   PAM_SETCRED(3)

NAME

       pam_setcred - establish / delete user credentials

SYNOPSIS

       #include <security/pam_appl.h>

       int pam_setcred(pam_handle_t *pamh, int flags);

DESCRIPTION

       The pam_setcred function is used to establish, maintain and delete the credentials of a user. It should be called to set the credentials
       after a user has been authenticated and before a session is opened for the user (with pam_open_session(3)). The credentials should be
       deleted after the session has been closed (with pam_close_session(3)).

       A credential is something that the user possesses. It is some property, such as a Kerberos ticket, or a supplementary group membership that
       make up the uniqueness of a given user. On a Linux system the user's UID and GID's are credentials too. However, it has been decided that
       these properties (along with the default supplementary groups of which the user is a member) are credentials that should be set directly by
       the application and not by PAM. Such credentials should be established, by the application, prior to a call to this function. For example,
       initgroups(2) (or equivalent) should have been performed.

       Valid flags, any one of which, may be logically OR'd with PAM_SILENT, are:

       PAM_ESTABLISH_CRED
           Initialize the credentials for the user.

       PAM_DELETE_CRED
           Delete the user's credentials.

       PAM_REINITIALIZE_CRED
           Fully reinitialize the user's credentials.

       PAM_REFRESH_CRED
           Extend the lifetime of the existing credentials.

RETURN VALUES

       PAM_BUF_ERR
           Memory buffer error.

       PAM_CRED_ERR
           Failed to set user credentials.

       PAM_CRED_EXPIRED
           User credentials are expired.

       PAM_CRED_UNAVAIL
           Failed to retrieve user credentials.

       PAM_SUCCESS
           Data was successful stored.

       PAM_SYSTEM_ERR
           A NULL pointer was submitted as PAM handle, the function was called by a module or another system error occured.

       PAM_USER_UNKNOWN
           User is not known to an authentication module.

SEE ALSO

       pam_authenticate(3), pam_open_session(3), pam_close_session(3), pam_strerror(3)

Linux-PAM Manual                                                    06/04/2011                                                      PAM_SETCRED(3)