Module

std/node/internal/crypto/keygen.ts

Deno standard library
Go to Latest
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.// Copyright Joyent, Inc. and Node.js contributors. All rights reserved. MIT license.
import { KeyObject } from "./keys.ts";import { notImplemented } from "../../_utils.ts";import { Buffer } from "../../buffer.ts";import { KeyFormat, KeyType } from "./types.ts";
export function generateKey( _type: "hmac" | "aes", _options: { length: number; }, _callback: (err: Error | null, key: KeyObject) => void,): void { notImplemented("crypto.generateKey");}
export interface BasePrivateKeyEncodingOptions<T extends KeyFormat> { format: T; cipher?: string | undefined; passphrase?: string | undefined;}
export interface RSAKeyPairOptions< PubF extends KeyFormat, PrivF extends KeyFormat,> { /** * Key size in bits */ modulusLength: number; /** * Public exponent * @default 0x10001 */ publicExponent?: number | undefined; publicKeyEncoding: { type: "pkcs1" | "spki"; format: PubF; }; privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { type: "pkcs1" | "pkcs8"; };}
export interface RSAPSSKeyPairOptions< PubF extends KeyFormat, PrivF extends KeyFormat,> { /** * Key size in bits */ modulusLength: number; /** * Public exponent * @default 0x10001 */ publicExponent?: number | undefined; /** * Name of the message digest */ hashAlgorithm?: string; /** * Name of the message digest used by MGF1 */ mgf1HashAlgorithm?: string; /** * Minimal salt length in bytes */ saltLength?: string; publicKeyEncoding: { type: "spki"; format: PubF; }; privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { type: "pkcs8"; };}
export interface DSAKeyPairOptions< PubF extends KeyFormat, PrivF extends KeyFormat,> { /** * Key size in bits */ modulusLength: number; /** * Size of q in bits */ divisorLength: number; publicKeyEncoding: { type: "spki"; format: PubF; }; privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { type: "pkcs8"; };}
export interface ECKeyPairOptions< PubF extends KeyFormat, PrivF extends KeyFormat,> { /** * Name of the curve to use. */ namedCurve: string; publicKeyEncoding: { type: "pkcs1" | "spki"; format: PubF; }; privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { type: "sec1" | "pkcs8"; };}
export interface ED25519KeyPairOptions< PubF extends KeyFormat, PrivF extends KeyFormat,> { publicKeyEncoding: { type: "spki"; format: PubF; }; privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { type: "pkcs8"; };}
export interface ED448KeyPairOptions< PubF extends KeyFormat, PrivF extends KeyFormat,> { publicKeyEncoding: { type: "spki"; format: PubF; }; privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { type: "pkcs8"; };}
export interface X25519KeyPairOptions< PubF extends KeyFormat, PrivF extends KeyFormat,> { publicKeyEncoding: { type: "spki"; format: PubF; }; privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { type: "pkcs8"; };}
export interface X448KeyPairOptions< PubF extends KeyFormat, PrivF extends KeyFormat,> { publicKeyEncoding: { type: "spki"; format: PubF; }; privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { type: "pkcs8"; };}
export interface RSAKeyPairKeyObjectOptions { /** * Key size in bits */ modulusLength: number; /** * Public exponent * @default 0x10001 */ publicExponent?: number | undefined;}
export interface RSAPSSKeyPairKeyObjectOptions { /** * Key size in bits */ modulusLength: number; /** * Public exponent * @default 0x10001 */ publicExponent?: number | undefined; /** * Name of the message digest */ hashAlgorithm?: string; /** * Name of the message digest used by MGF1 */ mgf1HashAlgorithm?: string; /** * Minimal salt length in bytes */ saltLength?: string;}
export interface DSAKeyPairKeyObjectOptions { /** * Key size in bits */ modulusLength: number; /** * Size of q in bits */ divisorLength: number;}
// deno-lint-ignore no-empty-interfaceexport interface ED25519KeyPairKeyObjectOptions {}
// deno-lint-ignore no-empty-interfaceexport interface ED448KeyPairKeyObjectOptions {}
// deno-lint-ignore no-empty-interfaceexport interface X25519KeyPairKeyObjectOptions {}
// deno-lint-ignore no-empty-interfaceexport interface X448KeyPairKeyObjectOptions {}
export interface ECKeyPairKeyObjectOptions { /** * Name of the curve to use */ namedCurve: string;}
export function generateKeyPair( type: "rsa", options: RSAKeyPairOptions<"pem", "pem">, callback: (err: Error | null, publicKey: string, privateKey: string) => void,): void;export function generateKeyPair( type: "rsa", options: RSAKeyPairOptions<"pem", "der">, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "rsa", options: RSAKeyPairOptions<"der", "pem">, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void,): void;export function generateKeyPair( type: "rsa", options: RSAKeyPairOptions<"der", "der">, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "rsa", options: RSAKeyPairKeyObjectOptions, callback: ( err: Error | null, publicKey: KeyObject, privateKey: KeyObject, ) => void,): void;export function generateKeyPair( type: "rsa-pss", options: RSAPSSKeyPairOptions<"pem", "pem">, callback: (err: Error | null, publicKey: string, privateKey: string) => void,): void;export function generateKeyPair( type: "rsa-pss", options: RSAPSSKeyPairOptions<"pem", "der">, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "rsa-pss", options: RSAPSSKeyPairOptions<"der", "pem">, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void,): void;export function generateKeyPair( type: "rsa-pss", options: RSAPSSKeyPairOptions<"der", "der">, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "rsa-pss", options: RSAPSSKeyPairKeyObjectOptions, callback: ( err: Error | null, publicKey: KeyObject, privateKey: KeyObject, ) => void,): void;export function generateKeyPair( type: "dsa", options: DSAKeyPairOptions<"pem", "pem">, callback: (err: Error | null, publicKey: string, privateKey: string) => void,): void;export function generateKeyPair( type: "dsa", options: DSAKeyPairOptions<"pem", "der">, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "dsa", options: DSAKeyPairOptions<"der", "pem">, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void,): void;export function generateKeyPair( type: "dsa", options: DSAKeyPairOptions<"der", "der">, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "dsa", options: DSAKeyPairKeyObjectOptions, callback: ( err: Error | null, publicKey: KeyObject, privateKey: KeyObject, ) => void,): void;export function generateKeyPair( type: "ec", options: ECKeyPairOptions<"pem", "pem">, callback: (err: Error | null, publicKey: string, privateKey: string) => void,): void;export function generateKeyPair( type: "ec", options: ECKeyPairOptions<"pem", "der">, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "ec", options: ECKeyPairOptions<"der", "pem">, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void,): void;export function generateKeyPair( type: "ec", options: ECKeyPairOptions<"der", "der">, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "ec", options: ECKeyPairKeyObjectOptions, callback: ( err: Error | null, publicKey: KeyObject, privateKey: KeyObject, ) => void,): void;export function generateKeyPair( type: "ed25519", options: ED25519KeyPairOptions<"pem", "pem">, callback: (err: Error | null, publicKey: string, privateKey: string) => void,): void;export function generateKeyPair( type: "ed25519", options: ED25519KeyPairOptions<"pem", "der">, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "ed25519", options: ED25519KeyPairOptions<"der", "pem">, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void,): void;export function generateKeyPair( type: "ed25519", options: ED25519KeyPairOptions<"der", "der">, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "ed25519", options: ED25519KeyPairKeyObjectOptions | undefined, callback: ( err: Error | null, publicKey: KeyObject, privateKey: KeyObject, ) => void,): void;export function generateKeyPair( type: "ed448", options: ED448KeyPairOptions<"pem", "pem">, callback: (err: Error | null, publicKey: string, privateKey: string) => void,): void;export function generateKeyPair( type: "ed448", options: ED448KeyPairOptions<"pem", "der">, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "ed448", options: ED448KeyPairOptions<"der", "pem">, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void,): void;export function generateKeyPair( type: "ed448", options: ED448KeyPairOptions<"der", "der">, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "ed448", options: ED448KeyPairKeyObjectOptions | undefined, callback: ( err: Error | null, publicKey: KeyObject, privateKey: KeyObject, ) => void,): void;export function generateKeyPair( type: "x25519", options: X25519KeyPairOptions<"pem", "pem">, callback: (err: Error | null, publicKey: string, privateKey: string) => void,): void;export function generateKeyPair( type: "x25519", options: X25519KeyPairOptions<"pem", "der">, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "x25519", options: X25519KeyPairOptions<"der", "pem">, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void,): void;export function generateKeyPair( type: "x25519", options: X25519KeyPairOptions<"der", "der">, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "x25519", options: X25519KeyPairKeyObjectOptions | undefined, callback: ( err: Error | null, publicKey: KeyObject, privateKey: KeyObject, ) => void,): void;export function generateKeyPair( type: "x448", options: X448KeyPairOptions<"pem", "pem">, callback: (err: Error | null, publicKey: string, privateKey: string) => void,): void;export function generateKeyPair( type: "x448", options: X448KeyPairOptions<"pem", "der">, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "x448", options: X448KeyPairOptions<"der", "pem">, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void,): void;export function generateKeyPair( type: "x448", options: X448KeyPairOptions<"der", "der">, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void,): void;export function generateKeyPair( type: "x448", options: X448KeyPairKeyObjectOptions | undefined, callback: ( err: Error | null, publicKey: KeyObject, privateKey: KeyObject, ) => void,): void;export function generateKeyPair( _type: KeyType, _options: unknown, _callback: ( err: Error | null, // deno-lint-ignore no-explicit-any publicKey: any, // deno-lint-ignore no-explicit-any privateKey: any, ) => void,): void { notImplemented("crypto.generateKeyPair");}
export interface KeyPairKeyObjectResult { publicKey: KeyObject; privateKey: KeyObject;}
export interface KeyPairSyncResult< T1 extends string | Buffer, T2 extends string | Buffer,> { publicKey: T1; privateKey: T2;}
export function generateKeyPairSync( type: "rsa", options: RSAKeyPairOptions<"pem", "pem">,): KeyPairSyncResult<string, string>;export function generateKeyPairSync( type: "rsa", options: RSAKeyPairOptions<"pem", "der">,): KeyPairSyncResult<string, Buffer>;export function generateKeyPairSync( type: "rsa", options: RSAKeyPairOptions<"der", "pem">,): KeyPairSyncResult<Buffer, string>;export function generateKeyPairSync( type: "rsa", options: RSAKeyPairOptions<"der", "der">,): KeyPairSyncResult<Buffer, Buffer>;export function generateKeyPairSync( type: "rsa", options: RSAKeyPairKeyObjectOptions,): KeyPairKeyObjectResult;export function generateKeyPairSync( type: "rsa-pss", options: RSAPSSKeyPairOptions<"pem", "pem">,): KeyPairSyncResult<string, string>;export function generateKeyPairSync( type: "rsa-pss", options: RSAPSSKeyPairOptions<"pem", "der">,): KeyPairSyncResult<string, Buffer>;export function generateKeyPairSync( type: "rsa-pss", options: RSAPSSKeyPairOptions<"der", "pem">,): KeyPairSyncResult<Buffer, string>;export function generateKeyPairSync( type: "rsa-pss", options: RSAPSSKeyPairOptions<"der", "der">,): KeyPairSyncResult<Buffer, Buffer>;export function generateKeyPairSync( type: "rsa-pss", options: RSAPSSKeyPairKeyObjectOptions,): KeyPairKeyObjectResult;export function generateKeyPairSync( type: "dsa", options: DSAKeyPairOptions<"pem", "pem">,): KeyPairSyncResult<string, string>;export function generateKeyPairSync( type: "dsa", options: DSAKeyPairOptions<"pem", "der">,): KeyPairSyncResult<string, Buffer>;export function generateKeyPairSync( type: "dsa", options: DSAKeyPairOptions<"der", "pem">,): KeyPairSyncResult<Buffer, string>;export function generateKeyPairSync( type: "dsa", options: DSAKeyPairOptions<"der", "der">,): KeyPairSyncResult<Buffer, Buffer>;export function generateKeyPairSync( type: "dsa", options: DSAKeyPairKeyObjectOptions,): KeyPairKeyObjectResult;export function generateKeyPairSync( type: "ec", options: ECKeyPairOptions<"pem", "pem">,): KeyPairSyncResult<string, string>;export function generateKeyPairSync( type: "ec", options: ECKeyPairOptions<"pem", "der">,): KeyPairSyncResult<string, Buffer>;export function generateKeyPairSync( type: "ec", options: ECKeyPairOptions<"der", "pem">,): KeyPairSyncResult<Buffer, string>;export function generateKeyPairSync( type: "ec", options: ECKeyPairOptions<"der", "der">,): KeyPairSyncResult<Buffer, Buffer>;export function generateKeyPairSync( type: "ec", options: ECKeyPairKeyObjectOptions,): KeyPairKeyObjectResult;export function generateKeyPairSync( type: "ed25519", options: ED25519KeyPairOptions<"pem", "pem">,): KeyPairSyncResult<string, string>;export function generateKeyPairSync( type: "ed25519", options: ED25519KeyPairOptions<"pem", "der">,): KeyPairSyncResult<string, Buffer>;export function generateKeyPairSync( type: "ed25519", options: ED25519KeyPairOptions<"der", "pem">,): KeyPairSyncResult<Buffer, string>;export function generateKeyPairSync( type: "ed25519", options: ED25519KeyPairOptions<"der", "der">,): KeyPairSyncResult<Buffer, Buffer>;export function generateKeyPairSync( type: "ed25519", options?: ED25519KeyPairKeyObjectOptions,): KeyPairKeyObjectResult;export function generateKeyPairSync( type: "ed448", options: ED448KeyPairOptions<"pem", "pem">,): KeyPairSyncResult<string, string>;export function generateKeyPairSync( type: "ed448", options: ED448KeyPairOptions<"pem", "der">,): KeyPairSyncResult<string, Buffer>;export function generateKeyPairSync( type: "ed448", options: ED448KeyPairOptions<"der", "pem">,): KeyPairSyncResult<Buffer, string>;export function generateKeyPairSync( type: "ed448", options: ED448KeyPairOptions<"der", "der">,): KeyPairSyncResult<Buffer, Buffer>;export function generateKeyPairSync( type: "ed448", options?: ED448KeyPairKeyObjectOptions,): KeyPairKeyObjectResult;export function generateKeyPairSync( type: "x25519", options: X25519KeyPairOptions<"pem", "pem">,): KeyPairSyncResult<string, string>;export function generateKeyPairSync( type: "x25519", options: X25519KeyPairOptions<"pem", "der">,): KeyPairSyncResult<string, Buffer>;export function generateKeyPairSync( type: "x25519", options: X25519KeyPairOptions<"der", "pem">,): KeyPairSyncResult<Buffer, string>;export function generateKeyPairSync( type: "x25519", options: X25519KeyPairOptions<"der", "der">,): KeyPairSyncResult<Buffer, Buffer>;export function generateKeyPairSync( type: "x25519", options?: X25519KeyPairKeyObjectOptions,): KeyPairKeyObjectResult;export function generateKeyPairSync( type: "x448", options: X448KeyPairOptions<"pem", "pem">,): KeyPairSyncResult<string, string>;export function generateKeyPairSync( type: "x448", options: X448KeyPairOptions<"pem", "der">,): KeyPairSyncResult<string, Buffer>;export function generateKeyPairSync( type: "x448", options: X448KeyPairOptions<"der", "pem">,): KeyPairSyncResult<Buffer, string>;export function generateKeyPairSync( type: "x448", options: X448KeyPairOptions<"der", "der">,): KeyPairSyncResult<Buffer, Buffer>;export function generateKeyPairSync( type: "x448", options?: X448KeyPairKeyObjectOptions,): KeyPairKeyObjectResult;export function generateKeyPairSync( _type: KeyType, _options: unknown,): | KeyPairKeyObjectResult | KeyPairSyncResult<string | Buffer, string | Buffer> { notImplemented("crypto.generateKeyPairSync");}
export function generateKeySync( _type: "hmac" | "aes", _options: { length: number; },): KeyObject { notImplemented("crypto.generateKeySync");}
export default { generateKey, generateKeySync, generateKeyPair, generateKeyPairSync,};