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