doc/silcd.conf.yo

   1 manpage(SILCD_CONF) (5) (November 2 2002) (silc-server) (silc-server)
   2
   3
   4 manpagename(silcd.conf) (format of configuration file for silcd)
   5
   6 manpagesection(CONFIGURATION FILE)
   7 bf(Silcd) reads its configuration from /etc/silc/silcd.conf (or the file
   8 specified with bf(-f)). The file contains sections, subsections and key-value
   9 pairs. Each section or subsection is bound with a starting em({) and ending
  10 em(}). Keys and values are of the format 'em(KEY)=em(VALUE);'. All statements
  11 as well as sections must be terminated with a ';'.
  12
  13 Mandatory section in configuration file is em(ServerInfo).  Other sections
  14 are optional but recommended.  If em(General) section is defined it must
  15 be defined before the em(ConnectionParams) section.  On the other hand,
  16 the em(ConnectionParams) section must be defined before em(Client),
  17 em(ServerConnection) and/or em(RouterConnection) sections.  Other sections
  18 can be in a free order in the configuration file.
  19
  20 nsect(SECTION: General)
  21
  22 em(General) section contains global settings for the silcd.
  23
  24 bf(dynamic_server)
  25 quote(Dynamic router connections.  If this is set for normal SILC server
  26 the connection to primary router is not created untill it is actually
  27 needed.  Giving for example em(/WHOIS foobar@silcnet.org) would then
  28 create connection to the primary router to resolve user foobar.
  29 On the other hand giving em(/WHOIS foobar) would try to search the
  30 user foobar locally, without creating the connection.  Note that
  31 giving em(/JOIN foobar) will also created the connection as current
  32 SILC Server version supports only global channels (all JOINs require
  33 connection to router, if one is configured).)
  34
  35 bf(prefer_passphrase_auth)
  36 quote(If both public key and passphrase authentication are set for a
  37 connection, public key authentication is by default preferred. Setting this
  38 value to em(true) causes silcd to prefer passphrase authentication in these
  39 cases.)
  40
  41 bf(require_reverse_lookup)
  42 quote(Set this value to em(true) if all connecting hosts must have a fully
  43 qualified domain name (FQDN). If set to true, a host without FQDN is not
  44 allowed to connect to server.)
  45
  46 bf(connections_max)
  47 quote(Maximum number of incoming connections to this server. Any further
  48 connections are refused.)
  49
  50 bf(connections_max_per_host)
  51 quote(Maximum number of incoming connections from any single host. This
  52 setting can be overridden on a connection-specific basis with
  53 em(ConnectionParams).)
  54
  55 bf(version_protocol)
  56 quote(Defines the minimum required version of protocol to allow connecting
  57 to server. A client or server using this version of protocol or newer is
  58 allowed to connect, one using anything older will be rejected. Leaving unset
  59 allows all versions to connect. This can be overridden with
  60 em(ConnectionParams).)
  61
  62 bf(version_software)
  63 quote(Defines the minimum required version of software to allow connecting
  64 to server. A client or server that is of this version or newer is allowed
  65 to connect, one using anything older will be rejected. Leaving unset allows
  66 all versions to connect.  This can be overridden with em(ConnectionParams).)
  67
  68 bf(version_software_vendor)
  69 quote(Defines the allowed software vendor string that is required to connect.
  70 Usually this is either a build number or special client tag. Using this
  71 requirement is not encouraged unless the server is in very limited use.
  72 Leaving unset allows all versions regardless of their vendor to connect.
  73 Can be overridden with em(ConnectionParams).)
  74
  75 bf(key_exchange_rekey)
  76 quote(Defines the interval, in seconds, how often the session key will be
  77 regenerated. This setting only applies to the connection initiator, as rekey
  78 is always performed by the initiating party. Setting has effect only when
  79 the server acts as an initiator, and can be overridden with
  80 em(ConnectionParams).)
  81
  82 bf(key_exchange_pfs)
  83 quote(Boolean value to determine, whether key-exchange is performed with
  84 Perfect Forward Secrecy (PFS) or without. If set to em(true), the rekey
  85 process will be somewhat slower, but more secure since the key is
  86 entirely regenerated. Can be overridden with em(ConnectionParams).)
  87
  88 bf(key_exchange_timeout)
  89 quote(Key exchange timeout in seconds. If the key exchange is not completed
  90 within this time, the remote connection will be closed.)
  91
  92 bf(conn_auth_timeout)
  93 quote(Connection authentication timeout in seconds. If the connection
  94 authentication is not completed within this time, the remote connection
  95 will be closed.)
  96
  97 bf(channel_rekey_secs)
  98 quote(Seconds, how often channel key will be regenerated. Note that channel
  99 key is regenerated each time someone joins or leaves the channel. This is
 100 the maximum time any channel can have the same key.)
 101
 102 bf(detach_disabled)
 103 quote(Boolean value controlling, whether clients are denied the use of DETACH
 104 command. Default value is false (DETACH is allowed).)
 105
 106 bf(detach_timeout)
 107 quote(Time in seconds how long detached sessions will be available. By
 108 default, detached sessions do not expire and as such, are persistent as long
 109 as the server is running. If DETACH command is allowed, this value should
 110 be set as well.)
 111
 112 bf(qos)
 113 quote(Boolean value controlling, whether Quality of Service settings are
 114 enabled. Default setting is false. NOTE: If you enable QoS in general section,
 115 it applies to every connection the server has, including server connections.
 116 This setting can be overridden with em(ConnectionParams) and in case of
 117 server connections, it SHOULD BE overridden (server connections should not
 118 use QoS).)
 119
 120 bf(qos_rate_limit)
 121 quote(Limits read operations per second to given amount. Do note that one read
 122 operation may read several SILC packets, so this setting does not
 123 automatically correspond to amount of messages transmitted or accepted.)
 124
 125 bf(qos_bytes_limit)
 126 quote(Limits incoming SILC data to the specified number of bytes per second.)
 127
 128 bf(qos_limit_sec)
 129 quote(This value defines the timeout, in seconds, for the delay of received
 130 data in case it was left in a QoS queue.)
 131
 132 bf(qos_limit_usec)
 133 quote(This value defines the timeout, in microseconds, for the delay of
 134 received data for received data in case it was left in a QoS queue.)
 135
 136 nsect(SECTION: ServerInfo)
 137
 138 em(ServerInfo) contains values for bound interfaces and administrative info.
 139
 140 bf(hostname)
 141 quote(Server's name (FQDN).)
 142
 143 bf(ServerType)
 144 quote(This is a descriptive text field, usually telling what the server and
 145 its purpose are.)
 146
 147 bf(Location)
 148 quote(Descriptive field of server's geographic location.)
 149
 150 bf(Admin)
 151 quote(Administrator's full name.)
 152
 153 bf(AdminEmail)
 154 quote(Administrator's email address.)
 155
 156 bf(User)
 157 quote(The name of the user account silcd will be running on. This must be an
 158 existing user. Silcd needs to executed as root; after binding the port it
 159 will drop root privileges and use the account given here.)
 160
 161 bf(Group)
 162 quote(The name of the group silcd will be running on. This must be an existing
 163 group. Silcd needs to be executed as root; after binding the port it will drop
 164 root privileges and use the group given here.)
 165
 166 bf(PublicKey)
 167 quote(Full path to server's public key file.)
 168
 169 bf(PrivateKey)
 170 quote(Full path to server's private key file.)
 171
 172 bf(MotdFile)
 173 quote(Full path to MOTD (Message Of The Day) file, a text file that will be
 174 displayed to each client upon connection.)
 175
 176 bf(PidFile)
 177 quote(Full path to file where silcd will write its PID.)
 178
 179 nsubsect(SUBSECTION: Primary)
 180
 181 This is the primary listener info. Each server can have no more than one em(Primary)
 182 section.
 183
 184 bf(ip)
 185 quote(Specifies the address silcd is listening on.)
 186
 187 bf(port)
 188 quote(Specifies the port silcd is listening on.)
 189
 190 nsubsect(SUBSECTION: Secondary)
 191
 192 This is a secondary listener info. A server may have any amount of
 193 em(Secondary) listener settings. These are needed only if silcd needs
 194 to listen on several interfaces. em(Secondary) subsections have the same
 195 information that em(Primary) does.
 196
 197 nsect(SECTION: Logging)
 198
 199 This section is used to set up various log files; their paths, maximum
 200 sizes and individual logging options.
 201
 202 There are four defined logging channels. The log channels have an
 203 importance value, and more important channels are always redirected to the
 204 less important ones. Setting a valid logging file for em(Info) will ensure
 205 logging for all channels, whereas a setting for em(Errors) would only ensure
 206 logging for em(Errors) and em(Fatals).
 207
 208 bf(Timestamp)
 209 quote(A boolean value that dictates whether log lines will have timestamps
 210 prefixed. In general, this is a good idea. You might want to disable this
 211 if you are running silcd under some special logging daemon, such as
 212 daemontools.)
 213
 214 bf(QuickLogs)
 215 quote(A boolean value that determines how often log files are updated. Setting
 216 this to em(true) makes silcd log in real-time. Setting this to em(false) makes
 217 silcd write to logs every em(FlushDelay) seconds. Real-time logging causes a
 218 bit more CPU and HDD usage but reduces memory consumption.)
 219
 220 bf(FlushDelay)
 221 quote(Time in seconds, how often logs are flushed to logfiles. This setting
 222 has effect only if em(QuickLogs) is disabled.)
 223
 224 nsubsect(SUBSECTION: Info)
 225 nsubsect(SUBSECTION: Warnings)
 226 nsubsect(SUBSECTION: Errors)
 227 nsubsect(SUBSECTION: Fatals)
 228 Each of these subsections has the same attributes, em(File) and em(Size).
 229 Different levels of problems are logged to their respective channels
 230 (em(Info), em(Warnings), em(Errors), em(Fatals)), depending on their need
 231 of attention.
 232
 233 bf(File)
 234 quote(Full path to log file.)
 235
 236 bf(Size)
 237 quote(Limit the size the log file is allowed to grow to. Any further messages
 238 to this file cause the oldest lines to be removed in order to keep the file
 239 size within given limit.)
 240
 241 nsect(SECTION: ConnectionParams)
 242
 243 This section defines connection parameters. Each connection may have its own
 244 set of em(ConnectionParams) but having one is in no way mandatory. If no
 245 separate parameters have been assigned, the defaults and the ones  from
 246 em(General) section will be used. A silcd configuration may have any number of
 247 em(ConnectionParams) sections.
 248
 249 bf(name)
 250 quote(This is a unique name that separates bf(this) particular
 251 em(ConnectionParams) section from all the others. It is also the name with
 252 which settings are referred to a given set of parameters. This field is
 253 mandatory.)
 254
 255 bf(connections_max)
 256 quote(Limits how many concurrent connections are allowed. Any further
 257 connections are simply refused. Note that this setting can not override the
 258 figure given in em(General) section.)
 259
 260 bf(connections_max_per_host)
 261 quote(Maximum number of connections allowed from any single host. If this
 262 parameter is set for a block controlling server connections, it is highly
 263 suggested to use a value of one (1).)
 264
 265 bf(version_protocol)
 266 quote(Exactly the same as in em(General) section.)
 267
 268 bf(version_software)
 269 quote(Exactly the same as in em(General) section.)
 270
 271 bf(version_software_vendor)
 272 quote(Exactly the same as in em(General) section.)
 273
 274 bf(keepalive_secs)
 275 quote(How often (seconds) to send HEARTBEAT packets to connected clients.)
 276
 277 bf(reconnect_count)
 278 quote(When connection is lost, how many times a reconnection is tried.)
 279
 280 bf(reconnect_interval)
 281 quote(How often, in seconds, a reconnection is attempted.)
 282
 283 bf(reconnect_interval_max)
 284 quote(Reconnection time is lengthened each time an unsuccessful attempt
 285 occurs. This value defines the maximum interval to which the delay may
 286 be prolonged.)
 287
 288 bf(reconnect_keep_trying)
 289 quote(Boolean value controlling whether server eventually gives up trying
 290 to reconnect. If set to em(false), server will give up once em(reconnect_count)
 291 is reached or, even at maximum interval no connection is established.)
 292
 293 bf(key_exchange_rekey)
 294 quote(Exactly the same as in em(General) section.)
 295
 296 bf(key_exchange_pfs)
 297 quote(Exactly the same as in em(General) section.)
 298
 299 bf(anonymous)
 300 quote(This boolean setting has meaning only to client connections. If set to
 301 em(true), client connections using this em(ConnectionParams) block will have
 302 their username and host scrambled. The client will also have an anonymous mode
 303 set to it.)
 304
 305 bf(qos)
 306 quote(Exactly the same as in em(General) section  NOTE: For server
 307 connection this should be set to em(false) value.)
 308
 309 bf(qos_rate_limit)
 310 quote(Exactly the same as in em(General) section.)
 311
 312 bf(qos_bytes_limit)
 313 quote(Exactly the same as in em(General) section.)
 314
 315 bf(qos_limit_sec)
 316 quote(Exactly the same as in em(General) section.)
 317
 318 bf(qos_limit_usec)
 319 quote(Exactly the same as in em(General) section.)
 320
 321 nsect(SECTION: Client)
 322
 323 This section defines how incoming client connections are handled. There can
 324 be several em(Client) sections, each with their own requirements. A bf(silcd)
 325 admin could for example require that connections from certain IP-address space
 326 must supply a connection password.
 327
 328 bf(Host)
 329 quote(An address or wildcarded set of addresses, either in numeric IP-address
 330 fashion or as hostnames. For example em("10.1.*") or
 331 em("*.mydomain.domain.org").)
 332
 333 bf(Passphrase)
 334 quote(The required passphrase to allow client connection.)
 335
 336 bf(PublicKey)
 337 quote(The path to a file containing the client's public key. There can be any
 338 number of em(PublicKey) statements in one em(Client) section. Matching any of
 339 them will do.)
 340
 341 bf(Params)
 342 quote(Name of client connection parameters.)
 343
 344 nsect(SECTION: ServerConnection)
 345
 346 This section defines a configured server connection. A regular SILC
 347 server does not need one at all. If this block exists, it means that the
 348 server is a SILC router. There must be one em(ServerConnection) for each
 349 SILC server that connects to this router.
 350
 351 bf(Host)
 352 quote(Either an FQDN or strict IP-address of the connecting server.)
 353
 354 bf(Passphrase)
 355 quote(If server connection requires passphrase authentication, set it here.)
 356
 357 bf(PublicKey)
 358 quote(This is a path to connecting server's public key. If server connection
 359 requires public key authentication, set this value. If both em(Passphrase)
 360 and em(PublicKey) are set, then either of them will be accepted.)
 361
 362 bf(Params)
 363 quote(Connection parameters.)
 364
 365 bf(Backup)
 366 quote(A boolean value controlling whether this server acts as a backup. Set
 367 to em(false) for normal servers. If set to em(true), this server is a backup
 368 router.)
 369
 370 nsect(SECTION: RouterConnection)
 371 This section covers router connections. Stand-alone servers won't have this
 372 section, and regular servers should only have one.
 373
 374 Router servers need one em(RouterConnection) for each other router they have
 375 been configured to connect to. First configured section is the primary route.
 376
 377 bf(Port)
 378 quote(If em(Initiator) is set tro em(true), this setting defines the remote
 379 port in which to connect. if em(Initiator) is set to false, then this defines
 380 the local (listening) port.)
 381
 382 bf(Passphrase)
 383 quote(If connecting server requires a passphrase authentication, it is set
 384 here.)
 385
 386 bf(PublicKey)
 387 quote(If connecting to server requires public key authentication, the path
 388 to server's public key file is set here.)
 389
 390 bf(Params)
 391 quote(Connection parameters.)
 392
 393 bf(Initiator)
 394 quote(A boolean setting that defines whether this server is the connecting
 395 party.)
 396
 397 bf(BackupHost)
 398 quote(If the configured connection is a backup connection, set this to the
 399 address of the main router that will be replaced. For normal router connection
 400 leave this option out.)
 401
 402 bf(BackupPort)
 403 quote(If the configured connection is a backup connection, set this to the
 404 remote port which to connect to. For normal router connection, leave this
 405 option out.)
 406
 407 bf(BackupLocal)
 408 quote(A boolean value. If this setting is em(true), then the backup router
 409 is in the same cell. If the backup router is in another cell, set this
 410 to em(false). Needless to say, for normal router connection, leave this
 411 option out.)
 412
 413 nsect(SECTION: Admin)
 414
 415 This section defines configured administration connections.
 416
 417 bf(Host)
 418 quote(Either FQDN or a strict IP-address to the origin of connection.
 419 This field is optional.)
 420
 421 bf(User)
 422 quote(Username that the connecting client announces. This field is optional.)
 423
 424 bf(Nick)
 425 quote(Nickname that the connecting client announces. This field is optional.)
 426
 427 bf(Passphrase)
 428 quote(Passphrase required to obtain server operator privileges.)
 429
 430 bf(PublicKey)
 431 quote(Path to administrator's public key file. If both em(Passphrase) and
 432 em(PublicKey) are defined, either one can be used.)
 433
 434 nsect(SECTION: Deny)
 435 This section defines denied incoming connections. They apply equally to both
 436 client and server connections, so make sure you know what you add here. Each
 437 em(Deny) section covers one instance of denied connection(s). There may be any
 438 number of em(Deny) sections.
 439
 440 bf(Host)
 441 quote(Address or wildcarded addresses of denied connections. bf(NOTE!) This
 442 field is not mandatory, but highly recommended. If you don't specify em(Host)
 443 at all, or give it a value of "*", you have a silcd that denies every single
 444 incoming connection.)
 445
 446 bf(Reason)
 447 quote(A string giving the reason as to why the connecting party is not allowed
 448 to connect. Unlike em(Host), this field IS mandatory.)
 449
 450
 451 manpagefiles()
 452 bf(silcd.conf)
 453
 454
 455 manpageseealso()
 456 bf(silcd(8))
 457
 458
 459 manpageauthor()
 460 SILC is designed and written by Pekka Riikonen <priikone@iki.fi> and rest
 461 of the SILC Project.
 462
 463 Configuration file format and parser is by Giovanni Giacobbi
 464 <giovanni@giacobbi.net>.
 465
 466 This manpage was written by Mika 'Bostik' Boström <bostik@lut.fi>
 467
 468 See bf(CREDITS) for full list of contributors.