contrib/openpam/doc/man/pam_setcred.3

   1 .\" Generated from pam_setcred.c by gendoc.pl
   2 .\" $OpenPAM: pam_setcred.c 938 2017-04-30 21:34:42Z des $
   3 .Dd April 30, 2017
   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 SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .Ft "int"
  13 .Fn pam_setcred "pam_handle_t *pamh" "int flags"
  14 .Sh DESCRIPTION
  15 The
  16 .Fn pam_setcred
  17 function manages the application's credentials.
  18 .Pp
  19 The
  20 .Fa flags
  21 argument is the binary or of zero or more of the following
  22 values:
  23 .Bl -tag -width 18n
  24 .It Dv PAM_SILENT
  25 Do not emit any messages.
  26 .It Dv PAM_ESTABLISH_CRED
  27 Establish the credentials of the target user.
  28 .It Dv PAM_DELETE_CRED
  29 Revoke all established credentials.
  30 .It Dv PAM_REINITIALIZE_CRED
  31 Fully reinitialise credentials.
  32 .It Dv PAM_REFRESH_CRED
  33 Refresh credentials.
  34 .El
  35 .Pp
  36 The latter four are mutually exclusive.
  37 .Pp
  38 If any other bits are set,
  39 .Fn pam_setcred
  40 will return
  41 .Dv PAM_BAD_CONSTANT .
  42 .Sh RETURN VALUES
  43 The
  44 .Fn pam_setcred
  45 function returns one of the following values:
  46 .Bl -tag -width 18n
  47 .It Bq Er PAM_SUCCESS
  48 Success.
  49 .It Bq Er PAM_ABORT
  50 General failure.
  51 .It Bq Er PAM_BAD_CONSTANT
  52 Bad constant.
  53 .It Bq Er PAM_BUF_ERR
  54 Memory buffer error.
  55 .It Bq Er PAM_CONV_ERR
  56 Conversation failure.
  57 .It Bq Er PAM_CRED_ERR
  58 Failed to set user credentials.
  59 .It Bq Er PAM_CRED_EXPIRED
  60 User credentials have expired.
  61 .It Bq Er PAM_CRED_UNAVAIL
  62 Failed to retrieve user credentials.
  63 .It Bq Er PAM_PERM_DENIED
  64 Permission denied.
  65 .It Bq Er PAM_SERVICE_ERR
  66 Error in service module.
  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 Mt des@des.no .