Home | History | Annotate | Line # | Download | only in man
pam_setcred.3 revision 1.5 
      1 <<<<<<< pam_setcred.3
      2 .\"	$NetBSD: pam_setcred.3,v 1.5 2014/10/24 18:17:56 christos Exp $
      3 .\"
      4 =======
      5 >>>>>>> 1.1.1.4
      6 .\" Generated from pam_setcred.c by gendoc.pl
      7 .\" Id: pam_setcred.c 648 2013-03-05 17:54:27Z des 
      8 .Dd September 12, 2014
      9 .Dt PAM_SETCRED 3
     10 .Os
     11 .Sh NAME
     12 .Nm pam_setcred
     13 .Nd modify / delete user credentials for an authentication service
     14 .Sh LIBRARY
     15 .Lb libpam
     16 .Sh SYNOPSIS
     17 .In sys/types.h
     18 .In security/pam_appl.h
     19 .Ft "int"
     20 .Fn pam_setcred "pam_handle_t *pamh" "int flags"
     21 .Sh DESCRIPTION
     22 The
     23 .Fn pam_setcred
     24 function manages the application's credentials.
     25 .Pp
     26 The
     27 .Fa flags
     28 argument is the binary or of zero or more of the following
     29 values:
     30 .Bl -tag -width 18n
     31 .It Dv PAM_SILENT
     32 Do not emit any messages.
     33 .It Dv PAM_ESTABLISH_CRED
     34 Establish the credentials of the target user.
     35 .It Dv PAM_DELETE_CRED
     36 Revoke all established credentials.
     37 .It Dv PAM_REINITIALIZE_CRED
     38 Fully reinitialise credentials.
     39 .It Dv PAM_REFRESH_CRED
     40 Refresh credentials.
     41 .El
     42 .Pp
     43 The latter four are mutually exclusive.
     44 .Pp
     45 If any other bits are set,
     46 .Fn pam_setcred
     47 will return
     48 .Dv PAM_SYMBOL_ERR .
     49 .Sh RETURN VALUES
     50 The
     51 .Fn pam_setcred
     52 function returns one of the following values:
     53 .Bl -tag -width 18n
     54 .It Bq Er PAM_ABORT
     55 General failure.
     56 .It Bq Er PAM_BUF_ERR
     57 Memory buffer error.
     58 .It Bq Er PAM_CONV_ERR
     59 Conversation failure.
     60 .It Bq Er PAM_CRED_ERR
     61 Failed to set user credentials.
     62 .It Bq Er PAM_CRED_EXPIRED
     63 User credentials have expired.
     64 .It Bq Er PAM_CRED_UNAVAIL
     65 Failed to retrieve user credentials.
     66 .It Bq Er PAM_PERM_DENIED
     67 Permission denied.
     68 .It Bq Er PAM_SERVICE_ERR
     69 Error in service module.
     70 .It Bq Er PAM_SYMBOL_ERR
     71 Invalid symbol.
     72 .It Bq Er PAM_SYSTEM_ERR
     73 System error.
     74 .It Bq Er PAM_USER_UNKNOWN
     75 Unknown user.
     76 .El
     77 .Sh SEE ALSO
     78 .Xr pam 3 ,
     79 .Xr pam_strerror 3
     80 .Sh STANDARDS
     81 .Rs
     82 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
     83 .%D "June 1997"
     84 .Re
     85 .Sh AUTHORS
     86 The
     87 .Fn pam_setcred
     88 function and this manual page were
     89 developed for the
     90 .Fx
     91 Project by ThinkSec AS and Network Associates Laboratories, the
     92 Security Research Division of Network Associates, Inc.\& under
     93 DARPA/SPAWAR contract N66001-01-C-8035
     94 .Pq Dq CBOSS ,
     95 as part of the DARPA CHATS research program.
     96 .Pp
     97 The OpenPAM library is maintained by
     98 .An Dag-Erling Sm\(/orgrav Aq des (a] des.no .
     99