@sphereon/ssi-sdk.kms-rest-client 0.34.1-feature.IDK.11.48

package/src/models/StoreKeyResponse.ts

@@ -0,0 +1,71 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { ManagedKeyInfo } from './ManagedKeyInfo';
+import {
+    ManagedKeyInfoFromJSON,
+    ManagedKeyInfoToJSON,
+} from './ManagedKeyInfo';
+
+/**
+ * Response body containing a stored key.
+ * @export
+ * @interface StoreKeyResponse
+ */
+export interface StoreKeyResponse {
+    /**
+     *
+     * @type {ManagedKeyInfo}
+     * @memberof StoreKeyResponse
+     */
+    keyInfo: ManagedKeyInfo;
+}
+
+/**
+ * Check if a given object implements the StoreKeyResponse interface.
+ */
+export function instanceOfStoreKeyResponse(value: object): value is StoreKeyResponse {
+    if (!('keyInfo' in value) || value['keyInfo'] === undefined) return false;
+    return true;
+}
+
+export function StoreKeyResponseFromJSON(json: any): StoreKeyResponse {
+    return StoreKeyResponseFromJSONTyped(json, false);
+}
+
+export function StoreKeyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): StoreKeyResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'keyInfo': ManagedKeyInfoFromJSON(json['keyInfo']),
+    };
+}
+
+export function StoreKeyResponseToJSON(json: any): StoreKeyResponse {
+    return StoreKeyResponseToJSONTyped(json, false);
+}
+
+export function StoreKeyResponseToJSONTyped(value?: StoreKeyResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'keyInfo': ManagedKeyInfoToJSON(value['keyInfo']),
+    };
+}
+

package/src/models/UpdateKeyProvider.ts

@@ -0,0 +1,99 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { AwsKmsSetting } from './AwsKmsSetting';
+import {
+    AwsKmsSettingFromJSON,
+    AwsKmsSettingToJSON,
+} from './AwsKmsSetting';
+import type { AzureKeyVaultSetting } from './AzureKeyVaultSetting';
+import {
+    AzureKeyVaultSettingFromJSON,
+    AzureKeyVaultSettingToJSON,
+} from './AzureKeyVaultSetting';
+
+/**
+ * Request body for updating an existing Key Provider instance.
+ * @export
+ * @interface UpdateKeyProvider
+ */
+export interface UpdateKeyProvider {
+    /**
+     *
+     * @type {AzureKeyVaultSetting}
+     * @memberof UpdateKeyProvider
+     */
+    azureKeyvaultSettings?: AzureKeyVaultSetting;
+    /**
+     *
+     * @type {AwsKmsSetting}
+     * @memberof UpdateKeyProvider
+     */
+    awsKmsSettings?: AwsKmsSetting;
+    /**
+     * Whether to enable caching for keys retrieved from this provider.
+     * @type {boolean}
+     * @memberof UpdateKeyProvider
+     */
+    cacheEnabled?: boolean;
+    /**
+     * Time-to-live for cached keys in seconds (if cacheEnabled is true).
+     * @type {number}
+     * @memberof UpdateKeyProvider
+     */
+    cacheTTLInSeconds?: number;
+}
+
+/**
+ * Check if a given object implements the UpdateKeyProvider interface.
+ */
+export function instanceOfUpdateKeyProvider(value: object): value is UpdateKeyProvider {
+    return true;
+}
+
+export function UpdateKeyProviderFromJSON(json: any): UpdateKeyProvider {
+    return UpdateKeyProviderFromJSONTyped(json, false);
+}
+
+export function UpdateKeyProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateKeyProvider {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'azureKeyvaultSettings': json['azureKeyvaultSettings'] == null ? undefined : AzureKeyVaultSettingFromJSON(json['azureKeyvaultSettings']),
+        'awsKmsSettings': json['awsKmsSettings'] == null ? undefined : AwsKmsSettingFromJSON(json['awsKmsSettings']),
+        'cacheEnabled': json['cacheEnabled'] == null ? undefined : json['cacheEnabled'],
+        'cacheTTLInSeconds': json['cacheTTLInSeconds'] == null ? undefined : json['cacheTTLInSeconds'],
+    };
+}
+
+export function UpdateKeyProviderToJSON(json: any): UpdateKeyProvider {
+    return UpdateKeyProviderToJSONTyped(json, false);
+}
+
+export function UpdateKeyProviderToJSONTyped(value?: UpdateKeyProvider | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'azureKeyvaultSettings': AzureKeyVaultSettingToJSON(value['azureKeyvaultSettings']),
+        'awsKmsSettings': AwsKmsSettingToJSON(value['awsKmsSettings']),
+        'cacheEnabled': value['cacheEnabled'],
+        'cacheTTLInSeconds': value['cacheTTLInSeconds'],
+    };
+}
+

