summaryrefslogtreecommitdiff
path: root/Linux-PAM/doc/man/pam_setcred.3
diff options
context:
space:
mode:
authorSteve Langasek <steve.langasek@ubuntu.com>2019-01-03 16:15:40 -0800
committerSteve Langasek <steve.langasek@ubuntu.com>2019-01-03 17:00:25 -0800
commit9727ff2a3fa0e94a42b34a579027bacf4146d571 (patch)
tree893f3d050906e7cb2284f97cf4577bb5e8ccbb60 /Linux-PAM/doc/man/pam_setcred.3
parent281e859131adad49301befbc50cfc5cd282c6937 (diff)
parentb2661a54ac276d20268dba45b4e025d58458241e (diff)
New upstream version 0.99.10.0
Diffstat (limited to 'Linux-PAM/doc/man/pam_setcred.3')
-rw-r--r--Linux-PAM/doc/man/pam_setcred.394
1 files changed, 58 insertions, 36 deletions
diff --git a/Linux-PAM/doc/man/pam_setcred.3 b/Linux-PAM/doc/man/pam_setcred.3
index 055ee56e..67f06e62 100644
--- a/Linux-PAM/doc/man/pam_setcred.3
+++ b/Linux-PAM/doc/man/pam_setcred.3
@@ -1,22 +1,22 @@
.\" Title: pam_setcred
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\" Date: 06/27/2006
-.\" Manual: Linux\-PAM Manual
-.\" Source: Linux\-PAM Manual
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\" Date: 02/04/2008
+.\" Manual: Linux-PAM Manual
+.\" Source: Linux-PAM Manual
.\"
-.TH "PAM_SETCRED" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.TH "PAM_SETCRED" "3" "02/04/2008" "Linux-PAM Manual" "Linux-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-pam_setcred \- establish / delete user credentials
+pam_setcred - establish / delete user credentials
.SH "SYNOPSIS"
.sp
.ft B
.nf
-#include <security/pam_appl.h>
+#include <security/pam_appl\.h>
.fi
.ft
.HP 16
@@ -25,55 +25,77 @@ pam_setcred \- establish / delete user credentials
.PP
The
\fBpam_setcred\fR
-function is used to establish, maintain and delete the credentials of a user. It should be called after a user has been authenticated and before a session is opened for the user (with
-\fBpam_open_session\fR(3)).
+function is used to establish, maintain and delete the credentials of a user\. It should be called after a user has been authenticated and before a session is opened for the user (with
+\fBpam_open_session\fR(3))\.
.PP
-A credential is something that the user possesses. It is some property, such as a
+A credential is something that the user possesses\. It is some property, such as a
\fIKerberos\fR
-ticket, or a supplementary group membership that make up the uniqueness of a given user. On a Linux system the user's
+ticket, or a supplementary group membership that make up the uniqueness of a given user\. On a Linux system the user\'s
\fIUID\fR
and
-\fIGID\fR's are credentials too. However, it has been decided that these properties (along with the default supplementary groups of which the user is a member) are credentials that should be set directly by the application and not by PAM. Such credentials should be established, by the application, prior to a call to this function. For example,
+\fIGID\fR\'s are credentials too\. However, it has been decided that these properties (along with the default supplementary groups of which the user is a member) are credentials that should be set directly by the application and not by PAM\. Such credentials should be established, by the application, prior to a call to this function\. For example,
\fBinitgroups\fR(2)
-(or equivalent) should have been performed.
+(or equivalent) should have been performed\.
.PP
Valid
-\fIflags\fR, any one of which, may be logically OR'd with
+\fIflags\fR, any one of which, may be logically OR\'d with
\fBPAM_SILENT\fR, are:
-.TP 3n
+.PP
PAM_ESTABLISH_CRED
-Initialize the credentials for the user.
-.TP 3n
+.RS 4
+Initialize the credentials for the user\.
+.RE
+.PP
PAM_DELETE_CRED
-Delete the user's credentials.
-.TP 3n
+.RS 4
+Delete the user\'s credentials\.
+.RE
+.PP
PAM_REINITIALIZE_CRED
-Fully reinitialize the user's credentials.
-.TP 3n
+.RS 4
+Fully reinitialize the user\'s credentials\.
+.RE
+.PP
PAM_REFRESH_CRED
-Extend the lifetime of the existing credentials.
+.RS 4
+Extend the lifetime of the existing credentials\.
+.RE
.SH "RETURN VALUES"
-.TP 3n
+.PP
PAM_BUF_ERR
-Memory buffer error.
-.TP 3n
+.RS 4
+Memory buffer error\.
+.RE
+.PP
PAM_CRED_ERR
-Failed to set user credentials.
-.TP 3n
+.RS 4
+Failed to set user credentials\.
+.RE
+.PP
PAM_CRED_EXPIRED
-User credentials are expired.
-.TP 3n
+.RS 4
+User credentials are expired\.
+.RE
+.PP
PAM_CRED_UNAVAIL
-Failed to retrieve user credentials.
-.TP 3n
+.RS 4
+Failed to retrieve user credentials\.
+.RE
+.PP
PAM_SUCCESS
-Data was successful stored.
-.TP 3n
+.RS 4
+Data was successful stored\.
+.RE
+.PP
PAM_SYSTEM_ERR
-A NULL pointer was submitted as PAM handle, the function was called by a module or another system error occured.
-.TP 3n
+.RS 4
+A NULL pointer was submitted as PAM handle, the function was called by a module or another system error occured\.
+.RE
+.PP
PAM_USER_UNKNOWN
-User is not known to an authentication module.
+.RS 4
+User is not known to an authentication module\.
+.RE
.SH "SEE ALSO"
.PP