Class OpenPgpJsEngine

The default OpenPgpEngine, backed by OpenPGP.js.

Implements

OpenPgpEngine

Index

Constructors

Methods

readPublicKeys readPrivateKeys unlock signDetached verifyDetached encrypt decrypt

Constructors

constructor

new OpenPgpJsEngine(): OpenPgpJsEngine

Returns OpenPgpJsEngine

Methods

readPublicKeys

readPublicKeys(
input: string | Uint8Array<ArrayBufferLike>,
): Promise<PublicKey[]>
Parse one or more public keys from armored text or binary key data.
Parameters
- input: string | Uint8Array<ArrayBufferLike>
Returns Promise<PublicKey[]>
Implementation of OpenPgpEngine.readPublicKeys
- Defined in src/openpgp/engine.ts:133

readPrivateKeys

readPrivateKeys(
input: string | Uint8Array<ArrayBufferLike>,
): Promise<PrivateKey[]>
Parse one or more (possibly locked) private keys from armored text or binary key data.
Parameters
- input: string | Uint8Array<ArrayBufferLike>
Returns Promise<PrivateKey[]>
Implementation of OpenPgpEngine.readPrivateKeys
- Defined in src/openpgp/engine.ts:140

unlock

unlock(key: PrivateKey, passphrase: string): Promise<PrivateKey>
Unlock a locked private key with the given passphrase.
Parameters
- key: PrivateKey
- passphrase: string
Returns Promise<PrivateKey>
Implementation of OpenPgpEngine.unlock
- Defined in src/openpgp/engine.ts:147

signDetached

signDetached(
    data: Uint8Array,
    signingKeys: PrivateKey[],
    digestAlgo: DigestAlgorithm,
): Promise<Uint8Array<ArrayBufferLike>>
Produce an ASCII-armored detached signature over data.
Parameters
- data: Uint8Array
- signingKeys: PrivateKey[]
- digestAlgo: DigestAlgorithm
Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of OpenPgpEngine.signDetached
- Defined in src/openpgp/engine.ts:153

verifyDetached

verifyDetached(
    data: Uint8Array,
    armoredSignature: Uint8Array,
    verificationKeys: PublicKey[],
): Promise<OpenPgpVerification[]>
Verify an ASCII-armored detached signature over data.
Parameters
- data: Uint8Array
- armoredSignature: Uint8Array
- verificationKeys: PublicKey[]
Returns Promise<OpenPgpVerification[]>
Implementation of OpenPgpEngine.verifyDetached
- Defined in src/openpgp/engine.ts:170

encrypt

encrypt(
    data: Uint8Array,
    encryptionKeys: PublicKey[],
    options?: {
        cipher?: EncryptionAlgorithm;
        signingKeys?: PrivateKey[];
        digestAlgo?: DigestAlgorithm;
    },
): Promise<Uint8Array<ArrayBufferLike>>
Produce an ASCII-armored encrypted (optionally signed) message.
Parameters
- data: Uint8Array
- encryptionKeys: PublicKey[]
- options: {
      cipher?: EncryptionAlgorithm;
      signingKeys?: PrivateKey[];
      digestAlgo?: DigestAlgorithm;
  } = {}
Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of OpenPgpEngine.encrypt
- Defined in src/openpgp/engine.ts:192

decrypt

decrypt(
    armored: Uint8Array,
    decryptionKeys: PrivateKey[],
    verificationKeys?: PublicKey[],
): Promise<OpenPgpDecryptResult>
Decrypt an ASCII-armored message and, if verification keys are supplied, verify its signatures.
Parameters
- armored: Uint8Array
- decryptionKeys: PrivateKey[]
- OptionalverificationKeys: PublicKey[]
Returns Promise<OpenPgpDecryptResult>
Implementation of OpenPgpEngine.decrypt
- Defined in src/openpgp/engine.ts:214