package/src/models/VerifyRawSignature.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { KeyInfo } from './KeyInfo';
+import {
+    KeyInfoFromJSON,
+    KeyInfoToJSON,
+} from './KeyInfo';
+
+/**
+ * Request body for verifying a raw signature.
+ * @export
+ * @interface VerifyRawSignature
+ */
+export interface VerifyRawSignature {
+    /**
+     *
+     * @type {KeyInfo}
+     * @memberof VerifyRawSignature
+     */
+    keyInfo: KeyInfo;
+    /**
+     *
+     * @type {string}
+     * @memberof VerifyRawSignature
+     */
+    input: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VerifyRawSignature
+     */
+    signature: string;
+}
+
+/**
+ * Check if a given object implements the VerifyRawSignature interface.
+ */
+export function instanceOfVerifyRawSignature(value: object): value is VerifyRawSignature {
+    if (!('keyInfo' in value) || value['keyInfo'] === undefined) return false;
+    if (!('input' in value) || value['input'] === undefined) return false;
+    if (!('signature' in value) || value['signature'] === undefined) return false;
+    return true;
+}
+
+export function VerifyRawSignatureFromJSON(json: any): VerifyRawSignature {
+    return VerifyRawSignatureFromJSONTyped(json, false);
+}
+
+export function VerifyRawSignatureFromJSONTyped(json: any, ignoreDiscriminator: boolean): VerifyRawSignature {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'keyInfo': KeyInfoFromJSON(json['keyInfo']),
+        'input': json['input'],
+        'signature': json['signature'],
+    };
+}
+
+export function VerifyRawSignatureToJSON(json: any): VerifyRawSignature {
+    return VerifyRawSignatureToJSONTyped(json, false);
+}
+
+export function VerifyRawSignatureToJSONTyped(value?: VerifyRawSignature | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'keyInfo': KeyInfoToJSON(value['keyInfo']),
+        'input': value['input'],
+        'signature': value['signature'],
+    };
+}
+

package/src/models/VerifyRawSignatureResponse.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Response body containing the details of the signature verification.
+ * @export
+ * @interface VerifyRawSignatureResponse
+ */
+export interface VerifyRawSignatureResponse {
+    /**
+     * Indicates whether the signature is valid or not.
+     * @type {boolean}
+     * @memberof VerifyRawSignatureResponse
+     */
+    isValid: boolean;
+}
+
+/**
+ * Check if a given object implements the VerifyRawSignatureResponse interface.
+ */
+export function instanceOfVerifyRawSignatureResponse(value: object): value is VerifyRawSignatureResponse {
+    if (!('isValid' in value) || value['isValid'] === undefined) return false;
+    return true;
+}
+
+export function VerifyRawSignatureResponseFromJSON(json: any): VerifyRawSignatureResponse {
+    return VerifyRawSignatureResponseFromJSONTyped(json, false);
+}
+
+export function VerifyRawSignatureResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VerifyRawSignatureResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'isValid': json['isValid'],
+    };
+}
+
+export function VerifyRawSignatureResponseToJSON(json: any): VerifyRawSignatureResponse {
+    return VerifyRawSignatureResponseToJSONTyped(json, false);
+}
+
+export function VerifyRawSignatureResponseToJSONTyped(value?: VerifyRawSignatureResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'isValid': value['isValid'],
+    };
+}
+

