* radsecproxy.conf-example: Sanitize and verify rewrite examples.
[radsecproxy.git] / radsecproxy.conf-example
1 # Master config file, must be in /etc/radsecproxy or specified with -c option
2 #       All possible config options are listed below
3
4 # First you may define any global options, these are:
5 #
6 # You can optionally specify addresses and ports to listen on
7 # Multiple statements can be used for multiple ports/addresses
8 #ListenUDP              *:1814
9 #listenUDP              localhost
10 #ListenTCP              [2001:700:1:7:215:f2ff:fe35:307d]:1812
11 #listenTLS              10.10.10.10:2084
12 #ListenTLS              [2001:700:1:7:215:f2ff:fe35:307d]:2084
13 #ListenDTLS             [2001:700:1:7:215:f2ff:fe35:307d]:2084
14
15 # To specify a certain address/port for UDP/TLS requests you can use e.g.
16 #SourceUDP              127.0.0.1:33000
17 #SourceTCP              *:33000
18 #SourceTLS              *:33001
19 #SourceDTLS             *:33001
20 # Optional log level. 3 is default, 1 is less, 4 is more
21 #LogLevel               3
22 # Optional LogDestinatinon, else stderr used for logging
23 # Logging to file
24 #LogDestination         file:///tmp/rp.log
25 # Or logging with Syslog. LOG_DAEMON used if facility not specified
26 # The supported facilities are LOG_DAEMON, LOG_MAIL, LOG_USER and
27 # LOG_LOCAL0, ..., LOG_LOCAL7
28 #LogDestination         x-syslog:///
29 #LogDestination         x-syslog:///log_local2
30
31 # There is an option for doing some simple loop prevention
32 #LoopPrevention         on
33 # Add TTL attribute with value 20 if not present (prevents endless loops)
34 #addTTL 20
35
36 # If we have TLS clients or servers we must define at least one tls block.
37 # You can name them whatever you like and then reference them by name when
38 # specifying clients or servers later. There are however three special names
39 # "default", "defaultclient" and "defaultserver". If no name is defined for
40 # a client, the "defaultclient" block will be used if it exists, if not the
41 # "default" will be used. For a server, "defaultserver" followed by "default"
42 # will be checked.
43 #
44 # The simplest configuration you can do is:
45 tls default {
46     # You must specify at least one of CACertificateFile or CACertificatePath
47     # for TLS to work. We always verify peer certificate (client and server)
48     # CACertificateFile    /etc/cacerts/CA.pem
49     CACertificatePath   /etc/cacerts
50
51     # You must specify the below for TLS, we always present our certificate
52     CertificateFile     /etc/hostcertkey/host.example.com.pem
53     CertificateKeyFile  /etc/hostcertkey/host.example.com.key.pem
54     # Optionally specify password if key is encrypted (not very secure)
55     CertificateKeyPassword      "follow the white rabbit"
56     # Optionally enable CRL checking
57     # CRLCheck on
58     # Optionally specify how long CAs and CRLs are cached, default forever
59     # CacheExpiry 3600
60     # Optionally require that peer certs have one of the specified policyOIDs
61     # policyoid     1.2.3 # this option can be used multiple times
62     # policyoid     1.3.4
63 }
64
65 # If you want one cert for all clients and another for all servers, use
66 # defaultclient and defaultserver instead of default. If we wanted some
67 # particular server to use something else you could specify a block
68 # "tls myserver" and then reference that for that server. If you always
69 # name the tls block in the client/server config you don't need a default
70
71 # Now we configure clients, servers and realms. Note that these and
72 # also the lines above may be in any order, except that a realm
73 # can only be configured to use a server that is previously configured.
74
75 # A realm can be a literal domain name, * which matches all, or a
76 # regexp. A regexp is specified by the character prefix /
77 # For regexp we do case insensitive matching of the entire username string.
78 # The matching of realms is done in the order they are specified, using the
79 # first match found. Some examples are
80 # "@example\.com$", "\.com$", ".*" and "^[a-z].*@example\.com$".
81 # To treat local users separately you might try first specifying "@"
82 # and after that "*".
83
84 # Configure a rewrite block if you want to add/remove/modify attributes
85 # rewrite example {
86 #       # Remove NAS-Port.
87 #       removeAttribute 5
88 #       # Remove vendor attribute 100.
89 #       removeVendorAttribute 99:100
90 #       # Called-Station-Id = "123456"
91 #       addAttribute 30:123456
92 #       # Vendor-99-Attr-101 = 0x0f
93 #       addVendorAttribute 99:101:%0f
94 #       # Change users @local to @example.com.
95 #       modifyAttribute 1:/^(.*)@local$/\1@example.com/
96 # }
97
98 client 2001:db8::1 {
99         type    tls
100         secret  verysecret
101 # we could specify tls here, e.g.
102 #       tls myclient
103 # in order to use tls parameters named myclient. We don't, so we will
104 # use "tls defaultclient" if defined, or look for "tls default" as a
105 # last resort
106 }
107 client 127.0.0.1 {
108         type    udp
109         secret  secret
110 #       Might do rewriting of incoming messages using rewrite block example
111 #       rewriteIn example
112 #       Can also do rewriting of outgoing messages
113 #       rewriteOut example      
114 }
115 client 127.0.0.1 {
116         type    tcp
117         secret  secret
118 }
119 client radius.example.com {
120         type tls
121 # secret is optional for TLS
122 }
123 client radius.example.com {
124         type dtls
125 # secret is optional for DTLS
126 }
127
128 server 127.0.0.1 {
129         type    UDP
130         secret  secret
131 #       Might do rewriting of incoming messages using rewrite block example
132 #       rewriteIn example
133 #       Can also do rewriting of outgoing messages
134 #       rewriteOut example      
135 }
136 realm   eduroam.cc {
137         server  127.0.0.1
138 # If also want to use this server for accounting, specify
139 #       accountingServer 127.0.0.1
140 }
141
142 server 2001:db8::1 {
143         type    TLS
144         port    2283
145 # secret is optional for TLS
146 # we could specify tls here, e.g.
147 #       tls myserver
148 # in order to use tls parameters named myserver. We don't, so we will
149 # use "tls defaultserver" if defined, or look for "tls default" as a
150 # last resort
151 }
152 server radius.example.com {
153         type    tls
154         secret  verysecret
155         StatusServer on
156 # statusserver is optional, can be on or off. Off is default
157 }
158 #server radius.example.com {
159 #       type    dtls
160 #       secret  verysecret
161 #       StatusServer on
162 ## statusserver is optional, can be on or off. Off is default
163 #}
164
165 # Equivalent to example.com
166 realm /@example\.com$ {
167         server 2001:db8::1
168 }
169 # One can define a realm without servers, the proxy will then reject
170 # and requests matching this. Optionally one can specify ReplyMessage
171 # attribute to be included in the reject message. One can also use
172 # AccountingResponse option to specify that the proxy should send such.
173 realm /\.com$ {
174 }
175 realm /^anonymous$ {
176         replymessage "No Access"
177 #       AccountingResponse On
178 }
179 # The realm below is equivalent to /.*
180 realm * {
181         server radius.example.com
182 }
183 # If you don't have a default server you probably want to
184 # reject all unknowns. Optionally you can also include a message
185 #realm * {
186 #        replymessage "User unknown"
187 #}