OSDN Git Service

commited.
[pam-smtpauth/pam_smtpauth.git] / pam_smtpauth.5
1 .TH pam_smtpauth 5
2 .\"  Copyright (C) 2009 HDE, Inc.
3 .\" Copying restrictions apply. See COPYING.
4 .\" $Id: pam_smtpauth.5,v 1.2 2009/06/11 10:02:05 taizo Exp $
5 .SH NAME
6 pam_smtpauth \-  Pluggable authentication module for SMTP Authentication
7 .SH DESCRIPTION
8 The
9 .B pam_smtpauth
10 module is a Pluggable Authentication Module (PAM) which provides
11 for authentication, authorization and password changing against
12 .I
13 SMTP Authentication
14 servers. 
15 .LP
16 The present version of
17 .B
18 pam_smtpauth
19 supports Linux.
20
21
22
23 .SH CONFIGURATION
24 .B
25 pam_smtpauth
26 stores its configuration in the
27 .B
28 pam_smtpauth.conf
29 file.
30 .LP
31 Configuration file options consist of
32 .B
33 "key = value"
34 format.
35 The following options are supported by
36 .B
37 pam_smtpauth
38 .B
39 .TP
40 .B Timeout
41 Specifies the timeout seconds of connection to
42 .I
43 SMTP Authentication
44 server. (default is
45 .I 30
46 seconds)
47 .TP
48 .B SMTPServer_<n>
49 Specifies the string of
50 .I
51 SMTP Authentication
52 server.
53 .I
54 <n>
55 is the number of server order.
56 .br
57 .B [example]
58 .br
59 SMTPServer_0 = mail.your.domain:25
60 .br
61 SMTPServer_1 = smtps:mail.your.domain:smtps
62 .TP
63 .B PasswordPrompt
64 Specifies the string of the password prompt.
65 .br
66 .B [example]
67 .br
68 PasswordPrompt = Password: 
69 .TP
70 .B SSLCertificateFile
71 Specifies the path of a PEM encoded certificate file.
72 .br
73 .B [example]
74 .br
75 SSLCertificateFile = /usr/share/ssl/certs/ca-bundle.crt
76
77
78 .SH FILES
79 .TP
80 /etc/pam_smtpauth.conf, /etc/pam.d/smtp
81 .SH SEE ALSO
82 .BR pam (8)