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