strongswan.conf.5 92 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247
  1. .TH STRONGSWAN.CONF 5 "" "5.8.1" "strongSwan"
  2. .SH NAME
  3. strongswan.conf \- strongSwan configuration file
  4. .SH DESCRIPTION
  5. While the
  6. .IR ipsec.conf (5)
  7. configuration file is well suited to define IPsec related configuration
  8. parameters, it is not useful for other strongSwan applications to read options
  9. from this file.
  10. The file is hard to parse and only
  11. .I ipsec starter
  12. is capable of doing so. As the number of components of the strongSwan project
  13. is continually growing, a more flexible configuration file was needed, one that
  14. is easy to extend and can be used by all components. With strongSwan 4.2.1
  15. .IR strongswan.conf (5)
  16. was introduced which meets these requirements.
  17. .SH SYNTAX
  18. The format of the strongswan.conf file consists of hierarchical
  19. .B sections
  20. and a list of
  21. .B key/value pairs
  22. in each section. Each section has a name, followed by C-Style curly brackets
  23. defining the section body. Each section body contains a set of subsections
  24. and key/value pairs:
  25. .PP
  26. .EX
  27. settings := (section|keyvalue)*
  28. section := name { settings }
  29. keyvalue := key = value\\n
  30. .EE
  31. .PP
  32. Values must be terminated by a newline.
  33. .PP
  34. Comments are possible using the \fB#\fP-character.
  35. .PP
  36. Section names and keys may contain any printable character except:
  37. .PP
  38. .EX
  39. . , : { } = " # \\n \\t space
  40. .EE
  41. .PP
  42. An example file in this format might look like this:
  43. .PP
  44. .EX
  45. a = b
  46. section-one {
  47. somevalue = asdf
  48. subsection {
  49. othervalue = xxx
  50. }
  51. # yei, a comment
  52. yetanother = zz
  53. }
  54. section-two {
  55. x = 12
  56. }
  57. .EE
  58. .PP
  59. Indentation is optional, you may use tabs or spaces.
  60. .SH REFERENCING OTHER SECTIONS
  61. It is possible to inherit settings and sections from another section. This
  62. feature is mainly useful in swanctl.conf (which uses the same file format).
  63. The syntax is as follows:
  64. .PP
  65. .EX
  66. section := name : references { settings }
  67. references := absname[, absname]*
  68. absname := name[.name]*
  69. .EE
  70. .PP
  71. All key/value pairs and all subsections of the referenced sections will be
  72. inherited by the section that references them via their absolute name. Values
  73. may be overridden in the section or any of its sub-sections (use an empty
  74. assignment to clear a value so its default value, if any, will apply). It is
  75. currently not possible to limit the inclusion level or clear/remove inherited
  76. sub-sections.
  77. If the order is important (e.g. for auth rounds in a connection, if \fIround\fR
  78. is not used), it should be noted that inherited settings/sections will follow
  79. those defined in the current section (if multiple sections are referenced, their
  80. settings are enumerated left to right).
  81. References are evaluated dynamically at runtime, so referring to sections later
  82. in the config file or included via other files is no problem.
  83. Here is an example of how this might look like:
  84. .PP
  85. .EX
  86. conn-defaults {
  87. # default settings for all conns (e.g. a cert, or IP pools)
  88. }
  89. eap-defaults {
  90. # defaults if eap is used (e.g. a remote auth round)
  91. }
  92. child-defaults {
  93. # defaults for child configs (e.g. traffic selectors)
  94. }
  95. connections {
  96. conn-a : conn-defaults, eap-defaults {
  97. # set/override stuff specific to this connection
  98. children {
  99. child-a : child-defaults {
  100. # set/override stuff specific to this child
  101. }
  102. }
  103. }
  104. conn-b : conn-defaults {
  105. # set/override stuff specific to this connection
  106. children {
  107. child-b : child-defaults {
  108. # set/override stuff specific to this child
  109. }
  110. }
  111. }
  112. conn-c : connections.conn-a {
  113. # everything is inherited, including everything conn-a
  114. # already inherits from the sections it and its
  115. # sub-section reference
  116. }
  117. }
  118. .EE
  119. .PP
  120. .SH INCLUDING FILES
  121. Using the
  122. .B include
  123. statement it is possible to include other files into strongswan.conf, e.g.
  124. .PP
  125. .EX
  126. include /some/path/*.conf
  127. .EE
  128. .PP
  129. If the file name is not an absolute path, it is considered to be relative
  130. to the directory of the file containing the include statement. The file name
  131. may include shell wildcards (see
  132. .IR sh (1)).
  133. Also, such inclusions can be nested.
  134. .PP
  135. Sections loaded from included files
  136. .I extend
  137. previously loaded sections; already existing values are
  138. .IR replaced .
  139. It is important to note that settings are added relative to the section the
  140. include statement is in.
  141. .PP
  142. As an example, the following three files result in the same final
  143. config as the one given above:
  144. .PP
  145. .EX
  146. a = b
  147. section-one {
  148. somevalue = before include
  149. include include.conf
  150. }
  151. include other.conf
  152. include.conf:
  153. # settings loaded from this file are added to section-one
  154. # the following replaces the previous value
  155. somevalue = asdf
  156. subsection {
  157. othervalue = yyy
  158. }
  159. yetanother = zz
  160. other.conf:
  161. # this extends section-one and subsection
  162. section-one {
  163. subsection {
  164. # this replaces the previous value
  165. othervalue = xxx
  166. }
  167. }
  168. section-two {
  169. x = 12
  170. }
  171. .EE
  172. .SH READING VALUES
  173. Values are accessed using a dot-separated section list and a key.
  174. With reference to the example above, accessing
  175. .B section-one.subsection.othervalue
  176. will return
  177. .BR xxx .
  178. .SH DEFINED KEYS
  179. The following keys are currently defined (using dot notation). The default
  180. value (if any) is listed in brackets after the key.
  181. .TP
  182. .BR aikgen.load " []"
  183. Plugins to load in ipsec aikgen tool.
  184. .TP
  185. .BR attest.database " []"
  186. File measurement information database URI. If it contains a password, make sure
  187. to adjust the permissions of the config file accordingly.
  188. .TP
  189. .BR attest.load " []"
  190. Plugins to load in ipsec attest tool.
  191. .TP
  192. .B charon
  193. .br
  194. Options for the charon IKE daemon.
  195. .RB "" "Note" ":"
  196. Many of the options in this section also apply to
  197. .RB "" "charon\-cmd" ""
  198. and
  199. other
  200. .RB "" "charon" ""
  201. derivatives. Just use their respective name (e.g.
  202. .RB "" "charon\-cmd" ""
  203. instead of
  204. .RB "" "charon" ")."
  205. For many options defaults can be defined
  206. in the
  207. .RB "" "libstrongswan" ""
  208. section.
  209. .TP
  210. .BR charon.accept_unencrypted_mainmode_messages " [no]"
  211. Accept unencrypted ID and HASH payloads in IKEv1 Main Mode.
  212. Some implementations send the third Main Mode message unencrypted, probably to
  213. find the PSKs for the specified ID for authentication. This is very similar to
  214. Aggressive Mode, and has the same security implications: A passive attacker can
  215. sniff the negotiated Identity, and start brute forcing the PSK using the HASH
  216. payload.
  217. It is recommended to keep this option to no, unless you know exactly what the
  218. implications are and require compatibility to such devices (for example, some
  219. SonicWall boxes).
  220. .TP
  221. .BR charon.block_threshold " [5]"
  222. Maximum number of half\-open IKE_SAs for a single peer IP.
  223. .TP
  224. .BR charon.cache_crls " [no]"
  225. Whether Certificate Revocation Lists (CRLs) fetched via HTTP or LDAP should be
  226. saved under a unique file name derived from the public key of the Certification
  227. Authority (CA) to
  228. .RB "" "/etc/ipsec.d/crls" ""
  229. (stroke) or
  230. .RB "" "/etc/swanctl/x509crl" ""
  231. (vici), respectively.
  232. .TP
  233. .BR charon.cert_cache " [yes]"
  234. Whether relations in validated certificate chains should be cached in memory.
  235. .TP
  236. .BR charon.cisco_unity " [no]"
  237. Send Cisco Unity vendor ID payload (IKEv1 only).
  238. .TP
  239. .BR charon.close_ike_on_child_failure " [no]"
  240. Close the IKE_SA if setup of the CHILD_SA along with IKE_AUTH failed.
  241. .TP
  242. .BR charon.cookie_threshold " [10]"
  243. Number of half\-open IKE_SAs that activate the cookie mechanism.
  244. .TP
  245. .BR charon.crypto_test.bench " [no]"
  246. Benchmark crypto algorithms and order them by efficiency.
  247. .TP
  248. .BR charon.crypto_test.bench_size " [1024]"
  249. Buffer size used for crypto benchmark.
  250. .TP
  251. .BR charon.crypto_test.bench_time " [50]"
  252. Time in ms during which crypto algorithm performance is measured.
  253. .TP
  254. .BR charon.crypto_test.on_add " [no]"
  255. Test crypto algorithms during registration (requires test vectors provided by
  256. the
  257. .RI "" "test\-vectors" ""
  258. plugin).
  259. .TP
  260. .BR charon.crypto_test.on_create " [no]"
  261. Test crypto algorithms on each crypto primitive instantiation.
  262. .TP
  263. .BR charon.crypto_test.required " [no]"
  264. Strictly require at least one test vector to enable an algorithm.
  265. .TP
  266. .BR charon.crypto_test.rng_true " [no]"
  267. Whether to test RNG with TRUE quality; requires a lot of entropy.
  268. .TP
  269. .BR charon.delete_rekeyed " [no]"
  270. Delete CHILD_SAs right after they got successfully rekeyed (IKEv1 only). Reduces
  271. the number of stale CHILD_SAs in scenarios with a lot of rekeyings. However,
  272. this might cause problems with implementations that continue to use rekeyed SAs
  273. until they expire.
  274. .TP
  275. .BR charon.delete_rekeyed_delay " [5]"
  276. Delay in seconds until inbound IPsec SAs are deleted after rekeyings (IKEv2
  277. only). To process delayed packets the inbound part of a CHILD_SA is kept
  278. installed up to the configured number of seconds after it got replaced during a
  279. rekeying. If set to 0 the CHILD_SA will be kept installed until it expires (if
  280. no lifetime is set it will be destroyed immediately).
  281. .TP
  282. .BR charon.dh_exponent_ansi_x9_42 " [yes]"
  283. Use ANSI X9.42 DH exponent size or optimum size matched to cryptographic
  284. strength.
  285. .TP
  286. .BR charon.dlopen_use_rtld_now " [no]"
  287. Use RTLD_NOW with dlopen when loading plugins and IMV/IMCs to reveal missing
  288. symbols immediately.
  289. .TP
  290. .BR charon.dns1 " []"
  291. DNS server assigned to peer via configuration payload (CP).
  292. .TP
  293. .BR charon.dns2 " []"
  294. DNS server assigned to peer via configuration payload (CP).
  295. .TP
  296. .BR charon.dos_protection " [yes]"
  297. Enable Denial of Service protection using cookies and aggressiveness checks.
  298. .TP
  299. .BR charon.ecp_x_coordinate_only " [yes]"
  300. Compliance with the errata for RFC 4753.
  301. .TP
  302. .B charon.filelog
  303. .br
  304. Section to define file loggers, see LOGGER CONFIGURATION in
  305. .RB "" "strongswan.conf" "(5)."
  306. .TP
  307. .B charon.filelog.<name>
  308. .br
  309. <name> may be the full path to the log file if it only contains characters
  310. permitted in section names. Is ignored if
  311. .RI "" "path" ""
  312. is specified.
  313. .TP
  314. .BR charon.filelog.<name>.<subsystem> " [<default>]"
  315. Loglevel for a specific subsystem.
  316. .TP
  317. .BR charon.filelog.<name>.append " [yes]"
  318. If this option is enabled log entries are appended to the existing file.
  319. .TP
  320. .BR charon.filelog.<name>.default " [1]"
  321. Specifies the default loglevel to be used for subsystems for which no specific
  322. loglevel is defined.
  323. .TP
  324. .BR charon.filelog.<name>.flush_line " [no]"
  325. Enabling this option disables block buffering and enables line buffering.
  326. .TP
  327. .BR charon.filelog.<name>.ike_name " [no]"
  328. Prefix each log entry with the connection name and a unique numerical identifier
  329. for each IKE_SA.
  330. .TP
  331. .BR charon.filelog.<name>.path " []"
  332. Optional path to the log file. Overrides the section name. Must be used if the
  333. path contains characters that aren't allowed in section names.
  334. .TP
  335. .BR charon.filelog.<name>.time_add_ms " [no]"
  336. Adds the milliseconds within the current second after the timestamp (separated
  337. by a dot, so
  338. .RI "" "time_format" ""
  339. should end with %S or %T).
  340. .TP
  341. .BR charon.filelog.<name>.time_format " []"
  342. Prefix each log entry with a timestamp. The option accepts a format string as
  343. passed to
  344. .RB "" "strftime" "(3)."
  345. .TP
  346. .BR charon.flush_auth_cfg " [no]"
  347. If enabled objects used during authentication (certificates, identities etc.)
  348. are released to free memory once an IKE_SA is established. Enabling this might
  349. conflict with plugins that later need access to e.g. the used certificates.
  350. .TP
  351. .BR charon.follow_redirects " [yes]"
  352. Whether to follow IKEv2 redirects (RFC 5685).
  353. .TP
  354. .BR charon.fragment_size " [1280]"
  355. Maximum size (complete IP datagram size in bytes) of a sent IKE fragment when
  356. using proprietary IKEv1 or standardized IKEv2 fragmentation, defaults to 1280
  357. (use 0 for address family specific default values, which uses a lower value for
  358. IPv4). If specified this limit is used for both IPv4 and IPv6.
  359. .TP
  360. .BR charon.group " []"
  361. Name of the group the daemon changes to after startup.
  362. .TP
  363. .BR charon.half_open_timeout " [30]"
  364. Timeout in seconds for connecting IKE_SAs (also see IKE_SA_INIT DROPPING).
  365. .TP
  366. .BR charon.hash_and_url " [no]"
  367. Enable hash and URL support.
  368. .TP
  369. .BR charon.host_resolver.max_threads " [3]"
  370. Maximum number of concurrent resolver threads (they are terminated if unused).
  371. .TP
  372. .BR charon.host_resolver.min_threads " [0]"
  373. Minimum number of resolver threads to keep around.
  374. .TP
  375. .BR charon.i_dont_care_about_security_and_use_aggressive_mode_psk " [no]"
  376. If enabled responders are allowed to use IKEv1 Aggressive Mode with pre\-shared
  377. keys, which is discouraged due to security concerns (offline attacks on the
  378. openly transmitted hash of the PSK).
  379. .TP
  380. .BR charon.ignore_acquire_ts " [no]"
  381. If this is disabled the traffic selectors from the kernel's acquire events,
  382. which are derived from the triggering packet, are prepended to the traffic
  383. selectors from the configuration for IKEv2 connection. By enabling this, such
  384. specific traffic selectors will be ignored and only the ones in the config will
  385. be sent. This always happens for IKEv1 connections as the protocol only supports
  386. one set of traffic selectors per CHILD_SA.
  387. .TP
  388. .BR charon.ignore_routing_tables " []"
  389. A space\-separated list of routing tables to be excluded from route lookups.
  390. .TP
  391. .BR charon.ikesa_limit " [0]"
  392. Maximum number of IKE_SAs that can be established at the same time before new
  393. connection attempts are blocked.
  394. .TP
  395. .BR charon.ikesa_table_segments " [1]"
  396. Number of exclusively locked segments in the hash table.
  397. .TP
  398. .BR charon.ikesa_table_size " [1]"
  399. Size of the IKE_SA hash table.
  400. .TP
  401. .B charon.imcv
  402. .br
  403. Defaults for options in this section can be configured in the
  404. .RI "" "libimcv" ""
  405. section.
  406. .TP
  407. .BR charon.imcv.assessment_result " [yes]"
  408. Whether IMVs send a standard IETF Assessment Result attribute.
  409. .TP
  410. .BR charon.imcv.database " []"
  411. Global IMV policy database URI. If it contains a password, make sure to adjust
  412. the permissions of the config file accordingly.
  413. .TP
  414. .BR charon.imcv.os_info.default_password_enabled " [no]"
  415. Manually set whether a default password is enabled
  416. .TP
  417. .BR charon.imcv.os_info.name " []"
  418. Manually set the name of the client OS (e.g. Ubuntu).
  419. .TP
  420. .BR charon.imcv.os_info.version " []"
  421. Manually set the version of the client OS (e.g. 12.04 i686).
  422. .TP
  423. .BR charon.imcv.policy_script " [ipsec _imv_policy]"
  424. Script called for each TNC connection to generate IMV policies.
  425. .TP
  426. .BR charon.inactivity_close_ike " [no]"
  427. Whether to close IKE_SA if the only CHILD_SA closed due to inactivity.
  428. .TP
  429. .BR charon.init_limit_half_open " [0]"
  430. Limit new connections based on the current number of half open IKE_SAs, see
  431. IKE_SA_INIT DROPPING in
  432. .RB "" "strongswan.conf" "(5)."
  433. .TP
  434. .BR charon.init_limit_job_load " [0]"
  435. Limit new connections based on the number of jobs currently queued for
  436. processing (see IKE_SA_INIT DROPPING).
  437. .TP
  438. .BR charon.initiator_only " [no]"
  439. Causes charon daemon to ignore IKE initiation requests.
  440. .TP
  441. .BR charon.install_routes " [yes]"
  442. Install routes into a separate routing table for established IPsec tunnels.
  443. .TP
  444. .BR charon.install_virtual_ip " [yes]"
  445. Install virtual IP addresses.
  446. .TP
  447. .BR charon.install_virtual_ip_on " []"
  448. The name of the interface on which virtual IP addresses should be installed. If
  449. not specified the addresses will be installed on the outbound interface.
  450. .TP
  451. .BR charon.integrity_test " [no]"
  452. Check daemon, libstrongswan and plugin integrity at startup.
  453. .TP
  454. .BR charon.interfaces_ignore " []"
  455. A comma\-separated list of network interfaces that should be ignored, if
  456. .RB "" "interfaces_use" ""
  457. is specified this option has no effect.
  458. .TP
  459. .BR charon.interfaces_use " []"
  460. A comma\-separated list of network interfaces that should be used by charon. All
  461. other interfaces are ignored.
  462. .TP
  463. .BR charon.keep_alive " [20s]"
  464. NAT keep alive interval.
  465. .TP
  466. .BR charon.leak_detective.detailed " [yes]"
  467. Includes source file names and line numbers in leak detective output.
  468. .TP
  469. .BR charon.leak_detective.usage_threshold " [10240]"
  470. Threshold in bytes for leaks to be reported (0 to report all).
  471. .TP
  472. .BR charon.leak_detective.usage_threshold_count " [0]"
  473. Threshold in number of allocations for leaks to be reported (0 to report all).
  474. .TP
  475. .BR charon.load " []"
  476. Plugins to load in the IKE daemon charon.
  477. .TP
  478. .BR charon.load_modular " [no]"
  479. If enabled, the list of plugins to load is determined via the value of the
  480. .RI "" "charon.plugins.<name>.load" ""
  481. options. In addition to a simple boolean flag that
  482. option may take an integer value indicating the priority of a plugin, which
  483. would influence the order of a plugin in the plugin list (the default is 1). If
  484. two plugins have the same priority their order in the default plugin list is
  485. preserved. Enabled plugins not found in that list are ordered alphabetically
  486. before other plugins with the same priority.
  487. .TP
  488. .BR charon.make_before_break " [no]"
  489. Initiate IKEv2 reauthentication with a make\-before\-break instead of a
  490. break\-before\-make scheme. Make\-before\-break uses overlapping IKE and CHILD_SA
  491. during reauthentication by first recreating all new SAs before deleting the old
  492. ones. This behavior can be beneficial to avoid connectivity gaps during
  493. reauthentication, but requires support for overlapping SAs by the peer.
  494. strongSwan can handle such overlapping SAs since version 5.3.0.
  495. .TP
  496. .BR charon.max_ikev1_exchanges " [3]"
  497. Maximum number of IKEv1 phase 2 exchanges per IKE_SA to keep state about and
  498. track concurrently.
  499. .TP
  500. .BR charon.max_packet " [10000]"
  501. Maximum packet size accepted by charon.
  502. .TP
  503. .BR charon.multiple_authentication " [yes]"
  504. Enable multiple authentication exchanges (RFC 4739).
  505. .TP
  506. .BR charon.nbns1 " []"
  507. WINS servers assigned to peer via configuration payload (CP).
  508. .TP
  509. .BR charon.nbns2 " []"
  510. WINS servers assigned to peer via configuration payload (CP).
  511. .TP
  512. .BR charon.plugin.ha.buflen " [2048]"
  513. Buffer size for received HA messages. For IKEv1 the public DH factors are also
  514. transmitted so depending on the DH group the HA messages can get quite big (the
  515. default should be fine up to
  516. .RI "" "modp4096" ")."
  517. .TP
  518. .BR charon.plugins.addrblock.strict " [yes]"
  519. If set to yes, a subject certificate without an addrblock extension is rejected
  520. if the issuer certificate has such an addrblock extension. If set to no, subject
  521. certificates issued without the addrblock extension are accepted without any
  522. traffic selector checks and no policy is enforced by the plugin.
  523. .TP
  524. .BR charon.plugins.android_log.loglevel " [1]"
  525. Loglevel for logging to Android specific logger.
  526. .TP
  527. .B charon.plugins.attr
  528. .br
  529. Section to specify arbitrary attributes that are assigned to a peer via
  530. configuration payload (CP).
  531. .TP
  532. .BR charon.plugins.attr.<attr> " []"
  533. .RB "" "<attr>" ""
  534. can be either
  535. .RI "" "address" ","
  536. .RI "" "netmask" ","
  537. .RI "" "dns" ","
  538. .RI "" "nbns" ","
  539. .RI "" "dhcp" ","
  540. .RI "" "subnet" ","
  541. .RI "" "split\-include" ","
  542. .RI "" "split\-exclude" ""
  543. or the numeric identifier of the attribute
  544. type. The assigned value can be an IPv4/IPv6 address, a subnet in CIDR notation
  545. or an arbitrary value depending on the attribute type. For some attribute types
  546. multiple values may be specified as a comma separated list.
  547. .TP
  548. .BR charon.plugins.attr-sql.crash_recovery " [yes]"
  549. Release all online leases during startup. Disable this to share the DB between
  550. multiple VPN gateways.
  551. .TP
  552. .BR charon.plugins.attr-sql.database " []"
  553. Database URI for attr\-sql plugin used by charon. If it contains a password, make
  554. sure to adjust the permissions of the config file accordingly.
  555. .TP
  556. .BR charon.plugins.attr-sql.lease_history " [yes]"
  557. Enable logging of SQL IP pool leases.
  558. .TP
  559. .BR charon.plugins.bliss.use_bliss_b " [yes]"
  560. Use the enhanced BLISS\-B key generation and signature algorithm.
  561. .TP
  562. .BR charon.plugins.bypass-lan.interfaces_ignore " []"
  563. A comma\-separated list of network interfaces for which connected subnets should
  564. be ignored, if
  565. .RB "" "interfaces_use" ""
  566. is specified this option has no effect.
  567. .TP
  568. .BR charon.plugins.bypass-lan.interfaces_use " []"
  569. A comma\-separated list of network interfaces for which connected subnets should
  570. be considered. All other interfaces are ignored.
  571. .TP
  572. .BR charon.plugins.certexpire.csv.cron " []"
  573. Cron style string specifying CSV export times.
  574. .TP
  575. .BR charon.plugins.certexpire.csv.empty_string " []"
  576. String to use in empty intermediate CA fields.
  577. .TP
  578. .BR charon.plugins.certexpire.csv.fixed_fields " [yes]"
  579. Use a fixed intermediate CA field count.
  580. .TP
  581. .BR charon.plugins.certexpire.csv.force " [yes]"
  582. Force export of all trustchains we have a private key for.
  583. .TP
  584. .BR charon.plugins.certexpire.csv.format " [%d:%m:%Y]"
  585. .RB "" "strftime" "(3)"
  586. format string to export expiration dates as.
  587. .TP
  588. .BR charon.plugins.certexpire.csv.local " []"
  589. .RB "" "strftime" "(3)"
  590. format string for the CSV file name to export local certificates
  591. to.
  592. .TP
  593. .BR charon.plugins.certexpire.csv.remote " []"
  594. .RB "" "strftime" "(3)"
  595. format string for the CSV file name to export remote
  596. certificates to.
  597. .TP
  598. .BR charon.plugins.certexpire.csv.separator " [,]"
  599. CSV field separator.
  600. .TP
  601. .BR charon.plugins.coupling.file " []"
  602. File to store coupling list to.
  603. .TP
  604. .BR charon.plugins.coupling.hash " [sha1]"
  605. Hashing algorithm to fingerprint coupled certificates.
  606. .TP
  607. .BR charon.plugins.coupling.max " [1]"
  608. Maximum number of coupling entries to create.
  609. .TP
  610. .BR charon.plugins.curl.redir " [-1]"
  611. Maximum number of redirects followed by the plugin, set to 0 to disable
  612. following redirects, set to \-1 for no limit.
  613. .TP
  614. .BR charon.plugins.dhcp.force_server_address " [no]"
  615. Always use the configured server address. This might be helpful if the DHCP
  616. server runs on the same host as strongSwan, and the DHCP daemon does not listen
  617. on the loopback interface. In that case the server cannot be reached via
  618. unicast (or even 255.255.255.255) as that would be routed via loopback. Setting
  619. this option to yes and configuring the local broadcast address (e.g.
  620. 192.168.0.255) as server address might work.
  621. .TP
  622. .BR charon.plugins.dhcp.identity_lease " [no]"
  623. Derive user\-defined MAC address from hash of IKE identity and send client
  624. identity DHCP option.
  625. .TP
  626. .BR charon.plugins.dhcp.interface " []"
  627. Interface name the plugin uses for address allocation. The default is to bind to
  628. any (0.0.0.0) and let the system decide which way to route the packets to the
  629. DHCP server.
  630. .TP
  631. .BR charon.plugins.dhcp.server " [255.255.255.255]"
  632. DHCP server unicast or broadcast IP address.
  633. .TP
  634. .BR charon.plugins.dhcp.use_server_port " [no]"
  635. Use the DHCP server port (67) as source port, instead of the DHCP client port
  636. (68), when a unicast server address is configured and the plugin acts as relay
  637. agent. When replying in this mode the DHCP server will always send packets to
  638. the DHCP server port and if no process binds that port an ICMP port unreachables
  639. will be sent back, which might be problematic for some DHCP servers. To avoid
  640. that, enabling this option will cause the plugin to bind the DHCP server port to
  641. send its requests when acting as relay agent. This is not necessary if a DHCP
  642. server is already running on the same host and might even cause conflicts (and
  643. since the server port is already bound, ICMPs should not be an issue).
  644. .TP
  645. .BR charon.plugins.dnscert.enable " [no]"
  646. Enable fetching of CERT RRs via DNS.
  647. .TP
  648. .BR charon.plugins.duplicheck.enable " [yes]"
  649. Enable duplicheck plugin (if loaded).
  650. .TP
  651. .BR charon.plugins.duplicheck.socket " [unix://${piddir}/charon.dck]"
  652. Socket provided by the duplicheck plugin.
  653. .TP
  654. .BR charon.plugins.eap-aka.request_identity " [yes]"
  655. .TP
  656. .BR charon.plugins.eap-aka-3gpp.seq_check " []"
  657. Enable to activate sequence check of the AKA SQN values in order to trigger
  658. resync cycles.
  659. .TP
  660. .BR charon.plugins.eap-aka-3gpp2.seq_check " []"
  661. Enable to activate sequence check of the AKA SQN values in order to trigger
  662. resync cycles.
  663. .TP
  664. .BR charon.plugins.eap-dynamic.prefer_user " [no]"
  665. If enabled the EAP methods proposed in an EAP\-Nak message sent by the peer are
  666. preferred over the methods registered locally.
  667. .TP
  668. .BR charon.plugins.eap-dynamic.preferred " []"
  669. The preferred EAP method(s) to be used. If it is not given the first registered
  670. method will be used initially. If a comma separated list is given the methods
  671. are tried in the given order before trying the rest of the registered methods.
  672. .TP
  673. .BR charon.plugins.eap-gtc.backend " [pam]"
  674. XAuth backend to be used for credential verification.
  675. .TP
  676. .BR charon.plugins.eap-peap.fragment_size " [1024]"
  677. Maximum size of an EAP\-PEAP packet.
  678. .TP
  679. .BR charon.plugins.eap-peap.include_length " [no]"
  680. Include length in non\-fragmented EAP\-PEAP packets.
  681. .TP
  682. .BR charon.plugins.eap-peap.max_message_count " [32]"
  683. Maximum number of processed EAP\-PEAP packets (0 = no limit).
  684. .TP
  685. .BR charon.plugins.eap-peap.phase2_method " [mschapv2]"
  686. Phase2 EAP client authentication method.
  687. .TP
  688. .BR charon.plugins.eap-peap.phase2_piggyback " [no]"
  689. Phase2 EAP Identity request piggybacked by server onto TLS Finished message.
  690. .TP
  691. .BR charon.plugins.eap-peap.phase2_tnc " [no]"
  692. Start phase2 EAP TNC protocol after successful client authentication.
  693. .TP
  694. .BR charon.plugins.eap-peap.request_peer_auth " [no]"
  695. Request peer authentication based on a client certificate.
  696. .TP
  697. .BR charon.plugins.eap-radius.accounting " [no]"
  698. Send RADIUS accounting information to RADIUS servers.
  699. .TP
  700. .BR charon.plugins.eap-radius.accounting_close_on_timeout " [yes]"
  701. Close the IKE_SA if there is a timeout during interim RADIUS accounting updates.
  702. .TP
  703. .BR charon.plugins.eap-radius.accounting_interval " [0]"
  704. Interval in seconds for interim RADIUS accounting updates, if not specified by
  705. the RADIUS server in the Access\-Accept message.
  706. .TP
  707. .BR charon.plugins.eap-radius.accounting_requires_vip " [no]"
  708. If enabled, accounting is disabled unless an IKE_SA has at least one virtual IP.
  709. Only for IKEv2, for IKEv1 a virtual IP is strictly necessary.
  710. .TP
  711. .BR charon.plugins.eap-radius.accounting_send_class " [no]"
  712. If enabled, adds the Class attributes received in Access\-Accept message to the
  713. RADIUS accounting messages.
  714. .TP
  715. .BR charon.plugins.eap-radius.class_group " [no]"
  716. Use the
  717. .RI "" "class" ""
  718. attribute sent in the RADIUS\-Accept message as group membership
  719. information that is compared to the groups specified in the
  720. .RB "" "rightgroups" ""
  721. option in
  722. .RB "" "ipsec.conf" "(5)."
  723. .TP
  724. .BR charon.plugins.eap-radius.close_all_on_timeout " [no]"
  725. Closes all IKE_SAs if communication with the RADIUS server times out. If it is
  726. not set only the current IKE_SA is closed.
  727. .TP
  728. .BR charon.plugins.eap-radius.dae.enable " [no]"
  729. Enables support for the Dynamic Authorization Extension (RFC 5176).
  730. .TP
  731. .BR charon.plugins.eap-radius.dae.listen " [0.0.0.0]"
  732. Address to listen for DAE messages from the RADIUS server.
  733. .TP
  734. .BR charon.plugins.eap-radius.dae.port " [3799]"
  735. Port to listen for DAE requests.
  736. .TP
  737. .BR charon.plugins.eap-radius.dae.secret " []"
  738. Shared secret used to verify/sign DAE messages. If set, make sure to adjust the
  739. permissions of the config file accordingly.
  740. .TP
  741. .BR charon.plugins.eap-radius.eap_start " [no]"
  742. Send EAP\-Start instead of EAP\-Identity to start RADIUS conversation.
  743. .TP
  744. .BR charon.plugins.eap-radius.filter_id " [no]"
  745. If the RADIUS
  746. .RI "" "tunnel_type" ""
  747. attribute with value
  748. .RB "" "ESP" ""
  749. is received, use the
  750. .RI "" "filter_id" ""
  751. attribute sent in the RADIUS\-Accept message as group membership
  752. information that is compared to the groups specified in the
  753. .RB "" "rightgroups" ""
  754. option in
  755. .RB "" "ipsec.conf" "(5)."
  756. .TP
  757. .BR charon.plugins.eap-radius.forward.ike_to_radius " []"
  758. RADIUS attributes to be forwarded from IKEv2 to RADIUS (can be defined by name
  759. or attribute number, a colon can be used to specify vendor\-specific attributes,
  760. e.g. Reply\-Message, or 11, or 36906:12).
  761. .TP
  762. .BR charon.plugins.eap-radius.forward.radius_to_ike " []"
  763. Same as
  764. .RI "" "charon.plugins.eap\-radius.forward.ike_to_radius" ""
  765. but from RADIUS to
  766. IKEv2, a strongSwan specific private notify (40969) is used to transmit the
  767. attributes.
  768. .TP
  769. .BR charon.plugins.eap-radius.id_prefix " []"
  770. Prefix to EAP\-Identity, some AAA servers use a IMSI prefix to select the EAP
  771. method.
  772. .TP
  773. .BR charon.plugins.eap-radius.nas_identifier " [strongSwan]"
  774. NAS\-Identifier to include in RADIUS messages.
  775. .TP
  776. .BR charon.plugins.eap-radius.port " [1812]"
  777. Port of RADIUS server (authentication).
  778. .TP
  779. .BR charon.plugins.eap-radius.retransmit_base " [1.4]"
  780. Base to use for calculating exponential back off.
  781. .TP
  782. .BR charon.plugins.eap-radius.retransmit_timeout " [2.0]"
  783. Timeout in seconds before sending first retransmit.
  784. .TP
  785. .BR charon.plugins.eap-radius.retransmit_tries " [4]"
  786. Number of times to retransmit a packet before giving up.
  787. .TP
  788. .BR charon.plugins.eap-radius.secret " []"
  789. Shared secret between RADIUS and NAS. If set, make sure to adjust the
  790. permissions of the config file accordingly.
  791. .TP
  792. .BR charon.plugins.eap-radius.server " []"
  793. IP/Hostname of RADIUS server.
  794. .TP
  795. .B charon.plugins.eap-radius.servers
  796. .br
  797. Section to specify multiple RADIUS servers. The
  798. .RB "" "nas_identifier" ","
  799. .RB "" "secret" ","
  800. .RB "" "sockets" ""
  801. and
  802. .RB "" "port" ""
  803. (or
  804. .RB "" "auth_port" ")"
  805. options can be specified for each
  806. server. A server's IP/Hostname can be configured using the
  807. .RB "" "address" ""
  808. option.
  809. The
  810. .RB "" "acct_port" ""
  811. [1813] option can be used to specify the port used for RADIUS
  812. accounting. For each RADIUS server a priority can be specified using the
  813. .RB "" "preference" ""
  814. [0] option. The retransmission time for each server can set set
  815. using
  816. .RB "" "retransmit_base" ","
  817. .RB "" "retransmit_timeout" ""
  818. and
  819. .RB "" "retransmit_tries" "."
  820. .TP
  821. .BR charon.plugins.eap-radius.sockets " [1]"
  822. Number of sockets (ports) to use, increase for high load.
  823. .TP
  824. .BR charon.plugins.eap-radius.station_id_with_port " [yes]"
  825. Whether to include the UDP port in the Called\- and Calling\-Station\-Id RADIUS
  826. attributes.
  827. .TP
  828. .B charon.plugins.eap-radius.xauth
  829. .br
  830. Section to configure multiple XAuth authentication rounds via RADIUS. The
  831. subsections define so called authentication profiles with arbitrary names. In
  832. each profile section one or more XAuth types can be configured, with an assigned
  833. message. For each type a separate XAuth exchange will be initiated and all
  834. replies get concatenated into the User\-Password attribute, which then gets
  835. verified over RADIUS.
  836. Available XAuth types are
  837. .RB "" "password" ","
  838. .RB "" "passcode" ","
  839. .RB "" "nextpin" ","
  840. and
  841. .RB "" "answer" "."
  842. This type is not relevant to strongSwan or the AAA server, but the
  843. client may show a different dialog (along with the configured message).
  844. To use the configured profiles, they have to be configured in the respective
  845. connection in
  846. .RB "" "ipsec.conf" "(5)"
  847. by appending the profile name, separated by a
  848. colon, to the
  849. .RB "" "xauth\-radius" ""
  850. XAauth backend configuration in
  851. .RI "" "rightauth" ""
  852. or
  853. .RI "" "rightauth2" ","
  854. for instance,
  855. .RI "" "rightauth2=xauth\-radius:profile" "."
  856. .TP
  857. .BR charon.plugins.eap-sim.request_identity " [yes]"
  858. .TP
  859. .BR charon.plugins.eap-simaka-sql.database " []"
  860. .TP
  861. .BR charon.plugins.eap-simaka-sql.remove_used " [no]"
  862. .TP
  863. .BR charon.plugins.eap-tls.fragment_size " [1024]"
  864. Maximum size of an EAP\-TLS packet.
  865. .TP
  866. .BR charon.plugins.eap-tls.include_length " [yes]"
  867. Include length in non\-fragmented EAP\-TLS packets.
  868. .TP
  869. .BR charon.plugins.eap-tls.max_message_count " [32]"
  870. Maximum number of processed EAP\-TLS packets (0 = no limit).
  871. .TP
  872. .BR charon.plugins.eap-tnc.max_message_count " [10]"
  873. Maximum number of processed EAP\-TNC packets (0 = no limit).
  874. .TP
  875. .BR charon.plugins.eap-tnc.protocol " [tnccs-2.0]"
  876. IF\-TNCCS protocol version to be used
  877. .RI "(" "tnccs\-1.1" ","
  878. .RI "" "tnccs\-2.0" ","
  879. .RI "" "tnccs\-dynamic" ")."
  880. .TP
  881. .BR charon.plugins.eap-ttls.fragment_size " [1024]"
  882. Maximum size of an EAP\-TTLS packet.
  883. .TP
  884. .BR charon.plugins.eap-ttls.include_length " [yes]"
  885. Include length in non\-fragmented EAP\-TTLS packets.
  886. .TP
  887. .BR charon.plugins.eap-ttls.max_message_count " [32]"
  888. Maximum number of processed EAP\-TTLS packets (0 = no limit).
  889. .TP
  890. .BR charon.plugins.eap-ttls.phase2_method " [md5]"
  891. Phase2 EAP client authentication method.
  892. .TP
  893. .BR charon.plugins.eap-ttls.phase2_piggyback " [no]"
  894. Phase2 EAP Identity request piggybacked by server onto TLS Finished message.
  895. .TP
  896. .BR charon.plugins.eap-ttls.phase2_tnc " [no]"
  897. Start phase2 EAP TNC protocol after successful client authentication.
  898. .TP
  899. .BR charon.plugins.eap-ttls.phase2_tnc_method " [pt]"
  900. Phase2 EAP TNC transport protocol
  901. .RI "(" "pt" ""
  902. as IETF standard or legacy
  903. .RI "" "tnc" ")"
  904. .TP
  905. .BR charon.plugins.eap-ttls.request_peer_auth " [no]"
  906. Request peer authentication based on a client certificate.
  907. .TP
  908. .BR charon.plugins.error-notify.socket " [unix://${piddir}/charon.enfy]"
  909. Socket provided by the error\-notify plugin.
  910. .TP
  911. .BR charon.plugins.ext-auth.script " []"
  912. Command to pass to the system shell for peer authorization. Authorization is
  913. considered successful if the command executes normally with an exit code of
  914. zero. For all other exit codes IKE_SA authorization is rejected.
  915. The following environment variables get passed to the script:
  916. .RI "" "IKE_UNIQUE_ID" ":"
  917. The IKE_SA numerical unique identifier.
  918. .RI "" "IKE_NAME" ":"
  919. The peer configuration
  920. connection name.
  921. .RI "" "IKE_LOCAL_HOST" ":"
  922. Local IKE IP address.
  923. .RI "" "IKE_REMOTE_HOST" ":"
  924. Remote IKE IP address.
  925. .RI "" "IKE_LOCAL_ID" ":"
  926. Local IKE identity.
  927. .RI "" "IKE_REMOTE_ID" ":"
  928. Remote IKE identity.
  929. .RI "" "IKE_REMOTE_EAP_ID" ":"
  930. Remote EAP or XAuth identity, if used.
  931. .TP
  932. .BR charon.plugins.forecast.groups " [224.0.0.1,224.0.0.22,224.0.0.251,224.0.0.252,239.255.255.250]"
  933. Comma separated list of multicast groups to join locally. The local host
  934. receives and forwards packets in the local LAN for joined multicast groups only.
  935. Packets matching the list of multicast groups get forwarded to connected
  936. clients. The default group includes host multicasts, IGMP, mDNS, LLMNR and
  937. SSDP/WS\-Discovery, and is usually a good choice for Windows clients.
  938. .TP
  939. .BR charon.plugins.forecast.interface " []"
  940. Name of the local interface to listen for broadcasts messages to forward. If no
  941. interface is configured, the first usable interface is used, which is usually
  942. just fine for single\-homed hosts. If your host has multiple interfaces, set this
  943. option to the local LAN interface you want to forward broadcasts from/to.
  944. .TP
  945. .BR charon.plugins.forecast.reinject " []"
  946. Comma separated list of CHILD_SA configuration names for which to perform
  947. multi/broadcast reinjection. For clients connecting over such a configuration,
  948. any multi/broadcast received over the tunnel gets reinjected to all active
  949. tunnels. This makes the broadcasts visible to other peers, and for examples
  950. allows clients to see others shares. If disabled, multi/broadcast messages
  951. received over a tunnel are injected to the local network only, but not to other
  952. IPsec clients.
  953. .TP
  954. .BR charon.plugins.gcrypt.quick_random " [no]"
  955. Use faster random numbers in gcrypt; for testing only, produces weak keys!
  956. .TP
  957. .BR charon.plugins.ha.autobalance " [0]"
  958. Interval in seconds to automatically balance handled segments between nodes. Set
  959. to 0 to disable.
  960. .TP
  961. .BR charon.plugins.ha.fifo_interface " [yes]"
  962. .TP
  963. .BR charon.plugins.ha.heartbeat_delay " [1000]"
  964. .TP
  965. .BR charon.plugins.ha.heartbeat_timeout " [2100]"
  966. .TP
  967. .BR charon.plugins.ha.local " []"
  968. .TP
  969. .BR charon.plugins.ha.monitor " [yes]"
  970. .TP
  971. .BR charon.plugins.ha.pools " []"
  972. .TP
  973. .BR charon.plugins.ha.remote " []"
  974. .TP
  975. .BR charon.plugins.ha.resync " [yes]"
  976. .TP
  977. .BR charon.plugins.ha.secret " []"
  978. .TP
  979. .BR charon.plugins.ha.segment_count " [1]"
  980. .TP
  981. .BR charon.plugins.ipseckey.enable " [no]"
  982. Enable fetching of IPSECKEY RRs via DNS.
  983. .TP
  984. .BR charon.plugins.kernel-libipsec.allow_peer_ts " [no]"
  985. Allow that the remote traffic selector equals the IKE peer. The route installed
  986. for such traffic (via TUN device) usually prevents further IKE traffic. The
  987. fwmark options for the
  988. .RI "" "kernel\-netlink" ""
  989. and
  990. .RI "" "socket\-default" ""
  991. plugins can be used
  992. to circumvent that problem.
  993. .TP
  994. .BR charon.plugins.kernel-netlink.buflen " [<min(PAGE_SIZE, 8192)>]"
  995. Buffer size for received Netlink messages.
  996. .TP
  997. .BR charon.plugins.kernel-netlink.force_receive_buffer_size " [no]"
  998. If the maximum Netlink socket receive buffer in bytes set by
  999. .RI "" "receive_buffer_size" ""
  1000. exceeds the system\-wide maximum from
  1001. /proc/sys/net/core/rmem_max, this option can be used to override the limit.
  1002. Enabling this option requires special privileges (CAP_NET_ADMIN).
  1003. .TP
  1004. .BR charon.plugins.kernel-netlink.fwmark " []"
  1005. Firewall mark to set on the routing rule that directs traffic to our routing
  1006. table. The format is [!]mark[/mask], where the optional exclamation mark inverts
  1007. the meaning (i.e. the rule only applies to packets that don't match the mark).
  1008. .TP
  1009. .BR charon.plugins.kernel-netlink.ignore_retransmit_errors " [no]"
  1010. Whether to ignore errors potentially resulting from a retransmission.
  1011. .TP
  1012. .BR charon.plugins.kernel-netlink.mss " [0]"
  1013. MSS to set on installed routes, 0 to disable.
  1014. .TP
  1015. .BR charon.plugins.kernel-netlink.mtu " [0]"
  1016. MTU to set on installed routes, 0 to disable.
  1017. .TP
  1018. .BR charon.plugins.kernel-netlink.parallel_route " [no]"
  1019. Whether to perform concurrent Netlink ROUTE queries on a single socket. While
  1020. parallel queries can improve throughput, it has more overhead. On vanilla Linux,
  1021. DUMP queries fail with EBUSY and must be retried, further decreasing
  1022. performance.
  1023. .TP
  1024. .BR charon.plugins.kernel-netlink.parallel_xfrm " [no]"
  1025. Whether to perform concurrent Netlink XFRM queries on a single socket.
  1026. .TP
  1027. .BR charon.plugins.kernel-netlink.policy_update " [no]"
  1028. Whether to always use XFRM_MSG_UPDPOLICY to install policies.
  1029. .TP
  1030. .BR charon.plugins.kernel-netlink.port_bypass " [no]"
  1031. Whether to use port or socket based IKE XFRM bypass policies. IKE bypass
  1032. policies are used to exempt IKE traffic from XFRM processing. The default socket
  1033. based policies are directly tied to the IKE UDP sockets, port based policies use
  1034. global XFRM bypass policies for the used IKE UDP ports.
  1035. .TP
  1036. .BR charon.plugins.kernel-netlink.process_rules " [no]"
  1037. Whether to process changes in routing rules to trigger roam events. This is
  1038. currently only useful if the kernel based route lookup is used (i.e. if route
  1039. installation is disabled or an inverted fwmark match is configured).
  1040. .TP
  1041. .BR charon.plugins.kernel-netlink.receive_buffer_size " [0]"
  1042. Maximum Netlink socket receive buffer in bytes. This value controls how many
  1043. bytes of Netlink messages can be received on a Netlink socket. The default value
  1044. is set by /proc/sys/net/core/rmem_default. The specified value cannot exceed the
  1045. system\-wide maximum from /proc/sys/net/core/rmem_max, unless
  1046. .RI "" "force_receive_buffer_size" ""
  1047. is enabled.
  1048. .TP
  1049. .BR charon.plugins.kernel-netlink.retries " [0]"
  1050. Number of Netlink message retransmissions to send on timeout.
  1051. .TP
  1052. .BR charon.plugins.kernel-netlink.roam_events " [yes]"
  1053. Whether to trigger roam events when interfaces, addresses or routes change.
  1054. .TP
  1055. .BR charon.plugins.kernel-netlink.set_proto_port_transport_sa " [no]"
  1056. Whether to set protocol and ports in the selector installed on transport mode
  1057. IPsec SAs in the kernel. While doing so enforces policies for inbound traffic,
  1058. it also prevents the use of a single IPsec SA by more than one traffic selector.
  1059. .TP
  1060. .B charon.plugins.kernel-netlink.spdh_thresh
  1061. .br
  1062. XFRM policy hashing threshold configuration for IPv4 and IPv6.
  1063. The section defines hashing thresholds to configure in the kernel during daemon
  1064. startup. Each address family takes a threshold for the local subnet of an IPsec
  1065. policy (src in out\-policies, dst in in\- and forward\-policies) and the remote
  1066. subnet (dst in out\-policies, src in in\- and forward\-policies).
  1067. If the subnet has more or equal net bits than the threshold, the first threshold
  1068. bits are used to calculate a hash to lookup the policy.
  1069. Policy hashing thresholds are not supported before Linux 3.18 and might conflict
  1070. with socket policies before Linux 4.8.
  1071. .TP
  1072. .BR charon.plugins.kernel-netlink.spdh_thresh.ipv4.lbits " [32]"
  1073. Local subnet XFRM policy hashing threshold for IPv4.
  1074. .TP
  1075. .BR charon.plugins.kernel-netlink.spdh_thresh.ipv4.rbits " [32]"
  1076. Remote subnet XFRM policy hashing threshold for IPv4.
  1077. .TP
  1078. .BR charon.plugins.kernel-netlink.spdh_thresh.ipv6.lbits " [128]"
  1079. Local subnet XFRM policy hashing threshold for IPv6.
  1080. .TP
  1081. .BR charon.plugins.kernel-netlink.spdh_thresh.ipv6.rbits " [128]"
  1082. Remote subnet XFRM policy hashing threshold for IPv6.
  1083. .TP
  1084. .BR charon.plugins.kernel-netlink.timeout " [0]"
  1085. Netlink message retransmission timeout, 0 to disable retransmissions.
  1086. .TP
  1087. .BR charon.plugins.kernel-netlink.xfrm_acq_expires " [165]"
  1088. Lifetime of XFRM acquire state created by the kernel when traffic matches a trap
  1089. policy. The value gets written to /proc/sys/net/core/xfrm_acq_expires.
  1090. Indirectly controls the delay between XFRM acquire messages triggered by the
  1091. kernel for a trap policy. The same value is used as timeout for SPIs allocated
  1092. by the kernel. The default value equals the total retransmission timeout for
  1093. IKE messages, see IKEv2 RETRANSMISSION in
  1094. .RB "" "strongswan.conf" "(5)."
  1095. .TP
  1096. .BR charon.plugins.kernel-pfkey.events_buffer_size " [0]"
  1097. Size of the receive buffer for the event socket (0 for default size). Because
  1098. events are received asynchronously installing e.g. lots of policies may require
  1099. a larger buffer than the default on certain platforms in order to receive all
  1100. messages.
  1101. .TP
  1102. .BR charon.plugins.kernel-pfkey.route_via_internal " [no]"
  1103. Whether to use the internal or external interface in installed routes. The
  1104. internal interface is the one where the IP address contained in the local
  1105. traffic selector is located, the external interface is the one over which the
  1106. destination address of the IPsec tunnel can be reached. This is not relevant if
  1107. virtual IPs are used, for which a TUN device is created that's used in the
  1108. routes.
  1109. .TP
  1110. .BR charon.plugins.kernel-pfroute.vip_wait " [1000]"
  1111. Time in ms to wait until virtual IP addresses appear/disappear before failing.
  1112. .TP
  1113. .BR charon.plugins.led.activity_led " []"
  1114. .TP
  1115. .BR charon.plugins.led.blink_time " [50]"
  1116. .TP
  1117. .B charon.plugins.load-tester
  1118. .br
  1119. Section to configure the load\-tester plugin, see LOAD TESTS in
  1120. .RB "" "strongswan.conf" "(5)"
  1121. for details.
  1122. .TP
  1123. .B charon.plugins.load-tester.addrs
  1124. .br
  1125. Section that contains key/value pairs with address pools (in CIDR notation) to
  1126. use for a specific network interface e.g. eth0 = 10.10.0.0/16.
  1127. .TP
  1128. .BR charon.plugins.load-tester.addrs_keep " [no]"
  1129. Whether to keep dynamic addresses even after the associated SA got terminated.
  1130. .TP
  1131. .BR charon.plugins.load-tester.addrs_prefix " [16]"
  1132. Network prefix length to use when installing dynamic addresses. If set to \-1 the
  1133. full address is used (i.e. 32 or 128).
  1134. .TP
  1135. .BR charon.plugins.load-tester.ca_dir " []"
  1136. Directory to load (intermediate) CA certificates from.
  1137. .TP
  1138. .BR charon.plugins.load-tester.child_rekey " [600]"
  1139. Seconds to start CHILD_SA rekeying after setup.
  1140. .TP
  1141. .BR charon.plugins.load-tester.crl " []"
  1142. URI to a CRL to include as certificate distribution point in generated
  1143. certificates.
  1144. .TP
  1145. .BR charon.plugins.load-tester.delay " [0]"
  1146. Delay between initiatons for each thread.
  1147. .TP
  1148. .BR charon.plugins.load-tester.delete_after_established " [no]"
  1149. Delete an IKE_SA as soon as it has been established.
  1150. .TP
  1151. .BR charon.plugins.load-tester.digest " [sha1]"
  1152. Digest algorithm used when issuing certificates.
  1153. .TP
  1154. .BR charon.plugins.load-tester.dpd_delay " [0]"
  1155. DPD delay to use in load test.
  1156. .TP
  1157. .BR charon.plugins.load-tester.dynamic_port " [0]"
  1158. Base port to be used for requests (each client uses a different port).
  1159. .TP
  1160. .BR charon.plugins.load-tester.eap_password " [default-pwd]"
  1161. EAP secret to use in load test.
  1162. .TP
  1163. .BR charon.plugins.load-tester.enable " [no]"
  1164. Enable the load testing plugin.
  1165. .RB "" "WARNING" ":"
  1166. Never enable this plugin on
  1167. productive systems. It provides preconfigured credentials and allows an attacker
  1168. to authenticate as any user.
  1169. .TP
  1170. .BR charon.plugins.load-tester.esp " [aes128-sha1]"
  1171. CHILD_SA proposal to use for load tests.
  1172. .TP
  1173. .BR charon.plugins.load-tester.fake_kernel " [no]"
  1174. Fake the kernel interface to allow load\-testing against self.
  1175. .TP
  1176. .BR charon.plugins.load-tester.ike_rekey " [0]"
  1177. Seconds to start IKE_SA rekeying after setup.
  1178. .TP
  1179. .BR charon.plugins.load-tester.init_limit " [0]"
  1180. Global limit of concurrently established SAs during load test.
  1181. .TP
  1182. .BR charon.plugins.load-tester.initiator " [0.0.0.0]"
  1183. Address to initiate from.
  1184. .TP
  1185. .BR charon.plugins.load-tester.initiator_auth " [pubkey]"
  1186. Authentication method(s) the intiator uses.
  1187. .TP
  1188. .BR charon.plugins.load-tester.initiator_id " []"
  1189. Initiator ID used in load test.
  1190. .TP
  1191. .BR charon.plugins.load-tester.initiator_match " []"
  1192. Initiator ID to match against as responder.
  1193. .TP
  1194. .BR charon.plugins.load-tester.initiator_tsi " []"
  1195. Traffic selector on initiator side, as proposed by initiator.
  1196. .TP
  1197. .BR charon.plugins.load-tester.initiator_tsr " []"
  1198. Traffic selector on responder side, as proposed by initiator.
  1199. .TP
  1200. .BR charon.plugins.load-tester.initiators " [0]"
  1201. Number of concurrent initiator threads to use in load test.
  1202. .TP
  1203. .BR charon.plugins.load-tester.issuer_cert " []"
  1204. Path to the issuer certificate (if not configured a hard\-coded default value is
  1205. used).
  1206. .TP
  1207. .BR charon.plugins.load-tester.issuer_key " []"
  1208. Path to private key that is used to issue certificates (if not configured a
  1209. hard\-coded default value is used).
  1210. .TP
  1211. .BR charon.plugins.load-tester.iterations " [1]"
  1212. Number of IKE_SAs to initiate by each initiator in load test.
  1213. .TP
  1214. .BR charon.plugins.load-tester.mode " [tunnel]"
  1215. IPsec mode to use, one of
  1216. .RI "" "tunnel" ","
  1217. .RI "" "transport" ","
  1218. or
  1219. .RI "" "beet" "."
  1220. .TP
  1221. .BR charon.plugins.load-tester.pool " []"
  1222. Provide INTERNAL_IPV4_ADDRs from a named pool.
  1223. .TP
  1224. .BR charon.plugins.load-tester.preshared_key " [<default-psk>]"
  1225. Preshared key to use in load test.
  1226. .TP
  1227. .BR charon.plugins.load-tester.proposal " [aes128-sha1-modp768]"
  1228. IKE proposal to use in load test.
  1229. .TP
  1230. .BR charon.plugins.load-tester.request_virtual_ip " [no]"
  1231. Request an INTERNAL_IPV4_ADDR from the server.
  1232. .TP
  1233. .BR charon.plugins.load-tester.responder " [127.0.0.1]"
  1234. Address to initiation connections to.
  1235. .TP
  1236. .BR charon.plugins.load-tester.responder_auth " [pubkey]"
  1237. Authentication method(s) the responder uses.
  1238. .TP
  1239. .BR charon.plugins.load-tester.responder_id " []"
  1240. Responder ID used in load test.
  1241. .TP
  1242. .BR charon.plugins.load-tester.responder_tsi " [initiator_tsi]"
  1243. Traffic selector on initiator side, as narrowed by responder.
  1244. .TP
  1245. .BR charon.plugins.load-tester.responder_tsr " [initiator_tsr]"
  1246. Traffic selector on responder side, as narrowed by responder.
  1247. .TP
  1248. .BR charon.plugins.load-tester.shutdown_when_complete " [no]"
  1249. Shutdown the daemon after all IKE_SAs have been established.
  1250. .TP
  1251. .BR charon.plugins.load-tester.socket " [unix://${piddir}/charon.ldt]"
  1252. Socket provided by the load\-tester plugin.
  1253. .TP
  1254. .BR charon.plugins.load-tester.version " [0]"
  1255. IKE version to use (0 means use IKEv2 as initiator and accept any version as
  1256. responder).
  1257. .TP
  1258. .BR charon.plugins.lookip.socket " [unix://${piddir}/charon.lkp]"
  1259. Socket provided by the lookip plugin.
  1260. .TP
  1261. .BR charon.plugins.ntru.max_drbg_requests " [4294967294]"
  1262. Number of pseudo\-random bit requests from the DRBG before an automatic reseeding
  1263. occurs.
  1264. .TP
  1265. .BR charon.plugins.ntru.parameter_set " [optimum]"
  1266. The following parameter sets are available:
  1267. .RB "" "x9_98_speed" ","
  1268. .RB "" "x9_98_bandwidth" ","
  1269. .RB "" "x9_98_balance" ""
  1270. and
  1271. .RB "" "optimum" ","
  1272. the last set not being
  1273. part of the X9.98 standard but having the best performance.
  1274. .TP
  1275. .BR charon.plugins.openssl.engine_id " [pkcs11]"
  1276. ENGINE ID to use in the OpenSSL plugin.
  1277. .TP
  1278. .BR charon.plugins.openssl.fips_mode " [0]"
  1279. Set OpenSSL FIPS mode: disabled(0), enabled(1), Suite B enabled(2).
  1280. .TP
  1281. .BR charon.plugins.osx-attr.append " [yes]"
  1282. Whether DNS servers are appended to existing entries, instead of replacing them.
  1283. .TP
  1284. .B charon.plugins.p-cscf.enable
  1285. .br
  1286. Section to enable requesting P\-CSCF server addresses for individual connections.
  1287. .TP
  1288. .BR charon.plugins.p-cscf.enable.<conn> " [no]"
  1289. <conn> is the name of a connection with an ePDG from which to request P\-CSCF
  1290. server addresses. Requests will be sent for addresses of the same families for
  1291. which internal IPs are requested.
  1292. .TP
  1293. .B charon.plugins.pkcs11.modules
  1294. .br
  1295. List of available PKCS#11 modules.
  1296. .TP
  1297. .BR charon.plugins.pkcs11.modules.<name>.load_certs " [yes]"
  1298. Whether to automatically load certificates from tokens.
  1299. .TP
  1300. .BR charon.plugins.pkcs11.modules.<name>.os_locking " [no]"
  1301. Whether OS locking should be enabled for this module.
  1302. .TP
  1303. .BR charon.plugins.pkcs11.modules.<name>.path " []"
  1304. Full path to the shared object file of this PKCS#11 module.
  1305. .TP
  1306. .BR charon.plugins.pkcs11.reload_certs " [no]"
  1307. Reload certificates from all tokens if charon receives a SIGHUP.
  1308. .TP
  1309. .BR charon.plugins.pkcs11.use_dh " [no]"
  1310. Whether the PKCS#11 modules should be used for DH and ECDH (see
  1311. .RI "" "use_ecc" ""
  1312. option).
  1313. .TP
  1314. .BR charon.plugins.pkcs11.use_ecc " [no]"
  1315. Whether the PKCS#11 modules should be used for ECDH and ECDSA public key
  1316. operations. ECDSA private keys can be used regardless of this option.
  1317. .TP
  1318. .BR charon.plugins.pkcs11.use_hasher " [no]"
  1319. Whether the PKCS#11 modules should be used to hash data.
  1320. .TP
  1321. .BR charon.plugins.pkcs11.use_pubkey " [no]"
  1322. Whether the PKCS#11 modules should be used for public key operations, even for
  1323. keys not stored on tokens.
  1324. .TP
  1325. .BR charon.plugins.pkcs11.use_rng " [no]"
  1326. Whether the PKCS#11 modules should be used as RNG.
  1327. .TP
  1328. .BR charon.plugins.radattr.dir " []"
  1329. Directory where RADIUS attributes are stored in client\-ID specific files.
  1330. .TP
  1331. .BR charon.plugins.radattr.message_id " [-1]"
  1332. Attributes are added to all IKE_AUTH messages by default (\-1), or only to the
  1333. IKE_AUTH message with the given IKEv2 message ID.
  1334. .TP
  1335. .BR charon.plugins.random.random " [${random_device}]"
  1336. File to read random bytes from.
  1337. .TP
  1338. .BR charon.plugins.random.strong_equals_true " [no]"
  1339. If set to yes the RNG_STRONG class reads random bytes from the same source as
  1340. the RNG_TRUE class.
  1341. .TP
  1342. .BR charon.plugins.random.urandom " [${urandom_device}]"
  1343. File to read pseudo random bytes from.
  1344. .TP
  1345. .BR charon.plugins.resolve.file " [/etc/resolv.conf]"
  1346. File where to add DNS server entries.
  1347. .TP
  1348. .BR charon.plugins.resolve.resolvconf.iface_prefix " [lo.inet.ipsec.]"
  1349. Prefix used for interface names sent to
  1350. .RB "" "resolvconf" "(8)."
  1351. The nameserver
  1352. address is appended to this prefix to make it unique. The result has to be a
  1353. valid interface name according to the rules defined by resolvconf. Also, it
  1354. should have a high priority according to the order defined in
  1355. .RB "" "interface\-order" "(5)."
  1356. .TP
  1357. .BR charon.plugins.revocation.enable_crl " [yes]"
  1358. Whether CRL validation should be enabled.
  1359. .TP
  1360. .BR charon.plugins.revocation.enable_ocsp " [yes]"
  1361. Whether OCSP validation should be enabled.
  1362. .TP
  1363. .BR charon.plugins.save-keys.esp " [no]"
  1364. Whether to save ESP keys.
  1365. .TP
  1366. .BR charon.plugins.save-keys.ike " [no]"
  1367. Whether to save IKE keys.
  1368. .TP
  1369. .BR charon.plugins.save-keys.load " [no]"
  1370. Whether to load the plugin.
  1371. .TP
  1372. .BR charon.plugins.save-keys.wireshark_keys " []"
  1373. Directory where the keys are stored in the format supported by Wireshark. IKEv1
  1374. keys are stored in the
  1375. .RI "" "ikev1_decryption_table" ""
  1376. file. IKEv2 keys are stored in
  1377. the
  1378. .RI "" "ikev2_decryption_table" ""
  1379. file. Keys for ESP CHILD_SAs are stored in the
  1380. .RI "" "esp_sa" ""
  1381. file.
  1382. .TP
  1383. .BR charon.plugins.socket-default.fwmark " []"
  1384. Firewall mark to set on outbound packets.
  1385. .TP
  1386. .BR charon.plugins.socket-default.set_source " [yes]"
  1387. Set source address on outbound packets, if possible.
  1388. .TP
  1389. .BR charon.plugins.socket-default.set_sourceif " [no]"
  1390. Force sending interface on outbound packets, if possible. This allows using IPv6
  1391. link\-local addresses as tunnel endpoints.
  1392. .TP
  1393. .BR charon.plugins.socket-default.use_ipv4 " [yes]"
  1394. Listen on IPv4, if possible.
  1395. .TP
  1396. .BR charon.plugins.socket-default.use_ipv6 " [yes]"
  1397. Listen on IPv6, if possible.
  1398. .TP
  1399. .BR charon.plugins.sql.database " []"
  1400. Database URI for charon's SQL plugin. If it contains a password, make sure to
  1401. adjust the permissions of the config file accordingly.
  1402. .TP
  1403. .BR charon.plugins.sql.loglevel " [-1]"
  1404. Loglevel for logging to SQL database.
  1405. .TP
  1406. .BR charon.plugins.stroke.allow_swap " [yes]"
  1407. Analyze addresses/hostnames in
  1408. .RI "" "left|right" ""
  1409. to detect which side is local and
  1410. swap configuration options if necessary. If disabled
  1411. .RI "" "left" ""
  1412. is always
  1413. .RI "" "local" "."
  1414. .TP
  1415. .BR charon.plugins.stroke.ignore_missing_ca_basic_constraint " [no]"
  1416. Treat certificates in ipsec.d/cacerts and ipsec.conf ca sections as CA
  1417. certificates even if they don't contain a CA basic constraint.
  1418. .TP
  1419. .BR charon.plugins.stroke.max_concurrent " [4]"
  1420. Maximum number of stroke messages handled concurrently.
  1421. .TP
  1422. .BR charon.plugins.stroke.prevent_loglevel_changes " [no]"
  1423. If enabled log level changes via stroke socket are not allowed.
  1424. .TP
  1425. .BR charon.plugins.stroke.secrets_file " [${sysconfdir}/ipsec.secrets]"
  1426. Location of the ipsec.secrets file
  1427. .TP
  1428. .BR charon.plugins.stroke.socket " [unix://${piddir}/charon.ctl]"
  1429. Socket provided by the stroke plugin.
  1430. .TP
  1431. .BR charon.plugins.stroke.timeout " [0]"
  1432. Timeout in ms for any stroke command. Use 0 to disable the timeout.
  1433. .TP
  1434. .BR charon.plugins.systime-fix.interval " [0]"
  1435. Interval in seconds to check system time for validity. 0 disables the check.
  1436. .TP
  1437. .BR charon.plugins.systime-fix.reauth " [no]"
  1438. Whether to use reauth or delete if an invalid cert lifetime is detected.
  1439. .TP
  1440. .BR charon.plugins.systime-fix.threshold " []"
  1441. Threshold date where system time is considered valid. Disabled if not specified.
  1442. .TP
  1443. .BR charon.plugins.systime-fix.threshold_format " [%Y]"
  1444. .RB "" "strptime" "(3)"
  1445. format used to parse threshold option.
  1446. .TP
  1447. .BR charon.plugins.systime-fix.timeout " [0s]"
  1448. How long to wait for a valid system time if an interval is configured. 0 to
  1449. recheck indefinitely.
  1450. .TP
  1451. .BR charon.plugins.tnc-ifmap.client_cert " []"
  1452. Path to X.509 certificate file of IF\-MAP client.
  1453. .TP
  1454. .BR charon.plugins.tnc-ifmap.client_key " []"
  1455. Path to private key file of IF\-MAP client.
  1456. .TP
  1457. .BR charon.plugins.tnc-ifmap.device_name " []"
  1458. Unique name of strongSwan server as a PEP and/or PDP device.
  1459. .TP
  1460. .BR charon.plugins.tnc-ifmap.renew_session_interval " [150]"
  1461. Interval in seconds between periodic IF\-MAP RenewSession requests.
  1462. .TP
  1463. .BR charon.plugins.tnc-ifmap.server_cert " []"
  1464. Path to X.509 certificate file of IF\-MAP server.
  1465. .TP
  1466. .BR charon.plugins.tnc-ifmap.server_uri " [https://localhost:8444/imap]"
  1467. URI of the form [https://]servername[:port][/path].
  1468. .TP
  1469. .BR charon.plugins.tnc-ifmap.username_password " []"
  1470. Credentials of IF\-MAP client of the form username:password. If set, make sure to
  1471. adjust the permissions of the config file accordingly.
  1472. .TP
  1473. .BR charon.plugins.tnc-imc.dlclose " [yes]"
  1474. Unload IMC after use.
  1475. .TP
  1476. .BR charon.plugins.tnc-imc.preferred_language " [en]"
  1477. Preferred language for TNC recommendations.
  1478. .TP
  1479. .BR charon.plugins.tnc-imv.dlclose " [yes]"
  1480. Unload IMV after use.
  1481. .TP
  1482. .BR charon.plugins.tnc-imv.recommendation_policy " [default]"
  1483. TNC recommendation policy, one of
  1484. .RI "" "default" ","
  1485. .RI "" "any" ","
  1486. or
  1487. .RI "" "all" "."
  1488. .TP
  1489. .BR charon.plugins.tnc-pdp.pt_tls.enable " [yes]"
  1490. Enable PT\-TLS protocol on the strongSwan PDP.
  1491. .TP
  1492. .BR charon.plugins.tnc-pdp.pt_tls.port " [271]"
  1493. PT\-TLS server port the strongSwan PDP is listening on.
  1494. .TP
  1495. .BR charon.plugins.tnc-pdp.radius.enable " [yes]"
  1496. Enable RADIUS protocol on the strongSwan PDP.
  1497. .TP
  1498. .BR charon.plugins.tnc-pdp.radius.method " [ttls]"
  1499. EAP tunnel method to be used.
  1500. .TP
  1501. .BR charon.plugins.tnc-pdp.radius.port " [1812]"
  1502. RADIUS server port the strongSwan PDP is listening on.
  1503. .TP
  1504. .BR charon.plugins.tnc-pdp.radius.secret " []"
  1505. Shared RADIUS secret between strongSwan PDP and NAS. If set, make sure to adjust
  1506. the permissions of the config file accordingly.
  1507. .TP
  1508. .BR charon.plugins.tnc-pdp.server " []"
  1509. Name of the strongSwan PDP as contained in the AAA certificate.
  1510. .TP
  1511. .BR charon.plugins.tnc-pdp.timeout " []"
  1512. Timeout in seconds before closing incomplete connections.
  1513. .TP
  1514. .BR charon.plugins.tnccs-11.max_message_size " [45000]"
  1515. Maximum size of a PA\-TNC message (XML & Base64 encoding).
  1516. .TP
  1517. .BR charon.plugins.tnccs-20.max_batch_size " [65522]"
  1518. Maximum size of a PB\-TNC batch (upper limit via PT\-EAP = 65529).
  1519. .TP
  1520. .BR charon.plugins.tnccs-20.max_message_size " [65490]"
  1521. Maximum size of a PA\-TNC message (upper limit via PT\-EAP = 65497).
  1522. .TP
  1523. .BR charon.plugins.tnccs-20.mutual " [no]"
  1524. Enable PB\-TNC mutual protocol.
  1525. .TP
  1526. .BR charon.plugins.tnccs-20.tests.pb_tnc_noskip " [no]"
  1527. Send an unsupported PB\-TNC message type with the NOSKIP flag set.
  1528. .TP
  1529. .BR charon.plugins.tnccs-20.tests.pb_tnc_version " [2]"
  1530. Send a PB\-TNC batch with a modified PB\-TNC version.
  1531. .TP
  1532. .BR charon.plugins.tpm.fips_186_4 " [no]"
  1533. Is the TPM 2.0 FIPS\-186\-4 compliant, forcing e.g. the use of the default salt
  1534. length instead of maximum salt length with RSAPSS padding.
  1535. .TP
  1536. .BR charon.plugins.tpm.tcti.name " [device|tabrmd]"
  1537. Name of TPM 2.0 TCTI library. Valid values:
  1538. .RI "" "tabrmd" ","
  1539. .RI "" "device" ""
  1540. or
  1541. .RI "" "mssim" "."
  1542. Defaults are
  1543. .RI "" "device" ""
  1544. if the
  1545. .RI "" "/dev/tpmrm0" ""
  1546. in\-kernel TPM 2.0 resource manager
  1547. device exists, and
  1548. .RI "" "tabrmd" ""
  1549. otherwise, requiring the d\-bus based TPM 2.0 access
  1550. broker and resource manager to be available.
  1551. .TP
  1552. .BR charon.plugins.tpm.tcti.opts " [/dev/tpmrm0|<none>]"
  1553. Options for the TPM 2.0 TCTI library. Defaults are
  1554. .RI "" "/dev/tpmrm0" ""
  1555. if the TCTI
  1556. library name is
  1557. .RI "" "device" ""
  1558. and no options otherwise.
  1559. .TP
  1560. .BR charon.plugins.tpm.use_rng " [no]"
  1561. Whether the TPM should be used as RNG.
  1562. .TP
  1563. .BR charon.plugins.unbound.dlv_anchors " []"
  1564. File to read trusted keys for DLV (DNSSEC Lookaside Validation) from. It uses
  1565. the same format as
  1566. .RI "" "trust_anchors" "."
  1567. Only one DLV can be configured, which is
  1568. then used as a root trusted DLV, this means that it is a lookaside for the root.
  1569. .TP
  1570. .BR charon.plugins.unbound.resolv_conf " [/etc/resolv.conf]"
  1571. File to read DNS resolver configuration from.
  1572. .TP
  1573. .BR charon.plugins.unbound.trust_anchors " [/etc/ipsec.d/dnssec.keys]"
  1574. File to read DNSSEC trust anchors from (usually root zone KSK). The format of
  1575. the file is the standard DNS Zone file format, anchors can be stored as DS or
  1576. DNSKEY entries in the file.
  1577. .TP
  1578. .BR charon.plugins.updown.dns_handler " [no]"
  1579. Whether the updown script should handle DNS servers assigned via IKEv1 Mode
  1580. Config or IKEv2 Config Payloads (if enabled they can't be handled by other
  1581. plugins, like resolve)
  1582. .TP
  1583. .BR charon.plugins.vici.socket " [unix://${piddir}/charon.vici]"
  1584. Socket the vici plugin serves clients.
  1585. .TP
  1586. .BR charon.plugins.whitelist.enable " [yes]"
  1587. Enable loaded whitelist plugin.
  1588. .TP
  1589. .BR charon.plugins.whitelist.socket " [unix://${piddir}/charon.wlst]"
  1590. Socket provided by the whitelist plugin.
  1591. .TP
  1592. .BR charon.plugins.wolfssl.fips_mode " [no]"
  1593. Enable to prevent loading the plugin if wolfSSL is not in FIPS mode.
  1594. .TP
  1595. .BR charon.plugins.xauth-eap.backend " [radius]"
  1596. EAP plugin to be used as backend for XAuth credential verification.
  1597. .TP
  1598. .BR charon.plugins.xauth-pam.pam_service " [login]"
  1599. PAM service to be used for authentication.
  1600. .TP
  1601. .BR charon.plugins.xauth-pam.session " [no]"
  1602. Open/close a PAM session for each active IKE_SA.
  1603. .TP
  1604. .BR charon.plugins.xauth-pam.trim_email " [yes]"
  1605. If an email address is received as an XAuth username, trim it to just the
  1606. username part.
  1607. .TP
  1608. .BR charon.port " [500]"
  1609. UDP port used locally. If set to 0 a random port will be allocated.
  1610. .TP
  1611. .BR charon.port_nat_t " [4500]"
  1612. UDP port used locally in case of NAT\-T. If set to 0 a random port will be
  1613. allocated. Has to be different from
  1614. .RB "" "charon.port" ","
  1615. otherwise a random port
  1616. will be allocated.
  1617. .TP
  1618. .BR charon.prefer_best_path " [no]"
  1619. By default, charon keeps SAs on the routing path with addresses it previously
  1620. used if that path is still usable. By setting this option to yes, it tries more
  1621. aggressively to update SAs with MOBIKE on routing priority changes using the
  1622. cheapest path. This adds more noise, but allows to dynamically adapt SAs to
  1623. routing priority changes. This option has no effect if MOBIKE is not supported
  1624. or disabled.
  1625. .TP
  1626. .BR charon.prefer_configured_proposals " [yes]"
  1627. Prefer locally configured proposals for IKE/IPsec over supplied ones as
  1628. responder (disabling this can avoid keying retries due to INVALID_KE_PAYLOAD
  1629. notifies).
  1630. .TP
  1631. .BR charon.prefer_temporary_addrs " [no]"
  1632. By default public IPv6 addresses are preferred over temporary ones (RFC 4941),
  1633. to make connections more stable. Enable this option to reverse this.
  1634. .TP
  1635. .BR charon.process_route " [yes]"
  1636. Process RTM_NEWROUTE and RTM_DELROUTE events.
  1637. .TP
  1638. .B charon.processor.priority_threads
  1639. .br
  1640. Section to configure the number of reserved threads per priority class see JOB
  1641. PRIORITY MANAGEMENT in
  1642. .RB "" "strongswan.conf" "(5)."
  1643. .TP
  1644. .BR charon.rdn_matching " [strict]"
  1645. How RDNs in subject DNs of certificates are matched against configured
  1646. identities. Possible values are
  1647. .RI "" "strict" ""
  1648. (the default),
  1649. .RI "" "reordered" ","
  1650. and
  1651. .RI "" "relaxed" "."
  1652. With
  1653. .RI "" "strict" ""
  1654. the number, type and order of all RDNs has to match,
  1655. wildcards (*) for the values of RDNs are allowed (that's the case for all three
  1656. variants). Using
  1657. .RI "" "reordered" ""
  1658. also matches DNs if the RDNs appear in a different
  1659. order, the number and type still has to match. Finally,
  1660. .RI "" "relaxed" ""
  1661. also allows
  1662. matches of DNs that contain more RDNs than the configured identity (missing RDNs
  1663. are treated like a wildcard match).
  1664. Note that
  1665. .RI "" "reordered" ""
  1666. and
  1667. .RI "" "relaxed" ""
  1668. impose a considerable overhead on memory
  1669. usage and runtime, in particular, for mismatches, compared to
  1670. .RI "" "strict" "."
  1671. .TP
  1672. .BR charon.receive_delay " [0]"
  1673. Delay in ms for receiving packets, to simulate larger RTT.
  1674. .TP
  1675. .BR charon.receive_delay_request " [yes]"
  1676. Delay request messages.
  1677. .TP
  1678. .BR charon.receive_delay_response " [yes]"
  1679. Delay response messages.
  1680. .TP
  1681. .BR charon.receive_delay_type " [0]"
  1682. Specific IKEv2 message type to delay, 0 for any.
  1683. .TP
  1684. .BR charon.replay_window " [32]"
  1685. Size of the AH/ESP replay window, in packets.
  1686. .TP
  1687. .BR charon.retransmit_base " [1.8]"
  1688. Base to use for calculating exponential back off, see IKEv2 RETRANSMISSION in
  1689. .RB "" "strongswan.conf" "(5)."
  1690. .TP
  1691. .BR charon.retransmit_jitter " [0]"
  1692. Maximum jitter in percent to apply randomly to calculated retransmission timeout
  1693. (0 to disable).
  1694. .TP
  1695. .BR charon.retransmit_limit " [0]"
  1696. Upper limit in seconds for calculated retransmission timeout (0 to disable).
  1697. .TP
  1698. .BR charon.retransmit_timeout " [4.0]"
  1699. Timeout in seconds before sending first retransmit.
  1700. .TP
  1701. .BR charon.retransmit_tries " [5]"
  1702. Number of times to retransmit a packet before giving up.
  1703. .TP
  1704. .BR charon.retry_initiate_interval " [0]"
  1705. Interval in seconds to use when retrying to initiate an IKE_SA (e.g. if DNS
  1706. resolution failed), 0 to disable retries.
  1707. .TP
  1708. .BR charon.reuse_ikesa " [yes]"
  1709. Initiate CHILD_SA within existing IKE_SAs (always enabled for IKEv1).
  1710. .TP
  1711. .BR charon.routing_table " []"
  1712. Numerical routing table to install routes to.
  1713. .TP
  1714. .BR charon.routing_table_prio " []"
  1715. Priority of the routing table.
  1716. .TP
  1717. .BR charon.rsa_pss " [no]"
  1718. Whether to use RSA with PSS padding instead of PKCS#1 padding by default.
  1719. .TP
  1720. .BR charon.send_delay " [0]"
  1721. Delay in ms for sending packets, to simulate larger RTT.
  1722. .TP
  1723. .BR charon.send_delay_request " [yes]"
  1724. Delay request messages.
  1725. .TP
  1726. .BR charon.send_delay_response " [yes]"
  1727. Delay response messages.
  1728. .TP
  1729. .BR charon.send_delay_type " [0]"
  1730. Specific IKEv2 message type to delay, 0 for any.
  1731. .TP
  1732. .BR charon.send_vendor_id " [no]"
  1733. Send strongSwan vendor ID payload
  1734. .TP
  1735. .BR charon.signature_authentication " [yes]"
  1736. Whether to enable Signature Authentication as per RFC 7427.
  1737. .TP
  1738. .BR charon.signature_authentication_constraints " [yes]"
  1739. If enabled, signature schemes configured in
  1740. .RI "" "rightauth" ","
  1741. in addition to getting
  1742. used as constraints against signature schemes employed in the certificate chain,
  1743. are also used as constraints against the signature scheme used by peers during
  1744. IKEv2.
  1745. .TP
  1746. .BR charon.spi_label " [0x0000000000000000]"
  1747. Value mixed into the local IKE SPIs after applying
  1748. .RI "" "spi_mask" "."
  1749. .TP
  1750. .BR charon.spi_mask " [0x0000000000000000]"
  1751. Mask applied to local IKE SPIs before mixing in
  1752. .RI "" "spi_label" ""
  1753. (bits set will be
  1754. replaced with
  1755. .RI "" "spi_label" ")."
  1756. .TP
  1757. .BR charon.spi_max " [0xcfffffff]"
  1758. The upper limit for SPIs requested from the kernel for IPsec SAs.
  1759. .TP
  1760. .BR charon.spi_min " [0xc0000000]"
  1761. The lower limit for SPIs requested from the kernel for IPsec SAs. Should not be
  1762. set lower than 0x00000100 (256), as SPIs between 1 and 255 are reserved by IANA.
  1763. .TP
  1764. .B charon.start-scripts
  1765. .br
  1766. Section containing a list of scripts (name = path) that are executed when the
  1767. daemon is started.
  1768. .TP
  1769. .B charon.stop-scripts
  1770. .br
  1771. Section containing a list of scripts (name = path) that are executed when the
  1772. daemon is terminated.
  1773. .TP
  1774. .B charon.syslog
  1775. .br
  1776. Section to define syslog loggers, see LOGGER CONFIGURATION in
  1777. .RB "" "strongswan.conf" "(5)."
  1778. .TP
  1779. .B charon.syslog.<facility>
  1780. .br
  1781. <facility> is one of the supported syslog facilities, see LOGGER CONFIGURATION
  1782. in
  1783. .RB "" "strongswan.conf" "(5)."
  1784. .TP
  1785. .BR charon.syslog.<facility>.<subsystem> " [<default>]"
  1786. Loglevel for a specific subsystem.
  1787. .TP
  1788. .BR charon.syslog.<facility>.default " [1]"
  1789. Specifies the default loglevel to be used for subsystems for which no specific
  1790. loglevel is defined.
  1791. .TP
  1792. .BR charon.syslog.<facility>.ike_name " [no]"
  1793. Prefix each log entry with the connection name and a unique numerical identifier
  1794. for each IKE_SA.
  1795. .TP
  1796. .BR charon.syslog.identifier " []"
  1797. Global identifier used for an
  1798. .RB "" "openlog" "(3)"
  1799. call, prepended to each log message
  1800. by syslog. If not configured,
  1801. .RB "" "openlog" "(3)"
  1802. is not called, so the value will
  1803. depend on system defaults (often the program name).
  1804. .TP
  1805. .BR charon.threads " [16]"
  1806. Number of worker threads in charon. Several of these are reserved for long
  1807. running tasks in internal modules and plugins. Therefore, make sure you don't
  1808. set this value too low. The number of idle worker threads listed in
  1809. .RI "" "ipsec statusall" ""
  1810. might be used as indicator on the number of reserved threads.
  1811. .TP
  1812. .BR charon.tls.cipher " []"
  1813. List of TLS encryption ciphers.
  1814. .TP
  1815. .BR charon.tls.key_exchange " []"
  1816. List of TLS key exchange methods.
  1817. .TP
  1818. .BR charon.tls.mac " []"
  1819. List of TLS MAC algorithms.
  1820. .TP
  1821. .BR charon.tls.suites " []"
  1822. List of TLS cipher suites.
  1823. .TP
  1824. .BR charon.tnc.tnc_config " [/etc/tnc_config]"
  1825. TNC IMC/IMV configuration file.
  1826. .TP
  1827. .BR charon.user " []"
  1828. Name of the user the daemon changes to after startup.
  1829. .TP
  1830. .BR charon.x509.enforce_critical " [yes]"
  1831. Discard certificates with unsupported or unknown critical extensions.
  1832. .TP
  1833. .BR charon-nm.ca_dir " [<default>]"
  1834. Directory from which to load CA certificates if no certificate is configured.
  1835. .TP
  1836. .B charon-systemd.journal
  1837. .br
  1838. Section to configure native systemd journal logger, very similar to the syslog
  1839. logger as described in LOGGER CONFIGURATION in
  1840. .RB "" "strongswan.conf" "(5)."
  1841. .TP
  1842. .BR charon-systemd.journal.<subsystem> " [<default>]"
  1843. Loglevel for a specific subsystem.
  1844. .TP
  1845. .BR charon-systemd.journal.default " [1]"
  1846. Specifies the default loglevel to be used for subsystems for which no specific
  1847. loglevel is defined.
  1848. .TP
  1849. .BR imv_policy_manager.command_allow " []"
  1850. Shell command to be executed with recommendation allow.
  1851. .TP
  1852. .BR imv_policy_manager.command_block " []"
  1853. Shell command to be executed with all other recommendations.
  1854. .TP
  1855. .BR imv_policy_manager.database " []"
  1856. Database URI for the database that stores the package information. If it
  1857. contains a password, make sure to adjust the permissions of the config file
  1858. accordingly.
  1859. .TP
  1860. .BR imv_policy_manager.load " [sqlite]"
  1861. Plugins to load in IMV policy manager.
  1862. .TP
  1863. .BR libimcv.debug_level " [1]"
  1864. Debug level for a stand\-alone
  1865. .RI "" "libimcv" ""
  1866. library.
  1867. .TP
  1868. .BR libimcv.load " [random nonce gmp pubkey x509]"
  1869. Plugins to load in IMC/IMVs with stand\-alone
  1870. .RI "" "libimcv" ""
  1871. library.
  1872. .TP
  1873. .BR libimcv.plugins.imc-attestation.aik_blob " []"
  1874. AIK encrypted private key blob file.
  1875. .TP
  1876. .BR libimcv.plugins.imc-attestation.aik_cert " []"
  1877. AIK certificate file.
  1878. .TP
  1879. .BR libimcv.plugins.imc-attestation.aik_handle " []"
  1880. AIK object handle.
  1881. .TP
  1882. .BR libimcv.plugins.imc-attestation.aik_pubkey " []"
  1883. AIK public key file.
  1884. .TP
  1885. .BR libimcv.plugins.imc-attestation.mandatory_dh_groups " [yes]"
  1886. Enforce mandatory Diffie\-Hellman groups.
  1887. .TP
  1888. .BR libimcv.plugins.imc-attestation.nonce_len " [20]"
  1889. DH nonce length.
  1890. .TP
  1891. .BR libimcv.plugins.imc-attestation.pcr17_after " []"
  1892. PCR17 value after measurement.
  1893. .TP
  1894. .BR libimcv.plugins.imc-attestation.pcr17_before " []"
  1895. PCR17 value before measurement.
  1896. .TP
  1897. .BR libimcv.plugins.imc-attestation.pcr17_meas " []"
  1898. Dummy measurement value extended into PCR17 if the TBOOT log is not available.
  1899. .TP
  1900. .BR libimcv.plugins.imc-attestation.pcr18_after " []"
  1901. PCR18 value after measurement.
  1902. .TP
  1903. .BR libimcv.plugins.imc-attestation.pcr18_before " []"
  1904. PCR18 value before measurement.
  1905. .TP
  1906. .BR libimcv.plugins.imc-attestation.pcr18_meas " []"
  1907. Dummy measurement value extended into PCR17 if the TBOOT log is not available.
  1908. .TP
  1909. .BR libimcv.plugins.imc-attestation.pcr_info " [no]"
  1910. Whether to send pcr_before and pcr_after info.
  1911. .TP
  1912. .BR libimcv.plugins.imc-attestation.use_quote2 " [yes]"
  1913. Use Quote2 AIK signature instead of Quote signature.
  1914. .TP
  1915. .BR libimcv.plugins.imc-attestation.use_version_info " [no]"
  1916. Version Info is included in Quote2 signature.
  1917. .TP
  1918. .BR libimcv.plugins.imc-hcd.push_info " [yes]"
  1919. Send quadruple info without being prompted.
  1920. .TP
  1921. .BR libimcv.plugins.imc-hcd.subtypes " []"
  1922. Section to define PWG HCD PA subtypes.
  1923. .TP
  1924. .BR libimcv.plugins.imc-hcd.subtypes.<section> " []"
  1925. Defines a PWG HCD PA subtype section. Recognized subtype section names are
  1926. .RI "" "system" ","
  1927. .RI "" "control" ","
  1928. .RI "" "marker" ","
  1929. .RI "" "finisher" ","
  1930. .RI "" "interface" ""
  1931. and
  1932. .RI "" "scanner" "."
  1933. .TP
  1934. .BR libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type> " []"
  1935. Defines a software type section. Recognized software type section names are
  1936. .RI "" "firmware" ","
  1937. .RI "" "resident_application" ""
  1938. and
  1939. .RI "" "user_application" "."
  1940. .TP
  1941. .BR libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software> " []"
  1942. Defines a software section having an arbitrary name.
  1943. .TP
  1944. .BR libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.name " []"
  1945. Name of the software installed on the hardcopy device.
  1946. .TP
  1947. .BR libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.patches " []"
  1948. String describing all patches applied to the given software on this hardcopy
  1949. device. The individual patches are separated by a newline character '\\n'.
  1950. .TP
  1951. .BR libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.string_version " []"
  1952. String describing the version of the given software on this hardcopy device.
  1953. .TP
  1954. .BR libimcv.plugins.imc-hcd.subtypes.<section>.<sw_type>.<software>.version " []"
  1955. Hex\-encoded version string with a length of 16 octets consisting of the fields
  1956. major version number (4 octets), minor version number (4 octets), build number
  1957. (4 octets), service pack major number (2 octets) and service pack minor number
  1958. (2 octets).
  1959. .TP
  1960. .BR libimcv.plugins.imc-hcd.subtypes.<section>.attributes_natural_language " [en]"
  1961. Variable length natural language tag conforming to RFC 5646 specifies the
  1962. language to be used in the health assessment message of a given subtype.
  1963. .TP
  1964. .BR libimcv.plugins.imc-hcd.subtypes.system.certification_state " []"
  1965. Hex\-encoded certification state.
  1966. .TP
  1967. .BR libimcv.plugins.imc-hcd.subtypes.system.configuration_state " []"
  1968. Hex\-encoded configuration state.
  1969. .TP
  1970. .BR libimcv.plugins.imc-hcd.subtypes.system.machine_type_model " []"
  1971. String specifying the machine type and model of the hardcopy device.
  1972. .TP
  1973. .BR libimcv.plugins.imc-hcd.subtypes.system.pstn_fax_enabled " [no]"
  1974. Specifies if a PSTN facsimile interface is installed and enabled on the hardcopy
  1975. device.
  1976. .TP
  1977. .BR libimcv.plugins.imc-hcd.subtypes.system.time_source " []"
  1978. String specifying the hostname of the network time server used by the hardcopy
  1979. device.
  1980. .TP
  1981. .BR libimcv.plugins.imc-hcd.subtypes.system.user_application_enabled " [no]"
  1982. Specifies if users can dynamically download and execute applications on the
  1983. hardcopy device.
  1984. .TP
  1985. .BR libimcv.plugins.imc-hcd.subtypes.system.user_application_persistence_enabled " [no]"
  1986. Specifies if user dynamically downloaded applications can persist outside the
  1987. boundaries of a single job on the hardcopy device.
  1988. .TP
  1989. .BR libimcv.plugins.imc-hcd.subtypes.system.vendor_name " []"
  1990. String specifying the manufacturer of the hardcopy device.
  1991. .TP
  1992. .BR libimcv.plugins.imc-hcd.subtypes.system.vendor_smi_code " []"
  1993. Integer specifying the globally unique 24\-bit SMI code assigned to the
  1994. manufacturer of the hardcopy device.
  1995. .TP
  1996. .BR libimcv.plugins.imc-os.device_cert " []"
  1997. Manually set the path to the client device certificate (e.g.
  1998. /etc/pts/aikCert.der)
  1999. .TP
  2000. .BR libimcv.plugins.imc-os.device_handle " []"
  2001. Manually set handle to a private key bound to a smartcard or TPM (e.g.
  2002. 0x81010004)
  2003. .TP
  2004. .BR libimcv.plugins.imc-os.device_id " []"
  2005. Manually set the client device ID in hexadecimal format (e.g.
  2006. 1083f03988c9762703b1c1080c2e46f72b99cc31)
  2007. .TP
  2008. .BR libimcv.plugins.imc-os.device_pubkey " []"
  2009. Manually set the path to the client device public key (e.g. /etc/pts/aikPub.der)
  2010. .TP
  2011. .BR libimcv.plugins.imc-os.push_info " [yes]"
  2012. Send operating system info without being prompted.
  2013. .TP
  2014. .BR libimcv.plugins.imc-scanner.push_info " [yes]"
  2015. Send open listening ports without being prompted.
  2016. .TP
  2017. .BR libimcv.plugins.imc-swima.eid_epoch " [0x11223344]"
  2018. Set 32 bit epoch value for event IDs manually if software collector database is
  2019. not available.
  2020. .TP
  2021. .BR libimcv.plugins.imc-swima.subscriptions " [no]"
  2022. Accept SW Inventory or SW Events subscriptions.
  2023. .TP
  2024. .BR libimcv.plugins.imc-swima.swid_database " []"
  2025. URI to software collector database containing event timestamps, software
  2026. creation and deletion events and collected software identifiers. If it contains
  2027. a password, make sure to adjust the permissions of the config file accordingly.
  2028. .TP
  2029. .BR libimcv.plugins.imc-swima.swid_directory " [${prefix}/share]"
  2030. Directory where SWID tags are located.
  2031. .TP
  2032. .BR libimcv.plugins.imc-swima.swid_full " [no]"
  2033. Include file information in the XML\-encoded SWID tags.
  2034. .TP
  2035. .BR libimcv.plugins.imc-swima.swid_pretty " [no]"
  2036. Generate XML\-encoded SWID tags with pretty indentation.
  2037. .TP
  2038. .BR libimcv.plugins.imc-test.additional_ids " [0]"
  2039. Number of additional IMC IDs.
  2040. .TP
  2041. .BR libimcv.plugins.imc-test.command " [none]"
  2042. Command to be sent to the Test IMV.
  2043. .TP
  2044. .BR libimcv.plugins.imc-test.dummy_size " [0]"
  2045. Size of dummy attribute to be sent to the Test IMV (0 = disabled).
  2046. .TP
  2047. .BR libimcv.plugins.imc-test.retry " [no]"
  2048. Do a handshake retry.
  2049. .TP
  2050. .BR libimcv.plugins.imc-test.retry_command " []"
  2051. Command to be sent to the Test IMV in the handshake retry.
  2052. .TP
  2053. .BR libimcv.plugins.imv-attestation.cadir " []"
  2054. Path to directory with AIK cacerts.
  2055. .TP
  2056. .BR libimcv.plugins.imv-attestation.dh_group " [ecp256]"
  2057. Preferred Diffie\-Hellman group.
  2058. .TP
  2059. .BR libimcv.plugins.imv-attestation.hash_algorithm " [sha256]"
  2060. Preferred measurement hash algorithm.
  2061. .TP
  2062. .BR libimcv.plugins.imv-attestation.mandatory_dh_groups " [yes]"
  2063. Enforce mandatory Diffie\-Hellman groups.
  2064. .TP
  2065. .BR libimcv.plugins.imv-attestation.min_nonce_len " [0]"
  2066. DH minimum nonce length.
  2067. .TP
  2068. .BR libimcv.plugins.imv-os.remediation_uri " []"
  2069. URI pointing to operating system remediation instructions.
  2070. .TP
  2071. .BR libimcv.plugins.imv-scanner.remediation_uri " []"
  2072. URI pointing to scanner remediation instructions.
  2073. .TP
  2074. .BR libimcv.plugins.imv-swima.rest_api.timeout " [120]"
  2075. Timeout of SWID REST API HTTP POST transaction.
  2076. .TP
  2077. .BR libimcv.plugins.imv-swima.rest_api.uri " []"
  2078. HTTP URI of the SWID REST API.
  2079. .TP
  2080. .BR libimcv.plugins.imv-test.rounds " [0]"
  2081. Number of IMC\-IMV retry rounds.
  2082. .TP
  2083. .BR libimcv.stderr_quiet " [no]"
  2084. Disable output to stderr with a stand\-alone
  2085. .RI "" "libimcv" ""
  2086. library.
  2087. .TP
  2088. .BR libimcv.swid_gen.command " [/usr/local/bin/swid_generator]"
  2089. SWID generator command to be executed.
  2090. .TP
  2091. .BR libimcv.swid_gen.tag_creator.name " [strongSwan Project]"
  2092. Name of the tagCreator entity.
  2093. .TP
  2094. .BR libimcv.swid_gen.tag_creator.regid " [strongswan.org]"
  2095. regid of the tagCreator entity.
  2096. .TP
  2097. .BR manager.database " []"
  2098. Credential database URI for manager. If it contains a password, make sure to
  2099. adjust the permissions of the config file accordingly.
  2100. .TP
  2101. .BR manager.debug " [no]"
  2102. Enable debugging in manager.
  2103. .TP
  2104. .BR manager.load " []"
  2105. Plugins to load in manager.
  2106. .TP
  2107. .BR manager.socket " []"
  2108. FastCGI socket of manager, to run it statically.
  2109. .TP
  2110. .BR manager.threads " [10]"
  2111. Threads to use for request handling.
  2112. .TP
  2113. .BR manager.timeout " [15m]"
  2114. Session timeout for manager.
  2115. .TP
  2116. .BR medsrv.database " []"
  2117. Mediation server database URI. If it contains a password, make sure to adjust
  2118. the permissions of the config file accordingly.
  2119. .TP
  2120. .BR medsrv.debug " [no]"
  2121. Debugging in mediation server web application.
  2122. .TP
  2123. .BR medsrv.dpd " [5m]"
  2124. DPD timeout to use in mediation server plugin.
  2125. .TP
  2126. .BR medsrv.load " []"
  2127. Plugins to load in mediation server plugin.
  2128. .TP
  2129. .BR medsrv.password_length " [6]"
  2130. Minimum password length required for mediation server user accounts.
  2131. .TP
  2132. .BR medsrv.rekey " [20m]"
  2133. Rekeying time on mediation connections in mediation server plugin.
  2134. .TP
  2135. .BR medsrv.socket " []"
  2136. Run Mediation server web application statically on socket.
  2137. .TP
  2138. .BR medsrv.threads " [5]"
  2139. Number of thread for mediation service web application.
  2140. .TP
  2141. .BR medsrv.timeout " [15m]"
  2142. Session timeout for mediation service.
  2143. .TP
  2144. .BR pki.load " []"
  2145. Plugins to load in ipsec pki tool.
  2146. .TP
  2147. .BR pool.database " []"
  2148. Database URI for the database that stores IP pools and configuration attributes.
  2149. If it contains a password, make sure to adjust the permissions of the
  2150. config file accordingly.
  2151. .TP
  2152. .BR pool.load " []"
  2153. Plugins to load in ipsec pool tool.
  2154. .TP
  2155. .BR scepclient.load " []"
  2156. Plugins to load in ipsec scepclient tool.
  2157. .TP
  2158. .B sec-updater
  2159. .br
  2160. Options for the sec\-updater tool.
  2161. .TP
  2162. .BR sec-updater.database " []"
  2163. Global IMV policy database URI. If it contains a password, make sure to adjust
  2164. the permissions of the config file accordingly.
  2165. .TP
  2166. .BR sec-updater.load " []"
  2167. Plugins to load in sec\-updater tool.
  2168. .TP
  2169. .BR sec-updater.swid_gen.command " [/usr/local/bin/swid_generator]"
  2170. SWID generator command to be executed.
  2171. .TP
  2172. .BR sec-updater.swid_gen.tag_creator.name " [strongSwan Project]"
  2173. Name of the tagCreator entity.
  2174. .TP
  2175. .BR sec-updater.swid_gen.tag_creator.regid " [strongswan.org]"
  2176. regid of the tagCreator entity.
  2177. .TP
  2178. .BR sec-updater.tmp.deb_file " [/tmp/sec-updater.deb]"
  2179. Temporary storage for downloaded deb package file.
  2180. .TP
  2181. .BR sec-updater.tmp.tag_file " [/tmp/sec-updater.tag]"
  2182. Temporary storage for generated SWID tags.
  2183. .TP
  2184. .BR sec-updater.tnc_manage_command " [/var/www/tnc/manage.py]"
  2185. strongTNC manage.py command used to import SWID tags.
  2186. .TP
  2187. .BR starter.config_file " [${sysconfdir}/ipsec.conf]"
  2188. Location of the ipsec.conf file
  2189. .TP
  2190. .BR starter.load_warning " [yes]"
  2191. Disable charon plugin load option warning.
  2192. .TP
  2193. .B sw-collector
  2194. .br
  2195. Options for the sw\-collector tool.
  2196. .TP
  2197. .BR sw-collector.database " []"
  2198. URI to software collector database containing event timestamps, software
  2199. creation and deletion events and collected software identifiers. If it contains
  2200. a password, make sure to adjust the permissions of the config file accordingly.
  2201. .TP
  2202. .BR sw-collector.first_file " [/var/log/bootstrap.log]"
  2203. Path pointing to file created when the Linux OS was installed.
  2204. .TP
  2205. .BR sw-collector.first_time " [0000-00-00T00:00:00Z]"
  2206. Time in UTC when the Linux OS was installed.
  2207. .TP
  2208. .BR sw-collector.history " []"
  2209. Path pointing to apt history.log file.
  2210. .TP
  2211. .BR sw-collector.load " []"
  2212. Plugins to load in sw\-collector tool.
  2213. .TP
  2214. .BR sw-collector.rest_api.timeout " [120]"
  2215. Timeout of REST API HTTP POST transaction.
  2216. .TP
  2217. .BR sw-collector.rest_api.uri " []"
  2218. HTTP URI of the central collector's REST API.
  2219. .TP
  2220. .BR swanctl.load " []"
  2221. Plugins to load in swanctl.
  2222. .TP
  2223. .BR swanctl.socket " [unix://${piddir}/charon.vici]"
  2224. VICI socket to connect to by default.
  2225. .SH LOGGER CONFIGURATION
  2226. Options in
  2227. .BR strongswan.conf (5)
  2228. provide a much more flexible way to configure loggers for the IKE daemon charon
  2229. than using the
  2230. .B charondebug
  2231. option in
  2232. .BR ipsec.conf (5).
  2233. .PP
  2234. .BR Note :
  2235. If any loggers are specified in strongswan.conf,
  2236. .B charondebug
  2237. does not have any effect.
  2238. .PP
  2239. There are currently two types of loggers:
  2240. .TP
  2241. .B File loggers
  2242. Log directly to a file and are defined by specifying an arbitrarily named
  2243. subsection in the
  2244. .B charon.filelog
  2245. section. The full path to the file is configured in the \fIpath\fR setting of
  2246. that subsection, however, if it only contains characters permitted in section
  2247. names, the setting may also be omitted and the path specified as name of the
  2248. subsection. To log to the console the two special filenames
  2249. .BR stdout " and " stderr
  2250. may be used.
  2251. .TP
  2252. .B Syslog loggers
  2253. Log into a syslog facility and are defined by specifying the facility to log to
  2254. as the name of a subsection in the
  2255. .B charon.syslog
  2256. section. The following facilities are currently supported:
  2257. .BR daemon " and " auth .
  2258. .PP
  2259. Multiple loggers can be defined for each type with different log verbosity for
  2260. the different subsystems of the daemon.
  2261. .SS Subsystems
  2262. .TP
  2263. .B dmn
  2264. Main daemon setup/cleanup/signal handling
  2265. .TP
  2266. .B mgr
  2267. IKE_SA manager, handling synchronization for IKE_SA access
  2268. .TP
  2269. .B ike
  2270. IKE_SA
  2271. .TP
  2272. .B chd
  2273. CHILD_SA
  2274. .TP
  2275. .B job
  2276. Jobs queueing/processing and thread pool management
  2277. .TP
  2278. .B cfg
  2279. Configuration management and plugins
  2280. .TP
  2281. .B knl
  2282. IPsec/Networking kernel interface
  2283. .TP
  2284. .B net
  2285. IKE network communication
  2286. .TP
  2287. .B asn
  2288. Low-level encoding/decoding (ASN.1, X.509 etc.)
  2289. .TP
  2290. .B enc
  2291. Packet encoding/decoding encryption/decryption operations
  2292. .TP
  2293. .B tls
  2294. libtls library messages
  2295. .TP
  2296. .B esp
  2297. libipsec library messages
  2298. .TP
  2299. .B lib
  2300. libstrongwan library messages
  2301. .TP
  2302. .B tnc
  2303. Trusted Network Connect
  2304. .TP
  2305. .B imc
  2306. Integrity Measurement Collector
  2307. .TP
  2308. .B imv
  2309. Integrity Measurement Verifier
  2310. .TP
  2311. .B pts
  2312. Platform Trust Service
  2313. .SS Loglevels
  2314. .TP
  2315. .B -1
  2316. Absolutely silent
  2317. .TP
  2318. .B 0
  2319. Very basic auditing logs, (e.g. SA up/SA down)
  2320. .TP
  2321. .B 1
  2322. Generic control flow with errors, a good default to see what's going on
  2323. .TP
  2324. .B 2
  2325. More detailed debugging control flow
  2326. .TP
  2327. .B 3
  2328. Including RAW data dumps in Hex
  2329. .TP
  2330. .B 4
  2331. Also include sensitive material in dumps, e.g. keys
  2332. .SS Example
  2333. .PP
  2334. .EX
  2335. charon {
  2336. filelog {
  2337. charon {
  2338. path = /var/log/charon.log
  2339. time_format = %b %e %T
  2340. append = no
  2341. default = 1
  2342. }
  2343. stderr {
  2344. ike = 2
  2345. knl = 3
  2346. ike_name = yes
  2347. }
  2348. }
  2349. syslog {
  2350. # enable logging to LOG_DAEMON, use defaults
  2351. daemon {
  2352. }
  2353. # minimalistic IKE auditing logging to LOG_AUTHPRIV
  2354. auth {
  2355. default = -1
  2356. ike = 0
  2357. }
  2358. }
  2359. }
  2360. .EE
  2361. .SH JOB PRIORITY MANAGEMENT
  2362. Some operations in the IKEv2 daemon charon are currently implemented
  2363. synchronously and blocking. Two examples for such operations are communication
  2364. with a RADIUS server via EAP-RADIUS, or fetching CRL/OCSP information during
  2365. certificate chain verification. Under high load conditions, the thread pool may
  2366. run out of available threads, and some more important jobs, such as liveness
  2367. checking, may not get executed in time.
  2368. .PP
  2369. To prevent thread starvation in such situations job priorities were introduced.
  2370. The job processor will reserve some threads for higher priority jobs, these
  2371. threads are not available for lower priority, locking jobs.
  2372. .SS Implementation
  2373. Currently 4 priorities have been defined, and they are used in charon as
  2374. follows:
  2375. .TP
  2376. .B CRITICAL
  2377. Priority for long-running dispatcher jobs.
  2378. .TP
  2379. .B HIGH
  2380. INFORMATIONAL exchanges, as used by liveness checking (DPD).
  2381. .TP
  2382. .B MEDIUM
  2383. Everything not HIGH/LOW, including IKE_SA_INIT processing.
  2384. .TP
  2385. .B LOW
  2386. IKE_AUTH message processing. RADIUS and CRL fetching block here
  2387. .PP
  2388. Although IKE_SA_INIT processing is computationally expensive, it is explicitly
  2389. assigned to the MEDIUM class. This allows charon to do the DH exchange while
  2390. other threads are blocked in IKE_AUTH. To prevent the daemon from accepting more
  2391. IKE_SA_INIT requests than it can handle, use IKE_SA_INIT DROPPING.
  2392. .PP
  2393. The thread pool processes jobs strictly by priority, meaning it will consume all
  2394. higher priority jobs before looking for ones with lower priority. Further, it
  2395. reserves threads for certain priorities. A priority class having reserved
  2396. .I n
  2397. threads will always have
  2398. .I n
  2399. threads available for this class (either currently processing a job, or waiting
  2400. for one).
  2401. .SS Configuration
  2402. To ensure that there are always enough threads available for higher priority
  2403. tasks, threads must be reserved for each priority class.
  2404. .TP
  2405. .BR charon.processor.priority_threads.critical " [0]"
  2406. Threads reserved for CRITICAL priority class jobs
  2407. .TP
  2408. .BR charon.processor.priority_threads.high " [0]"
  2409. Threads reserved for HIGH priority class jobs
  2410. .TP
  2411. .BR charon.processor.priority_threads.medium " [0]"
  2412. Threads reserved for MEDIUM priority class jobs
  2413. .TP
  2414. .BR charon.processor.priority_threads.low " [0]"
  2415. Threads reserved for LOW priority class jobs
  2416. .PP
  2417. Let's consider the following configuration:
  2418. .PP
  2419. .EX
  2420. charon {
  2421. processor {
  2422. priority_threads {
  2423. high = 1
  2424. medium = 4
  2425. }
  2426. }
  2427. }
  2428. .EE
  2429. .PP
  2430. With this configuration, one thread is reserved for HIGH priority tasks. As
  2431. currently only liveness checking and stroke message processing is done with
  2432. high priority, one or two threads should be sufficient.
  2433. .PP
  2434. The MEDIUM class mostly processes non-blocking jobs. Unless your setup is
  2435. experiencing many blocks in locks while accessing shared resources, threads for
  2436. one or two times the number of CPU cores is fine.
  2437. .PP
  2438. It is usually not required to reserve threads for CRITICAL jobs. Jobs in this
  2439. class rarely return and do not release their thread to the pool.
  2440. .PP
  2441. The remaining threads are available for LOW priority jobs. Reserving threads
  2442. does not make sense (until we have an even lower priority).
  2443. .SS Monitoring
  2444. To see what the threads are actually doing, invoke
  2445. .IR "ipsec statusall" .
  2446. Under high load, something like this will show up:
  2447. .PP
  2448. .EX
  2449. worker threads: 2 or 32 idle, 5/1/2/22 working,
  2450. job queue: 0/0/1/149, scheduled: 198
  2451. .EE
  2452. .PP
  2453. From 32 worker threads,
  2454. .IP 2
  2455. are currently idle.
  2456. .IP 5
  2457. are running CRITICAL priority jobs (dispatching from sockets, etc.).
  2458. .IP 1
  2459. is currently handling a HIGH priority job. This is actually the thread currently
  2460. providing this information via stroke.
  2461. .IP 2
  2462. are handling MEDIUM priority jobs, likely IKE_SA_INIT or CREATE_CHILD_SA
  2463. messages.
  2464. .IP 22
  2465. are handling LOW priority jobs, probably waiting for an EAP-RADIUS response
  2466. while processing IKE_AUTH messages.
  2467. .PP
  2468. The job queue load shows how many jobs are queued for each priority, ready for
  2469. execution. The single MEDIUM priority job will get executed immediately, as
  2470. we have two spare threads reserved for MEDIUM class jobs.
  2471. .SH IKE_SA_INIT DROPPING
  2472. If a responder receives more connection requests per seconds than it can handle,
  2473. it does not make sense to accept more IKE_SA_INIT messages. And if they are
  2474. queued but can't get processed in time, an answer might be sent after the
  2475. client has already given up and restarted its connection setup. This
  2476. additionally increases the load on the responder.
  2477. .PP
  2478. To limit the responder load resulting from new connection attempts, the daemon
  2479. can drop IKE_SA_INIT messages just after reception. There are two mechanisms to
  2480. decide if this should happen, configured with the following options:
  2481. .TP
  2482. .BR charon.init_limit_half_open " [0]"
  2483. Limit based on the number of half open IKE_SAs. Half open IKE_SAs are SAs in
  2484. connecting state, but not yet established.
  2485. .TP
  2486. .BR charon.init_limit_job_load " [0]"
  2487. Limit based on the number of jobs currently queued for processing (sum over all
  2488. job priorities).
  2489. .PP
  2490. The second limit includes load from other jobs, such as rekeying. Choosing a
  2491. good value is difficult and depends on the hardware and expected load.
  2492. .PP
  2493. The first limit is simpler to calculate, but includes the load from new
  2494. connections only. If your responder is capable of negotiating 100 tunnels/s, you
  2495. might set this limit to 1000. The daemon will then drop new connection attempts
  2496. if generating a response would require more than 10 seconds. If you are
  2497. allowing for a maximum response time of more than 30 seconds, consider adjusting
  2498. the timeout for connecting IKE_SAs
  2499. .RB ( charon.half_open_timeout ).
  2500. A responder, by default, deletes an IKE_SA if the initiator does not establish
  2501. it within 30 seconds. Under high load, a higher value might be required.
  2502. .SH LOAD TESTS
  2503. To do stability testing and performance optimizations, the IKE daemon charon
  2504. provides the \fIload-tester\fR plugin. This plugin allows one to setup thousands
  2505. of tunnels concurrently against the daemon itself or a remote host.
  2506. .PP
  2507. .B WARNING:
  2508. Never enable the load-testing plugin on productive systems. It provides
  2509. preconfigured credentials and allows an attacker to authenticate as any user.
  2510. .PP
  2511. .SS Configuration details
  2512. For public key authentication, the responder uses the
  2513. .B \(dqCN=srv, OU=load-test, O=strongSwan\(dq
  2514. identity. For the initiator, each connection attempt uses a different identity
  2515. in the form
  2516. .BR "\(dqCN=c1-r1, OU=load-test, O=strongSwan\(dq" ,
  2517. where the first number indicates the client number, the second the
  2518. authentication round (if multiple authentication rounds are used).
  2519. .PP
  2520. For PSK authentication, FQDN identities are used. The server uses
  2521. .BR srv.strongswan.org ,
  2522. the client uses an identity in the form
  2523. .BR c1-r1.strongswan.org .
  2524. .PP
  2525. For EAP authentication, the client uses a NAI in the form
  2526. .BR 100000000010001@strongswan.org .
  2527. .PP
  2528. To configure multiple authentication rounds, concatenate multiple methods using,
  2529. e.g.
  2530. .EX
  2531. initiator_auth = pubkey|psk|eap-md5|eap-aka
  2532. .EE
  2533. .PP
  2534. The responder uses a hardcoded certificate based on a 1024-bit RSA key.
  2535. This certificate additionally serves as CA certificate. A peer uses the same
  2536. private key, but generates client certificates on demand signed by the CA
  2537. certificate. Install the Responder/CA certificate on the remote host to
  2538. authenticate all clients.
  2539. .PP
  2540. To speed up testing, the load tester plugin implements a special Diffie-Hellman
  2541. implementation called \fImodpnull\fR. By setting
  2542. .EX
  2543. proposal = aes128-sha1-modpnull
  2544. .EE
  2545. this wicked fast DH implementation is used. It does not provide any security
  2546. at all, but allows one to run tests without DH calculation overhead.
  2547. .SS Examples
  2548. .PP
  2549. In the simplest case, the daemon initiates IKE_SAs against itself using the
  2550. loopback interface. This will actually establish double the number of IKE_SAs,
  2551. as the daemon is initiator and responder for each IKE_SA at the same time.
  2552. Installation of IPsec SAs would fail, as each SA gets installed twice. To
  2553. simulate the correct behavior, a fake kernel interface can be enabled which does
  2554. not install the IPsec SAs at the kernel level.
  2555. .PP
  2556. A simple loopback configuration might look like this:
  2557. .PP
  2558. .EX
  2559. charon {
  2560. # create new IKE_SAs for each CHILD_SA to simulate
  2561. # different clients
  2562. reuse_ikesa = no
  2563. # turn off denial of service protection
  2564. dos_protection = no
  2565. plugins {
  2566. load-tester {
  2567. # enable the plugin
  2568. enable = yes
  2569. # use 4 threads to initiate connections
  2570. # simultaneously
  2571. initiators = 4
  2572. # each thread initiates 1000 connections
  2573. iterations = 1000
  2574. # delay each initiation in each thread by 20ms
  2575. delay = 20
  2576. # enable the fake kernel interface to
  2577. # avoid SA conflicts
  2578. fake_kernel = yes
  2579. }
  2580. }
  2581. }
  2582. .EE
  2583. .PP
  2584. This will initiate 4000 IKE_SAs within 20 seconds. You may increase the delay
  2585. value if your box can not handle that much load, or decrease it to put more
  2586. load on it. If the daemon starts retransmitting messages your box probably can
  2587. not handle all connection attempts.
  2588. .PP
  2589. The plugin also allows one to test against a remote host. This might help to
  2590. test against a real world configuration. A connection setup to do stress
  2591. testing of a gateway might look like this:
  2592. .PP
  2593. .EX
  2594. charon {
  2595. reuse_ikesa = no
  2596. threads = 32
  2597. plugins {
  2598. load-tester {
  2599. enable = yes
  2600. # 10000 connections, ten in parallel
  2601. initiators = 10
  2602. iterations = 1000
  2603. # use a delay of 100ms, overall time is:
  2604. # iterations * delay = 100s
  2605. delay = 100
  2606. # address of the gateway
  2607. remote = 1.2.3.4
  2608. # IKE-proposal to use
  2609. proposal = aes128-sha1-modp1024
  2610. # use faster PSK authentication instead
  2611. # of 1024bit RSA
  2612. initiator_auth = psk
  2613. responder_auth = psk
  2614. # request a virtual IP using configuration
  2615. # payloads
  2616. request_virtual_ip = yes
  2617. # enable CHILD_SA every 60s
  2618. child_rekey = 60
  2619. }
  2620. }
  2621. }
  2622. .EE
  2623. .SH IKEv2 RETRANSMISSION
  2624. Retransmission timeouts in the IKEv2 daemon charon can be configured globally
  2625. using the three keys listed below:
  2626. .PP
  2627. .RS
  2628. .nf
  2629. .BR charon.retransmit_base " [1.8]"
  2630. .BR charon.retransmit_timeout " [4.0]"
  2631. .BR charon.retransmit_tries " [5]"
  2632. .BR charon.retransmit_jitter " [0]"
  2633. .BR charon.retransmit_limit " [0]"
  2634. .fi
  2635. .RE
  2636. .PP
  2637. The following algorithm is used to calculate the timeout:
  2638. .PP
  2639. .EX
  2640. relative timeout = retransmit_timeout * retransmit_base ^ (n-1)
  2641. .EE
  2642. .PP
  2643. Where
  2644. .I n
  2645. is the current retransmission count. The calculated timeout can't exceed the
  2646. configured retransmit_limit (if any), which is useful if the number of retries
  2647. is high.
  2648. .PP
  2649. If a jitter in percent is configured, the timeout is modified as follows:
  2650. .PP
  2651. .EX
  2652. relative timeout -= random(0, retransmit_jitter * relative timeout)
  2653. .EE
  2654. .PP
  2655. Using the default values, packets are retransmitted in:
  2656. .TS
  2657. l r r
  2658. ---
  2659. lB r r.
  2660. Retransmission Relative Timeout Absolute Timeout
  2661. 1 4s 4s
  2662. 2 7s 11s
  2663. 3 13s 24s
  2664. 4 23s 47s
  2665. 5 42s 89s
  2666. giving up 76s 165s
  2667. .TE
  2668. .
  2669. .SH VARIABLES
  2670. .
  2671. The variables used above are configured as follows:
  2672. .nf
  2673. .na
  2674. ${piddir} /var/run
  2675. ${prefix} /usr/local
  2676. ${random_device} /dev/random
  2677. ${urandom_device} /dev/urandom
  2678. .ad
  2679. .fi
  2680. .
  2681. .SH FILES
  2682. .
  2683. .nf
  2684. .na
  2685. /etc/strongswan.conf configuration file
  2686. /etc/strongswan.d/ directory containing included config snippets
  2687. /etc/strongswan.d/charon/ plugin specific config snippets
  2688. .ad
  2689. .fi
  2690. .
  2691. .SH SEE ALSO
  2692. \fBipsec.conf\fR(5), \fBipsec.secrets\fR(5), \fBipsec\fR(8), \fBcharon-cmd\fR(8)
  2693. .SH HISTORY
  2694. Written for the
  2695. .UR http://www.strongswan.org
  2696. strongSwan project
  2697. .UE
  2698. by Tobias Brunner, Andreas Steffen and Martin Willi.