import type { Jwk } from '../jose/jwk.js';
import type { AlgorithmIdentifier, KeyIdentifier } from './identifier.js';

/**
 * Parameters for KMS-based decryption operations. Intended for use with a Key Management System.
 */
export interface KmsDecryptParams {
  /** Identifier for the private key in the KMS. */
  keyUri: KeyIdentifier;

  /** Data to be decrypted. */
  data: Uint8Array;
}

/**
 * Parameters for KMS-based derivation of bits. Intended for use with a Key Management System.
 */
export interface KmsDeriveBitsParams {
  /** Identifier for the key used in derivation in the KMS. */
  keyUri: KeyIdentifier;

  /**
   * The number of bits to derive. To be compatible with all browsers, the number should be a
   * multiple of 8.
   */
  length: number;
}

/**
 * Parameters for KMS-based key derivation. Intended for use with a Key Management System.
 */
export interface KmsDeriveKeyParams {
  /** Identifier for the base key used in derivation in the KMS. */
  keyUri: KeyIdentifier;

  /** An object defining the algorithm-specific parameters for the derived key. */
  derivedKeyParams: unknown
}

/**
 * Parameters for KMS-based digest computation. Intended for use with a Key Management System.
 */
export interface KmsDigestParams {
  /** The algorithm identifier. */
  algorithm: AlgorithmIdentifier;

  /** Data to be digested. */
  data: Uint8Array;
}

/**
 * Parameters for KMS-based encryption operations. Intended for use with a Key Management System.
 */
export interface KmsEncryptParams {
  /** Identifier for the private key in the KMS. */
  keyUri: KeyIdentifier;

  /** Data to be encrypted. */
  data: Uint8Array;
}

/**
 * Parameters for exporting a key from a KMS. Intended for use with a Key Management System.
 */
export interface KmsExportKeyParams {
  /** Identifier for the private key to be exported from the KMS. */
  keyUri: KeyIdentifier;
}

/**
 * Parameters for generating a key in a KMS. Intended for use with a Key Management System.
 */
export interface KmsGenerateKeyParams {
  /** The algorithm identifier. */
  algorithm: AlgorithmIdentifier;
}

/**
 * Parameters for computing the Key URI of a public key. Intended for use with a Key Management
 * System.
 */
export interface KmsGetKeyUriParams {
  /** A {@link Jwk} containing the public key for which the Key URI will be computed. */
  key: Jwk;
}

/**
 * Parameters for retrieving a public key from a KMS using the private key's URI. Intended for use
 * with a Key Management System.
 */
export interface KmsGetPublicKeyParams {
  /** Identifier for the private key in the KMS. */
  keyUri: KeyIdentifier;
}

/**
 * Parameters for importing a private key into a KMS. Intended for use with a Key Management System.
 */
export interface KmsImportKeyParams {
  /** A {@link Jwk} containing the key to be imported into the KMS. */
  key: Jwk;
}

/**
 * Parameters for KMS-based signing operations. Intended for use with a Key Management System.
 */
export interface KmsSignParams {
  /** Identifier for the signing private key in the KMS. */
  keyUri: KeyIdentifier;

  /** Data to be signed. */
  data: Uint8Array;
}

/**
 * Parameters for verifying a signature using a key from a KMS. Intended for use with a Key
 * Management System.
 */
export interface KmsVerifyParams {
  /** A {@link Jwk} containing the public key to be used for verification. */
  key: Jwk;

  /** The signature to verify. */
  signature: Uint8Array;

  /** The data associated with the signature. */
  data: Uint8Array;
}

/**
 * Parameters for wrapping a key using a KMS. Intended for use with a Key Management System.
 */
export interface KmsWrapKeyParams {
  /** A {@link Jwk} containing the private key to be wrapped. */
  key: Jwk;

  /** Identifier for the private key in the KMS to be used for the wrapping operation. */
  wrappingKeyId: KeyIdentifier;

  /** Algorithm to be used for wrapping. */
  wrapAlgorithm: AlgorithmIdentifier;
}

/**
 * Parameters for unwrapping a key using a KMS. Intended for use with a Key Management System.
 */
export interface KmsUnwrapKeyParams {
  /** The wrapped key in a byte array. */
  wrappedKey: Uint8Array;

  /** Identifier for the private key in the KMS to be used for the unwrapping operation. */
  unwrappingKeyId: KeyIdentifier;

  /** Algorithm to be used for unwrapping. */
  unwrapAlgorithm: AlgorithmIdentifier;
}

/**
 * Parameters for KMS-based encryption and decryption operations.
 *
 * Intended for use with a Key Management System where the key is referenced by URI.
 */
export interface KmsCipherParams {
  /** Identifier for the private key in the KMS. */
  keyUri: KeyIdentifier;

  /** Data to be encrypted or decrypted. */
  data: Uint8Array;
}

/**
 * Parameters for KMS-based derivation of a byte array from a given base key.
 *
 * Intended for use with a Key Management System.
 */
export interface KmsDeriveKeyBytesParams {
  /** Identifier for the base key used in derivation in the KMS. */
  baseKeyUri: KeyIdentifier;

  /** The desired length of the derived key in bits. */
  length: number;
}

/**
 * Parameters for KMS-based key unwrapping. Intended for use with a Key Management System where
 * the decryption key is referenced by URI.
 */
export interface KmsUriUnwrapKeyParams {
  /** Identifier for the private key in the KMS used for decrypting the wrapped key. */
  decryptionKeyUri: KeyIdentifier;

  /** The wrapped private key as a byte array. */
  wrappedKeyBytes: Uint8Array;

  /** The algorithm identifier of the key encrypted in `wrappedKeyBytes`. */
  wrappedKeyAlgorithm: string;

  /** An object defining the algorithm-specific parameters for decrypting the `wrappedKeyBytes`. */
  decryptParams?: unknown;
}

/**
 * Parameters for KMS-based key wrapping. Intended for use with a Key Management System where
 * the encryption key is referenced by URI.
 */
export interface KmsUriWrapKeyParams {
  /** Identifier for the private key in the KMS used for encrypting the unwrapped key. */
  encryptionKeyUri: KeyIdentifier;

  /** A {@link Jwk} containing the private key to be wrapped. */
  unwrappedKey: Jwk;

  /** An object defining the algorithm-specific parameters for encrypting the `unwrappedKey`. */
  encryptParams?: unknown;
}

/**
 * Parameters for KMS-based key deletion. Intended for use with a Key Management System.
 */
export interface KmsDeleteKeyParams {
  /** Identifier for the key to be deleted in the KMS. */
  keyUri: KeyIdentifier;
}