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

package/src/models/AwsKmsSetting.ts

@@ -0,0 +1,126 @@
+/* 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 { AwsAssumeRoleCredentials } from './AwsAssumeRoleCredentials';
+import {
+    AwsAssumeRoleCredentialsFromJSON,
+    AwsAssumeRoleCredentialsToJSON,
+} from './AwsAssumeRoleCredentials';
+import type { AwsStaticCredentials } from './AwsStaticCredentials';
+import {
+    AwsStaticCredentialsFromJSON,
+    AwsStaticCredentialsToJSON,
+} from './AwsStaticCredentials';
+import type { AwsWebIdentityTokenCredentials } from './AwsWebIdentityTokenCredentials';
+import {
+    AwsWebIdentityTokenCredentialsFromJSON,
+    AwsWebIdentityTokenCredentialsToJSON,
+} from './AwsWebIdentityTokenCredentials';
+import type { AwsClientConfiguration } from './AwsClientConfiguration';
+import {
+    AwsClientConfigurationFromJSON,
+    AwsClientConfigurationToJSON,
+} from './AwsClientConfiguration';
+
+/**
+ * Configuration settings specific to the AWS_KMS provider type. Defines how to connect and authenticate to AWS KMS. If no specific credential provider is specified, the implementation should rely on the default AWS SDK credential provider chain.
+ * @export
+ * @interface AwsKmsSetting
+ */
+export interface AwsKmsSetting {
+    /**
+     * The AWS region where the KMS keys reside (e.g., 'us-east-1', 'eu-west-1').
+     * @type {string}
+     * @memberof AwsKmsSetting
+     */
+    region: string;
+    /**
+     *
+     * @type {AwsStaticCredentials}
+     * @memberof AwsKmsSetting
+     */
+    staticCredentials?: AwsStaticCredentials;
+    /**
+     *
+     * @type {AwsAssumeRoleCredentials}
+     * @memberof AwsKmsSetting
+     */
+    assumeRoleCredentials?: AwsAssumeRoleCredentials;
+    /**
+     *
+     * @type {AwsWebIdentityTokenCredentials}
+     * @memberof AwsKmsSetting
+     */
+    webIdentityTokenCredentials?: AwsWebIdentityTokenCredentials;
+    /**
+     * Optional custom endpoint URL for AWS KMS (e.g., for VPC endpoints or local testing).
+     * @type {string}
+     * @memberof AwsKmsSetting
+     */
+    endpointUrl?: string;
+    /**
+     *
+     * @type {AwsClientConfiguration}
+     * @memberof AwsKmsSetting
+     */
+    clientConfiguration?: AwsClientConfiguration;
+}
+
+/**
+ * Check if a given object implements the AwsKmsSetting interface.
+ */
+export function instanceOfAwsKmsSetting(value: object): value is AwsKmsSetting {
+    if (!('region' in value) || value['region'] === undefined) return false;
+    return true;
+}
+
+export function AwsKmsSettingFromJSON(json: any): AwsKmsSetting {
+    return AwsKmsSettingFromJSONTyped(json, false);
+}
+
+export function AwsKmsSettingFromJSONTyped(json: any, ignoreDiscriminator: boolean): AwsKmsSetting {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'region': json['region'],
+        'staticCredentials': json['staticCredentials'] == null ? undefined : AwsStaticCredentialsFromJSON(json['staticCredentials']),
+        'assumeRoleCredentials': json['assumeRoleCredentials'] == null ? undefined : AwsAssumeRoleCredentialsFromJSON(json['assumeRoleCredentials']),
+        'webIdentityTokenCredentials': json['webIdentityTokenCredentials'] == null ? undefined : AwsWebIdentityTokenCredentialsFromJSON(json['webIdentityTokenCredentials']),
+        'endpointUrl': json['endpointUrl'] == null ? undefined : json['endpointUrl'],
+        'clientConfiguration': json['clientConfiguration'] == null ? undefined : AwsClientConfigurationFromJSON(json['clientConfiguration']),
+    };
+}
+
+export function AwsKmsSettingToJSON(json: any): AwsKmsSetting {
+    return AwsKmsSettingToJSONTyped(json, false);
+}
+
+export function AwsKmsSettingToJSONTyped(value?: AwsKmsSetting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'region': value['region'],
+        'staticCredentials': AwsStaticCredentialsToJSON(value['staticCredentials']),
+        'assumeRoleCredentials': AwsAssumeRoleCredentialsToJSON(value['assumeRoleCredentials']),
+        'webIdentityTokenCredentials': AwsWebIdentityTokenCredentialsToJSON(value['webIdentityTokenCredentials']),
+        'endpointUrl': value['endpointUrl'],
+        'clientConfiguration': AwsClientConfigurationToJSON(value['clientConfiguration']),
+    };
+}
+

