api-extractor-index.d.ts

/// <reference types="node" />

import { BinaryToTextEncoding } from 'crypto';

export declare const createSHA256Hash: (input: string | Buffer, outputEncoding?: BinaryToTextEncoding) => string;

export declare interface Pkcs12ReadResult {
    ca?: string[];
    cert?: string;
    key?: string;
}

/**
 * Reads a private key and certificate chain from a PKCS12 key store.
 *
 * @remarks
 * The PKCS12 key store may contain the following:
 * - 0 or more certificates contained in a `certBag` (OID
 *  1.2.840.113549.1.12.10.1.3); if a certificate has an associated
 *  private key it is treated as an instance certificate, otherwise it is
 *  treated as a CA certificate
 * - 0 or 1 private keys contained in a `keyBag` (OID
 *  1.2.840.113549.1.12.10.1.1) or a `pkcs8ShroudedKeyBag` (OID
 *  1.2.840.113549.1.12.10.1.2)
 *
 * Any other PKCS12 bags are ignored.
 *
 * @privateRemarks
 * This intentionally does not allow for a separate key store password and
 * private key password. In conventional implementations, these two values
 * are expected to be identical, so we do not support other configurations.
 *
 * @param path The file path of the PKCS12 key store
 * @param password The optional password of the key store and private key;
 * if there is no password, this may be an empty string or `undefined`,
 * depending on how the key store was generated.
 * @returns the parsed private key and certificate(s) in PEM format
 */
export declare const readPkcs12Keystore: (path: string, password?: string | undefined) => Pkcs12ReadResult;

/**
 * Reads a certificate chain from a PKCS12 trust store.
 *
 * @remarks
 * The PKCS12 trust store may contain the following:
 * - 0 or more certificates contained in a `certBag` (OID
 *  1.2.840.113549.1.12.10.1.3); all are treated as CA certificates
 *
 * Any other PKCS12 bags are ignored.
 *
 * @param path The file path of the PKCS12 trust store
 * @param password The optional password of the trust store; if there is
 * no password, this may be an empty string or `undefined`, depending on
 * how the trust store was generated.
 * @returns the parsed certificate(s) in PEM format
 */
export declare const readPkcs12Truststore: (path: string, password?: string | undefined) => string[] | undefined;

export { }

type-summarizer-index.d.ts

/// <reference types="node" />
import { BinaryToTextEncoding } from 'crypto';
export interface Pkcs12ReadResult {
    ca?: string[];
    cert?: string;
    key?: string;
}
/**
 * Reads a private key and certificate chain from a PKCS12 key store.
 *
 * @remarks
 * The PKCS12 key store may contain the following:
 * - 0 or more certificates contained in a `certBag` (OID
 *  1.2.840.113549.1.12.10.1.3); if a certificate has an associated
 *  private key it is treated as an instance certificate, otherwise it is
 *  treated as a CA certificate
 * - 0 or 1 private keys contained in a `keyBag` (OID
 *  1.2.840.113549.1.12.10.1.1) or a `pkcs8ShroudedKeyBag` (OID
 *  1.2.840.113549.1.12.10.1.2)
 *
 * Any other PKCS12 bags are ignored.
 *
 * @privateRemarks
 * This intentionally does not allow for a separate key store password and
 * private key password. In conventional implementations, these two values
 * are expected to be identical, so we do not support other configurations.
 *
 * @param path The file path of the PKCS12 key store
 * @param password The optional password of the key store and private key;
 * if there is no password, this may be an empty string or `undefined`,
 * depending on how the key store was generated.
 * @returns the parsed private key and certificate(s) in PEM format
 */
export const readPkcs12Keystore: (path: string, password?: string | undefined) => Pkcs12ReadResult;
/**
 * Reads a certificate chain from a PKCS12 trust store.
 *
 * @remarks
 * The PKCS12 trust store may contain the following:
 * - 0 or more certificates contained in a `certBag` (OID
 *  1.2.840.113549.1.12.10.1.3); all are treated as CA certificates
 *
 * Any other PKCS12 bags are ignored.
 *
 * @param path The file path of the PKCS12 trust store
 * @param password The optional password of the trust store; if there is
 * no password, this may be an empty string or `undefined`, depending on
 * how the trust store was generated.
 * @returns the parsed certificate(s) in PEM format
 */
export const readPkcs12Truststore: (path: string, password?: string | undefined) => string[] | undefined;
export const createSHA256Hash: (input: string | Buffer, outputEncoding?: BinaryToTextEncoding) => string;
//# sourceMappingURL=index.d.ts.map

type-summarizer-index.d.ts.map

{"version":3,"sources":["src/pkcs12.ts","src/sha256.ts"],"names":[],"mappings":";;iBAWiB,gB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAgCJ,kB;;;;;;;;;;;;;;;;;aA0BA,oB;aC3DA,gB","file":"index.d.ts","sourceRoot":"../../../packages/kbn-crypto"}