package/src/models/VerifySimpleSignature.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KMS REST Server API
+ * A REST API for managing cryptographic keys and performing signing and verification operations.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ * Contact: support@sphereon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import type { SignInput } from './SignInput';
+import {
+    SignInputFromJSON,
+    SignInputToJSON,
+} from './SignInput';
+import type { Signature } from './Signature';
+import {
+    SignatureFromJSON,
+    SignatureToJSON,
+} from './Signature';
+
+/**
+ * Request body for verifying a digital signature.
+ * @export
+ * @interface VerifySimpleSignature
+ */
+export interface VerifySimpleSignature {
+    /**
+     *
+     * @type {SignInput}
+     * @memberof VerifySimpleSignature
+     */
+    signInput: SignInput;
+    /**
+     *
+     * @type {Signature}
+     * @memberof VerifySimpleSignature
+     */
+    signature: Signature;
+}
+
+/**
+ * Check if a given object implements the VerifySimpleSignature interface.
+ */
+export function instanceOfVerifySimpleSignature(value: object): value is VerifySimpleSignature {
+    if (!('signInput' in value) || value['signInput'] === undefined) return false;
+    if (!('signature' in value) || value['signature'] === undefined) return false;
+    return true;
+}
+
+export function VerifySimpleSignatureFromJSON(json: any): VerifySimpleSignature {
+    return VerifySimpleSignatureFromJSONTyped(json, false);
+}
+
+export function VerifySimpleSignatureFromJSONTyped(json: any, ignoreDiscriminator: boolean): VerifySimpleSignature {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'signInput': SignInputFromJSON(json['signInput']),
+        'signature': SignatureFromJSON(json['signature']),
+    };
+}
+
+export function VerifySimpleSignatureToJSON(json: any): VerifySimpleSignature {
+    return VerifySimpleSignatureToJSONTyped(json, false);
+}
+
+export function VerifySimpleSignatureToJSONTyped(value?: VerifySimpleSignature | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'signInput': SignInputToJSON(value['signInput']),
+        'signature': SignatureToJSON(value['signature']),
+    };
+}
+

package/src/models/index.ts

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AwsAssumeRoleCredentials';
+export * from './AwsClientConfiguration';
+export * from './AwsKmsSetting';
+export * from './AwsStaticCredentials';
+export * from './AwsWebIdentityTokenCredentials';
+export * from './AzureClientSecretCredentialOpts';
+export * from './AzureCredentialOpts';
+export * from './AzureKeyVaultSetting';
+export * from './CoseKey';
+export * from './CoseKeyPair';
+export * from './CoseKeyType';
+export * from './CreateKeyProvider';
+export * from './CreateRawSignature';
+export * from './CreateRawSignatureResponse';
+export * from './CreateSimpleSignature';
+export * from './CryptoAlg';
+export * from './Curve';
+export * from './DigestAlg';
+export * from './ErrorResponse';
+export * from './GenerateKey';
+export * from './GenerateKeyGlobal';
+export * from './GenerateKeyResponse';
+export * from './GetKeyResponse';
+export * from './IdentifierMethod';
+export * from './JoseKeyPair';
+export * from './Jwk';
+export * from './JwkKeyType';
+export * from './JwkUse';
+export * from './KeyEncoding';
+export * from './KeyInfo';
+export * from './KeyOperations';
+export * from './KeyProvider';
+export * from './KeyProviderResponse';
+export * from './KeyProviderType';
+export * from './KeyResolver';
+export * from './KeyType';
+export * from './KeyVisibility';
+export * from './ListKeyProvidersResponse';
+export * from './ListKeysResponse';
+export * from './ListResolversResponse';
+export * from './LookupMode';
+export * from './ManagedKeyInfo';
+export * from './ManagedKeyPair';
+export * from './MaskGenFunction';
+export * from './ProviderCapabilities';
+export * from './ResolvePublicKey';
+export * from './ResolvedKeyInfo';
+export * from './Resolver';
+export * from './SignInput';
+export * from './SignOutput';
+export * from './Signature';
+export * from './SignatureAlgorithm';
+export * from './StoreKey';
+export * from './StoreKeyResponse';
+export * from './UpdateKeyProvider';
+export * from './VerifyRawSignature';
+export * from './VerifyRawSignatureResponse';
+export * from './VerifySimpleSignature';

package/src/types/IKmsRestClient.ts

