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 socket I/O read/write to
  42 .I
  43 SMTP Authentication
  44 server. (default is
  45 .I 30
  46 seconds)
  47 .TP
  48 .B ConnectTimeout
  49 Specifies the timeout seconds of connection to
  50 .I
  51 SMTP Authentication
  52 server. (default is
  53 .I 10
  54 seconds)
  55 .TP
  56 .B SMTPServer_<n>
  57 Specifies the string of
  58 .I
  59 SMTP Authentication
  60 server.
  61 .I
  62 <n>
  63 is the number of server order.
  64 .br
  65 .B [example]
  66 .br
  67 SMTPServer_0 = mail.your.domain:25
  68 .br
  69 SMTPServer_1 = smtps:mail.your.domain:smtps
  70 .TP
  71 .B PasswordPrompt
  72 Specifies the string of the password prompt.
  73 .br
  74 .B [example]
  75 .br
  76 PasswordPrompt = Password:
  77 .TP
  78 .B SSLCertificateFile
  79 Specifies the path of a PEM encoded certificate file.
  80 .br
  81 .B [example]
  82 .br
  83 SSLCertificateFile = /usr/share/ssl/certs/ca-bundle.crt
  84 .TP
  85 .B BlockedUserListFile
  86 Specifies the path of a file that the unacceptable users is written.
  87 .br
  88 .B [example]
  89 .br
  90 BlockedUserListFile = /etc/pam_smtpauth.blockedusers
  91
  92 .SH FILES
  93 .TP
  94 /etc/pam_smtpauth.conf, /etc/pam.d/smtp
  95 .SH SEE ALSO
  96 .BR pam (8)