← Back to branch summary

~ubuntu-branches/ubuntu/breezy/pam/breezy

« back to all changes in this revision

Viewing changes to Linux-PAM/doc/man/pam_setcred.3

  • Committer: Bazaar Package Importer
  • Author(s): Sam Hartman
  • Date: 2004-06-28 14:28:08 UTC
  • mfrom: (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20040628142808-adikk7vtfg3pzcjw
Tags: 0.76-22
http://bugs.debian.org/254904
* Add uploaders
* Document location of repository
* Fix options containing arguments in pam_unix, Closes: #254904

Show diffs side-by-side

added added

removed removed

Lines of Context:
Linux-PAM/doc/man/pam_setcred.3
 
1
.\" Hey Emacs! This file is -*- nroff -*- source.
 
2
.\" $Id: pam_setcred.3,v 1.4 2002/09/21 18:19:20 hartmans Exp $
 
3
.\" Copyright (c) Andrew G. Morgan 1996,1997 <morgan@parc.power.net>
 
4
.TH PAM_SETCRED 3 "1997 July 6" "Linux-PAM 0.58" "App. Programmers' Manual"
 
5
.SH NAME
 
6
pam_setcred \- set the credentials for the user
 
7
.SH SYNOPSIS
 
8
.B #include <security/pam_appl.h>
 
9
.sp
 
10
.BI "int pam_setcred(pam_handle_t " *pamh ", int  " flags ");"
 
11
.sp 2
 
12
.SH DESCRIPTION
 
13
.B pam_setcred
 
14
 
 
15
This function is used to establish, maintain and delete the
 
16
credentials of a user. It should be called after a user has been
 
17
authenticated and before a session is opened for the user (with
 
18
.BR pam_open_session "(3))."
 
19
 
 
20
It should be noted that credentials come in many forms. Examples
 
21
include: group memberships; ticket-files; and Linux-PAM environment
 
22
variables.  For this reason, it is important that the basic identity
 
23
of the user is established, by the application, prior to a call to
 
24
this function.  For example, the default
 
25
.BR Linux-PAM
 
26
environment variables should be set and also
 
27
.BR initgroups "(2) "
 
28
(or equivalent) should have been performed.
 
29
 
 
30
.SH "VALID FLAGS"
 
31
.TP
 
32
.BR PAM_ESTABLISH_CRED
 
33
initialize the credentials for the user.
 
34
 
 
35
.TP
 
36
.BR PAM_DELETE_CRED
 
37
delete the user's credentials.
 
38
 
 
39
.TP
 
40
.BR PAM_REINITIALIZE_CRED
 
41
delete and then initialize the user's credentials.
 
42
 
 
43
.TP
 
44
.BR PAM_REFRESH_CRED
 
45
extend the lifetime of the existing credentials.
 
46
 
 
47
.SH "RETURN VALUE"
 
48
 
 
49
On success
 
50
.BR PAM_SUCCESS
 
51
is returned, all other return values should be treated as errors.
 
52
 
 
53
.SH ERRORS
 
54
May be translated to text with
 
55
.BR pam_strerror "(3). "
 
56
 
 
57
.SH "CONFORMING TO"
 
58
DCE-RFC 86.0, October 1995.
 
59
 
 
60
.SH BUGS
 
61
.sp 2
 
62
none known.
 
63
 
 
64
.SH "SEE ALSO"
 
65
 
 
66
.BR pam_authenticate "(3), "
 
67
.BR pam_strerror "(3)"
 
68
and
 
69
.BR pam_open_session "(3). "
 
70
 
 
71
Also, see the three
 
72
.BR Linux-PAM
 
73
Guides, for
 
74
.BR "System administrators" ", "
 
75
.BR "module developers" ", "
 
76
and
 
77
.BR "application developers" ". "