@@ -0,0 +1,133 @@
+import { IAgentContext, IPluginMethodMap } from '@veramo/core'
+import type { BearerTokenArg } from '@sphereon/ssi-types'
+import {
+  CreateRawSignature,
+  CreateRawSignatureResponse,
+  GenerateKey,
+  GenerateKeyGlobal,
+  KeyProviderResponse,
+  ListKeyProvidersResponse,
+  ListKeysResponse,
+  ListResolversResponse,
+  ManagedKeyInfo,
+  ManagedKeyPair,
+  ResolvedKeyInfo,
+  ResolvePublicKey,
+  Resolver,
+  StoreKey,
+  VerifyRawSignature,
+  VerifyRawSignatureResponse
+} from '../models'
+
+export interface IKmsRestClient extends IPluginMethodMap {
+  kmsGetResolver(args: kmsGetResolverArgs): Promise<Resolver>
+  kmsListResolvers(args: KmsListResolversArgs): Promise<ListResolversResponse>
+  kmsResolveKey(args: KmsResolveKeyArgs): Promise<ResolvedKeyInfo>
+  kmsCreateRawSignature(args: KmsCreateRawSignatureArgs): Promise<CreateRawSignatureResponse>
+  kmsIsValidRawSignature(args: KmsIsValidRawSignatureArgs): Promise<VerifyRawSignatureResponse>
+  kmsGetKey(args: KmsGetKeyArgs): Promise<ManagedKeyInfo>
+  kmsListKeys(args: KmsListKeysArgs): Promise<ListKeysResponse>
+  kmsStoreKey(args: KmsStoreKeyArgs): Promise<ManagedKeyInfo>
+  kmsGenerateKey(args: KmsGenerateKeyArgs): Promise<ManagedKeyPair>
+  kmsDeleteKey(args: KmsDeleteKeyArgs): Promise<boolean>
+  kmsGetKeyProvider(args: KmsGetKeyProviderArgs): Promise<KeyProviderResponse>
+  kmsListKeyProviders(args: KmsListKeyProvidersArgs): Promise<ListKeyProvidersResponse>
+  kmsProviderListKeys(args: KmsProviderListKeysArgs): Promise<ListKeysResponse>
+  kmsProviderStoreKey(args: KmsProviderStoreKey): Promise<ManagedKeyInfo>
+  kmsProviderGenerateKey(args: KmsProviderGenerateKey): Promise<ManagedKeyPair>
+  kmsProviderGetKey(args: KmsProviderGetKeyArgs): Promise<ManagedKeyInfo>
+  kmsProviderDeleteKey(args: KmsProviderDeleteKeyArgs): Promise<boolean>
+}
+
+export type KmsListResolversArgs = {
+  baseUrl?: string
+}
+
+export type kmsGetResolverArgs = {
+  baseUrl?: string
+  resolverId: string
+}
+
+export type KmsResolveKeyArgs = {
+  baseUrl?: string
+  resolverId: String
+} & ResolvePublicKey
+
+export type KmsCreateRawSignatureArgs = {
+  baseUrl?: string
+} & CreateRawSignature
+
+export type KmsIsValidRawSignatureArgs = {
+  baseUrl?: string
+} & VerifyRawSignature
+
+export type KmsGetKeyArgs = {
+  baseUrl?: string
+  aliasOrKid: string
+}
+
+export type KmsListKeysArgs = {
+  baseUrl?: string
+  providerId?: string
+}
+
+export type KmsStoreKeyArgs = {
+  baseUrl?: string
+} & StoreKey
+
+export type KmsGenerateKeyArgs = {
+  baseUrl?: string
+} & GenerateKeyGlobal
+
+export type KmsDeleteKeyArgs = {
+  baseUrl?: string
+  aliasOrKid?: string
+}
+
+export type KmsGetKeyProviderArgs = {
+  baseUrl?: string
+  providerId?: string
+}
+
+export type KmsListKeyProvidersArgs = {
+  baseUrl?: string
+}
+
+export type KmsProviderListKeysArgs = {
+  baseUrl?: string
+  providerId: string
+}
+
+export type KmsProviderStoreKey = {
+  baseUrl?: string
+  providerId: string
+} & StoreKey
+
+export type KmsProviderGenerateKey = {
+  baseUrl?: string
+  providerId: string
+} & GenerateKey
+
+export type KmsProviderGetKeyArgs = {
+  baseUrl?: string
+  providerId: string
+  aliasOrKid: string
+}
+
+export type KmsProviderDeleteKeyArgs = {
+  baseUrl?: string
+  providerId: string
+  aliasOrKid: string
+}
+
+export type RestClientAuthenticationOpts = {
+  enabled?: boolean
+  bearerToken?: BearerTokenArg
+}
+
+export type KmsRestClientArgs = {
+  baseUrl?: string,
+  authentication?: RestClientAuthenticationOpts
+}
+
+export type IRequiredContext = IAgentContext<never>