chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / pod / auth_smb.pod
1 =head1 NAME
2
3 auth_smb - nnrpd Samba authenticator
4
5 =head1 SYNOPSIS
6
7 B<auth_smb> B<server> [B<backup_server>] B<domain>
8
9 =head1 DESCRIPTION
10
11 This program does authentication for B<nnrpd> against an SMB server.  It
12 passes the received username and password to B<server> for validation in
13 the specified SMB B<domain>.  A backup server may optionally be
14 supplied; if it is missing, only B<server> is used.
15
16 If authentication is successful, the original username is returned as
17 the authentication identity.  Brief errors, including incorrect password
18 and failure contacting the server, are logged.
19
20 =head1 EXAMPLE
21
22 The following readers.conf(5) fragment grants access to users who can
23 authenticate against an SMB server:
24
25     auth windows {
26         auth: "auth_smb pdc.example.com bdc.example.com USERS"
27         default-domain: "users.example.com"
28     }
29
30     access internal {
31         users: "*@users.example.com"
32         newsgroups: example.*
33     }
34
35 Access is granted to the example.* groups after successful
36 authentication.
37
38 =head1 BUGS
39
40 We should link against an external SMB library rather than maintain one
41 within the INN source tree.
42
43 =head1 HISTORY
44
45 Originally written October 2000 by Krischan Jodies <krischan@jodies.cx>,
46 based heavily on pam_smb v1.1.6 by David Airlie <airlied@samba.org>.
47 This documentation was written by Jeffrey M. Vinocur <jeff@litech.org>.
48
49 $Id: auth_smb.pod 5988 2002-12-12 23:02:14Z vinocur $
50
51 =head1 SEE ALSO
52
53 nnrpd(8), readers.conf(5)
54
55 =cut