package/src/models/AwsStaticCredentials.ts

@@ -0,0 +1,98 @@
+/* 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 { LookupMode } from './LookupMode';
+import {
+    LookupModeFromJSON,
+    LookupModeToJSON,
+} from './LookupMode';
+
+/**
+ * Explicit AWS access key ID and secret access key. Use with caution; prefer IAM roles or other mechanisms where possible.
+ * @export
+ * @interface AwsStaticCredentials
+ */
+export interface AwsStaticCredentials {
+    /**
+     * AWS Access Key ID.
+     * @type {string}
+     * @memberof AwsStaticCredentials
+     */
+    accesskid: string;
+    /**
+     * AWS Secret Access Key.
+     * @type {string}
+     * @memberof AwsStaticCredentials
+     */
+    secretAccessKey: string;
+    /**
+     * Optional AWS session token, typically used with temporary credentials.
+     * @type {string}
+     * @memberof AwsStaticCredentials
+     */
+    sessionToken?: string;
+    /**
+     *
+     * @type {LookupMode}
+     * @memberof AwsStaticCredentials
+     */
+    lookupMode?: LookupMode;
+}
+
+
+
+/**
+ * Check if a given object implements the AwsStaticCredentials interface.
+ */
+export function instanceOfAwsStaticCredentials(value: object): value is AwsStaticCredentials {
+    if (!('accesskid' in value) || value['accesskid'] === undefined) return false;
+    if (!('secretAccessKey' in value) || value['secretAccessKey'] === undefined) return false;
+    return true;
+}
+
+export function AwsStaticCredentialsFromJSON(json: any): AwsStaticCredentials {
+    return AwsStaticCredentialsFromJSONTyped(json, false);
+}
+
+export function AwsStaticCredentialsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AwsStaticCredentials {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'accesskid': json['accesskid'],
+        'secretAccessKey': json['secretAccessKey'],
+        'sessionToken': json['sessionToken'] == null ? undefined : json['sessionToken'],
+        'lookupMode': json['lookupMode'] == null ? undefined : LookupModeFromJSON(json['lookupMode']),
+    };
+}
+
+export function AwsStaticCredentialsToJSON(json: any): AwsStaticCredentials {
+    return AwsStaticCredentialsToJSONTyped(json, false);
+}
+
+export function AwsStaticCredentialsToJSONTyped(value?: AwsStaticCredentials | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'accesskid': value['accesskid'],
+        'secretAccessKey': value['secretAccessKey'],
+        'sessionToken': value['sessionToken'],
+        'lookupMode': LookupModeToJSON(value['lookupMode']),
+    };
+}
+

package/src/models/AwsWebIdentityTokenCredentials.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 { LookupMode } from './LookupMode';
+import {
+    LookupModeFromJSON,
+    LookupModeToJSON,
+} from './LookupMode';
+
+/**
+ * Credentials obtained using a web identity token (e.g., from Cognito, OIDC provider).
+ * @export
+ * @interface AwsWebIdentityTokenCredentials
+ */
+export interface AwsWebIdentityTokenCredentials {
+    /**
+     * The Amazon Resource Name (ARN) of the role to assume.
+     * @type {string}
+     * @memberof AwsWebIdentityTokenCredentials
+     */
+    roleArn: string;
+    /**
+     * An identifier for the assumed role session.
+     * @type {string}
+     * @memberof AwsWebIdentityTokenCredentials
+     */
+    roleSessionName: string;
+    /**
+     * The web identity token (e.g., OIDC token, Cognito token) itself.
+     * @type {string}
+     * @memberof AwsWebIdentityTokenCredentials
+     */
+    webIdentityToken: string;
+    /**
+     *
+     * @type {LookupMode}
+     * @memberof AwsWebIdentityTokenCredentials
+     */
+    lookupMode?: LookupMode;
+}
+
+
+
+/**
+ * Check if a given object implements the AwsWebIdentityTokenCredentials interface.
+ */
+export function instanceOfAwsWebIdentityTokenCredentials(value: object): value is AwsWebIdentityTokenCredentials {
+    if (!('roleArn' in value) || value['roleArn'] === undefined) return false;
+    if (!('roleSessionName' in value) || value['roleSessionName'] === undefined) return false;
+    if (!('webIdentityToken' in value) || value['webIdentityToken'] === undefined) return false;
+    return true;
+}
+
+export function AwsWebIdentityTokenCredentialsFromJSON(json: any): AwsWebIdentityTokenCredentials {
+    return AwsWebIdentityTokenCredentialsFromJSONTyped(json, false);
+}
+
+export function AwsWebIdentityTokenCredentialsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AwsWebIdentityTokenCredentials {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'roleArn': json['roleArn'],
+        'roleSessionName': json['roleSessionName'],
+        'webIdentityToken': json['webIdentityToken'],
+        'lookupMode': json['lookupMode'] == null ? undefined : LookupModeFromJSON(json['lookupMode']),
+    };
+}
+
+export function AwsWebIdentityTokenCredentialsToJSON(json: any): AwsWebIdentityTokenCredentials {
+    return AwsWebIdentityTokenCredentialsToJSONTyped(json, false);
+}
+
+export function AwsWebIdentityTokenCredentialsToJSONTyped(value?: AwsWebIdentityTokenCredentials | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'roleArn': value['roleArn'],
+        'roleSessionName': value['roleSessionName'],
+        'webIdentityToken': value['webIdentityToken'],
+        'lookupMode': LookupModeToJSON(value['lookupMode']),
+    };
+}
+

