vici: Document NTLM secrets in README.md
[strongswan.git] / src / libcharon / plugins / vici / README.md
index 9bda949..49cce37 100644 (file)
@@ -480,11 +480,12 @@ Load a certificate into the daemon.
 Load a private key into the daemon.
 
        {
-               type = <private key type, RSA|ECDSA>
+               type = <private key type, rsa|ecdsa|bliss|any>
                data = <PEM or DER encoded key data>
        } => {
                success = <yes or no>
                errmsg = <error string on failure>
+               id = <hex-encoded SHA-1 key identifier of the public key on success>
        }
 
 ### unload-key() ###
@@ -529,11 +530,11 @@ on the key identifier derived from the public key).
 
 ### load-shared() ###
 
-Load a shared IKE PSK, EAP or XAuth secret into the daemon.
+Load a shared IKE PSK, EAP, XAuth or NTLM secret into the daemon.
 
        {
                id = <optional unique identifier of this shared key>
-               type = <shared key type, IKE|EAP|XAUTH>
+               type = <shared key type, IKE|EAP|XAUTH|NTLM>
                data = <raw shared key data>
                owners = [
                        <list of shared key owner identities>
@@ -545,8 +546,8 @@ Load a shared IKE PSK, EAP or XAuth secret into the daemon.
 
 ### unload-shared() ###
 
-Unload a previously loaded shared IKE PSK, EAP or XAuth secret by its unique
-identifier.
+Unload a previously loaded shared IKE PSK, EAP, XAuth or NTLM secret by its
+unique identifier.
 
        {
                id = <unique identifier of the shared key to unload>
@@ -681,6 +682,35 @@ List currently loaded algorithms and their implementation.
                }
        }
 
+### get-counters() ###
+
+List global or connection-specific counters for several IKE events.
+
+       {
+               name = <optional connection name, omit for global counters>
+               all = <yes to get counters for all connections, name is ignored>
+       } => {
+               counters = {
+                       <name|empty for global counters> = {
+                               <pairs of counter name and 64-bit counter value>
+                       }
+               }
+               success = <yes or no>
+               errmsg = <error string on failure>
+       }
+
+### reset-counters() ###
+
+Reset global or connection-specific IKE event counters.
+
+       {
+               name = <optional connection name, omit for global counters>
+               all = <yes to reset counters for all connections, name is ignored>
+       } => {
+               success = <yes or no>
+               errmsg = <error string on failure>
+       }
+
 ## Server-issued events ##
 
 Based on the packet layer, the vici plugin raises event messages using named