1 module netconf-keystore {
2 namespace "urn:opendaylight:netconf:keystore";
5 revision "2017-10-17" {
6 description "Initial revision of the Netconf SBP keystore.";
9 description "Store used for key based Credentials for Netconf SBP. Before a connector with key based authentication
10 is created it needs to have a record for the key pair it uses. All the records here need to be
11 encrypted as they contain sensitive data. Therefore NEVER do direct writes and only use the provided
12 RPCs for adding/removing key entries.";
14 grouping keystore-entry {
23 description "Base64 encoded private key that should be used for authentication with a netconf device.
24 Do not include a public key as that is calculated from the private key.
25 DO NOT write this directly into the data store, use the provided RPCs as these will
26 encrypt the key before the entry is written into the data store.";
31 description "If the provided key is encrypted by a passphrase this needs to be included. Leave empty
32 if the key does not have a passphrase.
33 DO NOT write write this directly into the data store, use the provided RPCs as these will
34 encrypt the passphrase before the entry is written into the data store.";
40 grouping private-keys {
43 description "A private key.";
48 description "Base64 encoded private key.";
51 leaf-list certificate-chain {
52 description "A certificate chain for this public key. Each certificate is an X.509 v3 certificate
53 structure as specified by RFC5280, encoded using the Base64 format.";
60 grouping trusted-certificates {
61 list trusted-certificate {
63 description "A list of trusted certificate. These certificates can be used by a server to authenticate
64 clients, or by clients to authenticate servers.";
69 description "An X.509 v3 certificate structure as specified by RFC5280, encoded using
79 uses trusted-certificates;
82 rpc add-keystore-entry {
83 description "Use this rpc to add a single or multiple new keys into the keystore. The private key and passphrase
84 will both be encrypted before they are written into the data store.";
90 rpc remove-keystore-entry {
91 description "Use this rpc to remove a single or multiple keys from the data store.";
100 description "Add a list of private keys into the keystore.";
106 rpc remove-private-key {
107 description "Remove a list of private keys from the data store.";
115 rpc add-trusted-certificate {
116 description "Add a list of trusted certificates into the keystore.";
118 uses trusted-certificates;
122 rpc remove-trusted-certificate {
123 description "Remove a list of trusted certificates from the data store.";