strongswan.conf Reference » History » Version 181
Tobias Brunner, 20.09.2018 14:43
Use headings for sections
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 | 179 | Tobias Brunner | {{>toc}} |
8 | 179 | Tobias Brunner | |
9 | 1 | Martin Willi | h2. Overview |
10 | 1 | Martin Willi | |
11 | 179 | 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. Starting with the strongSwan version:4.2.1 release, a default strongswan.conf file is installed in your sysconfdir, e.g. @/etc/strongswan.conf@. |
12 | 159 | Tobias Brunner | |
13 | 1 | Martin Willi | Since version:5.1.2 the default config file is split up and separate files are placed in the [[StrongswanDirectory|/etc/strongswan.d]] directory. |
14 | 159 | Tobias Brunner | |
15 | 179 | Tobias Brunner | h2. Reloading |
16 | 1 | Martin Willi | |
17 | 179 | Tobias Brunner | The IKE daemon [[charon]] (and some of its derivatives) reloads strongswan.conf if it receives a @SIGHUP@ (this has to be sent manually, [[ipseccommand|ipsec update/reload]] don't send it), or if triggered via [[vici]]'s @reload-settings@ or [[swanctl]]'s @--reload-settings@ commands. 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). |
18 | 179 | Tobias Brunner | |
19 | 1 | Martin Willi | h2. Syntax |
20 | 1 | Martin Willi | |
21 | 179 | Tobias Brunner | The format consists of hierarchical *sections* and a list of *key/value pairs* in each section. |
22 | 49 | Andreas Steffen | |
23 | 179 | Tobias Brunner | Each section has a name, followed by C-style curly brackets defining the section body. Each section body contains a set of subsections and key/value pairs: |
24 | 179 | Tobias Brunner | |
25 | 30 | Martin Willi | <pre> |
26 | 1 | Martin Willi | settings := (section|keyvalue)* |
27 | 1 | Martin Willi | section := name { settings } |
28 | 29 | Andreas Steffen | keyvalue := key = value\n |
29 | 1 | Martin Willi | </pre> |
30 | 49 | Andreas Steffen | |
31 | 179 | Tobias Brunner | Values must be terminated by a newline. Comments are possible using the #-character. Section names and keys may contain any printable character except: |
32 | 49 | Andreas Steffen | |
33 | 30 | Martin Willi | <pre> |
34 | 179 | Tobias Brunner | . , : { } = " # \n \t space |
35 | 29 | Andreas Steffen | </pre> |
36 | 49 | Andreas Steffen | |
37 | 29 | Andreas Steffen | An example might look like this: |
38 | 49 | Andreas Steffen | |
39 | 29 | Andreas Steffen | <pre> |
40 | 1 | Martin Willi | a = b |
41 | 1 | Martin Willi | section-one { |
42 | 1 | Martin Willi | somevalue = asdf |
43 | 1 | Martin Willi | subsection { |
44 | 1 | Martin Willi | othervalue = xxx |
45 | 1 | Martin Willi | } |
46 | 1 | Martin Willi | # yei, a comment |
47 | 1 | Martin Willi | yetanother = zz |
48 | 1 | Martin Willi | } |
49 | 1 | Martin Willi | section-two { |
50 | 1 | Martin Willi | x = 12 |
51 | 1 | Martin Willi | } |
52 | 1 | Martin Willi | </pre> |
53 | 1 | Martin Willi | |
54 | 1 | Martin Willi | Indentation is optional, you may use tabs or spaces. |
55 | 29 | Andreas Steffen | |
56 | 179 | Tobias Brunner | h3. Referencing other Sections |
57 | 1 | Martin Willi | |
58 | 179 | Tobias Brunner | Since version:5.7.0 it is possible to inherit settings and sections from another section. This feature is mainly useful in [[swanctl.conf]] (which uses the same file format). |
59 | 1 | Martin Willi | |
60 | 179 | Tobias Brunner | The syntax for references is as follows: |
61 | 179 | Tobias Brunner | |
62 | 1 | Martin Willi | <pre> |
63 | 179 | Tobias Brunner | section := name : references { settings } |
64 | 179 | Tobias Brunner | references := absname[, absname]* |
65 | 179 | Tobias Brunner | absname := name[.name]* |
66 | 179 | Tobias Brunner | </pre> |
67 | 179 | Tobias Brunner | |
68 | 179 | Tobias Brunner | All key/value pairs and all subsections of the referenced sections will be inherited by the section that references them via their absolute name. Values may be overridden in the section or any of its sub-sections (use an empty assignment to clear a value so its default value, if any, will apply). It is currently not possible to limit the inclusion level or clear/remove inherited sub-sections. |
69 | 179 | Tobias Brunner | |
70 | 179 | Tobias Brunner | If the order is important (e.g. for auth rounds in a connection, if _round_ is not used), it should be noted that inherited settings/sections will follow those defined in the current section (if multiple sections are referenced, their settings are enumerated left to right). |
71 | 179 | Tobias Brunner | |
72 | 179 | Tobias Brunner | References are evaluated dynamically at runtime, so referring to sections later in the config file or included via other files is no problem. |
73 | 179 | Tobias Brunner | |
74 | 179 | Tobias Brunner | Here is an example of how this might look like: |
75 | 179 | Tobias Brunner | |
76 | 179 | Tobias Brunner | <pre> |
77 | 179 | Tobias Brunner | conn-defaults { |
78 | 179 | Tobias Brunner | # default settings for all conns (e.g. a cert, or IP pools) |
79 | 179 | Tobias Brunner | } |
80 | 179 | Tobias Brunner | eap-defaults { |
81 | 179 | Tobias Brunner | # defaults if eap is used (e.g. a remote auth round) |
82 | 179 | Tobias Brunner | } |
83 | 179 | Tobias Brunner | child-defaults { |
84 | 179 | Tobias Brunner | # defaults for child configs (e.g. traffic selectors) |
85 | 179 | Tobias Brunner | } |
86 | 179 | Tobias Brunner | connections { |
87 | 179 | Tobias Brunner | conn-a : conn-defaults, eap-defaults { |
88 | 179 | Tobias Brunner | # set/override stuff specific to this connection |
89 | 179 | Tobias Brunner | children { |
90 | 179 | Tobias Brunner | child-a : child-defaults { |
91 | 179 | Tobias Brunner | # set/override stuff specific to this child |
92 | 179 | Tobias Brunner | } |
93 | 179 | Tobias Brunner | } |
94 | 179 | Tobias Brunner | } |
95 | 179 | Tobias Brunner | conn-b : conn-defaults { |
96 | 179 | Tobias Brunner | # set/override stuff specific to this connection |
97 | 179 | Tobias Brunner | children { |
98 | 179 | Tobias Brunner | child-b : child-defaults { |
99 | 179 | Tobias Brunner | # set/override stuff specific to this child |
100 | 179 | Tobias Brunner | } |
101 | 179 | Tobias Brunner | } |
102 | 179 | Tobias Brunner | } |
103 | 179 | Tobias Brunner | conn-c : connections.conn-a { |
104 | 179 | Tobias Brunner | # everything is inherited, including everything conn-a |
105 | 179 | Tobias Brunner | # already inherits from the sections it and its |
106 | 179 | Tobias Brunner | # sub-section reference |
107 | 179 | Tobias Brunner | } |
108 | 179 | Tobias Brunner | } |
109 | 179 | Tobias Brunner | </pre> |
110 | 179 | Tobias Brunner | |
111 | 179 | Tobias Brunner | h3. Including files |
112 | 179 | Tobias Brunner | |
113 | 179 | Tobias Brunner | Version version:4.5.1 introduced the *include* statement which allows to include other files into strongswan.conf, e.g. |
114 | 179 | Tobias Brunner | |
115 | 179 | Tobias Brunner | <pre> |
116 | 78 | Tobias Brunner | include /some/path/*.conf |
117 | 78 | Tobias Brunner | </pre> |
118 | 179 | Tobias Brunner | |
119 | 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 |
120 | 78 | Tobias Brunner | include statement. The file name may include shell wildcards. Also, such inclusions can be nested. |
121 | 78 | Tobias Brunner | |
122 | 78 | Tobias Brunner | Sections loaded from the included files *extend* previously loaded sections; already existing values are *replaced*. |
123 | 78 | Tobias Brunner | It is important to note that settings are added relative to the section the include statement is in. |
124 | 78 | Tobias Brunner | |
125 | 78 | Tobias Brunner | As an example, the following three files result in the same final config as the one given above: |
126 | 78 | Tobias Brunner | <pre> |
127 | 78 | Tobias Brunner | a = b |
128 | 78 | Tobias Brunner | section-one { |
129 | 78 | Tobias Brunner | somevalue = before include |
130 | 78 | Tobias Brunner | include include.conf |
131 | 78 | Tobias Brunner | } |
132 | 78 | Tobias Brunner | include other.conf |
133 | 78 | Tobias Brunner | </pre> |
134 | 78 | Tobias Brunner | include.conf: |
135 | 78 | Tobias Brunner | <pre> |
136 | 78 | Tobias Brunner | # settings loaded from this file are added to section-one |
137 | 78 | Tobias Brunner | # the following replaces the previous value |
138 | 78 | Tobias Brunner | somevalue = asdf |
139 | 78 | Tobias Brunner | subsection { |
140 | 78 | Tobias Brunner | othervalue = yyy |
141 | 78 | Tobias Brunner | } |
142 | 78 | Tobias Brunner | yetanother = zz |
143 | 78 | Tobias Brunner | </pre> |
144 | 78 | Tobias Brunner | other.conf: |
145 | 78 | Tobias Brunner | <pre> |
146 | 78 | Tobias Brunner | # this extends section-one and subsection |
147 | 78 | Tobias Brunner | section-one { |
148 | 78 | Tobias Brunner | subsection { |
149 | 78 | Tobias Brunner | # this replaces the previous value |
150 | 78 | Tobias Brunner | othervalue = xxx |
151 | 1 | Martin Willi | } |
152 | 78 | Tobias Brunner | } |
153 | 78 | Tobias Brunner | section-two { |
154 | 78 | Tobias Brunner | x = 12 |
155 | 78 | Tobias Brunner | } |
156 | 78 | Tobias Brunner | </pre> |
157 | 29 | Andreas Steffen | |
158 | 49 | Andreas Steffen | h2. Reading values |
159 | 1 | Martin Willi | |
160 | 179 | Tobias Brunner | The config file is read by libstrongswan during library initialization (or when a reload is triggered). Values are accessed using a dot-separated section list and a key: Accessing *section-one.subsection.othervalue* in the examples above will return *xxx*. |
161 | 1 | Martin Willi | |
162 | 138 | Martin Willi | Have a look at the settings interface (source:src/libstrongswan/utils/settings.h) to learn about the details. |
163 | 78 | Tobias Brunner | |
164 | 29 | Andreas Steffen | h2. Defined keys |
165 | 1 | Martin Willi | |
166 | 1 | Martin Willi | The following keys are currently defined (using dot notation). |
167 | 1 | Martin Willi | |
168 | 144 | Tobias Brunner | *${sysconfdir}* refers to the directory that can be [[AutoConf|configured]] with the _--sysconfdir_ option (defaults to _${prefix}/etc_). |
169 | 130 | Tobias Brunner | *${piddir}* refers to the directory that can be [[AutoConf|configured]] with the _--with-piddir_ option (defaults to _/var/run_). |
170 | 130 | Tobias Brunner | |
171 | 130 | Tobias Brunner | |_<.Key |_<.Default|_<.Description| |
172 | 181 | Tobias Brunner | |\3(level1). {{h3(aikgen section)}} | |
173 | 142 | Tobias Brunner | |aikgen.load | |Plugins to load in ipsec aikgen tool.| |
174 | 181 | Tobias Brunner | |\3(level1). {{h3(attest section)}} | |
175 | 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.| |
176 | 137 | Tobias Brunner | |attest.load | |Plugins to load in ipsec attest tool.| |
177 | 181 | Tobias Brunner | |\3(level1). {{h3(charon section)}} | |
178 | 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_).| |
179 | 137 | Tobias Brunner | |\3(level3). Defaults for options in this section can be configured in the _libstrongswan_ section.| |
180 | 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).| |
181 | 137 | Tobias Brunner | |charon.block_threshold |5 |Maximum number of half-open IKE_SAs for a single peer IP.| |
182 | 166 | Tobias Brunner | |charon.cache_crls |no |Whether Certicate Revocation Lists (CRLs) fetched via HTTP or LDAP should be saved under a unique file name derived from the public key of the Certification Authority (CA) to [[IpsecDirectoryCrls|/etc/ipsec.d/crls]] (stroke) or [[SwanctlDirectory|/etc/swanctl/x509crl]] (vici), respectively.| |
183 | 137 | Tobias Brunner | |charon.cert_cache |yes |Whether relations in validated certificate chains should be cached in memory.| |
184 | 137 | Tobias Brunner | |charon.cisco_unity |no |Send Cisco Unity vendor ID payload (IKEv1 only), see [[UnityPlugin|unity plugin]].| |
185 | 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.| |
186 | 137 | Tobias Brunner | |charon.cookie_threshold |10 |Number of half-open IKE_SAs that activate the cookie mechanism.| |
187 | 137 | Tobias Brunner | |charon.crypto_test.bench |no |Benchmark crypto algorithms and order them by efficiency.| |
188 | 137 | Tobias Brunner | |charon.crypto_test.bench_size |1024 |Buffer size used for crypto benchmark.| |
189 | 178 | Tobias Brunner | |charon.crypto_test.bench_time |50 |Time in ms during which crypto algorithm performance is measured.| |
190 | 137 | Tobias Brunner | |charon.crypto_test.on_add |no |Test crypto algorithms during registration (requires test vectors provided by the _test-vectors_ plugin).| |
191 | 137 | Tobias Brunner | |charon.crypto_test.on_create |no |Test crypto algorithms on each crypto primitive instantiation.| |
192 | 137 | Tobias Brunner | |charon.crypto_test.required |no |Strictly require at least one test vector to enable an algorithm.| |
193 | 137 | Tobias Brunner | |charon.crypto_test.rng_true |no |Whether to test RNG with TRUE quality; requires a lot of entropy.| |
194 | 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.| |
195 | 168 | Tobias Brunner | |charon.delete_rekeyed_delay |5 |Delay in seconds until inbound IPsec SAs are deleted after rekeyings (IKEv2 only). To process delayed packets the inbound part of a CHILD_SA is kept installed up to the configured number of seconds after it got replaced during a rekeying. If set to 0 the CHILD_SA will be kept installed until it expires (if no lifetime is set it will be destroyed immediately).| |
196 | 137 | Tobias Brunner | |charon.dh_exponent_ansi_x9_42 |yes |Use ANSI X9.42 DH exponent size or optimum size matched to cryptographical strength.| |
197 | 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.| |
198 | 137 | Tobias Brunner | |charon.dns1 | |DNS server assigned to peer via configuration payload (CP), see [[AttrPlugin|attr plugin]].| |
199 | 137 | Tobias Brunner | |charon.dns2 | |DNS server assigned to peer via configuration payload (CP).| |
200 | 137 | Tobias Brunner | |charon.dos_protection |yes |Enable Denial of Service protection using cookies and aggressiveness checks.| |
201 | 137 | Tobias Brunner | |charon.ecp_x_coordinate_only |yes |Compliance with the errata for RFC 4753.| |
202 | 1 | Martin Willi | |charon.filelog | |Section to define file loggers, see [[LoggerConfiguration]].| |
203 | 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.| |
204 | 1 | Martin Willi | |charon.follow_redirects |yes |Whether to follow IKEv2 redirects (RFC 5685).| |
205 | 166 | Tobias Brunner | |charon.fragment_size |1280 |Maximum size (complete IP datagram size in bytes) of a sent IKE fragment when using proprietary IKEv1 or standardized IKEv2 fragmentation, defaults to 1280 (use 0 for address family specific default values, which uses a lower value for IPv4). If specified this limit is used for both IPv4 and IPv6.| |
206 | 137 | Tobias Brunner | |charon.group | |Name of the [[ReducedPrivileges|group]] the daemon changes to after startup.| |
207 | 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]].| |
208 | 137 | Tobias Brunner | |charon.hash_and_url |no |Enable hash and URL support.| |
209 | 137 | Tobias Brunner | |charon.host_resolver.max_threads |3 |Maximum number of concurrent resolver threads (they are terminated if unused).| |
210 | 137 | Tobias Brunner | |charon.host_resolver.min_threads |0 |Minimum number of resolver threads to keep around.| |
211 | 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).| |
212 | 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.| |
213 | 137 | Tobias Brunner | |charon.ignore_routing_tables | |A space-separated list of routing tables to be excluded from route lookup.| |
214 | 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.| |
215 | 137 | Tobias Brunner | |charon.ikesa_table_segments |1 |Number of exclusively locked segments in the hash table, see [[IkeSaTable|IKE_SA lookup tuning]].| |
216 | 137 | Tobias Brunner | |charon.ikesa_table_size |1 |Size of the IKE_SA hash table, see [[IkeSaTable|IKE_SA lookup tuning]].| |
217 | 137 | Tobias Brunner | |charon.inactivity_close_ike |no |Whether to close IKE_SA if the only CHILD_SA closed due to inactivity.| |
218 | 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]].| |
219 | 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]].| |
220 | 137 | Tobias Brunner | |charon.initiator_only |no |Causes charon daemon to ignore IKE initiation requests.| |
221 | 167 | Tobias Brunner | |charon.install_routes |yes |Install routes into a separate routing table for established IPsec tunnels. If disabled a more efficient lookup for source and next-hop addresses is used since version:5.5.2.| |
222 | 137 | Tobias Brunner | |charon.install_virtual_ip |yes |Install virtual IP addresses.| |
223 | 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.| |
224 | 137 | Tobias Brunner | |charon.integrity_test |no |Check daemon, libstrongswan and plugin integrity at startup.| |
225 | 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.| |
226 | 1 | Martin Willi | |charon.interfaces_use | |A comma-separated list of network interfaces that should be used by charon. All other interfaces are ignored.| |
227 | 152 | Tobias Brunner | |charon.keep_alive |20s |NAT keep alive interval in seconds.| |
228 | 137 | Tobias Brunner | |charon.leak_detective.detailed |yes |Includes source file names and line numbers in leak detective output.| |
229 | 137 | Tobias Brunner | |charon.leak_detective.usage_threshold |10240 |Threshold in bytes for leaks to be reported (0 to report all).| |
230 | 137 | Tobias Brunner | |charon.leak_detective.usage_threshold_count |0 |Threshold in number of allocations for leaks to be reported (0 to report all).| |
231 | 137 | Tobias Brunner | |charon.load | |Plugins to load in IKEv2 charon daemon, see [[PluginLoad]].| |
232 | 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]].| |
233 | 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.| |
234 | 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.| |
235 | 146 | Tobias Brunner | |charon.max_packet |10000 |Maximum packet size accepted by charon.| |
236 | 137 | Tobias Brunner | |charon.multiple_authentication |yes |Enable multiple authentication exchanges (RFC 4739).| |
237 | 137 | Tobias Brunner | |charon.nbns1 | |WINS server assigned to peer via configuration payload (CP), see [[AttrPlugin|attr plugin]].| |
238 | 137 | Tobias Brunner | |charon.nbns2 | |WINS server assigned to peer via configuration payload (CP).| |
239 | 1 | Martin Willi | |charon.port |500 |UDP port used locally. If set to 0 a random port will be allocated.| |
240 | 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.| |
241 | 167 | Tobias Brunner | |charon.prefer_best_path |no |By default, charon keeps SAs on the routing path with addresses it previously used if that path is still usable. By enabling this option, it tries more aggressively to update SAs with MOBIKE on routing priority changes using the cheapest path. This adds more noise, but allows to dynamically adapt SAs to routing priority changes. This option has no effect if MOBIKE is not supported or disabled.| |
242 | 163 | Tobias Brunner | |charon.prefer_configured_proposals |yes |Prefer locally configured proposals for IKE/IPsec over supplied ones as responder (disabling this can avoid keying retries due to INVALID_KE_PAYLOAD notifies).| |
243 | 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.| |
244 | 137 | Tobias Brunner | |charon.process_route |yes |Process RTM_NEWROUTE and RTM_DELROUTE events.| |
245 | 137 | Tobias Brunner | |charon.processor.priority_threads | |Subsection to configure the number of reserved threads per priority class (see [[JobPriority]]).| |
246 | 137 | Tobias Brunner | |charon.receive_delay |0 |Delay in ms for receiving packets, to simulate larger RTT.| |
247 | 137 | Tobias Brunner | |charon.receive_delay_response |yes |Delay response messages.| |
248 | 137 | Tobias Brunner | |charon.receive_delay_request |yes |Delay request messages.| |
249 | 137 | Tobias Brunner | |charon.receive_delay_type |0 |Specific IKEv2 message type to delay, 0 for any.| |
250 | 1 | Martin Willi | |charon.replay_window |32 |Size of the AH/ESP replay window, in packets.| |
251 | 137 | Tobias Brunner | |charon.retransmit_base |1.8 |Base to use for calculating exponential back off, see [[Retransmission]].| |
252 | 168 | Tobias Brunner | |charon.retransmit_jitter |0 |Maximum jitter in percent to apply randomly to calculated retransmission timeout (0 to disable).| |
253 | 168 | Tobias Brunner | |charon.retransmit_limit |0 |Upper limit in seconds for calculated retransmission timeout (0 to disable).| |
254 | 137 | Tobias Brunner | |charon.retransmit_timeout |4.0 |Timeout in seconds before sending first retransmit.| |
255 | 152 | Tobias Brunner | |charon.retransmit_tries |5 |Number of times to retransmit a packet before giving up.| |
256 | 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.| |
257 | 157 | Tobias Brunner | |charon.reuse_ikesa |yes |Initiate CHILD_SA within existing IKE_SAs (always enabled for IKEv1).| |
258 | 151 | Juergen Seifert | |charon.routing_table |220 |Numerical routing table to install routes to.| |
259 | 151 | Juergen Seifert | |charon.routing_table_prio |220 |Priority of the routing table.| |
260 | 172 | Tobias Brunner | |charon.rsa_pss |no |Whether to use RSA with PSS padding instead of PKCS#1 padding by default.| |
261 | 137 | Tobias Brunner | |charon.send_delay |0 |Delay in ms for sending packets, to simulate larger RTT.| |
262 | 137 | Tobias Brunner | |charon.send_delay_request |yes |Delay request messages.| |
263 | 137 | Tobias Brunner | |charon.send_delay_response |yes |Delay response messages.| |
264 | 137 | Tobias Brunner | |charon.send_delay_type |0 |Specific IKEv2 message type to delay, 0 for any.| |
265 | 1 | Martin Willi | |charon.send_vendor_id |no |Send strongSwan vendor ID payload.| |
266 | 147 | Tobias Brunner | |charon.signature_authentication |yes |Whether to enable Signature Authentication as per "RFC 7427":http://tools.ietf.org/html/rfc7427.| |
267 | 1 | Martin Willi | |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.| |
268 | 167 | Tobias Brunner | |charon.spi_min |0xc0000000|The lower limit for SPIs requested from the kernel for IPsec SAs. Should not be set lower than 0x00000100 (256), as SPIs between 1 and 255 are reserved by IANA.| |
269 | 167 | Tobias Brunner | |charon.spi_max |0xcfffffff|The upper limit for SPIs requested from the kernel for IPsec SAs.| |
270 | 142 | Tobias Brunner | |charon.start-scripts | |Section containing a list of scripts (name = path) that are executed when the daemon is started.| |
271 | 142 | Tobias Brunner | |charon.stop-scripts | |Section containing a list of scripts (name = path) that are executed when the daemon is terminated.| |
272 | 137 | Tobias Brunner | |charon.syslog | |Section to define syslog loggers, see [[LoggerConfiguration]].| |
273 | 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).| |
274 | 137 | Tobias Brunner | |charon.user | |Name of the [[ReducedPrivileges|user]] the daemon changes to after startup.| |
275 | 137 | Tobias Brunner | |charon.x509.enforce_critical |yes |Discard certificates with unsupported or unknown critical extensions.| |
276 | 181 | Tobias Brunner | |\3(level2). {{h4(charon.plugins subsection)}} | |
277 | 167 | Tobias Brunner | |charon.plugins.addrblock.strict |yes |If enabled, a subject certificate without an "RFC 3779":http://tools.ietf.org/html/rfc3779 address block extension is rejected if the issuer certificate has such an _addrblock_ extension. If disabled, subject certificates issued without _addrblock_ extension are accepted without any traffic selector checks and no policy is enforced by the plugin.| |
278 | 137 | Tobias Brunner | |charon.plugins.android_log.loglevel |1 |Loglevel for logging to Android specific logger.| |
279 | 137 | Tobias Brunner | |charon.plugins.attr | |Section to specify arbitrary attributes that are assigned to a peer via configuration payload, see [[AttrPlugin|attr plugin]].| |
280 | 168 | Tobias Brunner | |charon.plugins.attr-sql.crash_recovery |yes |Release all online leases during startup. Disable this to share the DB between multiple VPN gateways.| |
281 | 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.| |
282 | 1 | Martin Willi | |charon.plugins.attr-sql.lease_history |yes |Enable logging of [[SQL]] IP pool leases.| |
283 | 1 | Martin Willi | |charon.plugins.bliss.use_bliss_b |yes |Use the enhanced BLISS-B key generation and signature algorithm.| |
284 | 167 | Tobias Brunner | |charon.plugins.bypass-lan.interfaces_ignore | |A comma-separated list of network interfaces for which connected subnets should be ignored, if _interfaces_use_ is specified this option has no effect.| |
285 | 167 | Tobias Brunner | |charon.plugins.bypass-lan.interfaces_use | |A comma-separated list of network interfaces for which connected subnets should be considered. All other interfaces are ignored.| |
286 | 1 | Martin Willi | |charon.plugins.certexpire.csv.cron | |Cron style string specifying CSV export times, see [[certexpire]] for details.| |
287 | 137 | Tobias Brunner | |charon.plugins.certexpire.csv.empty_string | |String to use in empty intermediate CA fields.| |
288 | 137 | Tobias Brunner | |charon.plugins.certexpire.csv.fixed_fields |yes |Use a fixed intermediate CA field count.| |
289 | 137 | Tobias Brunner | |charon.plugins.certexpire.csv.force |yes |Force export of all trustchains we have a private key for.| |
290 | 137 | Tobias Brunner | |charon.plugins.certexpire.csv.format |%d:%m:%Y |strftime(3) format string to export expiration dates as.| |
291 | 137 | Tobias Brunner | |charon.plugins.certexpire.csv.local | |strftime(3) format string for the CSV file name to export local certificates to.| |
292 | 137 | Tobias Brunner | |charon.plugins.certexpire.csv.remote | |strftime(3) format string for the CSV file name to export remote certificates to.| |
293 | 1 | Martin Willi | |charon.plugins.certexpire.csv.separator |, |CSV field separator.| |
294 | 137 | Tobias Brunner | |charon.plugins.coupling.file | |File to store coupling list to, see [[CertCoupling|certcoupling plugin]] for details.| |
295 | 1 | Martin Willi | |charon.plugins.coupling.hash |sha1 |Hashing algorithm to fingerprint coupled certificates.| |
296 | 137 | Tobias Brunner | |charon.plugins.coupling.max |1 |Maximum number of coupling entries to create.| |
297 | 137 | Tobias Brunner | |charon.plugins.curl.redir |-1 |Maximum number of redirects followed by the plugin, set to 0 to disable following redirects, set to -1 for no limit.| |
298 | 170 | Tobias Brunner | |charon.plugins.dhcp.force_server_address |no |Always use the configured server address, see [[DHCPPlugin|DHCP plugin]] for details.| |
299 | 137 | Tobias Brunner | |charon.plugins.dhcp.identity_lease |no |Derive user-defined MAC address from hash of IKE identity and send client identity DHCP option.| |
300 | 176 | 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.| |
301 | 137 | Tobias Brunner | |charon.plugins.dhcp.server |255.255.255.255|DHCP server unicast or broadcast IP address.| |
302 | 179 | Tobias Brunner | |charon.plugins.dhcp.use_server_port |no |Use the DHCP server port (67) as source port, instead of the DHCP client port (68), when a unicast server address is configured and the [[DHCPPlugin|DHCP plugin]] acts as relay agent. When replying in this mode the DHCP server will always send packets to the DHCP server port and if no process binds that port an ICMP port unreachables will be sent back, which might be problematic for some DHCP servers. To avoid that, enabling this option will cause the plugin to bind the DHCP server port to send its requests when acting as relay agent. This is not necessary if a DHCP server is already running on the same host and might even cause conflicts (and since the server port is already bound, ICMPs should not be an issue).| |
303 | 137 | Tobias Brunner | |charon.plugins.dnscert.enable |no |Enable fetching of CERT RRs via DNS.| |
304 | 137 | Tobias Brunner | |charon.plugins.duplicheck.enable |yes |Enable [[duplicheck]] plugin (if loaded).| |
305 | 137 | Tobias Brunner | |charon.plugins.duplicheck.socket |unix://${piddir}/charon.dck|Socket provided by the [[duplicheck]] plugin.| |
306 | 133 | Tobias Brunner | |charon.plugins.eap-aka.request_identity |yes || |
307 | 169 | Tobias Brunner | |charon.plugins.eap-aka-3gpp.seq_check | |Enable to activate sequence check of the AKA SQN values in order to trigger resync cycles.| |
308 | 169 | Tobias Brunner | |charon.plugins.eap-aka-3gpp2.seq_check | |Enable to activate sequence check of the AKA SQN values in order to trigger resync cycles.| |
309 | 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.| |
310 | 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.| |
311 | 137 | Tobias Brunner | |charon.plugins.eap-gtc.backend |pam |XAuth backend to be used for credential verification, see [[EapGtc|EAP-GTC]].| |
312 | 137 | Tobias Brunner | |charon.plugins.eap-peap.fragment_size |1024 |Maximum size of an EAP-PEAP packet.| |
313 | 137 | Tobias Brunner | |charon.plugins.eap-peap.max_message_count |32 |Maximum number of processed EAP-PEAP packets.| |
314 | 137 | Tobias Brunner | |charon.plugins.eap-peap.include_length |no |Include length in non-fragmented EAP-PEAP packets.| |
315 | 137 | Tobias Brunner | |charon.plugins.eap-peap.phase2_method |mschapv2 |Phase2 EAP client authentication method.| |
316 | 137 | Tobias Brunner | |charon.plugins.eap-peap.phase2_piggyback |no |Phase2 EAP Identity request piggybacked by server onto TLS Finished message.| |
317 | 137 | Tobias Brunner | |charon.plugins.eap-peap.phase2_tnc |no |Start phase2 EAP-TNC protocol after successful client authentication.| |
318 | 137 | Tobias Brunner | |charon.plugins.eap-peap.request_peer_auth |no |Request peer authentication based on a client certificate.| |
319 | 1 | Martin Willi | |charon.plugins.eap-radius.accounting |no |Enable EAP-RADIUS accounting.| |
320 | 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.| |
321 | 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.| |
322 | 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.| |
323 | 172 | Tobias Brunner | |charon.plugins.eap-radius.accounting_send_class |no |If enabled, adds the Class attributes received in Access-Accept message to the RADIUS accounting messages.| |
324 | 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]].| |
325 | 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.| |
326 | 137 | Tobias Brunner | |charon.plugins.eap-radius.dae.enable |no |Enables support for the Dynamic Authorization Extension (RFC 5176).| |
327 | 137 | Tobias Brunner | |charon.plugins.eap-radius.dae.listen |0.0.0.0 |Address to listen for DAE messages from the RADIUS server.| |
328 | 137 | Tobias Brunner | |charon.plugins.eap-radius.dae.port |3799 |Port to listen for DAE requests.| |
329 | 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.| |
330 | 137 | Tobias Brunner | |charon.plugins.eap-radius.eap_start |no |Send EAP-Start instead of EAP-Identity to start RADIUS conversation.| |
331 | 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.| |
332 | 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).| |
333 | 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.| |
334 | 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.| |
335 | 137 | Tobias Brunner | |charon.plugins.eap-radius.nas_identifier |strongSwan|NAS-Identifier to include in RADIUS messages.| |
336 | 137 | Tobias Brunner | |charon.plugins.eap-radius.port |1812 |Port of RADIUS server (authentication).| |
337 | 156 | Tobias Brunner | |charon.plugins.eap-radius.retransmit_base |1.4 |Base to use for calculating exponential back off.| |
338 | 156 | Tobias Brunner | |charon.plugins.eap-radius.retransmit_timeout |2.0 |Timeout in seconds before sending first retransmit.| |
339 | 156 | Tobias Brunner | |charon.plugins.eap-radius.retransmit_tries |4 |Number of times to retransmit a packet before giving up.| |
340 | 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.| |
341 | 1 | Martin Willi | |charon.plugins.eap-radius.server | |IP/Hostname of RADIUS server.| |
342 | 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.| |
343 | 137 | Tobias Brunner | |charon.plugins.eap-radius.sockets |1 |Number of sockets (ports) to use, increase for high load.| |
344 | 177 | Tobias Brunner | |charon.plugins.eap-radius.station_id_with_port |yes |Whether to include the UDP port in the Called- and Calling-Station-Id RADIUS attributes.| |
345 | 137 | Tobias Brunner | |charon.plugins.eap-radius.xauth | |Section to configure [[EapRadius#XAuth|multiple XAuth authentication rounds]] via RADIUS.| |
346 | 130 | Tobias Brunner | |charon.plugins.eap-sim.request_identity |yes || |
347 | 1 | Martin Willi | |charon.plugins.eap-simaka-sql.database | || |
348 | 30 | Martin Willi | |charon.plugins.eap-simaka-sql.remove_used | || |
349 | 137 | Tobias Brunner | |charon.plugins.eap-tls.fragment_size |1024 |Maximum size of an EAP-TLS packet.| |
350 | 137 | Tobias Brunner | |charon.plugins.eap-tls.include_length |yes |Include length in non-fragmented EAP-TLS packets.| |
351 | 137 | Tobias Brunner | |charon.plugins.eap-tls.max_message_count |32 |Maximum number of processed EAP-TLS packets (0 = no limit).| |
352 | 137 | Tobias Brunner | |charon.plugins.eap-tnc.max_message_count |10 |Maximum number of processed EAP-TNC packets (0 = no limit).| |
353 | 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).| |
354 | 137 | Tobias Brunner | |charon.plugins.eap-ttls.fragment_size |1024 |Maximum size of an EAP-TTLS packet.| |
355 | 137 | Tobias Brunner | |charon.plugins.eap-ttls.include_length |yes |Include length in non-fragmented EAP-TTLS packets.| |
356 | 137 | Tobias Brunner | |charon.plugins.eap-ttls.max_message_count |32 |Maximum number of processed EAP-TTLS packets (0 = no limit).| |
357 | 137 | Tobias Brunner | |charon.plugins.eap-ttls.phase2_method |md5 |Phase2 EAP client authentication method.| |
358 | 137 | Tobias Brunner | |charon.plugins.eap-ttls.phase2_piggyback |no |Phase2 EAP Identity request piggybacked by server onto TLS Finished message.| |
359 | 1 | Martin Willi | |charon.plugins.eap-ttls.phase2_tnc |no |Start phase2 EAP TNC protocol after successful client authentication.| |
360 | 1 | Martin Willi | |charon.plugins.eap-ttls-phase2_tnc_method |pt |Phase2 EAP TNC transport protocol (pt as IETF standard or legacy tnc)| |
361 | 141 | Andreas Steffen | |charon.plugins.eap-ttls.request_peer_auth |no |Request peer authentication based on a client certificate.| |
362 | 137 | Tobias Brunner | |charon.plugins.error-notify.socket |unix://${piddir}/charon.enfy|Socket provided by the [[ErrorNotifyPlugin|error-notify]] plugin.| |
363 | 144 | Tobias Brunner | |charon.plugins.ext-auth.script | |Shell script to invoke for peer authorization (see [[ext-auth]]).| |
364 | 137 | Tobias Brunner | |charon.plugins.gcrypt.quick_random |no |Use faster random numbers in gcrypt. *For testing only, produces weak keys!*| |
365 | 1 | Martin Willi | |charon.plugins.ha.autobalance |0 |Interval in seconds to automatically balance handled segments between nodes. Set to 0 to disable.| |
366 | 175 | Tobias Brunner | |charon.plugins.ha.buflen |2048 |Buffer size for received HA messages. For IKEv1 the public DH factors are also transmitted so depending on the DH group the HA messages can get quite big (the default should be fine up to _modp4096_).| |
367 | 1 | Martin Willi | |charon.plugins.ha.fifo_interface |yes || |
368 | 73 | Tobias Brunner | |charon.plugins.ha.heartbeat_delay |1000 || |
369 | 73 | Tobias Brunner | |charon.plugins.ha.heartbeat_timeout |2100 || |
370 | 87 | Tobias Brunner | |charon.plugins.ha.local | || |
371 | 73 | Tobias Brunner | |charon.plugins.ha.monitor |yes || |
372 | 130 | Tobias Brunner | |charon.plugins.ha.pools | || |
373 | 61 | Andreas Steffen | |charon.plugins.ha.remote | || |
374 | 130 | Tobias Brunner | |charon.plugins.ha.resync |yes || |
375 | 137 | Tobias Brunner | |charon.plugins.ha.secret | || |
376 | 137 | Tobias Brunner | |charon.plugins.ha.segment_count |1 || |
377 | 137 | Tobias Brunner | |charon.plugins.ipseckey.enable |no |Enable fetching of IPSECKEY RRs via DNS.| |
378 | 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).| |
379 | 1 | Martin Willi | |charon.plugins.kernel-netlink.buflen |min(PAGE_SIZE, 8192)|Buffer size for received Netlink messages.| |
380 | 167 | Tobias Brunner | |charon.plugins.kernel-netlink.force_receive_buffer_size|no |If the maximum Netlink socket receive buffer in bytes set by _receive_buffer_size_ exceeds the system-wide maximum from @/proc/sys/net/core/rmem_max@, this option can be used to override the limit. Enabling this option requires special priviliges (CAP_NET_ADMIN).| |
381 | 164 | 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]]. When set to _!<mark>_ a more efficient lookup for source and next-hop addresses may also be used since version:5.3.3.| |
382 | 144 | Tobias Brunner | |charon.plugins.kernel-netlink.mss |0 |MSS to set on installed routes, 0 to disable.| |
383 | 1 | Martin Willi | |charon.plugins.kernel-netlink.mtu |0 |MTU to set on installed routes, 0 to disable.| |
384 | 174 | Tobias Brunner | |charon.plugins.kernel-netlink.process_rules |no |Whether to process changes in routing rules to trigger roam events. This is currently only useful if the kernel based route lookup is used (i.e. if route installation is disabled or an inverted fwmark match is configured).| |
385 | 167 | Tobias Brunner | |charon.plugins.kernel-netlink.receive_buffer_size |0 |Maximum Netlink socket receive buffer in bytes. This value controls how many bytes of Netlink messages can be received on a Netlink socket. The default value is set by @/proc/sys/net/core/rmem_default@. The specified value cannot exceed the system-wide maximum from @/proc/sys/net/core/rmem_max@, unless _force_receive_buffer_size_ is enabled.| |
386 | 137 | Tobias Brunner | |charon.plugins.kernel-netlink.roam_events |yes |Whether to trigger roam events when interfaces, addresses or routes change.| |
387 | 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.| |
388 | 166 | Tobias Brunner | |charon.plugins.kernel-netlink.spdh_thresh | |Subsection to configure XFRM policy hashing thresholds for IPv4 and IPv6. The section defines hashing thresholds to configure in the kernel during daemon startup. Each address family takes a threshold for the local subnet of an IPsec policy (src in out-policies, dst in in- and forward-policies) and the remote subnet (dst in out-policies, src in in- and forward-policies). |
389 | 166 | Tobias Brunner | If the subnet has more or equal net bits than the threshold, the first threshold bits are used to calculate a hash to lookup the policy. |
390 | 166 | Tobias Brunner | Policy hashing thresholds are not supported before Linux 3.18 and might conflict with socket policies before Linux 4.8.| |
391 | 166 | Tobias Brunner | |charon.plugins.kernel-netlink.spdh_thresh.ipv4.lbits|32 |Local subnet XFRM policy hashing threshold for IPv4.| |
392 | 166 | Tobias Brunner | |charon.plugins.kernel-netlink.spdh_thresh.ipv4.rbits|32 |Remote subnet XFRM policy hashing threshold for IPv4.| |
393 | 166 | Tobias Brunner | |charon.plugins.kernel-netlink.spdh_thresh.ipv6.lbits|128 |Local subnet XFRM policy hashing threshold for IPv6.| |
394 | 1 | Martin Willi | |charon.plugins.kernel-netlink.spdh_thresh.ipv6.rbits|128 |Remote subnet XFRM policy hashing threshold for IPv6.| |
395 | 168 | Tobias Brunner | |charon.plugins.kernel-netlink.xfrm_acq_expires |165 |Lifetime of XFRM acquire state created by the kernel when traffic matches a trap policy. The value gets written to @/proc/sys/net/core/xfrm_acq_expires@. Indirectly controls the delay between XFRM acquire messages triggered by the kernel for a trap policy. The same value is used as timeout for SPIs allocated by the kernel. The default value equals the default total [[Retransmission|retransmission timeout]] for IKE messages (since version:5.5.3 this value is determined dynamically based on the configuration).| |
396 | 1 | Martin Willi | |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.| |
397 | 176 | Tobias Brunner | |charon.plugins.kernel-pfkey.route_via_internal |no |Whether to use the internal or external interface in installed routes. The internal interface is the one where the IP address contained in the local traffic selector is located, the external interface is the one over which the destination address of the IPsec tunnel can be reached. This is not relevant if virtual IPs are used, for which a TUN device is created that's used in the routes.| |
398 | 137 | Tobias Brunner | |charon.plugins.kernel-pfroute.vip_wait |1000 |Time in ms to wait until virtual IP addresses appear/disappear before failing.| |
399 | 1 | Martin Willi | |charon.plugins.led.activity_led | || |
400 | 1 | Martin Willi | |charon.plugins.led.blink_time |50 || |
401 | 137 | Tobias Brunner | |charon.plugins.load-tester | |Subsection to configure [[LoadTests|load tests]] using the [[LoadTests|load-tester]] plugin.| |
402 | 137 | Tobias Brunner | |charon.plugins.lookip.socket |unix://${piddir}/charon.lkp|Socket provided by the [[lookip]] plugin.| |
403 | 137 | Tobias Brunner | |charon.plugins.ntru.max_drbg_requests |4294967294|Number of pseudo-random bit requests from the DRBG before an automatic reseeding occurs.| |
404 | 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.| |
405 | 137 | Tobias Brunner | |charon.plugins.openssl.engine_id |pkcs11 |ENGINE ID to use in the OpenSSL plugin.| |
406 | 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.| |
407 | 154 | Tobias Brunner | |charon.plugins.osx-attr.append |yes |Whether DNS servers are appended to existing entries, instead of replacing them.| |
408 | 137 | Tobias Brunner | |charon.plugins.pkcs11.load_certs |yes |Whether to load certificates from tokens.| |
409 | 137 | Tobias Brunner | |charon.plugins.pkcs11.modules | |List of available PKCS#11 modules, see [[SmartCardsIKEv2]].| |
410 | 137 | Tobias Brunner | |charon.plugins.pkcs11.reload_certs |no |Reload certificates from all tokens if charon receives a SIGHUP.| |
411 | 137 | Tobias Brunner | |charon.plugins.pkcs11.use_dh |no |Whether the PKCS#11 modules should be used for DH and ECDH.| |
412 | 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.| |
413 | 137 | Tobias Brunner | |charon.plugins.pkcs11.use_hasher |no |Whether the PKCS#11 modules should be used to hash data.| |
414 | 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.| |
415 | 137 | Tobias Brunner | |charon.plugins.pkcs11.use_rng |no |Whether the PKCS#11 modules should be used as RNG.| |
416 | 137 | Tobias Brunner | |charon.plugins.radattr.dir | |Directory where RADIUS attributes are stored in client-ID specific files, see [[RadAttrPlugin|radattr]].| |
417 | 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.| |
418 | 137 | Tobias Brunner | |charon.plugins.random.random |/dev/random|File to read random bytes from.| |
419 | 137 | Tobias Brunner | |charon.plugins.random.urandom |/dev/urandom|File to read pseudo random bytes from.| |
420 | 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.| |
421 | 137 | Tobias Brunner | |charon.plugins.resolve.file |/etc/resolv.conf|File used by the [[resolveplugin|resolve plugin]] to write DNS server entries to.| |
422 | 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).| |
423 | 167 | Tobias Brunner | |charon.plugins.revocation.enable_crl |yes |Whether CRL validation should be enabled.| |
424 | 167 | Tobias Brunner | |charon.plugins.revocation.enable_ocsp |yes |Whether OCSP validation should be enabled.| |
425 | 175 | Tobias Brunner | |charon.plugins.save-keys.esp |no |Whether to save ESP keys.| |
426 | 175 | Tobias Brunner | |charon.plugins.save-keys.ike |no |Whether to save IKE keys.| |
427 | 175 | Tobias Brunner | |charon.plugins.save-keys.wireshark_keys | |Directory where the keys are stored in the format supported by Wireshark. IKEv1 keys are stored in the _ikev1_decryption_table_ file. IKEv2 keys are stored in the _ikev2_decryption_table_ file. Keys for ESP CHILD_SAs are stored in the _esp_sa_ file.| |
428 | 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]]).| |
429 | 1 | Martin Willi | |charon.plugins.socket-default.set_source |yes |Set source address on outbound packets, if possible.| |
430 | 168 | Tobias Brunner | |charon.plugins.socket-default.set_sourceif |no |Force sending interface on outbound packets, if possible. This allows using IPv6 link-local addresses as tunnel endpoints.| |
431 | 137 | Tobias Brunner | |charon.plugins.socket-default.use_ipv4 |yes |Listen on IPv4, if possible.| |
432 | 137 | Tobias Brunner | |charon.plugins.socket-default.use_ipv6 |yes |Listen on IPv6, if possible.| |
433 | 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.| |
434 | 1 | Martin Willi | |charon.plugins.sql.loglevel |-1 |Loglevel for logging to [[SQL]] database.| |
435 | 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_.| |
436 | 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.| |
437 | 1 | Martin Willi | |charon.plugins.stroke.max_concurrent |4 |Maximum number of stroke messages handled concurrently.| |
438 | 144 | Tobias Brunner | |charon.plugins.stroke.secrets_file |${sysconfdir}/ipsec.secrets|Location of the [[ipsec.secrets]] file.| |
439 | 137 | Tobias Brunner | |charon.plugins.stroke.socket |unix://${piddir}/charon.ctl|Socket provided by the stroke plugin.| |
440 | 137 | Tobias Brunner | |charon.plugins.stroke.timeout |0 |Timeout in ms for any stroke command. Use 0 to disable the timeout.| |
441 | 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]].| |
442 | 137 | Tobias Brunner | |charon.plugins.systime-fix.reauth |no |Whether to use reauth or delete if an invalid cert lifetime is detected.| |
443 | 137 | Tobias Brunner | |charon.plugins.systime-fix.threshold | |Threshold date where system time is considered valid. Disabled if not specified.| |
444 | 137 | Tobias Brunner | |charon.plugins.systime-fix.threshold_format |%Y |strptime(3) format used to parse threshold option.| |
445 | 172 | Tobias Brunner | |charon.plugins.systime-fix.timeout |0s |How long to wait for a valid system time if an interval is configured. 0 to recheck indefinitely.| |
446 | 137 | Tobias Brunner | |charon.plugins.tnc-ifmap.client_cert | |Path to X.509 certificate file of IF-MAP client.| |
447 | 137 | Tobias Brunner | |charon.plugins.tnc-ifmap.client_key | |Path to private key file of IF-MAP client.| |
448 | 137 | Tobias Brunner | |charon.plugins.tnc-ifmap.device_name | |Unique name of strongSwan server as a PEP and/or PDP device.| |
449 | 137 | Tobias Brunner | |charon.plugins.tnc-ifmap.renew_session_interval |150 |Interval in seconds between periodic IF-MAP RenewSession requests.| |
450 | 137 | Tobias Brunner | |charon.plugins.tnc-ifmap.server_cert | |Path to X.509 certificate file of IF-MAP server.| |
451 | 137 | Tobias Brunner | |charon.plugins.tnc-ifmap.server_uri |https://localhost:8444/imap|URI of the form <notextile>[https://]servername[:port][/path]</notextile>.| |
452 | 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.| |
453 | 137 | Tobias Brunner | |charon.plugins.tnc-imc.dlcose |yes |Unload IMC after use.| |
454 | 137 | Tobias Brunner | |charon.plugins.tnc-imc.preferred_language |en |Preferred language for TNC recommendations.| |
455 | 137 | Tobias Brunner | |charon.plugins.tnc-imv.dlcose |yes |Unload IMV after use.| |
456 | 137 | Tobias Brunner | |charon.plugins.tnc-imv.recommendation_policy |default |TNC recommendation policy, one of _default_, _any_, or _all_.| |
457 | 137 | Tobias Brunner | |charon.plugins.tnc-pdp.pt_tls.enable |yes |Enable PT-TLS protocol on the strongSwan PDP.| |
458 | 137 | Tobias Brunner | |charon.plugins.tnc-pdp.pt_tls.port |271 |PT-TLS server port the strongSwan PDP is listening on.| |
459 | 137 | Tobias Brunner | |charon.plugins.tnc-pdp.radius.enable |yes |Enable RADIUS protocol on the strongSwan PDP.| |
460 | 137 | Tobias Brunner | |charon.plugins.tnc-pdp.radius.method |ttls |EAP tunnel method to be used.| |
461 | 1 | Martin Willi | |charon.plugins.tnc-pdp.radius.port |1812 |RADIUS server port the strongSwan PDP is listening on.| |
462 | 1 | Martin Willi | |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.| |
463 | 137 | Tobias Brunner | |charon.plugins.tnc-pdp.server | |Name of the strongSwan PDP as contained in the AAA certificate.| |
464 | 137 | Tobias Brunner | |charon.plugins.tnc-pdp.timeout | |Timeout in seconds before closing incomplete connections.| |
465 | 137 | Tobias Brunner | |charon.plugins.tnccs-11.max_message_size |45000 |Maximum size of a PA-TNC message (XML & Base64 encoding).| |
466 | 137 | Tobias Brunner | |charon.plugins.tnccs-20.max_batch_size |65522 |Maximum size of a PB-TNC batch (upper limit via PT-EAP = 65529).| |
467 | 137 | Tobias Brunner | |charon.plugins.tnccs-20.max_message_size |65490 |Maximum size of a PA-TNC message (upper limit via PT-EAP = 65497).| |
468 | 137 | Tobias Brunner | |charon.plugins.tnccs-20.mutual |no |Enable PB-TNC mutual protocol.| |
469 | 1 | Martin Willi | |charon.plugins.tpm.use_rng |no |Whether the [[TPMPlugin|TPM]] should be used as RNG.| |
470 | 180 | Tobias Brunner | |charon.plugins.tpm.tcti.name |device<notextile>|</notextile>tabrmd|Name of TPM 2.0 TCTI library. Valid values: _tabrmd_, _device_ or _mssim_. Defaults are _device_ if the _/dev/tpmrm0_ in-kernel TPM 2.0 resource manager device exists, and _tabrmd_ otherwise, requiring the D-Bus based TPM 2.0 access broker and resource manager to be available.| |
471 | 180 | Tobias Brunner | |charon.plugins.tpm.tcti.opts |/dev/tpmrm0<notextile>|</notextile><none>|Options for the TPM 2.0 TCTI library. Defaults are _/dev/tpmrm0_ if the TCTI library name is _device_ and no options otherwise.| |
472 | 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.| |
473 | 137 | Tobias Brunner | |charon.plugins.unbound.resolv_conf |/etc/resolv.conf|File to read DNS resolver configuration from.| |
474 | 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.| |
475 | 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]]).| |
476 | 142 | Tobias Brunner | |charon.plugins.vici.socket |unix://${piddir}/charon.vici|Socket the [[vici|vici plugin]] serves clients.| |
477 | 1 | Martin Willi | |charon.plugins.whitelist.enable |yes |Enable loaded [[whitelist]] plugin.| |
478 | 1 | Martin Willi | |charon.plugins.whitelist.socket |unix://${piddir}/charon.wlst|Socket provided by the whitelist plugin.| |
479 | 1 | Martin Willi | |charon.plugins.xauth-eap.backend |radius |EAP plugin to be used as backend for XAuth credential verification, see [[XAuthEAP]].| |
480 | 1 | Martin Willi | |charon.plugins.xauth-pam.pam_service |login |PAM service to be used for authentication, see [[XAuthPAM]].| |
481 | 1 | Martin Willi | |charon.plugins.xauth-pam.session |no |Open/close a PAM session for each active IKE_SA.| |
482 | 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.| |
483 | 181 | Tobias Brunner | |\3(level2). {{h4(charon.imvc subsection)}} | |
484 | 181 | Tobias Brunner | |\3(level3). Defaults for options in this section can be configured in the *_libimcv_* section.| |
485 | 1 | Martin Willi | |charon.imcv.assessment_result |yes |Whether IMVs send a standard IETF Assessment Result attribute.| |
486 | 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.| |
487 | 1 | Martin Willi | |charon.imcv.os_info.default_password_enabled |no |Manually set whether a default password is enabled.| |
488 | 1 | Martin Willi | |charon.imcv.os_info.name | |Manually set the name of the client OS (e.g. Ubuntu).| |
489 | 1 | Martin Willi | |charon.imcv.os_info.version | |Manually set the version of the client OS (e.g. 12.04 i686).| |
490 | 1 | Martin Willi | |charon.imcv.policy_script |ipsec _imv_policy|Script called for each TNC connection to generate IMV policies.| |
491 | 181 | Tobias Brunner | |\3(level2). {{h4(charon.tls subsection)}} | |
492 | 181 | Tobias Brunner | |\3(level3). Defaults for options in this section can be configured in the *_libtls_* section.| |
493 | 1 | Martin Willi | |charon.tls.cipher | |List of TLS encryption ciphers.| |
494 | 1 | Martin Willi | |charon.tls.key_exchange | |List of TLS key exchange methods.| |
495 | 1 | Martin Willi | |charon.tls.mac | |List of TLS MAC algorithms.| |
496 | 166 | Tobias Brunner | |charon.tls.suites | |List of TLS cipher suites.| |
497 | 181 | Tobias Brunner | |\3(level2). {{h4(charon.tnc subsection)}} | |
498 | 181 | Tobias Brunner | |\3(level3). Defaults for options in this section can be configured in the *_libtnccs_* section.| |
499 | 144 | Tobias Brunner | |libtnccs.tnc_config |/etc/tnc_config|TNC IMC/IMV configuration file.| |
500 | 181 | Tobias Brunner | |\3(level1). {{h3([[NetworkManager|charon-nm]] section)}}| |
501 | 150 | Tobias Brunner | |charon-nm.ca_dir |<default> |Directory from which to load CA certificates if no certificate is configured.| |
502 | 181 | Tobias Brunner | |\3(level1). {{h3([[charon-systemd]] section)}} | |
503 | 150 | Tobias Brunner | |charon-systemd.journal | |Section to configure native systemd journal logger, very similar to the syslog logger as described in [[LoggerConfiguration]].| |
504 | 181 | Tobias Brunner | |\3(level1). {{h3(imv_policy_manager section)}} | |
505 | 1 | Martin Willi | |imv_policy_manager.command_allow | |Shell command to be executed with recommendation _allow_.| |
506 | 1 | Martin Willi | |imv_policy_manager.command_block | |Shell command to be executed with all other recommendations.| |
507 | 1 | Martin Willi | |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.| |
508 | 1 | Martin Willi | |imv_policy_manager.load |sqlite |Plugins to load in IMV policy manager.| |
509 | 181 | Tobias Brunner | |\3(level1). {{h3(libimcv section)}} | |
510 | 169 | Tobias Brunner | |libimcv.debug_level |1 |Debug level for a stand-alone libimcv library.| |
511 | 169 | Tobias Brunner | |libimcv.load |random nonce gmp pubkey x509|Plugins to load in IMC/IMVs with stand-alone libimcv library.| |
512 | 140 | Andreas Steffen | |libimcv.stderr_quiet |no |Disable the output to stderr with a stand-alone libimcv library.| |
513 | 140 | Andreas Steffen | |libimcv.swid_gen.command |/usr/local/bin/swid_generator|SWID generator command to be executed.| |
514 | 140 | Andreas Steffen | |libimcv.swid_gen.tag_creator.name |strongSwan Project|Name of the tagCreator entity.| |
515 | 163 | Tobias Brunner | |libimcv.swid_gen.tag_creator.reqid |strongswan.org|regid of the tagCreator entity.| |
516 | 181 | Tobias Brunner | |\3(level1). {{h4(libimcv.plugins subsection)}} | |
517 | 140 | Andreas Steffen | |libimcv.plugins.imc-attestation.aik_blob | |AIK encrypted private key blob file.| |
518 | 140 | Andreas Steffen | |libimcv.plugins.imc-attestation.aik_cert | |AIK certificate file.| |
519 | 140 | Andreas Steffen | |libimcv.plugins.imc-attestation.aik_handle | |AIK object handle, e.g. 0x81010003.| |
520 | 1 | Martin Willi | |libimcv.plugins.imc-attestation.aik_pubkey | |AIK public key file.| |
521 | 163 | Tobias Brunner | |libimcv.plugins.imc-attestation.mandatory_dh_groups|yes |Enforce mandatory Diffie-Hellman groups| |
522 | 153 | Tobias Brunner | |libimcv.plugins.imc-attestation.nonce_len |20 |DH nonce length.| |
523 | 153 | Tobias Brunner | |libimcv.plugins.imc-attestation.pcr_info |no |Whether to send pcr_before and pcr_after info.| |
524 | 153 | Tobias Brunner | |libimcv.plugins.imc-attestation.use_quote2 |yes |Use Quote2 AIK signature instead of Quote signature.| |
525 | 153 | Tobias Brunner | |libimcv.plugins.imc-attestation.use_version_info |no |Version Info is included in Quote2 signature.| |
526 | 153 | Tobias Brunner | |libimcv.plugins.imc-hcd.push_info |yes |Send quadruple info without being prompted.| |
527 | 153 | Tobias Brunner | |libimcv.plugins.imc-hcd.subtypes | |Section to define PWG HCD PA subtypes (see [[HCD-IMC]]).| |
528 | 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_.| |
529 | 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_.| |
530 | 153 | Tobias Brunner | |libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>||Defines a software section having an arbitrary name.| |
531 | 153 | Tobias Brunner | |libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.name||Name of the software installed on the hardcopy device.| |
532 | 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'.| |
533 | 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.| |
534 | 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).| |
535 | 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.| |
536 | 153 | Tobias Brunner | |libimcv.plugins.imc-hcd.subtypes.system.certification_state| |Hex-encoded certification state.| |
537 | 153 | Tobias Brunner | |libimcv.plugins.imc-hcd.subtypes.system.configuration_state| |Hex-encoded configuration state.| |
538 | 153 | Tobias Brunner | |libimcv.plugins.imc-hcd.subtypes.system.machine_type_model| |String specifying the machine type and model of the hardcopy device.| |
539 | 1 | Martin Willi | |libimcv.plugins.imc-hcd.subtypes.system.pstn_fax_enabled|no |Specifies if a PSTN facsimile interface is installed and enabled on the hardcopy device.| |
540 | 1 | Martin Willi | |libimcv.plugins.imc-hcd.subtypes.system.time_source| |String specifying the hostname of the network time server used by the hardcopy device.| |
541 | 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.| |
542 | 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.| |
543 | 140 | Andreas Steffen | |libimcv.plugins.imc-hcd.subtypes.system.vendor_name| |String specifying the manufacturer of the hardcopy device.| |
544 | 174 | 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.| |
545 | 140 | Andreas Steffen | |libimcv.plugins.imc-os.device_cert | |Manually set the path to the client device certificate (e.g. /etc/pts/aikCert.der)| |
546 | 140 | Andreas Steffen | |libimcv.plugins.imc-os.device_handle | |Manually set handle to a private key bound to a smartcard or TPM (e.g. 0x81010004)| |
547 | 1 | Martin Willi | |libimcv.plugins.imc-os.device_id | |Manually set the client device ID in hexadecimal format (e.g. 1083f03988c9762703b1c1080c2e46f72b99cc31)| |
548 | 141 | Andreas Steffen | |libimcv.plugins.imc-os.device_pubkey | |Manually set the path to the client device public key (e.g. /etc/pts/aikPub.der)| |
549 | 141 | Andreas Steffen | |libimcv.plugins.imc-os.push_info |yes |Send operating system info without being prompted.| |
550 | 1 | Martin Willi | |libimcv.plugins.imc-scanner.push_info |yes |Send open listening ports without being prompted.| |
551 | 179 | Tobias Brunner | |libimcv.plugins.imc-swima.eid_epoch |0x11223344|Set 32 bit epoch value for event IDs manually if software collector database is not available.| |
552 | 179 | Tobias Brunner | |libimcv.plugins.imc-swima.subscriptions |no |Accept SW Inventory or SW Events subscriptions.| |
553 | 169 | Tobias Brunner | |libimcv.plugins.imc-swima.swid_database | |URI to software collector database containing event timestamps, software creation and deletion events and collected software identifiers. If it contains a password, make sure to adjust the permissions of the config file accordingly.| |
554 | 169 | Tobias Brunner | |libimcv.plugins.imc-swima.swid_directory |${prefix}/share|Directory where SWID tags are located.| |
555 | 169 | Tobias Brunner | |libimcv.plugins.imc-swima.swid_full |no |Include file information in the XML-encoded SWID tags.| |
556 | 169 | Tobias Brunner | |libimcv.plugins.imc-swima.swid_pretty |no |Generate XML-encoded SWID tags with pretty indentation.| |
557 | 140 | Andreas Steffen | |libimcv.plugins.imc-test.additional_ids |0 |Number of additional IMC IDs.| |
558 | 140 | Andreas Steffen | |libimcv.plugins.imc-test.command |none |Command to be sent to the Test IMV.| |
559 | 140 | Andreas Steffen | |libimcv.plugins.imc-test.dummy_size |0 |Size of dummy attribute to be sent to the Test IMV (0 = disabled).| |
560 | 140 | Andreas Steffen | |libimcv.plugins.imc-test.retry |no |Do a handshake retry.| |
561 | 140 | Andreas Steffen | |libimcv.plugins.imc-test.retry_command | |Command to be sent to the IMV Test in the handshake retry.| |
562 | 140 | Andreas Steffen | |libimcv.plugins.imv-attestation.cadir | |Path to directory with AIK cacerts.| |
563 | 140 | Andreas Steffen | |libimcv.plugins.imv-attestation.dh_group |ecp256 |Preferred Diffie-Hellman group.| |
564 | 140 | Andreas Steffen | |libimcv.plugins.imv-attestation.hash_algorithm |sha256 |Preferred measurement hash algorithm.| |
565 | 140 | Andreas Steffen | |libimcv.plugins.imv-attestation.min_nonce_len |0 |DH minimum nonce length.| |
566 | 140 | Andreas Steffen | |libimcv.plugins.imv-attestation.remediation_uri | |URI pointing to attestation remediation instructions.| |
567 | 1 | Martin Willi | |libimcv.plugins.imv-os.remediation_uri | |URI pointing to operating system remediation instructions.| |
568 | 1 | Martin Willi | |libimcv.plugins.imv-scanner.remediation_uri | |URI pointing to scanner remediation instructions.| |
569 | 169 | Tobias Brunner | |libimcv.plugins.imv-swima.rest_api.timeout |120 |Timeout of SWID REST API HTTP POST transaction.| |
570 | 169 | Tobias Brunner | |libimcv.plugins.imv-swima.rest_api.uri | |HTTP URI of the SWID REST API.| |
571 | 140 | Andreas Steffen | |libimcv.plugins.imv-test.rounds |0 |Number of IMC-IMV retry rounds.| |
572 | 181 | Tobias Brunner | |\3(level1). {{h3([[manager]] section)}} | |
573 | 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.| |
574 | 137 | Tobias Brunner | |manager.debug |no |Enable debugging in manager.| |
575 | 137 | Tobias Brunner | |manager.load | |Plugins to load in manager.| |
576 | 137 | Tobias Brunner | |manager.socket | |FastCGI socket of manager, to run it statically.| |
577 | 137 | Tobias Brunner | |manager.threads |10 |Threads to use for request handling.| |
578 | 137 | Tobias Brunner | |manager.timeout |15m |Session timeout for manager.| |
579 | 181 | Tobias Brunner | |\3(level1). {{h3(mediation client section)}} | |
580 | 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.| |
581 | 137 | Tobias Brunner | |medcli.dpd |5m |DPD timeout to use in mediation client plugin.| |
582 | 137 | Tobias Brunner | |medcli.rekey |20m |Rekeying time on mediation connections in mediation client plugin.| |
583 | 181 | Tobias Brunner | |\3(level1). {{h3(mediation server section)}} | |
584 | 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.| |
585 | 137 | Tobias Brunner | |medsrv.debug |no |Debugging in mediation server web application.| |
586 | 137 | Tobias Brunner | |medsrv.dpd |5m |DPD timeout to use in mediation server plugin.| |
587 | 137 | Tobias Brunner | |medsrv.load | |Plugins to load in mediation server plugin.| |
588 | 137 | Tobias Brunner | |medsrv.password_length |6 |Minimum password length required for mediation server user accounts.| |
589 | 137 | Tobias Brunner | |medsrv.rekey |20m |Rekeying time on mediation connections in mediation server plugin.| |
590 | 1 | Martin Willi | |medsrv.socket | |Run Mediation server web application statically on socket.| |
591 | 137 | Tobias Brunner | |medsrv.threads |5 |Number of thread for mediation service web application.| |
592 | 1 | Martin Willi | |medsrv.timeout |15m |Session timeout for mediation service.| |
593 | 181 | Tobias Brunner | |\3(level1). {{h3(pki section)}} | |
594 | 1 | Martin Willi | |pki.load | |Plugins to load in ipsec pki tool.| |
595 | 181 | Tobias Brunner | |\3(level1). {{h3(pool section)}} | |
596 | 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.| |
597 | 1 | Martin Willi | |pool.load | |Plugins to load in ipsec pool tool.| |
598 | 181 | Tobias Brunner | |\3(level1). {{h3(pt-tls-client section)}} | |
599 | 1 | Martin Willi | |pt-tls-client.load | |Plugins to load in ipsec pt-tls-client tool.| |
600 | 181 | Tobias Brunner | |\3(level1). {{h3(scepclient section)}} | |
601 | 1 | Martin Willi | |scepclient.load | |Plugins to load in ipsec scepclient tool.| |
602 | 181 | Tobias Brunner | |\3(level1). {{h3(sec-updater section)}} | |
603 | 172 | Tobias Brunner | |sec-updater.database | |Global IMV policy database URI. If it contains a password, make sure to adjust the permissions of the config file accordingly.| |
604 | 172 | Tobias Brunner | |sec-updater.swid_gen.command |/usr/local/bin/swid_generator|SWID generator command to be executed.| |
605 | 172 | Tobias Brunner | |sec-updater.swid_gen.tag_creator.name |strongSwan Project|Name of the tagCreator entity.| |
606 | 172 | Tobias Brunner | |sec-updater.swid_gen.tag_creator.regid |strongswan.org|regid of the tagCreator entity.| |
607 | 172 | Tobias Brunner | |sec-updater.tnc_manage_command |/var/www/tnc/manage.py|strongTNC manage.py command used to import SWID tags.| |
608 | 172 | Tobias Brunner | |sec-updater.tmp.deb_file |/tmp/sec-updater.deb|Temporary storage for downloaded deb package file.| |
609 | 172 | Tobias Brunner | |sec-updater.tmp.tag_file |/tmp/sec-updater.tag|Temporary storage for generated SWID tags.| |
610 | 172 | Tobias Brunner | |sec-updater.load | |Plugins to load in sec-updater tool.| |
611 | 181 | Tobias Brunner | |\3(level1). {{h3(starter section)}} | |
612 | 1 | Martin Willi | |starter.config_file |${sysconfdir}/ipsec.conf|Location of the [[ipsec.conf]] file.| |
613 | 1 | Martin Willi | |starter.load_warning |yes |Show _charon.load_ setting warning, see [[PluginLoad]].| |
614 | 181 | Tobias Brunner | |\3(level1). {{h3(sw-collector section)}} | |
615 | 169 | Tobias Brunner | |sw-collector.database | |URI to software collector database containing event timestamps, software creation and deletion events and collected software identifiers. If it contains a password, make sure to adjust the permissions of the config file accordingly.| |
616 | 169 | Tobias Brunner | |sw-collector.first_file |/var/log/bootstrap.log|Path pointing to file created when the Linux OS was installed.| |
617 | 169 | Tobias Brunner | |sw-collector.first_time |0000-00-00T00:00:00Z|Time in UTC when the Linux OS was installed.| |
618 | 169 | Tobias Brunner | |sw-collector.history | |Path pointing to apt history.log file.| |
619 | 169 | Tobias Brunner | |sw-collector.load | |Plugins to load in [[swcollector|sw-collector]] tool.| |
620 | 169 | Tobias Brunner | |sw-collector.rest_api.timeout |120 |Timeout of REST API HTTP POST transaction.| |
621 | 169 | Tobias Brunner | |sw-collector.rest_api.uri | |HTTP URI of the central collector's REST API.| |
622 | 181 | Tobias Brunner | |\3(level1). {{h3(swanctl section)}} | |
623 | 142 | Tobias Brunner | |swanctl.load | |Plugins to load in [[swanctl]].| |
624 | 169 | Tobias Brunner | |swanctl.socket |unix://${piddir}/charon.vici|VICI socket to connect to by default.| |