dist/openpam/doc/man/pam_setcred.3

   1 .\"     $NetBSD: pam_setcred.3,v 1.4 2006/02/05 02:37:45 christos Exp $
   2 .\"
   3 .\"-
   4 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   5 .\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
   6 .\" All rights reserved.
   7 .\"
   8 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   9 .\" Network Associates Laboratories, the Security Research Division of
  10 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
  11 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  12 .\"
  13 .\" Redistribution and use in source and binary forms, with or without
  14 .\" modification, are permitted provided that the following conditions
  15 .\" are met:
  16 .\" 1. Redistributions of source code must retain the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer.
  18 .\" 2. Redistributions in binary form must reproduce the above copyright
  19 .\"    notice, this list of conditions and the following disclaimer in the
  20 .\"    documentation and/or other materials provided with the distribution.
  21 .\" 3. The name of the author may not be used to endorse or promote
  22 .\"    products derived from this software without specific prior written
  23 .\"    permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\" $P4$
  38 .\"
  39 .Dd December 21, 2007
  40 .Dt PAM_SETCRED 3
  41 .Os
  42 .Sh NAME
  43 .Nm pam_setcred
  44 .Nd modify / delete user credentials for an authentication service
  45 .Sh LIBRARY
  46 .Lb libpam
  47 .Sh SYNOPSIS
  48 .In sys/types.h
  49 .In security/pam_appl.h
  50 .Ft "int"
  51 .Fn pam_setcred "pam_handle_t *pamh" "int flags"
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 function manages the application's credentials.
  56 .Pp
  57 The
  58 .Fa flags
  59 argument is the binary or of zero or more of the following
  60 values:
  61 .Bl -tag -width 18n
  62 .It Dv PAM_SILENT
  63 Do not emit any messages.
  64 .It Dv PAM_ESTABLISH_CRED
  65 Establish the credentials of the target user.
  66 .It Dv PAM_DELETE_CRED
  67 Revoke all established credentials.
  68 .It Dv PAM_REINITIALIZE_CRED
  69 Fully reinitialise credentials.
  70 .It Dv PAM_REFRESH_CRED
  71 Refresh credentials.
  72 .El
  73 .Pp
  74 The latter four are mutually exclusive.
  75 .Pp
  76 If any other bits are set,
  77 .Nm
  78 will return
  79 .Dv PAM_SYMBOL_ERR .
  80 .Sh RETURN VALUES
  81 The
  82 .Nm
  83 function returns one of the following values:
  84 .Bl -tag -width 18n
  85 .It Bq Er PAM_ABORT
  86 General failure.
  87 .It Bq Er PAM_BUF_ERR
  88 Memory buffer error.
  89 .It Bq Er PAM_CONV_ERR
  90 Conversation failure.
  91 .It Bq Er PAM_CRED_ERR
  92 Failed to set user credentials.
  93 .It Bq Er PAM_CRED_EXPIRED
  94 User credentials have expired.
  95 .It Bq Er PAM_CRED_UNAVAIL
  96 Failed to retrieve user credentials.
  97 .It Bq Er PAM_PERM_DENIED
  98 Permission denied.
  99 .It Bq Er PAM_SERVICE_ERR
 100 Error in service module.
 101 .It Bq Er PAM_SYMBOL_ERR
 102 Invalid symbol.
 103 .It Bq Er PAM_SYSTEM_ERR
 104 System error.
 105 .It Bq Er PAM_USER_UNKNOWN
 106 Unknown user.
 107 .El
 108 .Sh SEE ALSO
 109 .Xr pam 3 ,
 110 .Xr pam_strerror 3
 111 .Sh STANDARDS
 112 .Rs
 113 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
 114 .%D "June 1997"
 115 .Re
 116 .Sh AUTHORS
 117 The
 118 .Nm
 119 function and this manual page were developed for the
 120 .Fx
 121 Project by ThinkSec AS and Network Associates Laboratories, the
 122 Security Research Division of Network Associates, Inc.\& under
 123 DARPA/SPAWAR contract N66001-01-C-8035
 124 .Pq Dq CBOSS ,
 125 as part of the DARPA CHATS research program.