summaryrefslogtreecommitdiff
path: root/doc/man/pam_setcred.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/pam_setcred.3')
-rw-r--r--doc/man/pam_setcred.382
1 files changed, 0 insertions, 82 deletions
diff --git a/doc/man/pam_setcred.3 b/doc/man/pam_setcred.3
deleted file mode 100644
index 055ee56e..00000000
--- a/doc/man/pam_setcred.3
+++ /dev/null
@@ -1,82 +0,0 @@
-.\" 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
-.\"
-.TH "PAM_SETCRED" "3" "06/27/2006" "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
-.SH "SYNOPSIS"
-.sp
-.ft B
-.nf
-#include <security/pam_appl.h>
-.fi
-.ft
-.HP 16
-.BI "int pam_setcred(pam_handle_t\ *" "pamh" ", int\ " "flags" ");"
-.SH "DESCRIPTION"
-.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)).
-.PP
-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
-\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,
-\fBinitgroups\fR(2)
-(or equivalent) should have been performed.
-.PP
-Valid
-\fIflags\fR, any one of which, may be logically OR'd with
-\fBPAM_SILENT\fR, are:
-.TP 3n
-PAM_ESTABLISH_CRED
-Initialize the credentials for the user.
-.TP 3n
-PAM_DELETE_CRED
-Delete the user's credentials.
-.TP 3n
-PAM_REINITIALIZE_CRED
-Fully reinitialize the user's credentials.
-.TP 3n
-PAM_REFRESH_CRED
-Extend the lifetime of the existing credentials.
-.SH "RETURN VALUES"
-.TP 3n
-PAM_BUF_ERR
-Memory buffer error.
-.TP 3n
-PAM_CRED_ERR
-Failed to set user credentials.
-.TP 3n
-PAM_CRED_EXPIRED
-User credentials are expired.
-.TP 3n
-PAM_CRED_UNAVAIL
-Failed to retrieve user credentials.
-.TP 3n
-PAM_SUCCESS
-Data was successful stored.
-.TP 3n
-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
-PAM_USER_UNKNOWN
-User is not known to an authentication module.
-.SH "SEE ALSO"
-.PP
-
-\fBpam_authenticate\fR(3),
-\fBpam_open_session\fR(3),
-\fBpam_strerror\fR(3)