chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / pod / domain.pod
1 =head1 NAME
2
3 domain - nnrpd domain resolver
4
5 =head1 SYNOPSIS
6
7 B<domain> B<domainname>
8
9 =head1 DESCRIPTION
10
11 This program can be used in F<readers.conf> to grant access based on the
12 subdomain part of the remote hostname.  In particular, it only returns
13 success if the remote hostname ends in B<domainname>.  (A leading dot on
14 B<domainname> is optional; even without it, the argument must match on
15 dot-separated boundaries).  The "username" returned is whatever initial
16 part of the remote hostname remains after B<domainname> is removed.  It
17 is an error if there is no initial part (that is, if the remote hostname
18 is I<exactly> the specified B<domainname>).
19
20 =head1 EXAMPLE
21
22 The following readers.conf(5) fragment grants access to hosts with
23 internal domain names:
24
25     auth internal {
26         res: "domain .internal"
27         default-domain: "example.com"
28     }
29
30     access internal {
31         users: "*@example.com"
32         newsgroups: example.*
33     }
34
35 Access is granted to the example.* groups for all connections from hosts
36 that resolve to hostnames ending in C<.internal>; a connection from
37 "foo.internal" would match access groups as "foo@example.com".
38
39 =head1 BUGS
40
41 It seems the code does not confirm that the matching part is actually at
42 the end of the remote hostname (e.g., "domain: example.com" would match
43 the remote host "foo.example.com.org" by ignoring the trailing ".org"
44 part).
45
46 Does this resolver actually provide any useful functionality not
47 available by using wildcards in the readers.conf(5) I<hosts> parameter?
48 If so, the example above should reflect this functionality.
49
50 =head1 HISTORY
51
52 This documentation was written by Jeffrey M. Vinocur <jeff@litech.org>.
53
54 $Id: domain.pod 5988 2002-12-12 23:02:14Z vinocur $
55
56 =head1 SEE ALSO
57
58 nnrpd(8), readers.conf(5)
59
60 =cut