package/src/models/AzureClientSecretCredentialOpts.ts

@@ -0,0 +1,90 @@
+/* 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 { LookupMode } from './LookupMode';
+import {
+    LookupModeFromJSON,
+    LookupModeToJSON,
+} from './LookupMode';
+
+/**
+ * Azure Service Principal credentials using a client secret.
+ * @export
+ * @interface AzureClientSecretCredentialOpts
+ */
+export interface AzureClientSecretCredentialOpts {
+    /**
+     * The Application (client) ID of the Azure service principal.
+     * @type {string}
+     * @memberof AzureClientSecretCredentialOpts
+     */
+    clientId: string;
+    /**
+     * The client secret for the service principal.
+     * @type {string}
+     * @memberof AzureClientSecretCredentialOpts
+     */
+    clientSecret: string;
+    /**
+     *
+     * @type {LookupMode}
+     * @memberof AzureClientSecretCredentialOpts
+     */
+    lookupMode?: LookupMode;
+}
+
+
+
+/**
+ * Check if a given object implements the AzureClientSecretCredentialOpts interface.
+ */
+export function instanceOfAzureClientSecretCredentialOpts(value: object): value is AzureClientSecretCredentialOpts {
+    if (!('clientId' in value) || value['clientId'] === undefined) return false;
+    if (!('clientSecret' in value) || value['clientSecret'] === undefined) return false;
+    return true;
+}
+
+export function AzureClientSecretCredentialOptsFromJSON(json: any): AzureClientSecretCredentialOpts {
+    return AzureClientSecretCredentialOptsFromJSONTyped(json, false);
+}
+
+export function AzureClientSecretCredentialOptsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AzureClientSecretCredentialOpts {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'clientId': json['clientId'],
+        'clientSecret': json['clientSecret'],
+        'lookupMode': json['lookupMode'] == null ? undefined : LookupModeFromJSON(json['lookupMode']),
+    };
+}
+
+export function AzureClientSecretCredentialOptsToJSON(json: any): AzureClientSecretCredentialOpts {
+    return AzureClientSecretCredentialOptsToJSONTyped(json, false);
+}
+
+export function AzureClientSecretCredentialOptsToJSONTyped(value?: AzureClientSecretCredentialOpts | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'clientId': value['clientId'],
+        'clientSecret': value['clientSecret'],
+        'lookupMode': LookupModeToJSON(value['lookupMode']),
+    };
+}
+

package/src/models/AzureCredentialOpts.ts

