Project

General

Profile

strongswan.conf Reference » History » Version 29

Andreas Steffen, 26.04.2009 00:29
forgot about pluto.load

1 1 Martin Willi
2 29 Andreas Steffen
h1. strongswan.conf
3 1 Martin Willi
4 1 Martin Willi
5 29 Andreas Steffen
6 29 Andreas Steffen
h2. Overview
7 29 Andreas Steffen
8 29 Andreas Steffen
9 29 Andreas Steffen
While the [[IpsecConf|ipsecconf]] configuration file is well suited to define IPsec related configuration parameters, it is not useful for other strongSwan applications to read options from this file. The file is hard to parse and only starter is capable of doing so.
10 29 Andreas Steffen
11 1 Martin Willi
As the number of components of the strongSwan project is growing, we need a more flexible configuration file, easy to extend and useable by all components. The configuration format uses hierarchal sections and a list of key/value pairs in each section. 
12 1 Martin Willi
13 29 Andreas Steffen
Since 4.2.1, a default strongswan.conf gets installed in your sysconfdir, e.g. _/etc/strongswan.conf_.
14 1 Martin Willi
15 1 Martin Willi
16 29 Andreas Steffen
h2. Syntax
17 29 Andreas Steffen
18 29 Andreas Steffen
19 1 Martin Willi
Each section has a name, followed by C-Style curly brackets defining the sections body. Each section body contains a set of subsections and key/value pairs:
20 29 Andreas Steffen
<pre>
21 1 Martin Willi
settings := (section|keyvalue)*
22 1 Martin Willi
section  := name { settings }
23 1 Martin Willi
keyvalue := key = value\n
24 29 Andreas Steffen
</pre>
25 1 Martin Willi
Values must be terminated by a newline. Comments are possible using the #-character, but be careful: The parser implementation is currently limited and does not like brackets in comments. Section names and keys may contain any printable character except:
26 29 Andreas Steffen
<pre>
27 1 Martin Willi
. { } # \n \t space
28 29 Andreas Steffen
</pre>
29 1 Martin Willi
An example might look like this:
30 29 Andreas Steffen
<pre>
31 1 Martin Willi
a = b
32 1 Martin Willi
section-one {
33 1 Martin Willi
  somevalue = asdf
34 1 Martin Willi
  subsection {
35 1 Martin Willi
    othervalue = xxx
36 1 Martin Willi
  }
37 1 Martin Willi
  # yei, a comment 
38 1 Martin Willi
  yetanother = zz
39 1 Martin Willi
}
40 1 Martin Willi
section-two {
41 1 Martin Willi
  x = 12
42 1 Martin Willi
}
43 29 Andreas Steffen
</pre>
44 1 Martin Willi
Indentation is optional, you may use tabs or spaces.
45 1 Martin Willi
46 1 Martin Willi
47 29 Andreas Steffen
h2. Reading values
48 29 Andreas Steffen
49 29 Andreas Steffen
50 29 Andreas Steffen
The config file is read by libstrongswan during library initialization. Values are accessed using a dot-separated section list and a key: Accessing *section-one.subsection.othervalue* will return *xxx*.
51 1 Martin Willi
Have a look at the [source:trunk/src/libstrongswan/settings.h settings interface] how to query values.
52 1 Martin Willi
53 29 Andreas Steffen
54 29 Andreas Steffen
h2. Defined keys
55 29 Andreas Steffen
56 27 Andreas Steffen
The following keys are currently defined (using dot notation).
57 27 Andreas Steffen
58 27 Andreas Steffen
||Key                                                ||Default   ||Description||
59 29 Andreas Steffen
||*charon section*                               ||          || ||
60 1 Martin Willi
||charon.close_ike_on_child_failure                  ||no        ||Close the IKE_SA if setup of the CHILD_SA along with IKE_AUTH failed||
61 1 Martin Willi
||charon.dh_exponent_ansi_x9_42                      ||yes       ||Use ANSI X9.42 DH exponent size or optimum size matched to cryptographical strength|| 
62 1 Martin Willi
||charon.dns1                                        ||          ||DNS server 1 assigned to peer via configuration payload (CP)||
63 1 Martin Willi
||charon.dns2                                        ||          ||DNS server 2 assigned to peer via configuration payload (CP)||
64 27 Andreas Steffen
||charon.dos_protection                              ||yes       ||Enable Denial of Service protection using cookies and aggressiveness checks||
65 27 Andreas Steffen
||charon.hash_and_url                                ||no        ||Enable hash and URL support||
66 27 Andreas Steffen
||charon.install_routes                              ||yes       ||Install routes into a separate routing table for established IPsec tunnels||
67 1 Martin Willi
||charon.keep_alive                                  ||20s       ||NAT keep alive interval||
68 27 Andreas Steffen
||charon.load                                        ||          ||Plugins to load in charon||
69 27 Andreas Steffen
||charon.multiple_authentication                     ||yes       ||Enable multiple authentication exchanges (RFC 4739)||
70 27 Andreas Steffen
||charon.process_route                               ||yes       ||Process RTM_NEWROUTE and RTM_DELROUTE events||
71 27 Andreas Steffen
||charon.reuse_ikesa                                 ||yes       ||Initiate CHILD_SA within existing IKE_SAs||
72 27 Andreas Steffen
||charon.routing_table                               ||          ||Numerical routing table to install routes to||
73 27 Andreas Steffen
||charon.routing_table_prio                          ||          ||Priority of the routing table||
74 27 Andreas Steffen
||charon.threads                                     ||16        ||Number of worker threads in charon||
75 27 Andreas Steffen
||charon.ikesa_table_size                            ||1         ||Size of the IKE_SA hash table||
76 27 Andreas Steffen
||charon.ikesa_table_segments                        ||1         ||Number of exclusively locked segments in the hash table||
77 27 Andreas Steffen
||charon.nbns1                                       ||          ||WINS server 1 assigned to peer via configuration payload (CP)||
78 27 Andreas Steffen
||charon.nbns2                                       ||          ||WINS server 2 assigned to peer via configuration payload (CP)||
79 29 Andreas Steffen
||charon.plugins.sql.database                        ||          ||Database URI for charons [[SQL]] plugin||
80 29 Andreas Steffen
||charon.plugins.sql.lease_history                   ||yes       ||Enable logging of [[SQL]] IP pool leases||
81 29 Andreas Steffen
||charon.plugins.sql.loglevel                        ||-1        ||Loglevel for logging to [[SQL]] database||
82 29 Andreas Steffen
||charon.plugins.load_tester.enable                  ||no        ||Enable the load testing plugin. Read [[LoadTests]] first!||
83 27 Andreas Steffen
||charon.plugins.load_tester.initiators              ||0         ||Number of concurrent initiator threads to use in load test||
84 20 Andreas Steffen
||charon.plugins.load_tester.iterations              ||1         ||Number of IKE_SAs to initate to self by each initiator in load test||
85 1 Martin Willi
||charon.plugins.load_tester.delay                   ||0         ||Delay between initiatons for each thread||
86 27 Andreas Steffen
||charon.plugins.load_tester.proposal                ||aes128-sha1-modp1024||IKE proposal to use in load test||
87 29 Andreas Steffen
||charon.plugins.load_tester.auth                    ||pubkey    ||Authentication method to use, _pubkey | psk_||
88 1 Martin Willi
||charon.plugins.load_tester.fake_kernel             ||no        ||Fake the kernel interface to allow load-testing against self||
89 27 Andreas Steffen
||charon.plugins.load_tester.delete_after_established||no        ||Delete an IKE_SA as soon as it has been established||
90 27 Andreas Steffen
||charon.plugins.load_tester.request_virtual_ip      ||no        ||Request an INTERNAL_IPV4_ADDR from the server||
91 27 Andreas Steffen
||charon.plugins.load_tester.pool                    ||NULL      ||Provide INTERNAL_IPV4_ADDRs from a named pool||
92 27 Andreas Steffen
||charon.plugins.load_tester.remote                  ||127.0.0.1 ||Address to initiation connections to||
93 27 Andreas Steffen
||charon.plugins.load_tester.ike_rekey               ||0         ||Seconds to start IKE_SA rekeying after setup||
94 27 Andreas Steffen
||charon.plugins.load_tester.child_rekey             ||600       ||Seconds to start CHILD_SA rekeying after setup||
95 15 Martin Willi
||charon.plugins.eap_radius.secret                   ||          ||Shared secret between RADIUS and NAS||
96 27 Andreas Steffen
||charon.plugins.eap_radius.server                   ||          ||IP/Hostname of RADIUS server||
97 1 Martin Willi
||charon.plugins.eap_radius.port                     ||1812      ||Port of RADIUS server (authentication)||
98 1 Martin Willi
||charon.plugins.eap_radius.sockets                  ||5         ||Number of sockets (ports) to use, increase for high load||
99 27 Andreas Steffen
||charon.plugins.eap_radius.nas_identifier           ||strongSwan||NAS-Identifier to include in RADIUS messages||
100 29 Andreas Steffen
||*manager section*                              ||          || || 
101 27 Andreas Steffen
||manager.database                                   ||          ||Credential database URI for manager||
102 27 Andreas Steffen
||manager.debug                                      ||no        ||Enable debugging in manager||
103 1 Martin Willi
||manager.load                                       ||          ||Plugins to load in manager||
104 1 Martin Willi
||manager.socket                                     ||          ||FastCGI socket of manager, to run it statically||
105 27 Andreas Steffen
||manager.threads                                    ||10        ||Threads to use for request handling||
106 27 Andreas Steffen
||manager.timeout                                    ||15m       ||Session timeout for manager||
107 29 Andreas Steffen
||*mediation client section*                     ||          || ||
108 27 Andreas Steffen
||medcli.database                                    ||          ||Mediation client database URI||
109 27 Andreas Steffen
||medcli.dpd                                         ||5m        ||DPD timeout to use in mediation client plugin||
110 27 Andreas Steffen
||medcli.rekey                                       ||20m       ||Rekeying time on mediation connections in mediation client plugin||
111 29 Andreas Steffen
||*mediation server section*                     ||          || ||
112 27 Andreas Steffen
||medsrv.database                                    ||          ||Mediation server database URI||
113 27 Andreas Steffen
||medsrv.debug                                       ||no        ||Debugging in mediation server web application||
114 27 Andreas Steffen
||medsrv.dpd                                         ||5m        ||DPD timeout to use in mediation server plugin||
115 27 Andreas Steffen
||medsrv.load                                        ||          ||Plugins to load in mediation server plugin||
116 27 Andreas Steffen
||medsrv.password_length                             ||6         ||Minimum password length required for mediation server user accounts||
117 27 Andreas Steffen
||medsrv.rekey                                       ||20m       ||Rekeying time on mediation connections in mediation server plugin||
118 27 Andreas Steffen
||medsrv.socket                                      ||          ||Run Mediation server web application statically on socket||
119 27 Andreas Steffen
||medsrv.threads                                     ||5         ||Number of thread for mediation service web application||
120 27 Andreas Steffen
||medsrv.timeout                                     ||15m       ||Session timeout for mediation service||
121 29 Andreas Steffen
||*openac section*                               ||          || ||
122 27 Andreas Steffen
||openac.load                                        ||          ||Plugins to load in ipsec openac tool||
123 29 Andreas Steffen
||*pluto section*                                ||          || ||
124 27 Andreas Steffen
||pluto.dns1                                         ||          ||DNS server 1 assigned to peer via configuration payload (CP)||
125 27 Andreas Steffen
||pluto.dns2                                         ||          ||DNS server 2 assigned to peer via configuration payload (CP)||
126 28 Andreas Steffen
||pluto.load                                         ||          ||Plugins to load in ipsec pluto daemon||
127 27 Andreas Steffen
||pluto.nbns1                                        ||          ||WINS server 1 assigned to peer via configuration payload (CP)||
128 27 Andreas Steffen
||pluto.nbns2                                        ||          ||WINS server 2 assigned to peer via configu+ration payload (CP)||
129 29 Andreas Steffen
||*pool section*                                 ||          || ||
130 27 Andreas Steffen
||pool.load                                          ||          ||Plugins to load in ipsec pool tool||
131 29 Andreas Steffen
||*scepclient section*                           ||          || ||
132 27 Andreas Steffen
||scepclient.load                                    ||          ||Plugins to load in ipsec scepclient tool||