feat: Added keyManagerGetKeyManagementSystems

decentralized-identity · Sep 7, 2020 · 9741462 · 9741462
1 parent cef06b1
commit 9741462
Show file tree

Hide file tree

Showing 10 changed files with 83 additions and 0 deletions.
diff --git a/docs/api/daf-core.ikeymanager.keymanagergetkeymanagementsystems.md b/docs/api/daf-core.ikeymanager.keymanagergetkeymanagementsystems.md
@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-core](./daf-core.md) &gt; [IKeyManager](./daf-core.ikeymanager.md) &gt; [keyManagerGetKeyManagementSystems](./daf-core.ikeymanager.keymanagergetkeymanagementsystems.md)
+
+## IKeyManager.keyManagerGetKeyManagementSystems() method
+
+Lists available key management systems
+
+<b>Signature:</b>
+
+```typescript
+keyManagerGetKeyManagementSystems(): Promise<Array<string>>;
+```
+<b>Returns:</b>
+
+Promise&lt;Array&lt;string&gt;&gt;
+
diff --git a/docs/api/daf-core.ikeymanager.md b/docs/api/daf-core.ikeymanager.md
@@ -22,6 +22,7 @@ export interface IKeyManager extends IPluginMethodMap
 |  [keyManagerDeleteKey(args)](./daf-core.ikeymanager.keymanagerdeletekey.md) | Deletes a key |
 |  [keyManagerEncryptJWE(args)](./daf-core.ikeymanager.keymanagerencryptjwe.md) | <b><i>(BETA)</i></b> Encrypts data |
 |  [keyManagerGetKey(args)](./daf-core.ikeymanager.keymanagergetkey.md) | Returns an existing key |
+|  [keyManagerGetKeyManagementSystems()](./daf-core.ikeymanager.keymanagergetkeymanagementsystems.md) | Lists available key management systems |
 |  [keyManagerImportKey(args)](./daf-core.ikeymanager.keymanagerimportkey.md) | Imports a created key |
 |  [keyManagerSignEthTX(args)](./daf-core.ikeymanager.keymanagersignethtx.md) | Signs Ethereum transaction |
 |  [keyManagerSignJWT(args)](./daf-core.ikeymanager.keymanagersignjwt.md) | Signs JWT |

diff --git a/docs/api/daf-key-manager.keymanager.keymanagergetkeymanagementsystems.md b/docs/api/daf-key-manager.keymanager.keymanagergetkeymanagementsystems.md
@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-key-manager](./daf-key-manager.md) &gt; [KeyManager](./daf-key-manager.keymanager.md) &gt; [keyManagerGetKeyManagementSystems](./daf-key-manager.keymanager.keymanagergetkeymanagementsystems.md)
+
+## KeyManager.keyManagerGetKeyManagementSystems() method
+
+Lists available key management systems
+
+<b>Signature:</b>
+
+```typescript
+keyManagerGetKeyManagementSystems(): Promise<Array<string>>;
+```
+<b>Returns:</b>
+
+Promise&lt;Array&lt;string&gt;&gt;
+
diff --git a/docs/api/daf-key-manager.keymanager.md b/docs/api/daf-key-manager.keymanager.md
@@ -34,6 +34,7 @@ export declare class KeyManager implements IAgentPlugin
 |  [keyManagerDeleteKey({ kid })](./daf-key-manager.keymanager.keymanagerdeletekey.md) |  | Deletes a key |
 |  [keyManagerEncryptJWE({ kid, to, data })](./daf-key-manager.keymanager.keymanagerencryptjwe.md) |  | Encrypts data |
 |  [keyManagerGetKey({ kid })](./daf-key-manager.keymanager.keymanagergetkey.md) |  | Returns an existing key |
+|  [keyManagerGetKeyManagementSystems()](./daf-key-manager.keymanager.keymanagergetkeymanagementsystems.md) |  | Lists available key management systems |
 |  [keyManagerImportKey(key)](./daf-key-manager.keymanager.keymanagerimportkey.md) |  | Imports a created key |
 |  [keyManagerSignEthTX({ kid, transaction })](./daf-key-manager.keymanager.keymanagersignethtx.md) |  | Signs Ethereum transaction |
 |  [keyManagerSignJWT({ kid, data })](./daf-key-manager.keymanager.keymanagersignjwt.md) |  | Signs JWT |