@@ -0,0 +1,70 @@
+/* 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 { AzureClientSecretCredentialOpts } from './AzureClientSecretCredentialOpts';
+import {
+    AzureClientSecretCredentialOptsFromJSON,
+    AzureClientSecretCredentialOptsToJSON,
+} from './AzureClientSecretCredentialOpts';
+
+/**
+ * Azure credential options for authenticating to Key Vault. Currently assumes Service Principal with Client Secret.
+ * @export
+ * @interface AzureCredentialOpts
+ */
+export interface AzureCredentialOpts {
+    /**
+     *
+     * @type {AzureClientSecretCredentialOpts}
+     * @memberof AzureCredentialOpts
+     */
+    clientSecretCredentialOpts?: AzureClientSecretCredentialOpts;
+}
+
+/**
+ * Check if a given object implements the AzureCredentialOpts interface.
+ */
+export function instanceOfAzureCredentialOpts(value: object): value is AzureCredentialOpts {
+    return true;
+}
+
+export function AzureCredentialOptsFromJSON(json: any): AzureCredentialOpts {
+    return AzureCredentialOptsFromJSONTyped(json, false);
+}
+
+export function AzureCredentialOptsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AzureCredentialOpts {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'clientSecretCredentialOpts': json['clientSecretCredentialOpts'] == null ? undefined : AzureClientSecretCredentialOptsFromJSON(json['clientSecretCredentialOpts']),
+    };
+}
+
+export function AzureCredentialOptsToJSON(json: any): AzureCredentialOpts {
+    return AzureCredentialOptsToJSONTyped(json, false);
+}
+
+export function AzureCredentialOptsToJSONTyped(value?: AzureCredentialOpts | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'clientSecretCredentialOpts': AzureClientSecretCredentialOptsToJSON(value['clientSecretCredentialOpts']),
+    };
+}
+

package/src/models/AzureKeyVaultSetting.ts

@@ -0,0 +1,112 @@
+/* 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 { AzureCredentialOpts } from './AzureCredentialOpts';
+import {
+    AzureCredentialOptsFromJSON,
+    AzureCredentialOptsToJSON,
+} from './AzureCredentialOpts';
+import type { LookupMode } from './LookupMode';
+import {
+    LookupModeFromJSON,
+    LookupModeToJSON,
+} from './LookupMode';
+
+/**
+ * Configuration settings specific to the Azure KeyVault provider type.
+ * @export
+ * @interface AzureKeyVaultSetting
+ */
+export interface AzureKeyVaultSetting {
+    /**
+     * The URL of the Azure Key Vault or Managed HSM instance.
+     * @type {string}
+     * @memberof AzureKeyVaultSetting
+     */
+    keyvaultUrl: string;
+    /**
+     * The Azure Active Directory tenant (directory) ID.
+     * @type {string}
+     * @memberof AzureKeyVaultSetting
+     */
+    tenantId: string;
+    /**
+     *
+     * @type {AzureCredentialOpts}
+     * @memberof AzureKeyVaultSetting
+     */
+    credentialOpts: AzureCredentialOpts;
+    /**
+     * An optional identifier for your application using the Key Vault.
+     * @type {string}
+     * @memberof AzureKeyVaultSetting
+     */
+    applicationId?: string;
+    /**
+     *
+     * @type {LookupMode}
+     * @memberof AzureKeyVaultSetting
+     */
+    lookupMode?: LookupMode;
+}
+
+
+
+/**
+ * Check if a given object implements the AzureKeyVaultSetting interface.
+ */
+export function instanceOfAzureKeyVaultSetting(value: object): value is AzureKeyVaultSetting {
+    if (!('keyvaultUrl' in value) || value['keyvaultUrl'] === undefined) return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    if (!('credentialOpts' in value) || value['credentialOpts'] === undefined) return false;
+    return true;
+}
+
+export function AzureKeyVaultSettingFromJSON(json: any): AzureKeyVaultSetting {
+    return AzureKeyVaultSettingFromJSONTyped(json, false);
+}
+
+export function AzureKeyVaultSettingFromJSONTyped(json: any, ignoreDiscriminator: boolean): AzureKeyVaultSetting {
+    if (json == null) {
+        return json;
+    }
+    return {
+
+        'keyvaultUrl': json['keyvaultUrl'],
+        'tenantId': json['tenantId'],
+        'credentialOpts': AzureCredentialOptsFromJSON(json['credentialOpts']),
+        'applicationId': json['applicationId'] == null ? undefined : json['applicationId'],
+        'lookupMode': json['lookupMode'] == null ? undefined : LookupModeFromJSON(json['lookupMode']),
+    };
+}
+
+export function AzureKeyVaultSettingToJSON(json: any): AzureKeyVaultSetting {
+    return AzureKeyVaultSettingToJSONTyped(json, false);
+}
+
+export function AzureKeyVaultSettingToJSONTyped(value?: AzureKeyVaultSetting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+
+        'keyvaultUrl': value['keyvaultUrl'],
+        'tenantId': value['tenantId'],
+        'credentialOpts': AzureCredentialOptsToJSON(value['credentialOpts']),
+        'applicationId': value['applicationId'],
+        'lookupMode': LookupModeToJSON(value['lookupMode']),
+    };
+}
+