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

package/src/models/ResolvedKeyInfo.ts

@@ -0,0 +1,165 @@
+/* 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 { KeyType } from './KeyType';
+import {
+    KeyTypeFromJSON,
+    KeyTypeToJSON,
+} from './KeyType';
+import type { KeyVisibility } from './KeyVisibility';
+import {
+    KeyVisibilityFromJSON,
+    KeyVisibilityToJSON,
+} from './KeyVisibility';
+import type { SignatureAlgorithm } from './SignatureAlgorithm';
+import {
+    SignatureAlgorithmFromJSON,
+    SignatureAlgorithmToJSON,
+} from './SignatureAlgorithm';
+import type { KeyEncoding } from './KeyEncoding';
+import {
+    KeyEncodingFromJSON,
+    KeyEncodingToJSON,
+} from './KeyEncoding';
+import type { Jwk } from './Jwk';
+import {
+    JwkFromJSON,
+    JwkToJSON,
+} from './Jwk';
+
+/**
+ * Represents a resolved cryptographic key information where the key is guaranteed to be present and resolved, providing concrete access to the key.
+ * @export
+ * @interface ResolvedKeyInfo
+ */
+export interface ResolvedKeyInfo {
+    /**
+     * Unique identifier for the cryptographic key. Can be null if the key identifier is not provided.
+     * @type {string}
+     * @memberof ResolvedKeyInfo
+     */
+    kid?: string;
+    /**
+     *
+     * @type {Jwk}
+     * @memberof ResolvedKeyInfo
+     */
+    key: Jwk;
+    /**
+     *
+     * @type {SignatureAlgorithm}
+     * @memberof ResolvedKeyInfo
+     */
+    signatureAlgorithm?: SignatureAlgorithm;
+    /**
+     *
+     * @type {KeyVisibility}
+     * @memberof ResolvedKeyInfo
+     */
+    keyVisibility?: KeyVisibility;
+    /**
+     * X.509 certificate chain associated with the key.
+     * @type {Array<string>}
+     * @memberof ResolvedKeyInfo
+     */
+    x5c?: Array<string>;
+    /**
+     * A reference or alias to the key in the Key Management Service (KMS).
+     * @type {string}
+     * @memberof ResolvedKeyInfo
+     */
+    alias?: string;
+    /**
+     * The Key Management System (KMS) identifier associated with the key.
+     * @type {string}
+     * @memberof ResolvedKeyInfo
+     */
+    providerId?: string;
+    /**
+     *
+     * @type {KeyType}
+     * @memberof ResolvedKeyInfo
+     */
+    keyType?: KeyType;
+    /**
+     *
+     * @type {KeyEncoding}
+     * @memberof ResolvedKeyInfo
+     */
+    keyEncoding?: KeyEncoding;
+    /**
+     * Additional configuration options as key-value pairs.
+     * @type {{ [key: string]: string; }}
+     * @memberof ResolvedKeyInfo
+     */
+    opts?: { [key: string]: string; };
+}
+
+
+
+/**
+ * Check if a given object implements the ResolvedKeyInfo interface.
+ */
+export function instanceOfResolvedKeyInfo(value: object): value is ResolvedKeyInfo {
+    if (!('key' in value) || value['key'] === undefined) return false;
+    return true;
+}
+
+export function ResolvedKeyInfoFromJSON(json: any): ResolvedKeyInfo {
+    return ResolvedKeyInfoFromJSONTyped(json, false);
+}
+
+export function ResolvedKeyInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResolvedKeyInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'kid': json['kid'] == null ? undefined : json['kid'],
+        'key': JwkFromJSON(json['key']),
+        'signatureAlgorithm': json['signatureAlgorithm'] == null ? undefined : SignatureAlgorithmFromJSON(json['signatureAlgorithm']),
+        'keyVisibility': json['keyVisibility'] == null ? undefined : KeyVisibilityFromJSON(json['keyVisibility']),
+        'x5c': json['x5c'] == null ? undefined : json['x5c'],
+        'alias': json['alias'] == null ? undefined : json['alias'],
+        'providerId': json['providerId'] == null ? undefined : json['providerId'],
+        'keyType': json['keyType'] == null ? undefined : KeyTypeFromJSON(json['keyType']),
+        'keyEncoding': json['keyEncoding'] == null ? undefined : KeyEncodingFromJSON(json['keyEncoding']),
+        'opts': json['opts'] == null ? undefined : json['opts'],
+    };
+}
+
+export function ResolvedKeyInfoToJSON(json: any): ResolvedKeyInfo {
+    return ResolvedKeyInfoToJSONTyped(json, false);
+}
+
+export function ResolvedKeyInfoToJSONTyped(value?: ResolvedKeyInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'kid': value['kid'],
+        'key': JwkToJSON(value['key']),
+        'signatureAlgorithm': SignatureAlgorithmToJSON(value['signatureAlgorithm']),
+        'keyVisibility': KeyVisibilityToJSON(value['keyVisibility']),
+        'x5c': value['x5c'],
+        'alias': value['alias'],
+        'providerId': value['providerId'],
+        'keyType': KeyTypeToJSON(value['keyType']),
+        'keyEncoding': KeyEncodingToJSON(value['keyEncoding']),
+        'opts': value['opts'],
+    };
+}
+

