Merge branch 'vici-updates'
[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                 matches = <number of matched SAs>
287                 terminated = <number of terminated SAs>
288                 errmsg = <error string on failure or timeout>
289         }
290
291 The default timeout of 0 waits indefinitely for a result, and a timeout value
292 of -1 returns a result immediately.
293
294 ### rekey() ###
295
296 Initiate the rekeying of an SA.
297
298         {
299                 child = <rekey a CHILD_SA by configuration name>
300                 ike = <rekey an IKE_SA by configuration name>
301                 child-id = <rekey a CHILD_SA by its reqid>
302                 ike-id = <rekey an IKE_SA by its unique id>
303         } => {
304                 success = <yes or no>
305                 matches = <number of matched SAs>
306                 errmsg = <error string on failure>
307         }
308
309 ### redirect() ###
310
311 Redirect a client-initiated IKE_SA to another gateway.  Only for IKEv2 and if
312 supported by the peer.
313
314         {
315                 ike = <redirect an IKE_SA by configuration name>
316                 ike-id = <redirect an IKE_SA by its unique id>
317                 peer-ip = <redirect an IKE_SA with matching peer IP, may also be a
318                                    subnet in CIDR notation or an IP range>
319                 peer-id = <redirect an IKE_SA with matching peer identity, may contain
320                                    wildcards>
321         } => {
322                 success = <yes or no>
323                 matches = <number of matched SAs>
324                 errmsg = <error string on failure>
325         }
326
327 ### install() ###
328
329 Install a trap, drop or bypass policy defined by a CHILD_SA config.
330
331         {
332                 child = <CHILD_SA configuration name to install>
333                 ike = <optional IKE_SA configuration name to find child under>
334         } => {
335                 success = <yes or no>
336                 errmsg = <error string on failure>
337         }
338
339 ### uninstall() ###
340
341 Uninstall a trap, drop or bypass policy defined by a CHILD_SA config.
342
343         {
344                 child = <CHILD_SA configuration name to install>
345                 ike = <optional IKE_SA configuration name to find child under,
346                            if not given the first policy matching child is removed>
347         } => {
348                 success = <yes or no>
349                 errmsg = <error string on failure>
350         }
351
352 ### list-sas() ###
353
354 Lists currently active IKE_SAs and associated CHILD_SAs by streaming _list-sa_
355 events.
356
357         {
358                 noblock = <use non-blocking mode if key is set>
359                 ike = <filter listed IKE_SAs by its name>
360                 ike-id = <filter listed IKE_SA by its unique id>
361         } => {
362                 # completes after streaming list-sa events
363         }
364
365 ### list-policies() ###
366
367 List currently installed trap, drop and bypass policies by streaming
368 _list-policy_ events.
369
370         {
371                 drop = <set to yes to list drop policies>
372                 pass = <set to yes to list bypass policies>
373                 trap = <set to yes to list trap policies>
374                 child = <filter by CHILD_SA configuration name>
375                 ike = <filter by IKE_SA configuration name>
376         } => {
377                 # completes after streaming list-sa events
378         }
379
380 ### list-conns() ###
381
382 List currently loaded connections by streaming _list-conn_ events. This
383 call includes all connections known by the daemon, not only those loaded
384 over vici.
385
386         {
387                 ike = <list connections matching a given configuration name only>
388         } => {
389                 # completes after streaming list-conn events
390         }
391
392 ### get-conns() ###
393
394 Return a list of connection names loaded exclusively over vici, not including
395 connections found in other backends.
396
397         {} => {
398                 conns = [
399                         <list of connection names>
400                 ]
401         }
402
403 ### list-certs() ###
404
405 List currently loaded certificates by streaming _list-cert_ events. This
406 call includes all certificates known by the daemon, not only those loaded
407 over vici.
408
409         {
410                 type = <certificate type to filter for, X509|X509_AC|X509_CRL|
411                                                                                                 OCSP_RESPONSE|PUBKEY  or ANY>
412                 flag = <X.509 certificate flag to filter for, NONE|CA|AA|OCSP or ANY>
413                 subject = <set to list only certificates having subject>
414         } => {
415                 # completes after streaming list-cert events
416         }
417
418 ### list-authorities() ###
419
420 List currently loaded certification authority information by streaming
421 _list-authority_ events.
422
423         {
424                 name = <list certification authority of a given name>
425         } => {
426                 # completes after streaming list-authority events
427         }
428
429 ### get-authorities() ###
430
431 Return a list of currently loaded certification authority names.
432
433         {} => {
434                 authorities = [
435                         <list of certification authority names>
436                 ]
437         }
438
439 ### load-conn() ###
440
441 Load a single connection definition into the daemon. An existing connection
442 with the same name gets updated or replaced.
443
444         {
445                 <IKE_SA config name> = {
446                         # IKE configuration parameters with authentication and CHILD_SA
447                         # subsections. Refer to swanctl.conf(5) for details.
448                 } => {
449                         success = <yes or no>
450                         errmsg = <error string on failure>
451                 }
452         }
453
454 ### unload-conn() ###
455
456 Unload a previously loaded connection definition by name.
457
458         {
459                 name = <IKE_SA config name>
460         } => {
461                 success = <yes or no>
462                 errmsg = <error string on failure>
463         }
464
465 ### load-cert() ###
466
467 Load a certificate into the daemon.
468
469         {
470                 type = <certificate type, X509|X509_AC|X509_CRL>
471                 flag = <X.509 certificate flag, NONE|CA|AA|OCSP>
472                 data = <PEM or DER encoded certificate data>
473         } => {
474                 success = <yes or no>
475                 errmsg = <error string on failure>
476         }
477
478 ### load-key() ###
479
480 Load a private key into the daemon.
481
482         {
483                 type = <private key type, RSA|ECDSA>
484                 data = <PEM or DER encoded key data>
485         } => {
486                 success = <yes or no>
487                 errmsg = <error string on failure>
488         }
489
490 ### unload-key() ###
491
492 Unload the private key with the given key identifier.
493
494         {
495                 id = <hex-encoded SHA-1 key identifier of the private key to unload>
496         } => {
497                 success = <yes or no>
498                 errmsg = <error string on failure>
499         }
500
501 ### get-keys() ###
502
503 Return a list of identifiers of private keys loaded exclusively over vici, not
504 including keys found in other backends.
505
506         {} => {
507                 keys = [
508                         <list of hex-encoded SHA-1 key identifiers>
509                 ]
510         }
511
512 ### load-token() ###
513
514 Load a private key located on a token into the daemon.  Such keys may be listed
515 and unloaded using the _get-keys_ and _unload-key_ commands, respectively (based
516 on the key identifier derived from the public key).
517
518         {
519                 handle = <hex-encoded CKA_ID of the private key on token>
520                 slot = <optional slot number>
521                 module = <optional PKCS#11 module>
522                 pin = <optional PIN to access the key, has to be provided via other
523                            means if not given>
524         } => {
525                 success = <yes or no>
526                 errmsg = <error string on failure>
527                 id = <hex-encoded SHA-1 key identifier of the public key on success>
528         }
529
530 ### load-shared() ###
531
532 Load a shared IKE PSK, EAP or XAuth secret into the daemon.
533
534         {
535                 id = <optional unique identifier of this shared key>
536                 type = <shared key type, IKE|EAP|XAUTH>
537                 data = <raw shared key data>
538                 owners = [
539                         <list of shared key owner identities>
540                 ]
541         } => {
542                 success = <yes or no>
543                 errmsg = <error string on failure>
544         }
545
546 ### unload-shared() ###
547
548 Unload a previously loaded shared IKE PSK, EAP or XAuth secret by its unique
549 identifier.
550
551         {
552                 id = <unique identifier of the shared key to unload>
553         } => {
554                 success = <yes or no>
555                 errmsg = <error string on failure>
556         }
557
558 ### get-shared() ###
559
560 Return a list of unique identifiers of shared keys loaded exclusively over vici,
561 not including keys found in other backends.
562
563         {} => {
564                 keys = [
565                         <list of unique identifiers>
566                 ]
567         }
568
569 ### flush-certs() ###
570
571 Flushes the certificate cache. The optional type argument allows to flush
572 only certificates of a given type, e.g. all cached CRLs.
573
574         {
575                 type = <certificate type to filter for, X509|X509_AC|X509_CRL|
576                                                                                                 OCSP_RESPONSE|PUBKEY or ANY>
577         } => {
578                 success = <yes or no>
579                 errmsg = <error string on failure>
580         }
581
582 ### clear-creds() ###
583
584 Clear all loaded certificate, private key and shared key credentials. This
585 affects only credentials loaded over vici, but additionally flushes the
586 credential cache.
587
588         {} => {
589                 success = <yes or no>
590                 errmsg = <error string on failure>
591         }
592
593 ### load-authority() ###
594
595 Load a single certification authority definition into the daemon. An existing
596 authority with the same name gets replaced.
597
598         {
599                 <certification authority name> = {
600                         # certification authority parameters
601                         # refer to swanctl.conf(5) for details.
602                 } => {
603                         success = <yes or no>
604                         errmsg = <error string on failure>
605                 }
606         }
607
608 ### unload-authority() ###
609
610 Unload a previously loaded certification authority definition by name.
611
612         {
613                 name = <certification authority name>
614         } => {
615                 success = <yes or no>
616                 errmsg = <error string on failure>
617         }
618
619 ### load-pool() ###
620
621 Load an in-memory virtual IP and configuration attribute pool. Existing
622 pools with the same name get updated, if possible.
623
624         {
625                 <pool name> = {
626                         addrs = <subnet of virtual IP pool addresses>
627                         <attribute type>* = [
628                                 # attribute type is one of address, dns, nbns, dhcp, netmask,
629                                 # server, subnet, split_include, split_exclude or a numerical
630                                 # attribute type identifier.
631                                 <list of attributes for type>
632                         ]
633                 }
634         } => {
635                 success = <yes or no>
636                 errmsg = <error string on failure>
637         }
638
639 ### unload-pool() ###
640
641 Unload a previously loaded virtual IP and configuration attribute pool.
642 Unloading fails for pools with leases currently online.
643
644         {
645                 name = <virtual IP address pool to delete>
646         } => {
647                 success = <yes or no>
648                 errmsg = <error string on failure>
649         }
650
651 ### get-pools() ###
652
653 List the currently loaded pools.
654
655         {
656                 leases = <set to yes to include leases>
657                 name = <optional name of the pool to query>
658         } => {
659                 <pool name>* = {
660                         base = <virtual IP pool base address>
661                         size = <total number of addresses in the pool>
662                         online = <number of leases online>
663                         offline = <number of leases offline>
664                         leases = {
665                                 <zero-based index>* = {
666                                         address = <IP address>
667                                         identity = <assigned identity>
668                                         status = <online|offline>
669                                 }
670                         }
671                 }
672         }
673
674 ### get-algorithms() ###
675
676 List currently loaded algorithms and their implementation.
677
678         {} => {
679                 <algorithm type> = {
680                         <algorithm> = <plugin providing the implementation>
681                 }
682         }
683
684 ## Server-issued events ##
685
686 Based on the packet layer, the vici plugin raises event messages using named
687 EVENT packets wrapping messages. The message contains event details.
688
689 ### log ###
690
691 The _log_ event is issued to registered clients for each debug log message.
692 This event is not associated with a command.
693
694         {
695                 group = <subsystem identifier for debug message>
696                 level = <log level, 0-4>
697                 thread = <numerical thread identifier issuing the log message>
698                 ikesa-name = <name of IKE_SA, if log is associated with any>
699                 ikesa-uniqued = <unique identifier of IKE_A, if log associated with any>
700                 msg = <log message text>
701         }
702
703 ### control-log ###
704
705 The _control-log_ event is issued for log events during active _initiate_ or
706 _terminate_ commands. It is issued only to clients currently having such
707 a command active.
708
709         {
710                 group = <subsystem identifier for debug message>
711                 level = <log level, 0-4>
712                 ikesa-name = <name of IKE_SA, if log associated with any>
713                 ikesa-uniqued = <unique identifier of IKE_A, if log associated with any>
714                 msg = <log message text>
715         }
716
717 ### list-sa ###
718
719 The _list-sa_ event is issued to stream IKE_SAs during an active _list-sas_
720 command.
721
722         {
723                 <IKE_SA config name> = {
724                         uniqueid = <IKE_SA unique identifier>
725                         version = <IKE version, 1 or 2>
726                         state = <IKE_SA state name>
727                         local-host = <local IKE endpoint address>
728                         local-port = <local IKE endpoint port>
729                         local-id = <local IKE identity>
730                         remote-host = <remote IKE endpoint address>
731                         remote-port = <remote IKE endpoint port>
732                         remote-id = <remote IKE identity>
733                         remote-xauth-id = <remote XAuth identity, if XAuth-authenticated>
734                         remote-eap-id = <remote EAP identity, if EAP-authenticated>
735                         initiator = <yes, if initiator of IKE_SA>
736                         initiator-spi = <hex encoded initiator SPI / cookie>
737                         responder-spi = <hex encoded responder SPI / cookie>
738                         nat-local = <yes, if local endpoint is behind a NAT>
739                         nat-remote = <yes, if remote endpoint is behind a NAT>
740                         nat-fake = <yes, if NAT situation has been faked as responder>
741                         nat-any = <yes, if any endpoint is behind a NAT (also if faked)>
742                         encr-alg = <IKE encryption algorithm string>
743                         encr-keysize = <key size for encr-alg, if applicable>
744                         integ-alg = <IKE integrity algorithm string>
745                         integ-keysize = <key size for encr-alg, if applicable>
746                         prf-alg = <IKE pseudo random function string>
747                         dh-group = <IKE Diffie-Hellman group string>
748                         established = <seconds the IKE_SA has been established>
749                         rekey-time = <seconds before IKE_SA gets rekeyed>
750                         reauth-time = <seconds before IKE_SA gets re-authenticated>
751                         local-vips = [
752                                 <list of virtual IPs assigned by the remote peer, installed locally>
753                         ]
754                         remote-vips = [
755                                 <list of virtual IPs assigned to the remote peer>
756                         ]
757                         tasks-queued = [
758                                 <list of currently queued tasks for execution>
759                         ]
760                         tasks-active = [
761                                 <list of tasks currently initiating actively>
762                         ]
763                         tasks-passive = [
764                                 <list of tasks currently handling passively>
765                         ]
766                         child-sas = {
767                                 <unique child-sa-name>* = {
768                                         name = <name of the CHILD_SA>
769                                         uniqueid = <unique CHILD_SA identifier>
770                                         reqid = <reqid of CHILD_SA>
771                                         state = <state string of CHILD_SA>
772                                         mode = <IPsec mode, tunnel|transport|beet>
773                                         protocol = <IPsec protocol AH|ESP>
774                                         encap = <yes if using UDP encapsulation>
775                                         spi-in = <hex encoded inbound SPI>
776                                         spi-out = <hex encoded outbound SPI>
777                                         cpi-in = <hex encoded inbound CPI, if using compression>
778                                         cpi-out = <hex encoded outbound CPI, if using compression>
779                                         mark-in = <hex encoded inbound Netfilter mark value>
780                                         mark-mask-in = <hex encoded inbound Netfilter mark mask>
781                                         mark-out = <hex encoded outbound Netfilter mark value>
782                                         mark-mask-out = <hex encoded outbound Netfilter mark mask>
783                                         encr-alg = <ESP encryption algorithm name, if any>
784                                         encr-keysize = <ESP encryption key size, if applicable>
785                                         integ-alg = <ESP or AH integrity algorithm name, if any>
786                                         integ-keysize = <ESP or AH integrity key size, if applicable>
787                                         prf-alg = <CHILD_SA pseudo random function name>
788                                         dh-group = <CHILD_SA PFS rekeying DH group name, if any>
789                                         esn = <1 if using extended sequence numbers>
790                                         bytes-in = <number of input bytes processed>
791                                         packets-in = <number of input packets processed>
792                                         use-in = <seconds since last inbound packet, if any>
793                                         bytes-out = <number of output bytes processed>
794                                         packets-out = <number of output packets processed>
795                                         use-out = <seconds since last outbound packet, if any>
796                                         rekey-time = <seconds before CHILD_SA gets rekeyed>
797                                         life-time = <seconds before CHILD_SA expires>
798                                         install-time = <seconds the CHILD_SA has been installed>
799                                         local-ts = [
800                                                 <list of local traffic selectors>
801                                         ]
802                                         remote-ts = [
803                                                 <list of remote traffic selectors>
804                                         ]
805                                 }
806                         }
807                 }
808         }
809
810 ### list-policy ###
811
812 The _list-policy_ event is issued to stream installed policies during an active
813 _list-policies_ command.
814
815         {
816                 <ike-sa-config-name/child-sa-config-name> = {
817                         child = <CHILD_SA configuration name>
818                         ike = <IKE_SA configuration name or namespace, if available>
819                         mode = <policy mode, tunnel|transport|pass|drop>
820                         local-ts = [
821                                 <list of local traffic selectors>
822                         ]
823                         remote-ts = [
824                                 <list of remote traffic selectors>
825                         ]
826                 }
827         }
828
829 ### list-conn ###
830
831 The _list-conn_ event is issued to stream loaded connection during an active
832 _list-conns_ command.
833
834         {
835                 <IKE_SA connection name> = {
836                         local_addrs = [
837                                 <list of valid local IKE endpoint addresses>
838                         ]
839                         remote_addrs = [
840                                 <list of valid remote IKE endpoint addresses>
841                         ]
842                         version = <IKE version as string, IKEv1|IKEv2 or 0 for any>
843                         reauth_time = <IKE_SA reauthentication interval in seconds>
844                         rekey_time = <IKE_SA rekeying interval in seconds>
845
846                         local*, remote* = { # multiple local and remote auth sections
847                                 class = <authentication type>
848                                 eap-type = <EAP type to authenticate if when using EAP>
849                                 eap-vendor = <EAP vendor for type, if any>
850                                 xauth = <xauth backend name>
851                                 revocation = <revocation policy>
852                                 id = <IKE identity>
853                                 aaa_id = <AAA authentication backend identity>
854                                 eap_id = <EAP identity for authentication>
855                                 xauth_id = <XAuth username for authentication>
856                                 groups = [
857                                         <group membership required to use connection>
858                                 ]
859                                 certs = [
860                                         <certificates allowed for authentication>
861                                 ]
862                                 cacerts = [
863                                         <CA certificates allowed for authentication>
864                                 ]
865                         }
866                         children = {
867                                 <CHILD_SA config name>* = {
868                                         mode = <IPsec mode>
869                                         rekey_time = <CHILD_SA rekeying interval in seconds>
870                                         rekey_bytes = <CHILD_SA rekeying interval in bytes>
871                                         rekey_packets = <CHILD_SA rekeying interval in packets>
872                                         local-ts = [
873                                                 <list of local traffic selectors>
874                                         ]
875                                         remote-ts = [
876                                                 <list of remote traffic selectors>
877                                         ]
878                                 }
879                         }
880                 }
881         }
882
883 ### list-cert ###
884
885 The _list-cert_ event is issued to stream loaded certificates during an active
886 _list-certs_ command.
887
888         {
889                 type = <certificate type, X509|X509_AC|X509_CRL|OCSP_RESPONSE|PUBKEY>
890                 flag = <X.509 certificate flag, NONE|CA|AA|OCSP>
891                 has_privkey = <set if a private key for the certificate is available>
892                 data = <ASN1 encoded certificate data>
893                 subject = <subject string if defined and certificate type is PUBKEY>
894                 not-before = <time string if defined and certificate type is PUBKEY>
895                 not-after  = <time string if defined and certificate type is PUBKEY>
896         }
897
898 ### list-authority ###
899
900 The _list-authority_ event is issued to stream loaded certification authority
901 information during an active_list-authorities_ command.
902
903         {
904                 <certification authority name> = {
905                         cacert = <subject distinguished name of CA certificate>
906                         crl_uris = [
907                                 <CRL URI (http, ldap or file)>
908                         ]
909                         ocsp_uris = [
910                                 <OCSP URI (http)>
911                         ]
912                         cert_uri_base = <base URI for download of hash-and-URL certificates>
913                 }
914         }
915
916 ### ike-updown ###
917
918 The _ike-updown_ event is issued when an IKE_SA is established or terminated.
919
920         {
921                 up = <set if up event>
922                 <IKE_SA config name> = {
923                         <same data as in the list-sas event, but without child-sas section>
924                 }
925         }
926
927 ### ike-rekey ###
928
929 The _ike-rekey_ event is issued when an IKE_SA is rekeyed.
930
931         {
932                 <IKE_SA config name> = {
933                         old = {
934                                 <same data as in the list-sas event, but without child-sas section>
935                         }
936                         new = {
937                                 <same data as in the list-sas event, but without child-sas section>
938                         }
939                 }
940         }
941
942 ### child-updown ###
943
944 The _child-updown_ event is issued when a CHILD_SA is established or terminated.
945
946         {
947                 up = <set if up event>
948                 <IKE_SA config name> = {
949                         <same data as in the list-sas event, but with only the affected
950                          CHILD_SA in the child-sas section>
951                 }
952         }
953
954 ### child-rekey ###
955
956 The _child-rekey_ event is issued when a CHILD_SA is rekeyed.
957
958         {
959                 <IKE_SA config name> = {
960                         <same data as in the list-sas event, but with the child-sas section
961                          as follows>
962                         child-sas = {
963                                 <child-sa-name> = {
964                                         old = {
965                                                 <same data as in the list-sas event>
966                                         }
967                                         new = {
968                                                 <same data as in the list-sas event>
969                                         }
970                                 }
971                         }
972                 }
973         }
974
975 # libvici C client library #
976
977 libvici is the reference implementation of a C client library implementing
978 the vici protocol. It builds upon libstrongswan, but provides a stable API
979 to implement client applications in the C programming language. libvici uses
980 the libstrongswan thread pool to deliver event messages asynchronously.
981
982 ## Connecting to the daemon ##
983
984 This example shows how to connect to the daemon using the default URI, and
985 then perform proper cleanup:
986
987         #include <stdio.h>
988         #include <errno.h>
989         #include <string.h>
990
991         #include <libvici.h>
992
993         int main(int argc, char *argv[])
994         {
995                 vici_conn_t *conn;
996                 int ret = 0;
997
998                 vici_init();
999                 conn = vici_connect(NULL);
1000                 if (conn)
1001                 {
1002                         /* do stuff */
1003                         vici_disconnect(conn);
1004                 }
1005                 else
1006                 {
1007                         ret = errno;
1008                         fprintf(stderr, "connecting failed: %s\n", strerror(errno));
1009                 }
1010                 vici_deinit();
1011                 return ret;
1012         }
1013
1014 ## A simple client request ##
1015
1016 In the following example, a simple _version_ request is issued to the daemon
1017 and the result is printed:
1018
1019         int get_version(vici_conn_t *conn)
1020         {
1021                 vici_req_t *req;
1022                 vici_res_t *res;
1023                 int ret = 0;
1024
1025                 req = vici_begin("version");
1026                 res = vici_submit(req, conn);
1027                 if (res)
1028                 {
1029                         printf("%s %s (%s, %s, %s)\n",
1030                                 vici_find_str(res, "", "daemon"),
1031                                 vici_find_str(res, "", "version"),
1032                                 vici_find_str(res, "", "sysname"),
1033                                 vici_find_str(res, "", "release"),
1034                                 vici_find_str(res, "", "machine"));
1035                         vici_free_res(res);
1036                 }
1037                 else
1038                 {
1039                         ret = errno;
1040                         fprintf(stderr, "version request failed: %s\n", strerror(errno));
1041                 }
1042                 return ret;
1043         }
1044
1045 ## A request with event streaming and callback parsing ##
1046
1047 In this more advanced example, the _list-conns_ command is used to stream
1048 loaded connections with the _list-conn_ event. The event message is parsed
1049 with a simple callback to print the connection name:
1050
1051         int conn_cb(void *null, vici_res_t *res, char *name)
1052         {
1053                 printf("%s\n", name);
1054                 return 0;
1055         }
1056
1057         void list_cb(void *null, char *name, vici_res_t *res)
1058         {
1059                 if (vici_parse_cb(res, conn_cb, NULL, NULL, NULL) != 0)
1060                 {
1061                         fprintf(stderr, "parsing failed: %s\n", strerror(errno));
1062                 }
1063         }
1064
1065         int list_conns(vici_conn_t *conn)
1066         {
1067                 vici_req_t *req;
1068                 vici_res_t *res;
1069                 int ret = 0;
1070
1071                 if (vici_register(conn, "list-conn", list_cb, NULL) == 0)
1072                 {
1073                         req = vici_begin("list-conns");
1074                         res = vici_submit(req, conn);
1075                         if (res)
1076                         {
1077                                 vici_free_res(res);
1078                         }
1079                         else
1080                         {
1081                                 ret = errno;
1082                                 fprintf(stderr, "request failed: %s\n", strerror(errno));
1083                         }
1084                         vici_register(conn, "list-conn", NULL, NULL);
1085                 }
1086                 else
1087                 {
1088                         ret = errno;
1089                         fprintf(stderr, "registration failed: %s\n", strerror(errno));
1090                 }
1091                 return ret;
1092         }
1093
1094 ## API documentation ##
1095
1096 More information about the libvici API is available in the _libvici.h_ header
1097 file or the generated Doxygen documentation.
1098
1099 # vici ruby gem #
1100
1101 The _vici ruby gem_ is a pure ruby implementation of the VICI protocol to
1102 implement client applications. It is provided in the _ruby_ subdirectory, and
1103 gets built and installed if strongSwan has been _./configure_'d with
1104 _--enable-vici_ and _--enable-ruby-gems_.
1105
1106 The _Connection_ class from the _Vici_ module provides the high level interface,
1107 the underlying classes are usually not required to build ruby applications
1108 using VICI. The _Connection_ class provides methods for the supported VICI
1109 commands and an event listening mechanism.
1110
1111 To represent the VICI message data tree, the gem converts the binary encoding
1112 to ruby data types. The _Connection_ class takes and returns ruby objects for
1113 the exchanged message data:
1114  * Sections get encoded as Hash, containing other sections as Hash, or
1115  * Key/Values, where the values are Strings as Hash values
1116  * Lists get encoded as Arrays with String values
1117 Non-String values that are not a Hash nor an Array get converted with .to_s
1118 during encoding.
1119
1120 ## Connecting to the daemon ##
1121
1122 To create a connection to the daemon, a socket can be passed to the
1123 _Connection_ constructor. If none is passed, a default Unix socket at
1124 _/var/run/charon.vici_ is used:
1125
1126         require "vici"
1127         require "socket"
1128
1129         v = Vici::Connection.new(UNIXSocket.new("/var/run/charon.vici"))
1130
1131 ## A simple client request ##
1132
1133 An example to print the daemon version information is as simple as:
1134
1135         x = v.version
1136         puts "%s %s (%s, %s, %s)" % [
1137                 x["daemon"], x["version"], x["sysname"], x["release"], x["machine"]
1138         ]
1139
1140 ## A request with closure invocation ##
1141
1142 The _Connection_ class takes care of event streaming by invoking a closure
1143 for each event. The following example lists all loaded connections using the
1144 _list-conns_ command and implicitly the _list-conn_ event:
1145
1146         v.list_conns { |conn|
1147                 conn.each { |key, value|
1148                         puts key
1149                 }
1150         }
1151
1152 ## API documentation ##
1153
1154 For more details about the ruby gem refer to the comments in the gem source
1155 code or the generated documentation.
1156
1157 # vici Python egg #
1158
1159 The _vici Python egg_ is a pure Python implementation of the VICI protocol to
1160 implement client applications. It is provided in the _python_ subdirectory, and
1161 gets built and installed if strongSwan has been _./configure_'d with
1162 _--enable-vici_ and _--enable-python-eggs_.
1163
1164 The _vici_ module provides a _Session()_ constructor for a high level interface,
1165 the underlying classes are usually not required to build Python applications
1166 using VICI. The _Session_ class provides methods for the supported VICI
1167 commands.
1168
1169 To represent the VICI message data tree, the library converts the binary
1170 encoding to Python data types. The _Session_ class takes and returns Python
1171 objects for the exchanged message data:
1172  * Sections get encoded as OrderedDict, containing other sections, or
1173  * Key/Values, where the values are strings as dictionary values
1174  * Lists get encoded as Python Lists with string values
1175 Values that do not conform to Python dict or list get converted to strings using
1176 str().
1177
1178 ## Connecting to the daemon ##
1179
1180 To create a connection to the daemon, a socket can be passed to the _Session_
1181 constructor. If none is passed, a default Unix socket at _/var/run/charon.vici_
1182 is used:
1183
1184         import vici
1185         import socket
1186
1187         s = socket.socket(socket.AF_UNIX)
1188         s.connect("/var/run/charon.vici")
1189         v = vici.Session(s)
1190
1191 ## A simple client request ##
1192
1193 An example to print the daemon version information is as simple as:
1194
1195         ver = v.version()
1196
1197         print "{daemon} {version} ({sysname}, {release}, {machine})".format(**ver)
1198
1199 ## A request with response iteration ##
1200
1201 The _Session_ class returns an iterable Python generator for streamed events to
1202 continuously stream objects to the caller. The following example lists all
1203 loaded connections using the _list-conns_ command and implicitly the _list-conn_
1204 event:
1205
1206         for conn in v.list_conns():
1207                 for key in conn:
1208                         print key
1209
1210 Please note that if the returned generator is not iterated completely, it must
1211 be closed using _close()_. This is implicitly done when breaking from a loop,
1212 but an explicit call may be required when directly iterating the generator with
1213 _next()_.
1214
1215 ## Sorting in dictionaries ##
1216
1217 In VICI, in some message trees the order of objects in dictionary matters. In
1218 contrast to ruby Hashes, Python dictionaries do not preserve order of added
1219 objects. It is therefore recommended to use OrderedDicts instead of the default
1220 dictionaries. Objects returned by the library use OrderedDicts.
1221
1222 ## API documentation ##
1223
1224 For more details about the Python egg refer to the comments in the Python source
1225 code.
1226
1227 # Vici::Session Perl CPAN module #
1228
1229 The _Vici::Session Perl CPAN module_ is a pure Perl implementation of the VICI
1230 protocol to implement client applications. It is provided in the _perl_
1231 subdirectory, and gets built and installed if strongSwan has been
1232  _./configure_'d with_--enable-vici_ and _--enable-perl-cpan_.
1233
1234 The _Vici::Session_ module provides a _new()_ constructor for a high level
1235 interface, the underlying _Vici::Packet_ and _Vici::Transport_ classes are
1236 usually not required to build Perl applications using VICI. The _Vici::Session_
1237 class provides methods for the supported VICI commands. The auxiliare
1238  _Vici::Message_ class is used to encode configuration parameters sent to
1239 the daemon and decode data returned by the daemon.
1240
1241 ## Connecting to the daemon ##
1242
1243         use IO::Socket::UNIX;
1244         use Vici::Session;
1245         use Vici::Message;
1246
1247         my $socket = IO::Socket::UNIX->new(
1248                         Type => SOCK_STREAM,
1249                         Peer => '/var/run/charon.vici',
1250         ) or die "Vici socket: $!";
1251
1252         my $session = Vici::Session->new($socket);
1253
1254 ## A simple client request ##
1255
1256 An example to print the daemon version information is as simple as:
1257
1258         my $version = $session->version()->hash();
1259
1260         foreach my $key ('daemon', 'version', 'sysname', 'release', 'machine' ) {
1261                 print $version->{$key}, " ";
1262         }
1263
1264 The _Vici::Session_ methods are explained in the perl/Vici-Session/README.pod
1265 document.