@credo-ts/core/build/modules/x509/X509ServiceOptions.d.mts

<p align="center"> <br /> <img alt="Credo Logo" src="https://github.com/openwallet-foundation/credo-ts/blob/c7886cb8377ceb8ee4efe8d264211e561a75072d/images/credo-logo.png" height="250px" /> </p> <h1 align="center"><b>Credo - Core</b></h1

import { X509Certificate, X509ExtendedKeyUsage, X509KeyUsage } from "./X509Certificate.mjs";
import { PublicJwk } from "../kms/jwk/PublicJwk.mjs";
import "../kms/index.mjs";
import { GeneralNameType } from "@peculiar/x509";

//#region src/modules/x509/X509ServiceOptions.d.ts
type AddMarkAsCritical<T extends Record<string, Record<string, unknown>>> = T & { [K in keyof T]: T[K] & {
  markAsCritical?: boolean;
} };
/**
 * Base64 or PEM
 */
type EncodedX509Certificate = string;
interface X509ValidateCertificateChainOptions {
  certificateChain: Array<EncodedX509Certificate>;
  certificate?: EncodedX509Certificate;
  /**
   * The date for which the certificate chain should be valid
   * @default new Date()
   *
   * The certificates must be valid on this date
   * according to the certificates certificate.notBefore and certificate.notAfter
   * otherwise, the validation will fail
   */
  verificationDate?: Date;
  trustedCertificates?: Array<EncodedX509Certificate>;
}
interface X509GetLeafCertificateOptions {
  certificateChain: Array<string>;
}
interface X509ParseCertificateOptions {
  encodedCertificate: string;
}
interface X509CreateCertificateChainOptions {
  certificates: Array<X509Certificate | string>;
  outputFormat?: 'pem' | 'base64';
}
type X509CertificateExtensionsOptions = AddMarkAsCritical<{
  subjectKeyIdentifier?: {
    include: boolean;
  };
  keyUsage?: {
    usages: Array<X509KeyUsage>;
  };
  extendedKeyUsage?: {
    usages: Array<X509ExtendedKeyUsage>;
  };
  authorityKeyIdentifier?: {
    include: boolean;
  };
  issuerAlternativeName?: {
    name: Array<{
      type: GeneralNameType;
      value: string;
    }>;
  };
  subjectAlternativeName?: {
    name: Array<{
      type: GeneralNameType;
      value: string;
    }>;
  };
  basicConstraints?: {
    ca: boolean;
    pathLenConstraint?: number;
  };
  crlDistributionPoints?: {
    urls: Array<string>;
  };
}>;
type X509CertificateSigningRequestExtensionsOptions = Pick<X509CertificateExtensionsOptions, 'subjectKeyIdentifier' | 'keyUsage' | 'extendedKeyUsage' | 'subjectAlternativeName'>;
interface X509CertificateIssuerAndSubjectOptions {
  countryName?: string;
  stateOrProvinceName?: string;
  organizationalUnit?: string;
  commonName?: string;
}
interface X509CreateCertificateOptions {
  /**
   *
   * Serial number of the X.509 certificate
   *
   */
  serialNumber?: string;
  /**
   *
   * The Key that will be used to sign the X.509 Certificate
   *
   */
  authorityKey: PublicJwk;
  /**
   *
   * The key that is the subject of the X.509 Certificate
   *
   * If the `subjectPublicKey` is not included, the `authorityKey` will be used.
   * This means that the certificate is self-signed
   *
   */
  subjectPublicKey?: PublicJwk;
  /**
   *
   * The issuer information of the X.509 Certificate
   *
   */
  issuer: string | X509CertificateIssuerAndSubjectOptions;
  /**
   *
   * The subject information of the X.509 Certificate
   *
   * If the `subject` is not included, the `issuer` will be used
   *
   *
   */
  subject?: string | X509CertificateIssuerAndSubjectOptions;
  /**
   *
   * Date range for when the X.509 Certificate is valid
   *
   */
  validity?: {
    /**
     *
     * Certificate is not valid before this date
     *
     */
    notBefore?: Date;
    /**
     *
     * Certificate is not valid after this date
     *
     */
    notAfter?: Date;
  };
  /**
   *
   * X.509 v3 Extensions to be added to the certificate
   *
   */
  extensions?: X509CertificateExtensionsOptions;
}
interface X509CreateCertificateSigningRequestOptions {
  /**
   * The key that is the subject of the certificate signing request.
   *
   * If you want to influence the specific signature algorithm to use
   * make sure to set the `alg` on the jwk.
   */
  subjectPublicKey: PublicJwk;
  /**
   * The subject information of the certificate signing request
   */
  subject: string | X509CertificateIssuerAndSubjectOptions;
  /**
   * X.509 v3 Extensions to be added to the certificate signing request
   */
  extensions?: X509CertificateSigningRequestExtensionsOptions;
}
interface X509ParseCertificateSigningRequestOptions {
  encodedCertificateSigningRequest: string;
}
//#endregion
export { EncodedX509Certificate, X509CertificateExtensionsOptions, X509CertificateIssuerAndSubjectOptions, X509CertificateSigningRequestExtensionsOptions, X509CreateCertificateChainOptions, X509CreateCertificateOptions, X509CreateCertificateSigningRequestOptions, X509GetLeafCertificateOptions, X509ParseCertificateOptions, X509ParseCertificateSigningRequestOptions, X509ValidateCertificateChainOptions };
//# sourceMappingURL=X509ServiceOptions.d.mts.map