pam_sm_setcred man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]

PAM_SM_SETCRED(3PAM)					  PAM_SM_SETCRED(3PAM)

NAME
       pam_sm_setcred - service provider implementation for pam_setcred

SYNOPSIS
       cc [ flag ... ] file ... -lpam [ library ... ]
       #include <security/pam_appl.h>
       #include <security/pam_modules.h>

       int pam_sm_setcred(pam_handle_t *pamh, int flags, int argc,
	    const char **argv);

DESCRIPTION
       In  response  to	 a call to pam_setcred(3PAM), the  PAM framework calls
       pam_sm_setcred() from the modules listed in the pam.conf(4) file.   The
       authentication  provider	 supplies  the back-end functionality for this
       interface function.

       The pam_sm_setcred() function is called to set the credentials  of  the
       current	user associated with the authentication handle, pamh. The fol‐
       lowing flags may be set in the flags field.  Note that the  first  four
       flags are mutually exclusive:

       PAM_ESTABLISH_CRED
				Set  user  credentials	for the authentication
				service.

       PAM_DELETE_CRED
				Delete user credentials	 associated  with  the
				authentication service.

       PAM_REINITIALIZE_CRED
				Reinitialize user credentials.

       PAM_REFRESH_CRED
				Extend lifetime of user credentials.

       PAM_SILENT
				Authentication	service	 should	 not  generate
				messages

       If no flag is set,  PAM_ESTABLISH _CRED is used as the default.

       The argc argument represents the number of  module  options  passed  in
       from  the  configuration	 file  pam.conf(4).  argv specifies the module
       options, which are interpreted and processed by the authentication ser‐
       vice.   If  an unknown option is passed to the  module, an error should
       be logged and the option ignored.

       If the  PAM_SILENT flag is not set, then pam_sm_setcred() should	 print
       any  failure status from the corresponding  pam_sm_authenticate() func‐
       tion using the conversation function.

       The authentication status (success or reason for failure) is  saved  as
       module-specific	state  in the authentication handle by the authentica‐
       tion module. The status should be retrieved using  pam_get_data(),  and
       used to determine if user credentials should be set.

RETURN VALUES
       Upon  successful	 completion,  PAM_SUCCESS should be returned. The fol‐
       lowing values may also be returned upon error:

       PAM_CRED_UNAVAIL
			   Underlying authentication service can not  retrieve
			   user credentials.

       PAM_CRED_EXPIRED
			   User credentials have expired.

       PAM_USER_UNKNOWN
			   User unknown to the authentication service.

       PAM_CRED_ERR
			   Failure in setting user credentials.

       PAM_IGNORE
			   Ignore  underlying authentication module regardless
			   of whether the control flag	is  required,optional,
			   or  sufficient.

ATTRIBUTES
       See attributes(5) for description of the following attributes:

       ┌────────────────────┬─────────────────────────┐
       │  ATTRIBUTE TYPE    │	  ATTRIBUTE VALUE     │
       ├────────────────────┼─────────────────────────┤
       │Interface Stability │  Stable		      │
       ├────────────────────┼─────────────────────────┤
       │MT-Level	    │ MT-Safe with exceptions │
       └────────────────────┴─────────────────────────┘

SEE ALSO
       pam(3PAM),    pam_authenticate(3PAM),	pam_get_data(3PAM)    pam_set‐
       cred(3PAM),   pam_sm_authenticate(3PAM),	  libpam(3LIB),	  pam.conf(4),
       attributes(5)

NOTES
       The  pam_sm_setcred()  function	is passed the same module options that
       are used by pam_sm_authenticate().

       The interfaces in  libpam are MT-Safe only if each  thread  within  the
       multithreaded application uses its own  PAM handle.

       If  the	PAM_REPOSITORY	item_type is set and a service module does not
       recognize the type, the service module does not	process	 any  informa‐
       tion,  and  returns  PAM_IGNORE. If the PAM_REPOSITORY item_type is not
       set, a service module performs its default action.

				 Nov 18, 2003		  PAM_SM_SETCRED(3PAM)
[top]

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net