package/src/models/Resolver.ts

@@ -0,0 +1,92 @@
+/* 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 { KeyType } from './KeyType';
+import {
+    KeyTypeFromJSON,
+    KeyTypeToJSON,
+} from './KeyType';
+import type { IdentifierMethod } from './IdentifierMethod';
+import {
+    IdentifierMethodFromJSON,
+    IdentifierMethodToJSON,
+} from './IdentifierMethod';
+
+/**
+ * Represents a key resolver configuration.
+ * @export
+ * @interface Resolver
+ */
+export interface Resolver {
+    /**
+     * Unique identifier for the resolver.
+     * @type {string}
+     * @memberof Resolver
+     */
+    resolverId: string;
+    /**
+     * List of identifier methods supported by this resolver.
+     * @type {Array<IdentifierMethod>}
+     * @memberof Resolver
+     */
+    supportedIdentifierMethods?: Array<IdentifierMethod>;
+    /**
+     * List of key types supported by this resolver.
+     * @type {Array<KeyType>}
+     * @memberof Resolver
+     */
+    supportedKeyTypes?: Array<KeyType>;
+}
+
+/**
+ * Check if a given object implements the Resolver interface.
+ */
+export function instanceOfResolver(value: object): value is Resolver {
+    if (!('resolverId' in value) || value['resolverId'] === undefined) return false;
+    return true;
+}
+
+export function ResolverFromJSON(json: any): Resolver {
+    return ResolverFromJSONTyped(json, false);
+}
+
+export function ResolverFromJSONTyped(json: any, ignoreDiscriminator: boolean): Resolver {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'resolverId': json['resolverId'],
+        'supportedIdentifierMethods': json['supportedIdentifierMethods'] == null ? undefined : ((json['supportedIdentifierMethods'] as Array<any>).map(IdentifierMethodFromJSON)),
+        'supportedKeyTypes': json['supportedKeyTypes'] == null ? undefined : ((json['supportedKeyTypes'] as Array<any>).map(KeyTypeFromJSON)),
+    };
+}
+
+export function ResolverToJSON(json: any): Resolver {
+    return ResolverToJSONTyped(json, false);
+}
+
+export function ResolverToJSONTyped(value?: Resolver | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'resolverId': value['resolverId'],
+        'supportedIdentifierMethods': value['supportedIdentifierMethods'] == null ? undefined : ((value['supportedIdentifierMethods'] as Array<any>).map(IdentifierMethodToJSON)),
+        'supportedKeyTypes': value['supportedKeyTypes'] == null ? undefined : ((value['supportedKeyTypes'] as Array<any>).map(KeyTypeToJSON)),
+    };
+}
+

package/src/models/SignInput.ts

