updates
[silc.git] / doc / example_silcd.conf.in
1 #
2 # Example configuration file.  Note that this attempts to present various
3 # configuration possibilities and may not actually give any sensible 
4 # configuration.  For real life example see the examples/ directory.
5 #
6
7 #
8 # Configured ciphers.
9 #
10 # Format: <name>:<module path>:<key length>:<block length>
11 #
12 # If the cipher is builtin the <module path> maybe omitted.
13 #
14 [Cipher]
15 aes-256-cbc:@MODULESDIR@/aes.sim.so:32:16
16 aes-192-cbc:@MODULESDIR@/aes.sim.so:24:16
17 aes-128-cbc:@MODULESDIR@/aes.sim.so:16:16
18 twofish-256-cbc:@MODULESDIR@/twofish.sim.so:32:16
19 twofish-192-cbc:@MODULESDIR@/twofish.sim.so:24:16
20 twofish-128-cbc:@MODULESDIR@/twofish.sim.so:16:16
21 mars-256-cbc:@MODULESDIR@/mars.sim.so:32:16
22 mars-192-cbc:@MODULESDIR@/mars.sim.so:24:16
23 mars-128-cbc:@MODULESDIR@/mars.sim.so:16:16
24 none:@MODULESDIR@/none.sim.so:0:0
25
26 #
27 # Configured hash functions.
28 #
29 # Format: <name>:<module path>:<block length>:<digest length>
30 #
31 # If the hash function is builtin the <module path> maybe omitted.
32 #
33 [Hash]
34 sha1::64:20
35 md5::64:16
36
37 #
38 # Configured HMAC functions. The hash function used in the HMAC must
39 # configured to the [hash] section.
40 #
41 # Format: <name>:<hash name>:<mac length>
42 #
43 [hmac]
44 hmac-sha1-96:sha1:12
45 hmac-md5-96:md5:12
46 hmac-sha1:sha1:20
47 hmac-md5:md5:16
48
49 #
50 # Configured PKCS.
51 #
52 # Format: <name>
53 #
54 [PKCS]
55 rsa
56
57 #
58 # Run SILC server as specific user and group. The server must be initially
59 # run as root.
60 #
61 # Format: <user>:<group>
62 #
63 [Identity]
64 nobody:nobody
65
66 #
67 # Server's administrative information.
68 #
69 # Format: <location>:<server type>:<admin's name>:<admin's email address>
70 #
71 [AdminInfo]
72 Kuopio, Finland:Test Server:Pekka Riikonen:priikone@poseidon.pspt.fi
73
74 #
75 # Server information.
76 #
77 # Format: +<server FQDN>:<server IP>:<geographic location>:<port>
78 #
79 [ServerInfo]
80 lassi.kuo.fi.ssh.com:10.2.1.6:Kuopio, Finland:706
81
82 #
83 # Server keys
84 #
85 # Format: +<public key>:<private key>
86 #
87 [ServerKeys]
88 @ETCDIR@/silcd.pub:@ETCDIR@/silcd.prv
89
90 #
91 # Listenning ports.
92 #
93 # Format: <local IP>:<Listener IP>:<port>
94 #
95 [ListenPort]
96 10.2.1.6:10.2.1.6:706
97
98 #
99 # Log files.
100 #
101 # This section is used to set various logging files, their paths
102 # and maximum sizes. There are only four defined channels allowed for
103 # defining (see list below).
104 # The log channels have an importance value, and most important channels
105 # are printed on the less important ones, thus setting the logging file
106 # for "infologfile" will ensure logging for all channels, while setting
107 # logging file for "errorlogfile" will ensure logging for channels
108 # "error" and "fatal" only.
109 # If a message can't find a valid output file it will be discarded, thus,
110 # if you unset all files you will completely disable server logging (and
111 # this is NOT recommended).
112 # If maximum size is given, the logfile will be rotated to a logfile with
113 # the ".old" extension added. Older logfiles are flushed.
114 # There are also two options, quicklogs and flushdelay. Their values
115 # must be enclosed in colons (:), see the format below.
116 #
117 # Format: quicklogs:<yes/no>:
118 #         flushdelay:<seconds>:
119 #         infologfile:<path>:<max byte size>
120 #         warninglogile:<path>:<max byte size>
121 #         errorlogile:<path>:<max byte size>
122 #         fatallogile:<path>:<max byte size>
123 #
124 [Logging]
125 quicklogs:no:
126 flushdelay:300:
127 infologfile:@LOGSDIR@/silcd.log:50000
128 warninglogfile:@LOGSDIR@/silcd_warnings.log:50000
129 #errorlogfile:@LOGSDIR@/silcd_errors.log:50000
130 #fatallogfile:@LOGSDIR@/silcd_fatals.log:
131
132 #
133 # Connection classes.
134 #
135 # This section is used to define connection classes. These can be
136 # used to optimize the server and the connections.#
137 #
138 # Format: <class number>:<ping freq>:<connect freq>:<max links>
139 #
140 [ConnectionClass]
141 1:100:100:100
142 2:200:300:400
143
144 #
145 # Configured client connections.
146 #
147 # Format: <remote host>:<auth method>:<auth data>:<port>:<class>
148 #
149 # The <auth data> is either passphrase or file path to the public key
150 # file.
151 #
152 [ClientConnection]
153 :::706:1
154
155 #
156 # Configured server administrator connections
157 #
158 # Format: <host>:<username>:<nickname>:<auth method>:<auth data>
159 #
160 # The <auth data> is either passphrase or file path to the public key
161 # file.
162 #
163 [AdminConnection]
164 10.2.1.199:priikone:pekka:passwd:veryscret
165
166 #
167 # Configured server connections.
168 #
169 # If server connections are configured it means that our server is
170 # router server.  Normal server must not configure server connections.
171 # Thus, if your server is not router do not configure this section.  If
172 # your server is router, this must be configured.
173 #
174 # Format: <remote host>:<auth method>:<auth data>:<port>:
175 #         <version ID>:<class>:<backup connection>
176 #
177 # The <auth data> is either passphrase or file path to the public key
178 # file. If the connection is backup connection then set the <backup 
179 # connection> to value 1. For normal connections set it 0. If it is
180 # set to value 1 then this server will be backup router.
181 #
182 [ServerConnection]
183 10.2.1.7:passwd:veryscret:706:1:1:0
184 10.2.1.17:passwd:veryscret13:706:1:1:1   # backup connection, that host
185                                          # will use this server as backup
186                                          # router.
187
188 #
189 # Configured router connections.
190 #
191 # For normal server only one entry maybe configured to this section.  It
192 # must be the router this server will be connected to.  For router server,
193 # this sections includes all configured router connections.  The first
194 # configured connection is the primary route.
195 #
196 # Format: <remote host>:<auth method>:<auth data>:<port>:<version ID>:
197 #         <class>:<initiator>:<backup replace IP>:<backup replace port>:
198 #         <local backup>
199 #
200 # The <auth data> is either passphrase or file path to the public key
201 # file. If you are the initiator of the connection then set the <initiator>
202 # to value 1.  If you are the responder of the connection (waiting for 
203 # incoming connection) then set it to 0.
204 #
205 # If the connection is backup router connection then set the <backup
206 # replace IP> to the IP address of the router that the backup router will
207 # replace if it becomes unavailable.  Set also the router's port to the
208 # <backup replace port>.  For normal connection leave both empty. If this
209 # backup router is in our cell then set the <local backup> to value 1.
210 # If the backup router is in other cell then set it to value 0.
211 #
212 [RouterConnection]
213 #10.2.1.100:passwd:veryverysecret:706:1:1:1
214 #10.2.100.131:pubkey:/path/to/the/publickey:706:1:1:1
215 #10.2.100.100:pubkey:/path/to/the/publickey:706:1:1:0:10.2.1.6:706:1
216
217 #
218 # Denied connections.
219 #
220 # These connections are denied to connect our server.
221 #
222 # Format: <remote host>:<port>:<comment>
223 #
224 [DenyConnection]
225 #10.2.1.99:0:Your connection has been denied
226
227 #
228 # Message Of The Day
229 #
230 # specify the text file containing the motd:
231 #
232 #[motd]
233 #@ETCDIR@/motd.txt
234
235 #
236 # Pid File
237 #
238 # specify the pidfile where it will be written:
239 #
240 [pid]
241 @PIDFILE@