diff --git a/docs/methods.md b/docs/methods.md
@@ -145,6 +145,11 @@ Encrypts data
 Returns an existing key
 
 
+### [keyManagerGetKeyManagementSystems](./api/daf-core.ikeymanager.keymanagergetkeymanagementsystems.md)
+
+Lists available key management systems
+
+
 ### [keyManagerImportKey](./api/daf-core.ikeymanager.keymanagerimportkey.md)
 
 Imports a created key

diff --git a/packages/daf-core/src/types.ts b/packages/daf-core/src/types.ts
@@ -737,6 +737,11 @@ export interface IKeyManagerSignEthTXArgs {
  * @public
  */
 export interface IKeyManager extends IPluginMethodMap {
+  /**
+   * Lists available key management systems
+   */
+  keyManagerGetKeyManagementSystems(): Promise<Array<string>>
+
   /**
    * Creates and returns a new key
    */

diff --git a/packages/daf-key-manager/src/key-manager.ts b/packages/daf-key-manager/src/key-manager.ts
@@ -31,6 +31,7 @@ export class KeyManager implements IAgentPlugin {
     this.store = options.store
     this.kms = options.kms
     this.methods = {
+      keyManagerGetKeyManagementSystems: this.keyManagerGetKeyManagementSystems.bind(this),
       keyManagerCreateKey: this.keyManagerCreateKey.bind(this),
       keyManagerGetKey: this.keyManagerGetKey.bind(this),
       keyManagerDeleteKey: this.keyManagerDeleteKey.bind(this),
@@ -48,6 +49,11 @@ export class KeyManager implements IAgentPlugin {
     return kms
   }
 
+  /** {@inheritDoc daf-core#IKeyManager.keyManagerGetKeyManagementSystems} */
+  async keyManagerGetKeyManagementSystems(): Promise<Array<string>> {
+    return Object.keys(this.kms)
+  }
+
   /** {@inheritDoc daf-core#IKeyManager.keyManagerCreateKey} */
   async keyManagerCreateKey(args: IKeyManagerCreateKeyArgs): Promise<IKey> {
     const kms = this.getKms(args.kms)

diff --git a/packages/daf-rest/src/openApiSchema.ts b/packages/daf-rest/src/openApiSchema.ts
@@ -2335,6 +2335,34 @@ export const openApiSchema: OpenAPIV3.Document = {
         }
       }
     },
+    "/keyManagerGetKeyManagementSystems": {
+      "post": {
+        "description": "Lists available key management systems",
+        "operationId": "keyManagerGetKeyManagementSystems",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {}
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Lists available key management systems",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/keyManagerImportKey": {
       "post": {
         "description": "Imports a created key",

diff --git a/report/daf-core.api.md b/report/daf-core.api.md
@@ -165,6 +165,7 @@ export interface IKeyManager extends IPluginMethodMap {
     // @beta
     keyManagerEncryptJWE(args: IKeyManagerEncryptJWEArgs): Promise<string>;
     keyManagerGetKey(args: IKeyManagerGetKeyArgs): Promise<IKey>;
+    keyManagerGetKeyManagementSystems(): Promise<Array<string>>;
     keyManagerImportKey(args: IKey): Promise<boolean>;
     keyManagerSignEthTX(args: IKeyManagerSignEthTXArgs): Promise<string>;
     keyManagerSignJWT(args: IKeyManagerSignJWTArgs): Promise<string>;

diff --git a/report/daf-key-manager.api.md b/report/daf-key-manager.api.md
@@ -89,6 +89,8 @@ export class KeyManager implements IAgentPlugin {
     // (undocumented)
     keyManagerGetKey({ kid }: IKeyManagerGetKeyArgs): Promise<IKey>;
     // (undocumented)
+    keyManagerGetKeyManagementSystems(): Promise<Array<string>>;
+    // (undocumented)
     keyManagerImportKey(key: IKey): Promise<boolean>;
     // (undocumented)
     keyManagerSignEthTX({ kid, transaction }: IKeyManagerSignEthTXArgs): Promise<string>;