@@ -0,0 +1,92 @@
+/* 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.
+ */
+
+/**
+ * The input data and metadata required for creating a signature.
+ * @export
+ * @interface SignInput
+ */
+export interface SignInput {
+    /**
+     * The data to be signed, encoded as a base64 string.
+     * @type {string}
+     * @memberof SignInput
+     */
+    data: string;
+    /**
+     * The signing mode to be used.
+     * @type {string}
+     * @memberof SignInput
+     */
+    mode?: SignInputModeEnum;
+    /**
+     * Additional metadata to be included in the signature.
+     * @type {{ [key: string]: any; }}
+     * @memberof SignInput
+     */
+    metadata?: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const SignInputModeEnum = {
+    Detached: 'DETACHED',
+    Attached: 'ATTACHED'
+} as const;
+export type SignInputModeEnum = typeof SignInputModeEnum[keyof typeof SignInputModeEnum];
+
+
+/**
+ * Check if a given object implements the SignInput interface.
+ */
+export function instanceOfSignInput(value: object): value is SignInput {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function SignInputFromJSON(json: any): SignInput {
+    return SignInputFromJSONTyped(json, false);
+}
+
+export function SignInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'data': json['data'],
+        'mode': json['mode'] == null ? undefined : json['mode'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+
+export function SignInputToJSON(json: any): SignInput {
+    return SignInputToJSONTyped(json, false);
+}
+
+export function SignInputToJSONTyped(value?: SignInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'data': value['data'],
+        'mode': value['mode'],
+        'metadata': value['metadata'],
+    };
+}
+

package/src/models/SignOutput.ts

@@ -0,0 +1,79 @@
+/* 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 { Signature } from './Signature';
+import {
+    SignatureFromJSON,
+    SignatureToJSON,
+} from './Signature';
+
+/**
+ * The output of a signature creation operation.
+ * @export
+ * @interface SignOutput
+ */
+export interface SignOutput {
+    /**
+     *
+     * @type {Signature}
+     * @memberof SignOutput
+     */
+    signature: Signature;
+    /**
+     * Additional metadata included in the signature output.
+     * @type {{ [key: string]: any; }}
+     * @memberof SignOutput
+     */
+    metadata?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the SignOutput interface.
+ */
+export function instanceOfSignOutput(value: object): value is SignOutput {
+    if (!('signature' in value) || value['signature'] === undefined) return false;
+    return true;
+}
+
+export function SignOutputFromJSON(json: any): SignOutput {
+    return SignOutputFromJSONTyped(json, false);
+}
+
+export function SignOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'signature': SignatureFromJSON(json['signature']),
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+
+export function SignOutputToJSON(json: any): SignOutput {
+    return SignOutputToJSONTyped(json, false);
+}
+
+export function SignOutputToJSONTyped(value?: SignOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'signature': SignatureToJSON(value['signature']),
+        'metadata': value['metadata'],
+    };
+}
+

package/src/models/Signature.ts

@@ -0,0 +1,103 @@
+/* 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';
+import type { SignatureAlgorithm } from './SignatureAlgorithm';
+import {
+    SignatureAlgorithmFromJSON,
+    SignatureAlgorithmToJSON,
+} from './SignatureAlgorithm';
+
+/**
+ * A cryptographic signature including the signature value and related information.
+ * @export
+ * @interface Signature
+ */
+export interface Signature {
+    /**
+     * The signature value, encoded as a base64 string.
+     * @type {string}
+     * @memberof Signature
+     */
+    value: string;
+    /**
+     *
+     * @type {SignatureAlgorithm}
+     * @memberof Signature
+     */
+    algorithm: SignatureAlgorithm;
+    /**
+     *
+     * @type {KeyInfo}
+     * @memberof Signature
+     */
+    keyInfo?: KeyInfo;
+    /**
+     * Additional metadata included in the signature.
+     * @type {{ [key: string]: any; }}
+     * @memberof Signature
+     */
+    metadata?: { [key: string]: any; };
+}
+
+
+
+/**
+ * Check if a given object implements the Signature interface.
+ */
+export function instanceOfSignature(value: object): value is Signature {
+    if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('algorithm' in value) || value['algorithm'] === undefined) return false;
+    return true;
+}
+
+export function SignatureFromJSON(json: any): Signature {
+    return SignatureFromJSONTyped(json, false);
+}
+
+export function SignatureFromJSONTyped(json: any, ignoreDiscriminator: boolean): Signature {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'value': json['value'],
+        'algorithm': SignatureAlgorithmFromJSON(json['algorithm']),
+        'keyInfo': json['keyInfo'] == null ? undefined : KeyInfoFromJSON(json['keyInfo']),
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+
+export function SignatureToJSON(json: any): Signature {
+    return SignatureToJSONTyped(json, false);
+}
+
+export function SignatureToJSONTyped(value?: Signature | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'value': value['value'],
+        'algorithm': SignatureAlgorithmToJSON(value['algorithm']),
+        'keyInfo': KeyInfoToJSON(value['keyInfo']),
+        'metadata': value['metadata'],
+    };
+}
+

package/src/models/SignatureAlgorithm.ts

@@ -0,0 +1,63 @@
+/* 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.
+ */
+
+
+/**
+ * Cryptographic signature algorithm identifier.
+ * @export
+ */
+export const SignatureAlgorithm = {
+    Ed25519: 'ED25519',
+    EcdsaSha256: 'ECDSA_SHA256',
+    EcdsaSha384: 'ECDSA_SHA384',
+    EcdsaSha512: 'ECDSA_SHA512',
+    Es256K: 'ES256K',
+    EckaDhSha256: 'ECKA_DH_SHA256',
+    HmacSha256: 'HMAC_SHA256',
+    HmacSha384: 'HMAC_SHA384',
+    HmacSha512: 'HMAC_SHA512',
+    RsaSsaPssSha256Mgf1: 'RSA_SSA_PSS_SHA256_MGF1',
+    RsaSsaPssSha384Mgf1: 'RSA_SSA_PSS_SHA384_MGF1',
+    RsaSsaPssSha512Mgf1: 'RSA_SSA_PSS_SHA512_MGF1'
+} as const;
+export type SignatureAlgorithm = typeof SignatureAlgorithm[keyof typeof SignatureAlgorithm];
+
+
+export function instanceOfSignatureAlgorithm(value: any): boolean {
+    for (const key in SignatureAlgorithm) {
+        if (Object.prototype.hasOwnProperty.call(SignatureAlgorithm, key)) {
+            if (SignatureAlgorithm[key as keyof typeof SignatureAlgorithm] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SignatureAlgorithmFromJSON(json: any): SignatureAlgorithm {
+    return SignatureAlgorithmFromJSONTyped(json, false);
+}
+
+export function SignatureAlgorithmFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignatureAlgorithm {
+    return json as SignatureAlgorithm;
+}
+
+export function SignatureAlgorithmToJSON(value?: SignatureAlgorithm | null): any {
+    return value as any;
+}
+
+export function SignatureAlgorithmToJSONTyped(value: any, ignoreDiscriminator: boolean): SignatureAlgorithm {
+    return value as SignatureAlgorithm;
+}
+

package/src/models/StoreKey.ts

@@ -0,0 +1,79 @@
+/* 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 { ResolvedKeyInfo } from './ResolvedKeyInfo';
+import {
+    ResolvedKeyInfoFromJSON,
+    ResolvedKeyInfoToJSON,
+} from './ResolvedKeyInfo';
+
+/**
+ * Request body for storing a key.
+ * @export
+ * @interface StoreKey
+ */
+export interface StoreKey {
+    /**
+     *
+     * @type {ResolvedKeyInfo}
+     * @memberof StoreKey
+     */
+    keyInfo: ResolvedKeyInfo;
+    /**
+     * X.509 certificate chain as base64-encoded DER certificates.
+     * @type {Array<string>}
+     * @memberof StoreKey
+     */
+    certChain?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the StoreKey interface.
+ */
+export function instanceOfStoreKey(value: object): value is StoreKey {
+    if (!('keyInfo' in value) || value['keyInfo'] === undefined) return false;
+    return true;
+}
+
+export function StoreKeyFromJSON(json: any): StoreKey {
+    return StoreKeyFromJSONTyped(json, false);
+}
+
+export function StoreKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): StoreKey {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'keyInfo': ResolvedKeyInfoFromJSON(json['keyInfo']),
+        'certChain': json['certChain'] == null ? undefined : json['certChain'],
+    };
+}
+
+export function StoreKeyToJSON(json: any): StoreKey {
+    return StoreKeyToJSONTyped(json, false);
+}
+
+export function StoreKeyToJSONTyped(value?: StoreKey | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'keyInfo': ResolvedKeyInfoToJSON(value['keyInfo']),
+        'certChain': value['certChain'],
+    };
+}
+