Project

General

Profile

strongswan.conf Reference » History » Version 159

Tobias Brunner, 18.05.2016 10:37
Document reloading and strongswan.d

1 101 Tobias Brunner
{{title(strongswan.conf Reference)}}
2 101 Tobias Brunner
3 29 Andreas Steffen
h1. strongswan.conf
4 1 Martin Willi
5 118 Tobias Brunner
bq. *Please note:* This page documents the configuration options of the most current release. Therefore, you should always consult the strongswan.conf(5) man page that comes with the release you are using to confirm which options are actually available.
6 110 Tobias Brunner
7 1 Martin Willi
h2. Overview
8 1 Martin Willi
9 159 Tobias Brunner
While the [[IpsecConf|ipsec.conf]] 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 [[IpsecStarter|ipsec starter]] is capable of doing so. As the number of components of the strongSwan project is continually growing, we needed a more flexible configuration file that is easy to extend and can be used by all components. The new configuration format consists of hierarchical sections and a list of key/value pairs in each section. Starting with the strongSwan version:4.2.1 release, a default strongswan.conf file is installed in your sysconfdir, e.g. @/etc/strongswan.conf@.
10 159 Tobias Brunner
11 159 Tobias Brunner
Since version:5.1.2 the default config file is split up and separate files are placed in the [[StrongswanDirectory|/etc/strongswan.d]] directory.
12 159 Tobias Brunner
13 159 Tobias Brunner
The IKE daemon [[charon]] reloads strongswan.conf if it receives a @SIGHUP@.  This reloads the [[LoggerConfiguration|logger settings]] and some plugins also support reloading their configuration (e.g. the [[AttrPlugin|attr]], the [[PKCS11plugin|pkcs11]] or the [[EapRadius|eap-radius]] plugins), and many settings are always read directly from the latest config (some at least for new connections).
14 1 Martin Willi
15 1 Martin Willi
h2. Syntax
16 1 Martin Willi
17 49 Andreas Steffen
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:
18 1 Martin Willi
19 1 Martin Willi
<pre>
20 30 Martin Willi
settings := (section|keyvalue)*
21 30 Martin Willi
section  := name { settings }
22 1 Martin Willi
keyvalue := key = value\n
23 29 Andreas Steffen
</pre>
24 49 Andreas Steffen
25 86 Tobias Brunner
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 braces in comments. Section names and keys may contain any printable character except:
26 49 Andreas Steffen
27 30 Martin Willi
<pre>
28 30 Martin Willi
. { } # \n \t space
29 29 Andreas Steffen
</pre>
30 49 Andreas Steffen
31 29 Andreas Steffen
An example might look like this:
32 49 Andreas Steffen
33 29 Andreas Steffen
<pre>
34 1 Martin Willi
a = b
35 1 Martin Willi
section-one {
36 1 Martin Willi
  somevalue = asdf
37 1 Martin Willi
  subsection {
38 1 Martin Willi
    othervalue = xxx
39 1 Martin Willi
  }
40 1 Martin Willi
  # yei, a comment 
41 1 Martin Willi
  yetanother = zz
42 1 Martin Willi
}
43 1 Martin Willi
section-two {
44 1 Martin Willi
  x = 12
45 1 Martin Willi
}
46 1 Martin Willi
</pre>
47 29 Andreas Steffen
48 1 Martin Willi
Indentation is optional, you may use tabs or spaces.
49 30 Martin Willi
50 30 Martin Willi
51 78 Tobias Brunner
h2. Including files
52 78 Tobias Brunner
53 86 Tobias Brunner
[[451|Version 4.5.1]] introduced the *include* statement which allows to include other files into strongswan.conf, e.g.
54 78 Tobias Brunner
<pre>
55 78 Tobias Brunner
include /some/path/*.conf
56 78 Tobias Brunner
</pre>
57 78 Tobias Brunner
If the file name is not an absolute path, it is considered to be relative to the directory of the file containing the
58 81 Martin Willi
include statement. The file name may include shell wildcards. Also, such inclusions can be nested.
59 78 Tobias Brunner
60 78 Tobias Brunner
Sections loaded from the included files *extend* previously loaded sections; already existing values are *replaced*.
61 78 Tobias Brunner
It is important to note that settings are added relative to the section the include statement is in.
62 78 Tobias Brunner
63 78 Tobias Brunner
As an example, the following three files result in the same final config as the one given above:
64 78 Tobias Brunner
<pre>
65 78 Tobias Brunner
a = b
66 78 Tobias Brunner
section-one {
67 78 Tobias Brunner
    somevalue = before include
68 78 Tobias Brunner
    include include.conf
69 78 Tobias Brunner
}
70 78 Tobias Brunner
include other.conf
71 78 Tobias Brunner
</pre>
72 78 Tobias Brunner
include.conf:
73 78 Tobias Brunner
<pre>
74 78 Tobias Brunner
# settings loaded from this file are added to section-one
75 78 Tobias Brunner
# the following replaces the previous value
76 78 Tobias Brunner
somevalue = asdf
77 78 Tobias Brunner
subsection {
78 78 Tobias Brunner
    othervalue = yyy
79 78 Tobias Brunner
}
80 78 Tobias Brunner
yetanother = zz
81 78 Tobias Brunner
</pre>
82 78 Tobias Brunner
other.conf:
83 78 Tobias Brunner
<pre>
84 78 Tobias Brunner
# this extends section-one and subsection
85 78 Tobias Brunner
section-one {
86 78 Tobias Brunner
    subsection {
87 78 Tobias Brunner
        # this replaces the previous value
88 78 Tobias Brunner
        othervalue = xxx
89 78 Tobias Brunner
    }
90 78 Tobias Brunner
}
91 78 Tobias Brunner
section-two {
92 78 Tobias Brunner
    x = 12
93 78 Tobias Brunner
}
94 78 Tobias Brunner
</pre>
95 78 Tobias Brunner
96 29 Andreas Steffen
h2. Reading values
97 49 Andreas Steffen
98 1 Martin Willi
The config file is read by libstrongswan during library initialization. Values are accessed using a dot-separated section list and a key: 
99 78 Tobias Brunner
Accessing *section-one.subsection.othervalue* will return *xxx*.
100 1 Martin Willi
101 138 Martin Willi
Have a look at the settings interface (source:src/libstrongswan/utils/settings.h) to learn about the details.
102 78 Tobias Brunner
103 29 Andreas Steffen
h2. Defined keys
104 1 Martin Willi
105 1 Martin Willi
The following keys are currently defined (using dot notation).
106 1 Martin Willi
107 144 Tobias Brunner
*${sysconfdir}* refers to the directory that can be [[AutoConf|configured]] with the _--sysconfdir_ option (defaults to _${prefix}/etc_).
108 130 Tobias Brunner
*${piddir}* refers to the directory that can be [[AutoConf|configured]] with the _--with-piddir_ option (defaults to _/var/run_).
109 130 Tobias Brunner
110 130 Tobias Brunner
|_<.Key                                             |_<.Default|_<.Description|
111 142 Tobias Brunner
|\3(level1). *aikgen section*                       |
112 142 Tobias Brunner
|aikgen.load                                        |          |Plugins to load in ipsec aikgen tool.|
113 130 Tobias Brunner
|\3(level1). *attest section*                       |
114 137 Tobias Brunner
|attest.database                                    |          |File  measurement  information  database  URI.  If it contains a password, make sure to adjust the permissions of the config file accordingly.|
115 137 Tobias Brunner
|attest.load                                        |          |Plugins to load in ipsec attest tool.|
116 1 Martin Willi
|\3(level1). *charon section*                       |
117 144 Tobias Brunner
|\3(level2). *Note:* Many of the options in this section also apply to [[charon-cmd]], [[charon-systemd]] and other _charon_ derivatives. Just use their respective name (e.g. _charon-cmd_ instead of _charon_).|
118 137 Tobias Brunner
|\3(level3). Defaults for options in this section can be configured in the _libstrongswan_ section.|
119 142 Tobias Brunner
|charon.accept_unencrypted_mainmode_messages        |no        |Accept unencrypted ID and HASH payloads in IKEv1 Main Mode. Some implementations send the third Main Mode message unencrypted, probably to find the PSKs for the specified ID for authentication. This is very similar to Aggressive Mode, and has the same security implications: A passive attacker can sniff the negotiated Identity, and start brute forcing the PSK using the HASH payload. It is recommended to keep this option to no, unless you know exactly what the implications are and require compatibility to such devices (for example, some SonicWall boxes).|
120 137 Tobias Brunner
|charon.block_threshold                             |5         |Maximum number of half-open IKE_SAs for a single peer IP.|
121 137 Tobias Brunner
|charon.cert_cache                                  |yes       |Whether relations in validated certificate chains should be cached in memory.|
122 137 Tobias Brunner
|charon.cisco_unity                                 |no        |Send Cisco Unity vendor ID payload (IKEv1 only), see [[UnityPlugin|unity plugin]].|
123 137 Tobias Brunner
|charon.close_ike_on_child_failure                  |no        |Close the IKE_SA if setup of the CHILD_SA along with IKE_AUTH failed.|
124 137 Tobias Brunner
|charon.cookie_threshold                            |10        |Number of half-open IKE_SAs that activate the cookie mechanism.|
125 137 Tobias Brunner
|charon.crypto_test.bench                           |no        |Benchmark crypto algorithms and order them by efficiency.|
126 137 Tobias Brunner
|charon.crypto_test.bench_size                      |1024      |Buffer size used for crypto benchmark.|
127 137 Tobias Brunner
|charon.crypto_test.bench_time                      |50        |Number of iterations to test each algorithm.|
128 137 Tobias Brunner
|charon.crypto_test.on_add                          |no        |Test crypto algorithms during registration (requires test vectors provided by the _test-vectors_ plugin).|
129 137 Tobias Brunner
|charon.crypto_test.on_create                       |no        |Test crypto algorithms on each crypto primitive instantiation.|
130 137 Tobias Brunner
|charon.crypto_test.required                        |no        |Strictly require at least one test vector to enable an algorithm.|
131 137 Tobias Brunner
|charon.crypto_test.rng_true                        |no        |Whether to test RNG with TRUE quality; requires a lot of entropy.|
132 157 Tobias Brunner
|charon.delete_rekeyed                              |no        |Delete CHILD_SAs right after they got successfully rekeyed (IKEv1 only). Reduces the number of stale CHILD_SAs in scenarios with a lot of rekeyings. However, this might cause problems with implementations that continue to use rekeyed SAs until they expire.|
133 137 Tobias Brunner
|charon.dh_exponent_ansi_x9_42                      |yes       |Use ANSI X9.42 DH exponent size or optimum size matched to cryptographical strength.|
134 155 Tobias Brunner
|charon.dlopen_use_rtld_now                         |no        |Use RTLD_NOW with dlopen() when loading plugins and IMV/IMCs to reveal missing symbols immediately. Useful during development of custom plugins.|
135 137 Tobias Brunner
|charon.dns1                                        |          |DNS server assigned to peer via configuration payload (CP), see [[AttrPlugin|attr plugin]].|
136 137 Tobias Brunner
|charon.dns2                                        |          |DNS server assigned to peer via configuration payload (CP).|
137 137 Tobias Brunner
|charon.dos_protection                              |yes       |Enable Denial of Service protection using cookies and aggressiveness checks.|
138 137 Tobias Brunner
|charon.ecp_x_coordinate_only                       |yes       |Compliance with the errata for RFC 4753.|
139 1 Martin Willi
|charon.filelog                                     |          |Section to define file loggers, see [[LoggerConfiguration]].|
140 1 Martin Willi
|charon.flush_auth_cfg                              |no        |If enabled objects used during authentication (certificates, identities etc.) are released to free memory once an IKE_SA is established. Enabling this might conflict with plugins that later need access to e.g. the used certificates.|
141 157 Tobias Brunner
|charon.follow_redirects                            |yes       |Whether to follow IKEv2 redirects (RFC 5685).|
142 145 Tobias Brunner
|charon.fragment_size                               |0         |Maximum size (complete IP datagram size in bytes) of a sent IKE fragment when using proprietary IKEv1 or standardized IKEv2 fragmentation (use 0 for address family specific default values). If specified this limit is used for both IPv4 and IPv6.|
143 137 Tobias Brunner
|charon.group                                       |          |Name of the [[ReducedPrivileges|group]] the daemon changes to after startup.|
144 137 Tobias Brunner
|charon.half_open_timeout                           |30        |Timeout in seconds for connecting IKE_SAs, also see [[JobPriority#IKE_SA_INIT-dropping|IKE_SA_INIT dropping]].|
145 137 Tobias Brunner
|charon.hash_and_url                                |no        |Enable hash and URL support.|
146 137 Tobias Brunner
|charon.host_resolver.max_threads                   |3         |Maximum number of concurrent resolver threads (they are terminated if unused).|
147 137 Tobias Brunner
|charon.host_resolver.min_threads                   |0         |Minimum number of resolver threads to keep around.|
148 137 Tobias Brunner
|charon.i_dont_care_about_security_and_use_aggressive_mode_psk|no|If enabled _responders_ are allowed to use IKEv1 Aggressive Mode with pre-shared keys, which is discouraged due to security concerns (offline attacks on the openly transmitted hash of the PSK).|
149 147 Tobias Brunner
|charon.ignore_acquire_ts                           |no        |If this is disabled the traffic selectors from the kernel's acquire events, which are derived from the triggering packet, are prepended to the traffic selectors from the configuration for IKEv2 connection. By enabling this, such specific traffic selectors will be ignored and only the ones in the config will be sent. This always happens for IKEv1 connections as the protocol only supports one set of traffic selectors per CHILD_SA.|
150 137 Tobias Brunner
|charon.ignore_routing_tables                       |          |A space-separated list of routing tables to be excluded from route lookup.|
151 137 Tobias Brunner
|charon.ikesa_limit                                 |0         |Maximum number of IKE_SAs that can be established at the same time before new connection attempts are blocked.|
152 137 Tobias Brunner
|charon.ikesa_table_segments                        |1         |Number of exclusively locked segments in the hash table, see [[IkeSaTable|IKE_SA lookup tuning]].|
153 137 Tobias Brunner
|charon.ikesa_table_size                            |1         |Size of the IKE_SA hash table, see [[IkeSaTable|IKE_SA lookup tuning]].|
154 137 Tobias Brunner
|charon.inactivity_close_ike                        |no        |Whether to close IKE_SA if the only CHILD_SA closed due to inactivity.|
155 137 Tobias Brunner
|charon.init_limit_half_open                        |0         |Limit new connections based on the current number of half open IKE_SAs, see [[JobPriority#IKE_SA_INIT-dropping|IKE_SA_INIT dropping]].|
156 137 Tobias Brunner
|charon.init_limit_job_load                         |0         |Limit new connections based on the number of jobs currently queued for processing, see [[JobPriority#IKE_SA_INIT-dropping|IKE_SA_INIT dropping]].|
157 137 Tobias Brunner
|charon.initiator_only                              |no        |Causes charon daemon to ignore IKE initiation requests.|
158 137 Tobias Brunner
|charon.install_routes                              |yes       |Install routes into a separate routing table for established IPsec tunnels.|
159 137 Tobias Brunner
|charon.install_virtual_ip                          |yes       |Install virtual IP addresses.|
160 1 Martin Willi
|charon.install_virtual_ip_on                       |          |The name of the interface on which virtual IP addresses should be installed. If not specified the addresses will be installed on the outbound interface.|
161 137 Tobias Brunner
|charon.integrity_test                              |no        |Check daemon, libstrongswan and plugin integrity at startup.|
162 1 Martin Willi
|charon.interfaces_ignore                           |          |A comma-separated list of network interfaces that should be ignored, if _charon.interfaces_use_ is specified this option has no effect.|
163 1 Martin Willi
|charon.interfaces_use                              |          |A comma-separated list of network interfaces that should be used by charon. All other interfaces are ignored.|
164 152 Tobias Brunner
|charon.keep_alive                                  |20s       |NAT keep alive interval in seconds.|
165 137 Tobias Brunner
|charon.leak_detective.detailed                     |yes       |Includes source file names and line numbers in leak detective output.|
166 137 Tobias Brunner
|charon.leak_detective.usage_threshold              |10240     |Threshold in bytes for leaks to be reported (0 to report all).|
167 137 Tobias Brunner
|charon.leak_detective.usage_threshold_count        |0         |Threshold in number of allocations for leaks to be reported (0 to report all).|
168 137 Tobias Brunner
|charon.load                                        |          |Plugins to load in IKEv2 charon daemon, see [[PluginLoad]].|
169 137 Tobias Brunner
|charon.load_modular                                |no        |If enabled the list of plugins to load is determined by individual _load_ settings for each plugin, see [[PluginLoad#Modular-Configuration]].|
170 147 Tobias Brunner
|charon.make_before_break                           |no        |Initiate IKEv2 reauthentication with a make-before-break instead of a break-before-make scheme. Make-before-break uses overlapping IKE and CHILD_SA during reauthentication by first recreating all new SAs before deleting the old ones. This behavior can be beneficial to avoid connectivity gaps during reauthentication, but requires support for overlapping SAs by the peer. strongSwan can handle such overlapping SAs since version:5.3.0.|
171 155 Tobias Brunner
|charon.max_ikev1_exchanges                         |3         |Maximum number of IKEv1 phase 2 exchanges per IKE_SA to keep state about and track concurrently.|
172 146 Tobias Brunner
|charon.max_packet                                  |10000     |Maximum packet size accepted by charon.|
173 137 Tobias Brunner
|charon.multiple_authentication                     |yes       |Enable multiple authentication exchanges (RFC 4739).|
174 137 Tobias Brunner
|charon.nbns1                                       |          |WINS server assigned to peer via configuration payload (CP), see [[AttrPlugin|attr plugin]].|
175 137 Tobias Brunner
|charon.nbns2                                       |          |WINS server assigned to peer via configuration payload (CP).|
176 1 Martin Willi
|charon.port                                        |500       |UDP port used locally. If set to 0 a random port will be allocated.|
177 1 Martin Willi
|charon.port_nat_t                                  |4500      |UDP port used locally in case of NAT-T. If set to 0 a random port will be allocated. Has to be different from _charon.port_, otherwise a random port will be allocated.|
178 142 Tobias Brunner
|charon.prefer_temporary_addrs                      |no        |By default public IPv6 addresses are preferred over temporary ones (according to RFC 4941), to make connections more stable. Enable this option to reverse this.|
179 137 Tobias Brunner
|charon.process_route                               |yes       |Process RTM_NEWROUTE and RTM_DELROUTE events.|
180 137 Tobias Brunner
|charon.processor.priority_threads                  |          |Subsection to configure the number of reserved threads per priority class (see [[JobPriority]]).|
181 137 Tobias Brunner
|charon.receive_delay                               |0         |Delay in ms for receiving packets, to simulate larger RTT.|
182 137 Tobias Brunner
|charon.receive_delay_response                      |yes       |Delay response messages.|
183 137 Tobias Brunner
|charon.receive_delay_request                       |yes       |Delay request messages.|
184 137 Tobias Brunner
|charon.receive_delay_type                          |0         |Specific IKEv2 message type to delay, 0 for any.|
185 1 Martin Willi
|charon.replay_window                               |32        |Size of the AH/ESP replay window, in packets.|
186 137 Tobias Brunner
|charon.retransmit_base                             |1.8       |Base to use for calculating exponential back off, see [[Retransmission]].|
187 137 Tobias Brunner
|charon.retransmit_timeout                          |4.0       |Timeout in seconds before sending first retransmit.|
188 152 Tobias Brunner
|charon.retransmit_tries                            |5         |Number of times to retransmit a packet before giving up.|
189 1 Martin Willi
|charon.retry_initiate_interval                     |0         |Interval in seconds to use when retrying to initiate an IKE_SA (e.g. if DNS resolution failed), 0 to disable retries.|
190 157 Tobias Brunner
|charon.reuse_ikesa                                 |yes       |Initiate CHILD_SA within existing IKE_SAs (always enabled for IKEv1).|
191 151 Juergen Seifert
|charon.routing_table                               |220       |Numerical routing table to install routes to.|
192 151 Juergen Seifert
|charon.routing_table_prio                          |220       |Priority of the routing table.|
193 137 Tobias Brunner
|charon.send_delay                                  |0         |Delay in ms for sending packets, to simulate larger RTT.|
194 137 Tobias Brunner
|charon.send_delay_request                          |yes       |Delay request messages.|
195 137 Tobias Brunner
|charon.send_delay_response                         |yes       |Delay response messages.|
196 137 Tobias Brunner
|charon.send_delay_type                             |0         |Specific IKEv2 message type to delay, 0 for any.|
197 1 Martin Willi
|charon.send_vendor_id                              |no        |Send strongSwan vendor ID payload.|
198 147 Tobias Brunner
|charon.signature_authentication                    |yes       |Whether to enable Signature Authentication as per "RFC 7427":http://tools.ietf.org/html/rfc7427.|
199 147 Tobias Brunner
|charon.signature_authentication_constraints        |yes       |If enabled, signature schemes configured in _rightauth_, in addition to getting used as constraints against signature schemes employed in the certificate chain, are also used as constraints against the signature scheme used by peers during IKEv2.|
200 142 Tobias Brunner
|charon.start-scripts                               |          |Section containing a list of scripts (name = path) that are executed when the daemon is started.|
201 142 Tobias Brunner
|charon.stop-scripts                                |          |Section containing a list of scripts (name = path) that are executed when the daemon is terminated.|
202 137 Tobias Brunner
|charon.syslog                                      |          |Section to define syslog loggers, see [[LoggerConfiguration]].|
203 1 Martin Willi
|charon.threads                                     |16        |Number of worker threads in charon. Several of these are reserved for long running tasks in internal modules and plugins. Therefore, make sure you don't set this value too low. The number of idle worker threads listed in _[[IPsecCommand|ipsec]] statusall_ might be used as indicator on the number of reserved threads ([[JobPriority]] has more on this).|
204 137 Tobias Brunner
|charon.user                                        |          |Name of the [[ReducedPrivileges|user]] the daemon changes to after startup.|
205 137 Tobias Brunner
|charon.x509.enforce_critical                       |yes       |Discard certificates with unsupported or unknown critical extensions.|
206 137 Tobias Brunner
|\3(level2). *charon.plugins subsection*            |
207 137 Tobias Brunner
|charon.plugins.android_log.loglevel                |1         |Loglevel for logging to Android specific logger.|
208 137 Tobias Brunner
|charon.plugins.attr                                |          |Section to specify arbitrary attributes that are assigned to a peer via configuration payload, see [[AttrPlugin|attr plugin]].|
209 137 Tobias Brunner
|charon.plugins.attr-sql.database                   |          |Database  URI for [[attrsql|attr-sql plugin]] used by charon. If it contains a password, make sure to adjust the permissions  of  the  config file accordingly.|
210 1 Martin Willi
|charon.plugins.attr-sql.lease_history              |yes       |Enable logging of [[SQL]] IP pool leases.|
211 147 Tobias Brunner
|charon.plugins.bliss.use_bliss_b                   |yes       |Use the enhanced BLISS-B key generation and signature algorithm.|
212 1 Martin Willi
|charon.plugins.certexpire.csv.cron                 |          |Cron style string specifying CSV export times, see [[certexpire]] for details.|
213 137 Tobias Brunner
|charon.plugins.certexpire.csv.empty_string         |          |String to use in empty intermediate CA fields.|
214 137 Tobias Brunner
|charon.plugins.certexpire.csv.fixed_fields         |yes       |Use a fixed intermediate CA field count.|
215 137 Tobias Brunner
|charon.plugins.certexpire.csv.force                |yes       |Force export of all trustchains we have a private key for.|
216 137 Tobias Brunner
|charon.plugins.certexpire.csv.format               |%d:%m:%Y  |strftime(3) format string to export expiration dates as.|
217 137 Tobias Brunner
|charon.plugins.certexpire.csv.local                |          |strftime(3) format string for the CSV file name to export local certificates to.|
218 137 Tobias Brunner
|charon.plugins.certexpire.csv.remote               |          |strftime(3) format string for the CSV file name to export remote certificates to.|
219 137 Tobias Brunner
|charon.plugins.certexpire.csv.separator            |,         |CSV field separator.|
220 1 Martin Willi
|charon.plugins.coupling.file                       |          |File to store coupling list to, see [[CertCoupling|certcoupling plugin]] for details.|
221 137 Tobias Brunner
|charon.plugins.coupling.hash                       |sha1      |Hashing algorithm to fingerprint coupled certificates.|
222 137 Tobias Brunner
|charon.plugins.coupling.max                        |1         |Maximum number of coupling entries to create.|
223 137 Tobias Brunner
|charon.plugins.dhcp.force_server_address           |no        |Always use the configured server address, see [[DHCPPlugin|DHCP plugin]] for details.|
224 137 Tobias Brunner
|charon.plugins.dhcp.identity_lease                 |no        |Derive user-defined MAC address from hash of IKEv2 identity.|
225 137 Tobias Brunner
|charon.plugins.dhcp.interface                      |          |Interface name the plugin uses for address allocation. The default is to bind to any and let the system decide which way to route the packets to the DHCP server.|
226 137 Tobias Brunner
|charon.plugins.dhcp.server                         |255.255.255.255|DHCP server unicast or broadcast IP address.|
227 137 Tobias Brunner
|charon.plugins.dnscert.enable                      |no        |Enable fetching of CERT RRs via DNS.|
228 137 Tobias Brunner
|charon.plugins.duplicheck.enable                   |yes       |Enable [[duplicheck]] plugin (if loaded).|
229 137 Tobias Brunner
|charon.plugins.duplicheck.socket                   |unix://${piddir}/charon.dck|Socket provided by the [[duplicheck]] plugin.|
230 133 Tobias Brunner
|charon.plugins.eap-aka.request_identity            |yes       ||
231 133 Tobias Brunner
|charon.plugins.eap-aka-3ggp2.seq_check             |          ||
232 148 Tobias Brunner
|charon.plugins.eap-dynamic.prefer_user             |no        |If enabled, the [[eap-dynamic]] plugin will prefer the order of the EAP methods in an EAP-Nak message sent by a client over the one configured locally.|
233 148 Tobias Brunner
|charon.plugins.eap-dynamic.preferred               |          |The preferred EAP method(s) to be used by the [[eap-dynamic]] plugin. If it is not set, the first registered method will be used initially. If a comma separated list is specified, the methods are tried in the given order before trying the rest of the registered methods.|
234 137 Tobias Brunner
|charon.plugins.eap-gtc.backend                     |pam       |XAuth backend to be used for credential verification, see [[EapGtc|EAP-GTC]].|
235 137 Tobias Brunner
|charon.plugins.eap-peap.fragment_size              |1024      |Maximum size of an EAP-PEAP packet.|
236 137 Tobias Brunner
|charon.plugins.eap-peap.max_message_count          |32        |Maximum number of processed EAP-PEAP packets.|
237 137 Tobias Brunner
|charon.plugins.eap-peap.include_length             |no        |Include length in non-fragmented EAP-PEAP packets.|
238 137 Tobias Brunner
|charon.plugins.eap-peap.phase2_method              |mschapv2  |Phase2 EAP client authentication method.|
239 137 Tobias Brunner
|charon.plugins.eap-peap.phase2_piggyback           |no        |Phase2 EAP Identity request piggybacked by server onto TLS Finished message.|
240 137 Tobias Brunner
|charon.plugins.eap-peap.phase2_tnc                 |no        |Start phase2 EAP-TNC protocol after successful client authentication.|
241 137 Tobias Brunner
|charon.plugins.eap-peap.request_peer_auth          |no        |Request peer authentication based on a client certificate.|
242 1 Martin Willi
|charon.plugins.eap-radius.accounting               |no        |Enable EAP-RADIUS accounting.|
243 1 Martin Willi
|charon.plugins.eap-radius.accounting_close_on_timeout|yes     |Close the IKE_SA if there is a timeout during interim RADIUS accounting	updates.|
244 152 Tobias Brunner
|charon.plugins.eap-radius.accounting_interval      |0         |Interval in seconds for interim RADIUS accounting updates, if not specified by the RADIUS server in the Access-Accept message.|
245 137 Tobias Brunner
|charon.plugins.eap-radius.accounting_requires_vip  |no        |If enabled, accounting is disabled unless an IKE_SA has at least one virtual IP.|
246 144 Tobias Brunner
|charon.plugins.eap-radius.class_group              |no        |Use the class attribute sent in the Access-Accept message as group membership information, see [[EapRadius]].|
247 1 Martin Willi
|charon.plugins.eap-radius.close_all_on_timeout     |no        |Closes all IKE_SAs if communication with the RADIUS server times out. If it is not set only the current IKE_SA is closed.|
248 137 Tobias Brunner
|charon.plugins.eap-radius.dae.enable               |no        |Enables support for the Dynamic Authorization Extension (RFC 5176).|
249 137 Tobias Brunner
|charon.plugins.eap-radius.dae.listen               |0.0.0.0   |Address to listen for DAE messages from the RADIUS server.|
250 137 Tobias Brunner
|charon.plugins.eap-radius.dae.port                 |3799      |Port to listen for DAE requests.|
251 137 Tobias Brunner
|charon.plugins.eap-radius.dae.secret               |          |Shared secret used to verify/sign DAE messages.If  set, make sure to adjust the permissions of the config file accordingly.|
252 137 Tobias Brunner
|charon.plugins.eap-radius.eap_start                |no        |Send EAP-Start instead of EAP-Identity to start RADIUS conversation.|
253 137 Tobias Brunner
|charon.plugins.eap-radius.filter_id                |no        |Use the filter_id attribute sent in the RADIUS-Accept message as group membership if the RADIUS tunnel_type attribute is set to ESP.|
254 122 Tobias Brunner
|charon.plugins.eap-radius.forward.ike_to_radius    |          |RADIUS attributes to be forwarded from IKEv2 to RADIUS (can be defined by name or attribute number, a colon can be used to specify vendor-specific attributes, e.g. Reply-Message, or 11, or 36906:12).|
255 122 Tobias Brunner
|charon.plugins.eap-radius.forward.radius_to_ike    |          |Same as above but from RADIUS to IKEv2, a strongSwan specific private notify (40969) is used to transmit the attributes.|
256 137 Tobias Brunner
|charon.plugins.eap-radius.id_prefix                |          |Prefix to EAP-Identity, some AAA servers use a IMSI prefix to select the EAP method.|
257 137 Tobias Brunner
|charon.plugins.eap-radius.nas_identifier           |strongSwan|NAS-Identifier to include in RADIUS messages.|
258 137 Tobias Brunner
|charon.plugins.eap-radius.port                     |1812      |Port of RADIUS server (authentication).|
259 156 Tobias Brunner
|charon.plugins.eap-radius.retransmit_base          |1.4       |Base to use for calculating exponential back off.|
260 156 Tobias Brunner
|charon.plugins.eap-radius.retransmit_timeout       |2.0       |Timeout in seconds before sending first retransmit.|
261 156 Tobias Brunner
|charon.plugins.eap-radius.retransmit_tries         |4         |Number of times to retransmit a packet before giving up.|
262 137 Tobias Brunner
|charon.plugins.eap-radius.secret                   |          |Shared secret between RADIUS and NAS. If set, make sure to adjust the permissions of the config file accordingly.|
263 1 Martin Willi
|charon.plugins.eap-radius.server                   |          |IP/Hostname of RADIUS server.|
264 156 Tobias Brunner
|charon.plugins.eap-radius.servers                  |          |Section to specify multiple RADIUS servers, see [[EapRadius]]. The _nas_identifier_, _secret_, _sockets_ and _port_ (or _auth_port_) options can be specified for each server. The _retransmit_ settings can also be changed for each server.  A server's IP/Hostname can be configured using the _address_ option. The _acct_port_ [1813] option can be used to specify the port used for RADIUS accounting. For each server a priority can be specified using the _preference_ [0] option.|
265 137 Tobias Brunner
|charon.plugins.eap-radius.sockets                  |1         |Number of sockets (ports) to use, increase for high load.|
266 137 Tobias Brunner
|charon.plugins.eap-radius.xauth                    |          |Section to configure [[EapRadius#XAuth|multiple XAuth authentication rounds]] via RADIUS.|
267 130 Tobias Brunner
|charon.plugins.eap-sim.request_identity            |yes       ||
268 1 Martin Willi
|charon.plugins.eap-simaka-sql.database             |          ||
269 30 Martin Willi
|charon.plugins.eap-simaka-sql.remove_used          |          ||
270 137 Tobias Brunner
|charon.plugins.eap-tls.fragment_size               |1024      |Maximum size of an EAP-TLS packet.|
271 137 Tobias Brunner
|charon.plugins.eap-tls.include_length              |yes       |Include length in non-fragmented EAP-TLS packets.|
272 137 Tobias Brunner
|charon.plugins.eap-tls.max_message_count           |32        |Maximum number of processed EAP-TLS packets (0 = no limit).|
273 137 Tobias Brunner
|charon.plugins.eap-tnc.max_message_count           |10        |Maximum number of processed EAP-TNC packets (0 = no limit).|
274 139 Andreas Steffen
|charon.plugins.eap-tnc.protocol                    |tnccs-2.0 |IF-TNCCS protocol version to be used (tnccs-1.1, tnccs-2.0, tnccs-dynamic).|
275 137 Tobias Brunner
|charon.plugins.eap-ttls.fragment_size              |1024      |Maximum size of an EAP-TTLS packet.|
276 137 Tobias Brunner
|charon.plugins.eap-ttls.include_length             |yes       |Include length in non-fragmented EAP-TTLS packets.|
277 137 Tobias Brunner
|charon.plugins.eap-ttls.max_message_count          |32        |Maximum number of processed EAP-TTLS packets (0 = no limit).|
278 137 Tobias Brunner
|charon.plugins.eap-ttls.phase2_method              |md5       |Phase2 EAP client authentication method.|
279 137 Tobias Brunner
|charon.plugins.eap-ttls.phase2_piggyback           |no        |Phase2 EAP Identity request piggybacked by server onto TLS Finished message.|
280 1 Martin Willi
|charon.plugins.eap-ttls.phase2_tnc                 |no        |Start phase2 EAP TNC protocol after successful client authentication.|
281 1 Martin Willi
|charon.plugins.eap-ttls-phase2_tnc_method          |pt        |Phase2 EAP TNC transport protocol (pt as IETF standard or legacy tnc)|
282 141 Andreas Steffen
|charon.plugins.eap-ttls.request_peer_auth          |no        |Request peer authentication based on a client certificate.|
283 137 Tobias Brunner
|charon.plugins.error-notify.socket                 |unix://${piddir}/charon.enfy|Socket provided by the [[ErrorNotifyPlugin|error-notify]] plugin.|
284 144 Tobias Brunner
|charon.plugins.ext-auth.script                     |          |Shell script to invoke for peer authorization (see [[ext-auth]]).|
285 137 Tobias Brunner
|charon.plugins.gcrypt.quick_random                 |no        |Use faster random numbers in gcrypt. *For testing only, produces weak keys!*|
286 1 Martin Willi
|charon.plugins.ha.autobalance                      |0         |Interval in seconds to automatically balance handled segments between nodes. Set to 0 to disable.|
287 1 Martin Willi
|charon.plugins.ha.fifo_interface                   |yes       ||
288 73 Tobias Brunner
|charon.plugins.ha.heartbeat_delay                  |1000      ||
289 73 Tobias Brunner
|charon.plugins.ha.heartbeat_timeout                |2100      ||
290 87 Tobias Brunner
|charon.plugins.ha.local                            |          ||
291 73 Tobias Brunner
|charon.plugins.ha.monitor                          |yes       ||
292 130 Tobias Brunner
|charon.plugins.ha.pools                            |          ||
293 61 Andreas Steffen
|charon.plugins.ha.remote                           |          ||
294 130 Tobias Brunner
|charon.plugins.ha.resync                           |yes       ||
295 137 Tobias Brunner
|charon.plugins.ha.secret                           |          ||
296 137 Tobias Brunner
|charon.plugins.ha.segment_count                    |1         ||
297 137 Tobias Brunner
|charon.plugins.ipseckey.enable                     |no        |Enable fetching of IPSECKEY RRs via DNS.|
298 1 Martin Willi
|charon.plugins.kernel-libipsec.allow_peer_ts       |no        |Allow that the remote traffic selector equals the IKE peer (see [[kernel-libipsec#Host-to-Host-Tunnels|kernel-libipsec]] for details).|
299 158 Tobias Brunner
|charon.plugins.kernel-netlink.buflen               |min(PAGE_SIZE, 8192)|Buffer size for received Netlink messages.|
300 137 Tobias Brunner
|charon.plugins.kernel-netlink.fwmark               |          |Firewall mark to set on the routing rule that directs traffic to our own routing table. The format is [!]mark[/mask], where the optional exclamation mark inverts the meaning (i.e. the rule only applies to packets that don't match the mark). A possible use case are [[kernel-libipsec#Host-to-Host-Tunnels|host-to-host tunnels with kernel-libipsec]].|
301 144 Tobias Brunner
|charon.plugins.kernel-netlink.mss                  |0         |MSS to set on installed routes, 0 to disable.|
302 144 Tobias Brunner
|charon.plugins.kernel-netlink.mtu                  |0         |MTU to set on installed routes, 0 to disable.|
303 137 Tobias Brunner
|charon.plugins.kernel-netlink.roam_events          |yes       |Whether to trigger roam events when interfaces, addresses or routes change.|
304 1 Martin Willi
|charon.plugins.kernel-netlink.set_proto_port_transport_sa|no  |Whether to set protocol and ports in the selector installed on transport mode IPsec SAs in the kernel. While doing so enforces policies for inbound traffic, it also prevents the use of a single IPsec SA by more than one traffic selector.|
305 149 Tobias Brunner
|charon.plugins.kernel-netlink.xfrm_acq_expires     |165       |Lifetime of XFRM acquire state in kernel. The value gets written to @/proc/sys/net/core/xfrm_acq_expires@. Indirectly controls the dealy of XFRM acquire messages sent.|
306 147 Tobias Brunner
|charon.plugins.kernel-pfkey.events_buffer_size     |0         |Size of the receive buffer for the event socket (0 for default size). Because events are received asynchronously installing e.g. lots of policies may require a larger buffer than the default on certain platforms in order to receive all messages.|
307 137 Tobias Brunner
|charon.plugins.kernel-pfroute.vip_wait             |1000      |Time in ms to wait until virtual IP addresses appear/disappear before failing.|
308 1 Martin Willi
|charon.plugins.led.activity_led                    |          ||
309 1 Martin Willi
|charon.plugins.led.blink_time                      |50        ||
310 137 Tobias Brunner
|charon.plugins.load-tester                         |          |Subsection to configure [[LoadTests|load tests]] using the [[LoadTests|load-tester]] plugin.|
311 137 Tobias Brunner
|charon.plugins.lookip.socket                       |unix://${piddir}/charon.lkp|Socket provided by the [[lookip]] plugin.|
312 137 Tobias Brunner
|charon.plugins.ntru.max_drbg_requests              |4294967294|Number of pseudo-random bit requests from the DRBG before an automatic reseeding occurs.|
313 137 Tobias Brunner
|charon.plugins.ntru.parameter_set                  |optimum   |The following parameter sets are available: x9_98_speed, x9_98_bandwidth, x9_98_balance and optimum, the last set not being part of the X9.98 standard but  having  the best performance.|
314 137 Tobias Brunner
|charon.plugins.openssl.engine_id                   |pkcs11    |ENGINE ID to use in the OpenSSL plugin.|
315 137 Tobias Brunner
|charon.plugins.openssl.fips_mode                   |0         |Set OpenSSL FIPS mode: disabled (0), enabled (1), Suite B enabled (2). Defaults to the value [[Autoconf#--with-options|configured]] with the _--with-fips-mode_ option.|
316 154 Tobias Brunner
|charon.plugins.osx-attr.append                     |yes       |Whether DNS servers are appended to existing entries, instead of replacing them.|
317 137 Tobias Brunner
|charon.plugins.pkcs11.load_certs                   |yes       |Whether to load certificates from tokens.|
318 137 Tobias Brunner
|charon.plugins.pkcs11.modules                      |          |List of available PKCS#11 modules, see [[SmartCardsIKEv2]].|
319 137 Tobias Brunner
|charon.plugins.pkcs11.reload_certs                 |no        |Reload certificates from all tokens if charon receives a SIGHUP.|
320 137 Tobias Brunner
|charon.plugins.pkcs11.use_dh                       |no        |Whether the PKCS#11 modules should be used for DH and ECDH.|
321 137 Tobias Brunner
|charon.plugins.pkcs11.use_ecc                      |no        |Whether the PKCS#11 modules should be used for ECDH and ECDSA public key operations. ECDSA private keys are used regardless of this option.|
322 137 Tobias Brunner
|charon.plugins.pkcs11.use_hasher                   |no        |Whether the PKCS#11 modules should be used to hash data.|
323 137 Tobias Brunner
|charon.plugins.pkcs11.use_pubkey                   |no        |Whether the PKCS#11 modules should be used for public key operations, even for keys not stored on tokens.|
324 137 Tobias Brunner
|charon.plugins.pkcs11.use_rng                      |no        |Whether the PKCS#11 modules should be used as RNG.|
325 137 Tobias Brunner
|charon.plugins.radattr.dir                         |          |Directory where RADIUS attributes are stored in client-ID specific files, see [[RadAttrPlugin|radattr]].|
326 137 Tobias Brunner
|charon.plugins.radattr.message_id                  |-1        |RADIUS attributes are added to all IKE_AUTH messages by default (-1), or only to the IKE_AUTH message with the given IKEv2 message ID.|
327 137 Tobias Brunner
|charon.plugins.random.random                       |/dev/random|File to read random bytes from.|
328 137 Tobias Brunner
|charon.plugins.random.urandom                      |/dev/urandom|File to read pseudo random bytes from.|
329 137 Tobias Brunner
|charon.plugins.random.strong_equals_true           |no        |If enabled the RNG_STRONG class reads random bytes from the same source as the RNG_TRUE class.|
330 137 Tobias Brunner
|charon.plugins.resolve.file                        |/etc/resolv.conf|File used by the [[resolveplugin|resolve plugin]] to write DNS server entries to.|
331 1 Martin Willi
|charon.plugins.resolve.resolvconf.iface_prefix     |lo.inet.ipsec.|Prefix used by the [[resolveplugin|resolve plugin]] for interface names sent to resolvconf(8). The name server address is appended to this prefix to make it unique. The result has to be a valid interface name according to the rules defined by resolvconf. Also, it should have a high priority according to the order defined in interface-order(5).|
332 137 Tobias Brunner
|charon.plugins.socket-default.fwmark               |          |Firewall mark to set on outbound packets (a possible use case are [[kernel-libipsec#Host-to-Host-Tunnels|host-to-host tunnels with kernel-libipsec]]).|
333 137 Tobias Brunner
|charon.plugins.socket-default.set_source           |yes       |Set source address on outbound packets, if possible.|
334 137 Tobias Brunner
|charon.plugins.socket-default.use_ipv4             |yes       |Listen on IPv4, if possible.|
335 137 Tobias Brunner
|charon.plugins.socket-default.use_ipv6             |yes       |Listen on IPv6, if possible.|
336 137 Tobias Brunner
|charon.plugins.sql.database                        |          |Database URI for charon's [[SQL]] plugin. If it contains a password, make sure to adjust the permissions of the config  file  accordingly.|
337 1 Martin Willi
|charon.plugins.sql.loglevel                        |-1        |Loglevel for logging to [[SQL]] database.|
338 153 Tobias Brunner
|charon.plugins.stroke.allow_swap                   |yes       |Analyze addresses/hostnames in _left/right_ to detect which side is local and swap configuration options if necessary. If disabled _left_ is always _local_.|
339 137 Tobias Brunner
|charon.plugins.stroke.ignore_missing_ca_basic_constraint|no   |Treat certificates in [[IpsecDirectoryCacerts|ipsec.d/cacerts]] and ipsec.conf [[CASection|ca sections]] as CA certificates even if they don't contain a CA basic constraint.|
340 1 Martin Willi
|charon.plugins.stroke.max_concurrent               |4         |Maximum number of stroke messages handled concurrently.|
341 144 Tobias Brunner
|charon.plugins.stroke.secrets_file                 |${sysconfdir}/ipsec.secrets|Location of the [[ipsec.secrets]] file.|
342 137 Tobias Brunner
|charon.plugins.stroke.socket                       |unix://${piddir}/charon.ctl|Socket provided by the stroke plugin.|
343 137 Tobias Brunner
|charon.plugins.stroke.timeout                      |0         |Timeout in ms for any stroke command. Use 0 to disable the timeout.|
344 137 Tobias Brunner
|charon.plugins.systime-fix.interval                |0         |Interval in seconds to check system time for validity. 0 disables the check. See [[SystimeFixPlugin|systime-fix plugin]].|
345 137 Tobias Brunner
|charon.plugins.systime-fix.reauth                  |no        |Whether to use reauth or delete if an invalid cert lifetime is detected.|
346 137 Tobias Brunner
|charon.plugins.systime-fix.threshold               |          |Threshold date where system time is considered valid. Disabled if not specified.|
347 137 Tobias Brunner
|charon.plugins.systime-fix.threshold_format        |%Y        |strptime(3) format used to parse threshold option.|
348 137 Tobias Brunner
|charon.plugins.tnc-ifmap.client_cert               |          |Path to X.509 certificate file of IF-MAP client.|
349 137 Tobias Brunner
|charon.plugins.tnc-ifmap.client_key                |          |Path to private key file of IF-MAP client.|
350 137 Tobias Brunner
|charon.plugins.tnc-ifmap.device_name               |          |Unique name of strongSwan server as a PEP and/or PDP device.|
351 137 Tobias Brunner
|charon.plugins.tnc-ifmap.renew_session_interval    |150       |Interval in seconds between periodic IF-MAP RenewSession requests.|
352 137 Tobias Brunner
|charon.plugins.tnc-ifmap.server_cert               |          |Path to X.509 certificate file of IF-MAP server.|
353 137 Tobias Brunner
|charon.plugins.tnc-ifmap.server_uri                |https://localhost:8444/imap|URI of the form <notextile>[https://]servername[:port][/path]</notextile>.|
354 137 Tobias Brunner
|charon.plugins.tnc-ifmap.username_password         |          |Credentials of IF-MAP client of the form username:password. If set,  make  sure  to adjust  the permissions of the config file accordingly.|
355 137 Tobias Brunner
|charon.plugins.tnc-imc.dlcose                      |yes       |Unload IMC after use.|
356 137 Tobias Brunner
|charon.plugins.tnc-imc.preferred_language          |en        |Preferred language for TNC recommendations.|
357 137 Tobias Brunner
|charon.plugins.tnc-imv.dlcose                      |yes       |Unload IMV after use.|
358 137 Tobias Brunner
|charon.plugins.tnc-imv.recommendation_policy       |default   |TNC recommendation policy, one of _default_, _any_, or _all_.|
359 137 Tobias Brunner
|charon.plugins.tnc-pdp.pt_tls.enable               |yes       |Enable PT-TLS protocol on the strongSwan PDP.|
360 137 Tobias Brunner
|charon.plugins.tnc-pdp.pt_tls.port                 |271       |PT-TLS server port the strongSwan PDP is listening on.|
361 137 Tobias Brunner
|charon.plugins.tnc-pdp.radius.enable               |yes       |Enable RADIUS protocol on the strongSwan PDP.|
362 137 Tobias Brunner
|charon.plugins.tnc-pdp.radius.method               |ttls      |EAP tunnel method to be used.|
363 137 Tobias Brunner
|charon.plugins.tnc-pdp.radius.port                 |1812      |RADIUS server port the strongSwan PDP is listening on.|
364 137 Tobias Brunner
|charon.plugins.tnc-pdp.radius.secret               |          |Shared RADIUS secret between strongSwan PDP and NAS. If set, make  sure  to adjust the permissions of the config file accordingly.|
365 137 Tobias Brunner
|charon.plugins.tnc-pdp.server                      |          |Name of the strongSwan PDP as contained in the AAA certificate.|
366 137 Tobias Brunner
|charon.plugins.tnc-pdp.timeout                     |          |Timeout in seconds before closing incomplete connections.|
367 137 Tobias Brunner
|charon.plugins.tnccs-11.max_message_size           |45000     |Maximum size of a PA-TNC message (XML & Base64 encoding).|
368 137 Tobias Brunner
|charon.plugins.tnccs-20.max_batch_size             |65522     |Maximum size of a PB-TNC batch (upper limit via PT-EAP = 65529).|
369 1 Martin Willi
|charon.plugins.tnccs-20.max_message_size           |65490     |Maximum size of a PA-TNC message (upper limit via PT-EAP = 65497).|
370 147 Tobias Brunner
|charon.plugins.tnccs-20.mutual                     |no        |Enable PB-TNC mutual protocol.|
371 137 Tobias Brunner
|charon.plugins.unbound.dlv_anchors                 |          |File to read trusted keys for DLV(DNSSEC Lookaside Validation) from. It uses the same format as _trust_anchors_. Only one DLV can be configured, which is then used as a root trusted DLV, this means that it is a lookaside for the root.|
372 137 Tobias Brunner
|charon.plugins.unbound.resolv_conf                 |/etc/resolv.conf|File to read DNS resolver configuration from.|
373 1 Martin Willi
|charon.plugins.unbound.trust_anchors               |/etc/ipsec.d/dnssec.keys|File to read DNSSEC trust anchors from (usually root zone KSK). The format of the file is the standard DNS Zone file format, anchors can be stored as DS or DNSKEY entries in the file.|
374 137 Tobias Brunner
|charon.plugins.updown.dns_handler                  |no        |Whether the updown script should handle DNS servers assigned via IKEv1 Mode Config or IKEv2 Config Payloads (if enabled they can't be handled by other plugins, like [[resolveplugin|resolve]]).|
375 142 Tobias Brunner
|charon.plugins.vici.socket                         |unix://${piddir}/charon.vici|Socket the [[vici|vici plugin]] serves clients.|
376 1 Martin Willi
|charon.plugins.whitelist.enable                    |yes       |Enable loaded [[whitelist]] plugin.|
377 1 Martin Willi
|charon.plugins.whitelist.socket                    |unix://${piddir}/charon.wlst|Socket provided by the whitelist plugin.|
378 1 Martin Willi
|charon.plugins.xauth-eap.backend                   |radius    |EAP plugin to be used as backend for XAuth credential verification, see [[XAuthEAP]].|
379 1 Martin Willi
|charon.plugins.xauth-pam.pam_service               |login     |PAM service to be used for authentication, see [[XAuthPAM]].|
380 1 Martin Willi
|charon.plugins.xauth-pam.session                   |no        |Open/close a PAM session for each active IKE_SA.|
381 1 Martin Willi
|charon.plugins.xauth-pam.trim_email                |yes       |If an email address is given as an XAuth username, trim it to just the username part.|
382 1 Martin Willi
|\3(level2). *charon.imcv subsection*               |
383 1 Martin Willi
|\3(level3). Defaults for options in this section can be configured in the _libimcv_ section.|
384 1 Martin Willi
|charon.imcv.assessment_result                      |yes       |Whether IMVs send a standard IETF Assessment Result attribute.|
385 1 Martin Willi
|charon.imcv.database                               |          |Global IMV policy database URI. If it contains a password, make sure to adjust the permissions of the config file accordingly.|
386 153 Tobias Brunner
|charon.imcv.os_info.default_password_enabled       |no        |Manually set whether a default password is enabled.|
387 1 Martin Willi
|charon.imcv.os_info.name                           |          |Manually set the name of the client OS (e.g. Ubuntu).|
388 1 Martin Willi
|charon.imcv.os_info.version                        |          |Manually set the version of the client OS (e.g. 12.04 i686).|
389 1 Martin Willi
|charon.imcv.policy_script                          |ipsec _imv_policy|Script called for each TNC connection to generate IMV policies.|
390 1 Martin Willi
|\3(level2). *charon.tls subsection*                |
391 1 Martin Willi
|\3(level3). Defaults for options in this section can be configured in the _libtls_ section.|
392 1 Martin Willi
|charon.tls.cipher                                  |          |List of TLS encryption ciphers.|
393 1 Martin Willi
|charon.tls.key_exchange                            |          |List of TLS key exchange methods.|
394 1 Martin Willi
|charon.tls.mac                                     |          |List of TLS MAC algorithms.|
395 1 Martin Willi
|charon.tls.suites                                  |          |List of TLS cipher suites.|
396 1 Martin Willi
|\3(level2). *charon.tnc subsection*                |
397 1 Martin Willi
|\3(level3). Defaults for options in this section can be configured in the _libtnccs_ section.|
398 1 Martin Willi
|libtnccs.tnc_config                                |/etc/tnc_config|TNC IMC/IMV configuration file.|
399 144 Tobias Brunner
|\3(level1). *[[charon-systemd]] section*           |
400 144 Tobias Brunner
|charon-systemd.journal                             |          |Section to configure native systemd journal logger, very similar to the syslog logger as described in [[LoggerConfiguration]].|
401 150 Tobias Brunner
|\3(level1). *imv_policy_manager section*           |
402 150 Tobias Brunner
|imv_policy_manager.command_allow                   |          |Shell command to be executed with recommendation _allow_.|
403 150 Tobias Brunner
|imv_policy_manager.command_block                   |          |Shell command to be executed with all other recommendations.|
404 150 Tobias Brunner
|imv_policy_manager.database                        |          |Database URI for the database that stores the package information. If it contains a password, make sure to adjust permissions of the config file accordingly.|
405 150 Tobias Brunner
|imv_policy_manager.load                            |sqlite    |Plugins to load in IMV policy manager.|
406 1 Martin Willi
|\3(level1). *libimcv section*                      |
407 1 Martin Willi
|libimcv.debug_level                                |1         |Debug level for a stand-alone libimcv library.|
408 1 Martin Willi
|libimcv.load                                       |random nonce gmp pubkey x509|Plugins to load in IMC/IMVs with stand-alone libimcv library.|
409 1 Martin Willi
|libimcv.stderr_quiet                               |no        |Disable the output to stderr with a stand-alone libimcv library.|
410 140 Andreas Steffen
|\3(level1). *libimcv plugins subsection*           |
411 140 Andreas Steffen
|libimcv.plugins.imc-attestation.aik_blob           |          |AIK encrypted private key blob file.|
412 140 Andreas Steffen
|libimcv.plugins.imc-attestation.aik_cert           |          |AIK certificate file.|
413 140 Andreas Steffen
|libimcv.plugins.imc-attestation.aik_pubkey         |          |AIK public key file.|
414 140 Andreas Steffen
|libimcv.plugins.imc-attestation.mandatory_dh_groups|yes       |Enforce mandatory Diffie-Hellman groups|
415 140 Andreas Steffen
|libimcv.plugins.imc-attestation.nonce_len          |20        |DH nonce length.|
416 140 Andreas Steffen
|libimcv.plugins.imc-attestation.pcr_info           |no        |Whether to send pcr_before and pcr_after info.|
417 140 Andreas Steffen
|libimcv.plugins.imc-attestation.use_quote2         |yes       |Use Quote2 AIK signature instead of Quote signature.|
418 153 Tobias Brunner
|libimcv.plugins.imc-hcd.push_info                  |yes       |Send quadruple info without being prompted.|
419 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes                   |          |Section to define PWG HCD PA subtypes (see [[HCD-IMC]]).|
420 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.<section>         |          |Defines a PWG HCD PA subtype section. Recognized subtype section names are _system_, _control_, _marker_, _finisher_, _interface_ and _scanner_.|
421 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>|         |Defines a software type section. Recognized software type section names are _firmware_, _resident_application_ and _user_application_.|
422 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>||Defines a software section having an arbitrary name.|
423 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.name||Name of the software installed on the hardcopy device.|
424 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.patches||String describing all patches applied to the given software on this hardcopy device. The individual patches are separated by a newline character '\n'.|
425 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.string_version||String describing the version of the given software on this hardcopy device.|
426 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.version||Hex-encoded version string with a length of 16 octets consisting of the fields major version number (4 octets), minor version number (4 octets), build number (4 octets), service pack major number (2 octets) and service pack minor number (2 octets).|
427 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.<section>.attributes_natural_language|en|Variable length natural language tag conforming to RFC 5646 specifies the language to be used in the health assessment message of a given subtype.|
428 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.certification_state|  |Hex-encoded certification state.|
429 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.configuration_state|  |Hex-encoded configuration state.|
430 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.machine_type_model|   |String specifying the machine type and model of the hardcopy device.|
431 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.pstn_fax_enabled|no   |Specifies if a PSTN facsimile interface is installed and enabled on the hardcopy device.|
432 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.time_source|          |String specifying the hostname of the network time server used by the hardcopy device.|
433 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.user_application_enabled|no|Specifies if users can dynamically download and execute applications on the hardcopy device.|
434 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.user_application_persistence_enabled|no|Specifies if user dynamically downloaded applications can persist outside the boundaries of a single job on the hardcopy device.|
435 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.vendor_name|          |String specifying the manufacturer of the hardcopy device.|
436 153 Tobias Brunner
|libimcv.plugins.imc-hcd.subtypes.system.vendor_smi_code|      |Integer specifying the globally unique 24-bit SMI code assigned to the manufacturer of the hardcopy device.|
437 140 Andreas Steffen
|libimcv.plugins.imc-os.device_cert                 |          |Manually set the path to the client device certificate (e.g. /etc/pts/aikCert.der)|
438 140 Andreas Steffen
|libimcv.plugins.imc-os.device_id                   |          |Manually set the client device ID in hexadecimal format (e.g. 1083f03988c9762703b1c1080c2e46f72b99cc31)|
439 140 Andreas Steffen
|libimcv.plugins.imc-os.device_pubkey               |          |Manually set the path to the client device public key (e.g. /etc/pts/aikPub.der)|
440 140 Andreas Steffen
|libimcv.plugins.imc-os.push_info                   |yes       |Send operating system info without being prompted.|
441 1 Martin Willi
|libimcv.plugins.imc-scanner.push_info              |yes       |Send open listening ports without being prompted.|
442 141 Andreas Steffen
|libimcv.plugins.imc-swid.full                      |no        |include files in SWID tags|
443 141 Andreas Steffen
|libimcv.plugins.imc-swid.pretty                    |no        |output XML descriptions of SWID tags in pretty print|
444 1 Martin Willi
|libimcv.plugins.imc-swid.swid_directory            |${prefix}/share|Directory where SWID tags are located.|
445 141 Andreas Steffen
|libimcv.plugins.imc-swid.swid_generator            |          |path and options of swid_generator command.|
446 140 Andreas Steffen
|libimcv.plugins.imc-test.additional_ids            |0         |Number of additional IMC IDs.|
447 140 Andreas Steffen
|libimcv.plugins.imc-test.command                   |none      |Command to be sent to the Test IMV.|
448 140 Andreas Steffen
|libimcv.plugins.imc-test.dummy_size                |0         |Size of dummy attribute to be sent to the Test IMV (0 = disabled).|
449 140 Andreas Steffen
|libimcv.plugins.imc-test.retry                     |no        |Do a handshake retry.|
450 140 Andreas Steffen
|libimcv.plugins.imc-test.retry_command             |          |Command to be sent to the IMV Test in the handshake retry.|
451 140 Andreas Steffen
|libimcv.plugins.imv-attestation.cadir              |          |Path to directory with AIK cacerts.|
452 140 Andreas Steffen
|libimcv.plugins.imv-attestation.dh_group           |ecp256    |Preferred Diffie-Hellman group.|
453 140 Andreas Steffen
|libimcv.plugins.imv-attestation.hash_algorithm     |sha256    |Preferred measurement hash algorithm.|
454 140 Andreas Steffen
|libimcv.plugins.imv-attestation.min_nonce_len      |0         |DH minimum nonce length.|
455 140 Andreas Steffen
|libimcv.plugins.imv-attestation.remediation_uri    |          |URI pointing to attestation remediation instructions.|
456 140 Andreas Steffen
|libimcv.plugins.imv-os.remediation_uri             |          |URI pointing to operating system remediation instructions.|
457 140 Andreas Steffen
|libimcv.plugins.imv-scanner.remediation_uri        |          |URI pointing to scanner remediation instructions.|
458 140 Andreas Steffen
|libimcv.plugins.imv-test.rounds                    |0         |Number of IMC-IMV retry rounds.|
459 1 Martin Willi
|\3(level1). *manager section*                      |
460 137 Tobias Brunner
|manager.database                                   |          |Credential database URI for manager. If it contains a password, make sure to adjust the permissions of the config file accordingly.|
461 137 Tobias Brunner
|manager.debug                                      |no        |Enable debugging in manager.|
462 137 Tobias Brunner
|manager.load                                       |          |Plugins to load in manager.|
463 137 Tobias Brunner
|manager.socket                                     |          |FastCGI socket of manager, to run it statically.|
464 137 Tobias Brunner
|manager.threads                                    |10        |Threads to use for request handling.|
465 137 Tobias Brunner
|manager.timeout                                    |15m       |Session timeout for manager.|
466 1 Martin Willi
|\3(level1). *mediation client section*             |
467 137 Tobias Brunner
|medcli.database                                    |          |Mediation client database URI. If it contains a password, make sure to adjust the permissions of the config file accordingly.|
468 137 Tobias Brunner
|medcli.dpd                                         |5m        |DPD timeout to use in mediation client plugin.|
469 137 Tobias Brunner
|medcli.rekey                                       |20m       |Rekeying time on mediation connections in mediation client plugin.|
470 1 Martin Willi
|\3(level1). *mediation server section*             |
471 137 Tobias Brunner
|medsrv.database                                    |          |Mediation server database URI. If it contains a  password, make sure to adjust the permissions of the config file accordingly.|
472 137 Tobias Brunner
|medsrv.debug                                       |no        |Debugging in mediation server web application.|
473 137 Tobias Brunner
|medsrv.dpd                                         |5m        |DPD timeout to use in mediation server plugin.|
474 137 Tobias Brunner
|medsrv.load                                        |          |Plugins to load in mediation server plugin.|
475 137 Tobias Brunner
|medsrv.password_length                             |6         |Minimum password length required for mediation server user accounts.|
476 137 Tobias Brunner
|medsrv.rekey                                       |20m       |Rekeying time on mediation connections in mediation server plugin.|
477 1 Martin Willi
|medsrv.socket                                      |          |Run Mediation server web application statically on socket.|
478 137 Tobias Brunner
|medsrv.threads                                     |5         |Number of thread for mediation service web application.|
479 1 Martin Willi
|medsrv.timeout                                     |15m       |Session timeout for mediation service.|
480 137 Tobias Brunner
|\3(level1). *pacman section*                       |
481 1 Martin Willi
|pacman.database                                    |          |Database  URI for the database that stores the package information. If it contains a password, make sure to adjust the permissions of the config file accordingly.|
482 137 Tobias Brunner
|\3(level1). *pki section*                          |
483 1 Martin Willi
|pki.load                                           |          |Plugins to load in ipsec pki tool.|
484 137 Tobias Brunner
|\3(level1). *pool section*                         |
485 137 Tobias Brunner
|pool.database                                      |          |Database  URI for the database that stores IP pools and configuration attributes. If it contains a password, make sure to adjust the permissions of the config file accordingly.|
486 1 Martin Willi
|pool.load                                          |          |Plugins to load in ipsec pool tool.|
487 137 Tobias Brunner
|\3(level1). *pt-tls-client section*                |
488 1 Martin Willi
|pt-tls-client.load                                 |          |Plugins to load in ipsec pt-tls-client tool.|
489 1 Martin Willi
|\3(level1). *scepclient section*                   |
490 1 Martin Willi
|scepclient.load                                    |          |Plugins to load in ipsec scepclient tool.|
491 144 Tobias Brunner
|\3(level1). *starter section*                      |
492 137 Tobias Brunner
|starter.config_file                                |${sysconfdir}/ipsec.conf|Location of the [[ipsec.conf]] file.|
493 1 Martin Willi
|starter.load_warning                               |yes       |Show _charon.load_ setting warning, see [[PluginLoad]].|
494 142 Tobias Brunner
|\3(level1). *swanctl section*                      |
495 142 Tobias Brunner
|swanctl.load                                       |          |Plugins to load in [[swanctl]].|