contrib/openpam/doc/man/pam_setcred.3

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