vici: Match identity with wildcards against remote ID in redirect command
[strongswan.git] / src / libcharon / plugins / vici / README.md
1 # The Versatile IKE Control Interface (VICI) protocol #
2
3 The vici plugin implements the server side of an IPC protocol to configure,
4 monitor and control the IKE daemon charon. It uses request/response and event
5 messages to communicate over a reliable stream based transport.
6
7 ## Transport protocol ##
8
9 To provide the service, the plugin opens a listening socket using a reliable,
10 stream based transport. charon relies on the different stream service
11 abstractions provided by libstrongswan, such as TCP and UNIX sockets.
12
13 A client connects to this service to access functionality. It may send an
14 arbitrary number of packets over the connection before closing it.
15
16 To exchange data, the transport protocol is segmented into byte sequences.
17 Each byte sequence is prefixed by a 32-bit length header in network order,
18 followed by the data. The maximum segment length is currently limited to 512KB
19 of data, and the length field contains the length of the data only, not
20 including the length field itself.
21
22 The order of byte sequences must be strict, byte sequences must arrive in the
23 same order as sent.
24
25 ## Packet layer ##
26
27 Within the byte sequences defined by the transport layer, both the client
28 and the server can exchange packets. The type of packet defines its structure
29 and purpose. The packet type is a 8-bit identifier, and is the first byte
30 in a transport layer byte sequence. The length of the packet is given by the
31 transport layer.
32
33 While a packet type may define the format of the wrapped data freely, currently
34 all types either contain a name, a message or both. The following packet types
35 are currently defined:
36
37 * _CMD_REQUEST = 0_: A named request message
38 * _CMD_RESPONSE = 1_: An unnamed response message for a request
39 * _CMD_UNKNOWN = 2_: An unnamed response if requested command is unknown
40 * _EVENT_REGISTER = 3_: A named event registration request
41 * _EVENT_UNREGISTER = 4_: A named event deregistration request
42 * _EVENT_CONFIRM = 5_: An unnamed response for successful event (de-)registration
43 * _EVENT_UNKNOWN = 6_: A unnamed response if event (de-)registration failed
44 * _EVENT = 7_: A named event message
45
46 For packets having a named type, after the packet type an 8-bit length header
47 of the name follows, indicating the string length in bytes of the name tag, not
48 including the length field itself. The name is an ASCII string that is not
49 null-terminated.
50
51 The rest of the packet forms the exchanged message, the length is determined
52 by the transport byte sequence length, subtracting the packet type and
53 the optional name tag in some messages.
54
55 ### Commands ###
56
57 Commands are currently always requested by the client. The server replies with
58 a response, or with a CMD_UNKNOWN failure message to let the client know
59 that it does not have a handler for such a command. There is no sequence number
60 to associate responses to requests, so only one command can be active at
61 a time on a single connection.
62
63 ### Events ###
64
65 To receive event messages, the client explicitly registers for events by name,
66 and also unregisters if it does not want to receive events of the named kind
67 anymore. The server confirms event registration using EVENT_CONFIRM, or
68 indicates that there is no such event source with EVENT_UNKNOWN.
69
70 Events may get raised at any time while registered, even during an active
71 request command. This mechanism is used to feed continuous data during a request,
72 for example.
73
74 ## Message format ##
75
76 The defined packet types optionally wrap a message with additional data.
77 Messages are currently used in CMD_REQUEST/CMD_RESPONSE, and in EVENT packets.
78 A message uses a hierarchial tree of sections. Each section (or the implicit
79 root section) contains an arbitrary set of key/value pairs, lists and
80 sub-sections. The length of a message is not part of the message itself, but
81 the wrapping layer, usually calculated from the transport byte sequence length.
82
83 The message encoding consists of a sequence of elements. Each element starts
84 with the element type, optionally followed by an element name and/or an element
85 value. Currently the following message element types are defined:
86
87 * _SECTION_START = 1_: Begin a new section having a name
88 * _SECTION_END = 2_: End a previously started section
89 * _KEY_VALUE = 3_: Define a value for a named key in the current section
90 * _LIST_START = 4_: Begin a named list for list items
91 * _LIST_ITEM = 5_: Define an unnamed item value in the current list
92 * _LIST_END = 6_: End a previously started list
93
94 Types are encoded as 8-bit values. Types having a name (SECTION_START,
95 KEY_VALUE and LIST_START) have an ASCII string following the type, which itself
96 uses an 8-bit length header. The string must not be null-terminated, the string
97 length does not include the length field itself.
98
99 Types having a value (KEY_VALUE and LIST_ITEM) have a raw blob sequence,
100 prefixed with a 16-bit network order length. The blob follows the type or the
101 name tag if available, the length defined by the length field does not include
102 the length field itself.
103
104 The interpretation of any value is not defined by the message format; it can
105 take arbitrary blobs. The application may specify types for specific keys, such
106 as strings or integer representations. The vici plugin currently uses
107 non-null terminated strings as values only; numbers get encoded as strings.
108
109 ### Sections ###
110
111 Sections may be opened in the implicit root section, or any previously section.
112 They can be nested to arbitrary levels. A SECTION_END marker always closes
113 the last opened section; SECTION_START and SECTION_END items must be balanced
114 in a valid message.
115
116 ### Key/Values ###
117
118 Key/Value pair elements may appear in the implicit root section or any explicit
119 sub-section at any level. Key names must be unique in the current section, use
120 lists to define multiple values for a key. Key/values may not appear in lists,
121 use a sub-section instead.
122
123 ### Lists ###
124
125 Lists may appear at the same locations as Key/Values, and may not be nested.
126 Only a single list may be opened at the same time, and all lists must be closed
127 in valid messages. After opening a list, only list items may appear before the
128 list closing element. Empty lists are allowed, list items may appear within
129 lists only.
130
131 ### Encoding example ###
132
133 Consider the following structure using pseudo-markup for this example:
134
135         key1 = value1
136         section1 = {
137                 sub-section = {
138                         key2 = value2
139                 }
140                 list1 = [ item1, item2 ]
141         }
142
143 The example above reprensents a valid tree structure, that gets encoded as
144 the following C array:
145
146         char msg[] = {
147                 /* key1 = value1 */
148                 3, 4,'k','e','y','1', 0,6,'v','a','l','u','e','1',
149                 /* section1 */
150                 1, 8,'s','e','c','t','i','o','n','1',
151                 /* sub-section */
152                 1, 11,'s','u','b','-','s','e','c','t','i','o','n',
153                 /* key2 = value2 */
154                 3, 4,'k','e','y','2', 0,6,'v','a','l','u','e','2',
155                 /* sub-section end */
156                 2,
157                 /* list1 */
158                 4, 5, 'l','i','s','t','1',
159                 /* item1 */
160                 5, 0,5,'i','t','e','m','1',
161                 /* item2 */
162                 5, 0,5,'i','t','e','m','2',
163                 /* list1 end */
164                 6,
165                 /* section1 end */
166                 2,
167         };
168
169 ## Client-initiated commands ##
170
171 Based on the packet layer, VICI implements commands requested by the client
172 and responded to by the server using named _CMD_REQUEST_ and _CMD_RESPONSE_
173 packets wrapping messages. The request message may contain command arguments,
174 the response message the reply.
175
176 Some commands use response streaming, that is, a request triggers a series of
177 events to consecutively stream data to the client before the response message
178 completes the stream. A client must register for the appropriate event to
179 receive the stream, and unregister after the response has been received.
180
181 The following client issued commands with the appropriate command input and
182 output messages are currently defined:
183
184 ### version() ###
185
186 Returns daemon and system specific version information.
187
188         {} => {
189                 daemon = <IKE daemon name>
190                 version = <strongSwan version>
191                 sysname = <operating system name>
192                 release = <operating system release>
193                 machine = <hardware identifier>
194         }
195
196 ### stats() ###
197
198 Returns IKE daemon statistics and load information.
199
200         {} => {
201                 uptime = {
202                         running = <relative uptime in human-readable form>
203                         since = <absolute startup time>
204                 }
205                 workers = {
206                         total = <total number of worker threads>
207                         idle = <worker threads currently idle>
208                         active = {
209                                 critical = <threads processing "critical" priority jobs>
210                                 high = <threads processing "high" priority jobs>
211                                 medium = <threads processing "medium" priority jobs>
212                                 low = <threads processing "low" priority jobs>
213                         }
214                 }
215                 queues = {
216                         critical = <jobs queued with "critical" priority>
217                         high = <jobs queued with "high" priority>
218                         medium = <jobs queued with "medium" priority>
219                         low = <jobs queued with "low" priority>
220                 }
221                 scheduled = <number of jobs scheduled for timed execution>
222                 ikesas = {
223                         total = <total number of IKE_SAs active>
224                         half-open = <number of IKE_SAs in half-open state>
225                 }
226                 plugins = [
227                         <names of loaded plugins>
228                 ]
229                 mem = { # available if built with leak-detective or on Windows
230                         total = <total heap memory usage in bytes>
231                         allocs = <total heap allocation blocks>
232                         <heap-name>* = { # on Windows only
233                                 total = <heap memory usage in bytes by this heap>
234                                 allocs = <allocated blocks for this heap>
235                         }
236                 }
237                 mallinfo = { # available with mallinfo() support
238                         sbrk = <non-mmaped space available>
239                         mmap = <mmaped space available>
240                         used = <total number of bytes used>
241                         free = <available but unused bytes>
242                 }
243         }
244
245 ### reload-settings() ###
246
247 Reloads _strongswan.conf_ settings and all plugins supporting configuration
248 reload.
249
250         {} => {
251                 success = <yes or no>
252                 errmsg = <error string on failure>
253         }
254
255 ### initiate() ###
256
257 Initiates an SA while streaming _control-log_ events.
258
259         {
260                 child = <CHILD_SA configuration name to initiate>
261                 ike = <optional IKE_SA configuraiton name to find child under>
262                 timeout = <timeout in ms before returning>
263                 init-limits = <whether limits may prevent initiating the CHILD_SA>
264                 loglevel = <loglevel to issue "control-log" events for>
265         } => {
266                 success = <yes or no>
267                 errmsg = <error string on failure or timeout>
268         }
269
270 The default timeout of 0 waits indefinitely for a result, and a timeout value
271 of -1 returns a result immediately.
272
273 ### terminate() ###
274
275 Terminates an SA while streaming _control-log_ events.
276
277         {
278                 child = <terminate a CHILD_SA by configuration name>
279                 ike = <terminate an IKE_SA by configuration name>
280                 child_id = <terminate a CHILD_SA by its reqid>
281                 ike_id = <terminate an IKE_SA by its unique id>
282                 timeout = <timeout in ms before returning>
283                 loglevel = <loglevel to issue "control-log" events for>
284         } => {
285                 success = <yes or no>
286                 errmsg = <error string on failure or timeout>
287         }
288
289 The default timeout of 0 waits indefinitely for a result, and a timeout value
290 of -1 returns a result immediately.
291
292 ### redirect() ###
293
294 Redirect a client-initiated IKE_SA to another gateway.  Only for IKEv2 and if
295 supported by the peer.
296
297         {
298                 ike = <redirect an IKE_SA by configuration name>
299                 ike-id = <redirect an IKE_SA by its unique id>
300                 peer-ip = <redirect an IKE_SA with matching peer IP>
301                 peer-id = <redirect an IKE_SA with matching peer identity, may contain
302                                    wildcards>
303         } => {
304                 success = <yes or no>
305                 errmsg = <error string on failure>
306         }
307
308 ### install() ###
309
310 Install a trap, drop or bypass policy defined by a CHILD_SA config.
311
312         {
313                 child = <CHILD_SA configuration name to install>
314                 ike = <optional IKE_SA configuraiton name to find child under>
315         } => {
316                 success = <yes or no>
317                 errmsg = <error string on failure>
318         }
319
320 ### uninstall() ###
321
322 Uninstall a trap, drop or bypass policy defined by a CHILD_SA config.
323
324         {
325                 child = <CHILD_SA configuration name to install>
326         } => {
327                 success = <yes or no>
328                 errmsg = <error string on failure>
329         }
330
331 ### list-sas() ###
332
333 Lists currently active IKE_SAs and associated CHILD_SAs by streaming _list-sa_
334 events.
335
336         {
337                 noblock = <use non-blocking mode if key is set>
338                 ike = <filter listed IKE_SAs by its name>
339                 ike_id = <filter listed IKE_SA by its unique id>
340         } => {
341                 # completes after streaming list-sa events
342         }
343
344 ### list-policies() ###
345
346 List currently installed trap, drop and bypass policies by streaming
347 _list-policy_ events.
348
349         {
350                 drop = <set to yes to list drop policies>
351                 pass = <set to yes to list bypass policies>
352                 trap = <set to yes to list trap policies>
353                 child = <filter by CHILD_SA configuration name>
354         } => {
355                 # completes after streaming list-sa events
356         }
357
358 ### list-conns() ###
359
360 List currently loaded connections by streaming _list-conn_ events. This
361 call includes all connections known by the daemon, not only those loaded
362 over vici.
363
364         {
365                 ike = <list connections matching a given configuration name only>
366         } => {
367                 # completes after streaming list-conn events
368         }
369
370 ### get-conns() ###
371
372 Return a list of connection names loaded exclusively over vici, not including
373 connections found in other backends.
374
375         {} => {
376                 conns = [
377                         <list of connection names>
378                 ]
379         }
380
381 ### list-certs() ###
382
383 List currently loaded certificates by streaming _list-cert_ events. This
384 call includes all certificates known by the daemon, not only those loaded
385 over vici.
386
387         {
388                 type = <certificate type to filter for, X509|X509_AC|X509_CRL|
389                                                                                                 OCSP_RESPONSE|PUBKEY  or ANY>
390                 flag = <X.509 certificate flag to filter for, NONE|CA|AA|OCSP or ANY>
391                 subject = <set to list only certificates having subject>
392         } => {
393                 # completes after streaming list-cert events
394         }
395
396 ### list-authorities() ###
397
398 List currently loaded certification authority information by streaming
399 _list-authority_ events.
400
401         {
402                 name = <list certification authority of a given name>
403         } => {
404                 # completes after streaming list-authority events
405         }
406
407 ### get-authorities() ###
408
409 Return a list of currently loaded certification authority names.
410
411         {} => {
412                 authorities = [
413                         <list of certification authority names>
414                 ]
415         }
416
417 ### load-conn() ###
418
419 Load a single connection definition into the daemon. An existing connection
420 with the same name gets updated or replaced.
421
422         {
423                 <IKE_SA config name> = {
424                         # IKE configuration parameters with authentication and CHILD_SA
425                         # subsections. Refer to swanctl.conf(5) for details.
426                 } => {
427                         success = <yes or no>
428                         errmsg = <error string on failure>
429                 }
430         }
431
432 ### unload-conn() ###
433
434 Unload a previously loaded connection definition by name.
435
436         {
437                 name = <IKE_SA config name>
438         } => {
439                 success = <yes or no>
440                 errmsg = <error string on failure>
441         }
442
443 ### load-cert() ###
444
445 Load a certificate into the daemon.
446
447         {
448                 type = <certificate type, X509|X509_AC|X509_CRL>
449                 flag = <X.509 certificate flag, NONE|CA|AA|OCSP>
450                 data = <PEM or DER encoded certificate data>
451         } => {
452                 success = <yes or no>
453                 errmsg = <error string on failure>
454         }
455
456 ### load-key() ###
457
458 Load a private key into the daemon.
459
460         {
461                 type = <private key type, RSA|ECDSA>
462                 data = <PEM or DER encoded key data>
463         } => {
464                 success = <yes or no>
465                 errmsg = <error string on failure>
466         }
467
468 ### load-shared() ###
469
470 Load a shared IKE PSK, EAP or XAuth secret into the daemon.
471
472         {
473                 type = <private key type, IKE|EAP|XAUTH>
474                 data = <raw shared key data>
475                 owners = [
476                         <list of shared key owner identities>
477                 ]
478         } => {
479                 success = <yes or no>
480                 errmsg = <error string on failure>
481         }
482
483 ### clear-creds() ###
484
485 Clear all loaded certificate, private key and shared key credentials. This
486 affects only credentials loaded over vici, but additionally flushes the
487 credential cache.
488
489         {} => {
490                 success = <yes or no>
491                 errmsg = <error string on failure>
492         }
493
494 ### load-authority() ###
495
496 Load a single certification authority definition into the daemon. An existing
497 authority with the same name gets replaced.
498
499         {
500                 <certification authority name> = {
501                         # certification authority parameters
502                         # refer to swanctl.conf(5) for details.
503                 } => {
504                         success = <yes or no>
505                         errmsg = <error string on failure>
506                 }
507         }
508
509 ### unload-authority() ###
510
511 Unload a previously loaded certification authority definition by name.
512
513         {
514                 name = <certification authority name>
515         } => {
516                 success = <yes or no>
517                 errmsg = <error string on failure>
518         }
519
520 ### load-pool() ###
521
522 Load an in-memory virtual IP and configuration attribute pool. Existing
523 pools with the same name get updated, if possible.
524
525         {
526                 <pool name> = {
527                         addrs = <subnet of virtual IP pool addresses>
528                         <attribute type>* = [
529                                 # attribute type is one of address, dns, nbns, dhcp, netmask,
530                                 # server, subnet, split_include, split_exclude or a numerical
531                                 # attribute type identifier.
532                                 <list of attributes for type>
533                         ]
534                 }
535         } => {
536                 success = <yes or no>
537                 errmsg = <error string on failure>
538         }
539
540 ### unload-pool() ###
541
542 Unload a previously loaded virtual IP and configuration attribute pool.
543 Unloading fails for pools with leases currently online.
544
545         {
546                 name = <virtual IP address pool to delete>
547         } => {
548                 success = <yes or no>
549                 errmsg = <error string on failure>
550         }
551
552 ### get-pools() ###
553
554 List the currently loaded pools.
555
556         {
557                 leases = <set to yes to include leases>
558         } => {
559                 <pool name>* = {
560                         base = <virtual IP pool base address>
561                         size = <total number of addresses in the pool>
562                         online = <number of leases online>
563                         offline = <number of leases offline>
564                         leases = {
565                                 <zero-based index>* = {
566                                         address = <IP address>
567                                         identity = <assigned identity>
568                                         status = <online|offline>
569                                 }
570                         }
571                 }
572         }
573
574 ### get-algorithms() ###
575
576 List currently loaded algorithms and their implementation.
577
578         {} => {
579                 <algorithm type> = {
580                         <algorithm> = <plugin providing the implementation>
581                 }
582         }
583
584 ## Server-issued events ##
585
586 Based on the packet layer, the vici plugin raises event messages using named
587 EVENT packets wrapping messages. The message contains event details.
588
589 ### log ###
590
591 The _log_ event is issued to registered clients for each debug log message.
592 This event is not associated with a command.
593
594         {
595                 group = <subsystem identifier for debug message>
596                 level = <log level, 0-4>
597                 thread = <numerical thread identifier issuing the log message>
598                 ikesa-name = <name of IKE_SA, if log is associated with any>
599                 ikesa-uniqued = <unique identifier of IKE_A, if log associated with any>
600                 msg = <log message text>
601         }
602
603 ### control-log ###
604
605 The _control-log_ event is issued for log events during active _initiate_ or
606 _terminate_ commands. It is issued only to clients currently having such
607 a command active.
608
609         {
610                 group = <subsystem identifier for debug message>
611                 level = <log level, 0-4>
612                 ikesa-name = <name of IKE_SA, if log associated with any>
613                 ikesa-uniqued = <unique identifier of IKE_A, if log associated with any>
614                 msg = <log message text>
615         }
616
617 ### list-sa ###
618
619 The _list-sa_ event is issued to stream IKE_SAs during an active _list-sas_
620 command.
621
622         {
623                 <IKE_SA config name> = {
624                         uniqueid = <IKE_SA unique identifier>
625                         version = <IKE version, 1 or 2>
626                         state = <IKE_SA state name>
627                         local-host = <local IKE endpoint address>
628                         local-port = <local IKE endpoint port>
629                         local-id = <local IKE identity>
630                         remote-host = <remote IKE endpoint address>
631                         remote-port = <remote IKE endpoint port>
632                         remote-id = <remote IKE identity>
633                         remote-xauth-id = <remote XAuth identity, if XAuth-authenticated>
634                         remote-eap-id = <remote EAP identity, if EAP-authenticated>
635                         initiator = <yes, if initiator of IKE_SA>
636                         initiator-spi = <hex encoded initiator SPI / cookie>
637                         responder-spi = <hex encoded responder SPI / cookie>
638                         nat-local = <yes, if local endpoint is behind a NAT>
639                         nat-remote = <yes, if remote endpoint is behind a NAT>
640                         nat-fake = <yes, if NAT situation has been faked as responder>
641                         nat-any = <yes, if any endpoint is behind a NAT (also if faked)>
642                         encr-alg = <IKE encryption algorithm string>
643                         encr-keysize = <key size for encr-alg, if applicable>
644                         integ-alg = <IKE integrity algorithm string>
645                         integ-keysize = <key size for encr-alg, if applicable>
646                         prf-alg = <IKE pseudo random function string>
647                         dh-group = <IKE Diffie-Hellman group string>
648                         established = <seconds the IKE_SA has been established>
649                         rekey-time = <seconds before IKE_SA gets rekeyed>
650                         reauth-time = <seconds before IKE_SA gets re-authenticated>
651                         local-vips = [
652                                 <list of virtual IPs assigned by the remote peer, installed locally>
653                         ]
654                         remote-vips = [
655                                 <list of virtual IPs assigned to the remote peer>
656                         ]
657                         tasks-queued = [
658                                 <list of currently queued tasks for execution>
659                         ]
660                         tasks-active = [
661                                 <list of tasks currently initiating actively>
662                         ]
663                         tasks-passive = [
664                                 <list of tasks currently handling passively>
665                         ]
666                         child-sas = {
667                                 <child-sa-name>* = {
668                                         uniqueid = <unique CHILD_SA identifier>
669                                         reqid = <reqid of CHILD_SA>
670                                         state = <state string of CHILD_SA>
671                                         mode = <IPsec mode, tunnel|transport|beet>
672                                         protocol = <IPsec protocol AH|ESP>
673                                         encap = <yes if using UDP encapsulation>
674                                         spi-in = <hex encoded inbound SPI>
675                                         spi-out = <hex encoded outbound SPI>
676                                         cpi-in = <hex encoded inbound CPI, if using compression>
677                                         cpi-out = <hex encoded outbound CPI, if using compression>
678                                         encr-alg = <ESP encryption algorithm name, if any>
679                                         encr-keysize = <ESP encryption key size, if applicable>
680                                         integ-alg = <ESP or AH integrity algorithm name, if any>
681                                         integ-keysize = <ESP or AH integrity key size, if applicable>
682                                         prf-alg = <CHILD_SA pseudo random function name>
683                                         dh-group = <CHILD_SA PFS rekeying DH group name, if any>
684                                         esn = <1 if using extended sequence numbers>
685                                         bytes-in = <number of input bytes processed>
686                                         packets-in = <number of input packets processed>
687                                         use-in = <seconds since last inbound packet, if any>
688                                         bytes-out = <number of output bytes processed>
689                                         packets-out = <number of output packets processed>
690                                         use-out = <seconds since last outbound packet, if any>
691                                         rekey-time = <seconds before CHILD_SA gets rekeyed>
692                                         life-time = <seconds before CHILD_SA expires>
693                                         install-time = <seconds the CHILD_SA has been installed>
694                                         local-ts = [
695                                                 <list of local traffic selectors>
696                                         ]
697                                         remote-ts = [
698                                                 <list of remote traffic selectors>
699                                         ]
700                                 }
701                         }
702                 }
703         }
704
705 ### list-policy ###
706
707 The _list-policy_ event is issued to stream installed policies during an active
708 _list-policies_ command.
709
710         {
711                 <child-sa-config-name> = {
712                         mode = <policy mode, tunnel|transport|pass|drop>
713                         local-ts = [
714                                 <list of local traffic selectors>
715                         ]
716                         remote-ts = [
717                                 <list of remote traffic selectors>
718                         ]
719                 }
720         }
721
722 ### list-conn ###
723
724 The _list-conn_ event is issued to stream loaded connection during an active
725 _list-conns_ command.
726
727         {
728                 <IKE_SA connection name> = {
729                         local_addrs = [
730                                 <list of valid local IKE endpoint addresses>
731                         ]
732                         remote_addrs = [
733                                 <list of valid remote IKE endpoint addresses>
734                         ]
735                         version = <IKE version as string, IKEv1|IKEv2 or 0 for any>
736
737                         local*, remote* = { # multiple local and remote auth sections
738                                 class = <authentication type>
739                                 eap-type = <EAP type to authenticate if when using EAP>
740                                 eap-vendor = <EAP vendor for type, if any>
741                                 xauth = <xauth backend name>
742                                 revocation = <revocation policy>
743                                 id = <IKE identity>
744                                 aaa_id = <AAA authentication backend identity>
745                                 eap_id = <EAP identity for authentication>
746                                 xauth_id = <XAuth username for authentication>
747                                 groups = [
748                                         <group membership required to use connection>
749                                 ]
750                                 certs = [
751                                         <certificates allowed for authentication>
752                                 ]
753                                 cacerts = [
754                                         <CA certificates allowed for authentication>
755                                 ]
756                         }
757                         children = {
758                                 <CHILD_SA config name>* = {
759                                         mode = <IPsec mode>
760                                         local-ts = [
761                                                 <list of local traffic selectors>
762                                         ]
763                                         remote-ts = [
764                                                 <list of remote traffic selectors>
765                                         ]
766                                 }
767                         }
768                 }
769         }
770
771 ### list-cert ###
772
773 The _list-cert_ event is issued to stream loaded certificates during an active
774 _list-certs_ command.
775
776         {
777                 type = <certificate type, X509|X509_AC|X509_CRL|OCSP_RESPONSE|PUBKEY>
778                 flag = <X.509 certificate flag, NONE|CA|AA|OCSP>
779                 has_privkey = <set if a private key for the certificate is available>
780                 data = <ASN1 encoded certificate data>
781                 subject = <subject string if defined and certificate type is PUBKEY>
782                 not-before = <time string if defined and certificate type is PUBKEY>
783                 not-after  = <time string if defined and certificate type is PUBKEY>
784         }
785
786 ### list-authority ###
787
788 The _list-authority_ event is issued to stream loaded certification authority
789 information during an active_list-authorities_ command.
790
791         {
792                 <certification authority name> = {
793                         cacert = <subject distinguished name of CA certificate>
794                         crl_uris = [
795                                 <CRL URI (http, ldap or file)>
796                         ]
797                         ocsp_uris = [
798                                 <OCSP URI (http)>
799                         ]
800                         cert_uri_base = <base URI for download of hash-and-URL certificates>
801                 }
802         }
803
804 ### ike-updown ###
805
806 The _ike-updown_ event is issued when an IKE_SA is established or terminated.
807
808         {
809                 up = <set if up event>
810                 <IKE_SA config name> = {
811                         <same data as in the list-sas event, but without child-sas section>
812                 }
813         }
814
815 ### ike-rekey ###
816
817 The _ike-rekey_ event is issued when an IKE_SA is rekeyed.
818
819         {
820                 <IKE_SA config name> = {
821                         old = {
822                                 <same data as in the list-sas event, but without child-sas section>
823                         }
824                         new = {
825                                 <same data as in the list-sas event, but without child-sas section>
826                         }
827                 }
828         }
829
830 ### child-updown ###
831
832 The _child-updown_ event is issued when a CHILD_SA is established or terminated.
833
834         {
835                 up = <set if up event>
836                 <IKE_SA config name> = {
837                         <same data as in the list-sas event, but with only the affected
838                          CHILD_SA in the child-sas section>
839                 }
840         }
841
842 ### child-rekey ###
843
844 The _child-rekey_ event is issued when a CHILD_SA is rekeyed.
845
846         {
847                 <IKE_SA config name> = {
848                         <same data as in the list-sas event, but with the child-sas section
849                          as follows>
850                         child-sas = {
851                                 <child-sa-name> = {
852                                         old = {
853                                                 <same data as in the list-sas event>
854                                         }
855                                         new = {
856                                                 <same data as in the list-sas event>
857                                         }
858                                 }
859                         }
860                 }
861         }
862
863 # libvici C client library #
864
865 libvici is the reference implementation of a C client library implementing
866 the vici protocol. It builds upon libstrongswan, but provides a stable API
867 to implement client applications in the C programming language. libvici uses
868 the libstrongswan thread pool to deliver event messages asynchronously.
869
870 ## Connecting to the daemon ##
871
872 This example shows how to connect to the daemon using the default URI, and
873 then perform proper cleanup:
874
875         #include <stdio.h>
876         #include <errno.h>
877         #include <string.h>
878
879         #include <libvici.h>
880
881         int main(int argc, char *argv[])
882         {
883                 vici_conn_t *conn;
884                 int ret = 0;
885
886                 vici_init();
887                 conn = vici_connect(NULL);
888                 if (conn)
889                 {
890                         /* do stuff */
891                         vici_disconnect(conn);
892                 }
893                 else
894                 {
895                         ret = errno;
896                         fprintf(stderr, "connecting failed: %s\n", strerror(errno));
897                 }
898                 vici_deinit();
899                 return ret;
900         }
901
902 ## A simple client request ##
903
904 In the following example, a simple _version_ request is issued to the daemon
905 and the result is printed:
906
907         int get_version(vici_conn_t *conn)
908         {
909                 vici_req_t *req;
910                 vici_res_t *res;
911                 int ret = 0;
912
913                 req = vici_begin("version");
914                 res = vici_submit(req, conn);
915                 if (res)
916                 {
917                         printf("%s %s (%s, %s, %s)\n",
918                                 vici_find_str(res, "", "daemon"),
919                                 vici_find_str(res, "", "version"),
920                                 vici_find_str(res, "", "sysname"),
921                                 vici_find_str(res, "", "release"),
922                                 vici_find_str(res, "", "machine"));
923                         vici_free_res(res);
924                 }
925                 else
926                 {
927                         ret = errno;
928                         fprintf(stderr, "version request failed: %s\n", strerror(errno));
929                 }
930                 return ret;
931         }
932
933 ## A request with event streaming and callback parsing ##
934
935 In this more advanced example, the _list-conns_ command is used to stream
936 loaded connections with the _list-conn_ event. The event message is parsed
937 with a simple callback to print the connection name:
938
939         int conn_cb(void *null, vici_res_t *res, char *name)
940         {
941                 printf("%s\n", name);
942                 return 0;
943         }
944
945         void list_cb(void *null, char *name, vici_res_t *res)
946         {
947                 if (vici_parse_cb(res, conn_cb, NULL, NULL, NULL) != 0)
948                 {
949                         fprintf(stderr, "parsing failed: %s\n", strerror(errno));
950                 }
951         }
952
953         int list_conns(vici_conn_t *conn)
954         {
955                 vici_req_t *req;
956                 vici_res_t *res;
957                 int ret = 0;
958
959                 if (vici_register(conn, "list-conn", list_cb, NULL) == 0)
960                 {
961                         req = vici_begin("list-conns");
962                         res = vici_submit(req, conn);
963                         if (res)
964                         {
965                                 vici_free_res(res);
966                         }
967                         else
968                         {
969                                 ret = errno;
970                                 fprintf(stderr, "request failed: %s\n", strerror(errno));
971                         }
972                         vici_register(conn, "list-conn", NULL, NULL);
973                 }
974                 else
975                 {
976                         ret = errno;
977                         fprintf(stderr, "registration failed: %s\n", strerror(errno));
978                 }
979                 return ret;
980         }
981
982 ## API documentation ##
983
984 More information about the libvici API is available in the _libvici.h_ header
985 file or the generated Doxygen documentation.
986
987 # vici ruby gem #
988
989 The _vici ruby gem_ is a pure ruby implementation of the VICI protocol to
990 implement client applications. It is provided in the _ruby_ subdirectory, and
991 gets built and installed if strongSwan has been _./configure_'d with
992 _--enable-vici_ and _--enable-ruby-gems_.
993
994 The _Connection_ class from the _Vici_ module provides the high level interface,
995 the underlying classes are usually not required to build ruby applications
996 using VICI. The _Connection_ class provides methods for the supported VICI
997 commands and an event listening mechanism.
998
999 To represent the VICI message data tree, the gem converts the binary encoding
1000 to ruby data types. The _Connection_ class takes and returns ruby objects for
1001 the exchanged message data:
1002  * Sections get encoded as Hash, containing other sections as Hash, or
1003  * Key/Values, where the values are Strings as Hash values
1004  * Lists get encoded as Arrays with String values
1005 Non-String values that are not a Hash nor an Array get converted with .to_s
1006 during encoding.
1007
1008 ## Connecting to the daemon ##
1009
1010 To create a connection to the daemon, a socket can be passed to the
1011 _Connection_ constructor. If none is passed, a default Unix socket at
1012 _/var/run/charon.vici_ is used:
1013
1014         require "vici"
1015         require "socket"
1016
1017         v = Vici::Connection.new(UNIXSocket.new("/var/run/charon.vici"))
1018
1019 ## A simple client request ##
1020
1021 An example to print the daemon version information is as simple as:
1022
1023         x = v.version
1024         puts "%s %s (%s, %s, %s)" % [
1025                 x["daemon"], x["version"], x["sysname"], x["release"], x["machine"]
1026         ]
1027
1028 ## A request with closure invocation ##
1029
1030 The _Connection_ class takes care of event streaming by invoking a closure
1031 for each event. The following example lists all loaded connections using the
1032 _list-conns_ command and implicitly the _list-conn_ event:
1033
1034         v.list_conns { |conn|
1035                 conn.each { |key, value|
1036                         puts key
1037                 }
1038         }
1039
1040 ## API documentation ##
1041
1042 For more details about the ruby gem refer to the comments in the gem source
1043 code or the generated documentation.
1044
1045 # vici Python egg #
1046
1047 The _vici Python egg_ is a pure Python implementation of the VICI protocol to
1048 implement client applications. It is provided in the _python_ subdirectory, and
1049 gets built and installed if strongSwan has been _./configure_'d with
1050 _--enable-vici_ and _--enable-python-eggs_.
1051
1052 The _vici_ module provides a _Session()_ constructor for a high level interface,
1053 the underlying classes are usually not required to build Python applications
1054 using VICI. The _Session_ class provides methods for the supported VICI
1055 commands.
1056
1057 To represent the VICI message data tree, the library converts the binary
1058 encoding to Python data types. The _Session_ class takes and returns Python
1059 objects for the exchanged message data:
1060  * Sections get encoded as OrderedDict, containing other sections, or
1061  * Key/Values, where the values are strings as dictionary values
1062  * Lists get encoded as Python Lists with string values
1063 Values that do not conform to Python dict or list get converted to strings using
1064 str().
1065
1066 ## Connecting to the daemon ##
1067
1068 To create a connection to the daemon, a socket can be passed to the _Session_
1069 constructor. If none is passed, a default Unix socket at _/var/run/charon.vici_
1070 is used:
1071
1072         import vici
1073         import socket
1074
1075         s = socket.socket(socket.AF_UNIX)
1076         s.connect("/var/run/charon.vici")
1077         v = vici.Session(s)
1078
1079 ## A simple client request ##
1080
1081 An example to print the daemon version information is as simple as:
1082
1083         ver = v.version()
1084
1085         print "{daemon} {version} ({sysname}, {release}, {machine})".format(**ver)
1086
1087 ## A request with response iteration ##
1088
1089 The _Session_ class returns an iterable Python generator for streamed events to
1090 continuously stream objects to the caller. The following example lists all
1091 loaded connections using the _list-conns_ command and implicitly the _list-conn_
1092 event:
1093
1094         for conn in v.list_conns():
1095                 for key in conn:
1096                         print key
1097
1098 Please note that if the returned generator is not iterated completely, it must
1099 be closed using _close()_. This is implicitly done when breaking from a loop,
1100 but an explicit call may be required when directly iterating the generator with
1101 _next()_.
1102
1103 ## Sorting in dictionaries ##
1104
1105 In VICI, in some message trees the order of objects in dictionary matters. In
1106 contrast to ruby Hashes, Python dictionaries do not preserve order of added
1107 objects. It is therefore recommended to use OrderedDicts instead of the default
1108 dictionaries. Objects returned by the library use OrderedDicts.
1109
1110 ## API documentation ##
1111
1112 For more details about the Python egg refer to the comments in the Python source
1113 code.
1114
1115 # Vici::Session Perl CPAN module #
1116
1117 The _Vici::Session Perl CPAN module_ is a pure Perl implementation of the VICI
1118 protocol to implement client applications. It is provided in the _perl_
1119 subdirectory, and gets built and installed if strongSwan has been
1120  _./configure_'d with_--enable-vici_ and _--enable-perl-cpan_.
1121
1122 The _Vici::Session_ module provides a _new()_ constructor for a high level
1123 interface, the underlying _Vici::Packet_ and _Vici::Transport_ classes are
1124 usually not required to build Perl applications using VICI. The _Vici::Session_
1125 class provides methods for the supported VICI commands. The auxiliare
1126  _Vici::Message_ class is used to encode configuration parameters sent to
1127 the daemon and decode data returned by the daemon.
1128
1129 ## Connecting to the daemon ##
1130
1131         use IO::Socket::UNIX;
1132         use Vici::Session;
1133         use Vici::Message;
1134
1135         my $socket = IO::Socket::UNIX->new(
1136                         Type => SOCK_STREAM,
1137                         Peer => '/var/run/charon.vici',
1138         ) or die "Vici socket: $!";
1139
1140         my $session = Vici::Session->new($socket);
1141
1142 ## A simple client request ##
1143
1144 An example to print the daemon version information is as simple as:
1145
1146         my $version = $session->version()->hash();
1147
1148         foreach my $key ('daemon', 'version', 'sysname', 'release', 'machine' ) {
1149                 print $version->{$key}, " ";
1150         }
1151
1152 The _Vici::Session_ methods are explained in the perl/Vici-Session/README.pod
1153 document.