source: openpam/trunk/bin/pamtest/pamtest.1 @ 578

Last change on this file since 578 was 578, checked in by des, 2 years ago

As previously mentioned, move from 2-clause BSD to 3-clause BSD.

  • Property svn:keywords set to Id
File size: 4.5 KB
Line 
1.\"-
2.\" Copyright (c) 2011 Dag-Erling Smørgrav
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. The name of the author may not be used to endorse or promote
14.\"    products derived from this software without specific prior written
15.\"    permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\" $Id$
30.\"
31.Dd November 2, 2011
32.Dt PAMTEST 1
33.Os
34.Sh NAME
35.Nm pamtest
36.Nd PAM policy tester
37.Sh SYNOPSYS
38.Nm
39.Op Fl dksv
40.Op Fl H Ar rhost
41.Op Fl h Ar host
42.Op Fl t Ar tty
43.Op Fl U Ar ruser
44.Op Fl u Ar user
45.Ar service
46.Op Ar command ...
47.Sh DESCRIPTION
48The
49.Nm
50utility offers an easy way to test PAM modules and policies from the
51command line.
52.Pp
53The
54.Nm
55utility loads the PAM policy specified by the
56.Ar service
57argument, starts a PAM transaction by calling
58.Xr pam_start 3 ,
59then executes the primitives specified by the remaining command-line
60arguments.
61Finally, it ends the transaction by calling
62.Xr pam_end 3 .
63.Pp
64The commands are:
65.Bl -tag -width 6n
66.It Cm authenticate , Cm auth
67Call
68.Xr pam_authenticate 3 .
69.It Cm acct_mgmt , Cm account
70Call
71.Xr pam_acct_mgmt 3 .
72.It Cm chauthtok , Cm change
73Call
74.Xr pam_chauthtok 3
75with the
76.Dv PAM_CHANGE_EXPIRED_AUTHTOK
77flag set.
78.It Cm forcechauthtok , Cm forcechange
79Call
80.Xr pam_chauthtok 3
81with no flags set.
82.It Cm setcred , Cm establish_cred
83Call
84.Xr pam_setcred 3
85with the
86.Dv PAM_ESTABLISH_CRED
87flag set.
88.It Cm open_session , Cm open
89Call
90.Xr pam_open_session 3 .
91.It Cm close_session , Cm close
92Call
93.Xr pam_close_session 3 .
94.It Cm unsetcred , Cm delete_cred
95Call
96.Xr pam_setcred 3
97with the
98.Dv PAM_DELETE_CRED
99flag set.
100.It Cm listenv , Cm env
101Call
102.Xr pam_getenvlist 3
103and print the contents of the list it returns.
104.El
105.Pp
106The following options are available:
107.Bl -tag -width Fl
108.It Fl d
109Enables debug messages within the OpenPAM library.
110See
111.Xr openpam_log 3
112for details.
113.It Fl H Ar rhost
114Specify the name of the fictitious remote host.
115The default is to use the name of the local host.
116.It Fl h Ar host
117Specify the name of the local host.
118The default is to use the result of calling
119.Xr gethostname 3 .
120.It Fl k
121Keep going even if one of the commands fails.
122.It Fl s
123Set the
124.Dv PAM_SILENT
125flag when calling the
126.Xr pam_authenticate 3 ,
127.Xr pam_acct_mgmt 3 ,
128.Xr pam_chauthok 3 ,
129.Xr pam_setcred 3 ,
130.Xr pam_open_session 3
131and
132.Xr pam_close_session 3
133primitives.
134.It Fl t Ar tty
135Specify the name of the tty.
136The default is to use the result of calling
137.Xr ttyname 3 .
138.It Fl U Ar ruser
139Specify the name of the supplicant (remote user).
140.It Fl u Ar user
141Specify the name of the principal (local user).
142.It Fl v
143Enables debug messages from
144.Nm
145itself.
146.El
147.Sh EXAMPLES
148Simulate a typical PAM transaction using the
149.Dq system
150policy:
151.Bd -literal -offset indent
152pamtest -v system auth account change setcred open close unsetcred
153.Ed
154.Sh SEE ALSO
155.Xr openpam 3 ,
156.Xr pam 3 ,
157.Xr pam.conf 5
158.Sh AUTHORS
159The
160.Nm
161utility and this manual page were written by
162.An Dag-Erling Sm\(/orgrav Aq des@des.no .
163.Sh BUGS
164The
165.Nm
166utility does not (yet) support setting and getting individual PAM
167items or environment variables.
168.Pp
169The
170.Nm
171utility does not afford the user complete control over the flags
172passed to the
173.Xr pam_authenticate 3 ,
174.Xr pam_acct_mgmt 3 ,
175.Xr pam_chauthok 3 ,
176.Xr pam_setcred 3 ,
177.Xr pam_open_session 3
178and
179.Xr pam_close_session 3
180primitives.
Note: See TracBrowser for help on using the repository browser.