Module: config

This object contains global configuration values.

Source:
See:
  • module:config/config

Members

(static) aead_chunk_size_byte

Chunk Size Byte for Authenticated Encryption with Additional Data (AEAD) mode Only has an effect when aead_protect is set to true. Must be an integer value from 0 to 56.

Properties:
Name Type Description
aead_chunk_size_byte Integer
Source:

(static) aead_mode

Default Authenticated Encryption with Additional Data (AEAD) encryption mode Only has an effect when aead_protect is set to true.

Properties:
Name Type Description
aead_mode Integer

Default AEAD mode module:enums.aead

Source:

(static) aead_protect

Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption. NOT INTEROPERABLE WITH OTHER OPENPGP IMPLEMENTATIONS FUTURE OPENPGP.JS VERSIONS MAY BREAK COMPATIBILITY WHEN USING THIS OPTION

Properties:
Name Type Description
aead_protect Boolean
Source:

(static) aead_protect_version

Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption. 0 means we implement a variant of this IETF draft. 4 means we implement RFC4880bis-04. Note that this determines how AEAD packets are parsed even when aead_protect is set to false

Properties:
Name Type Description
aead_protect_version Integer
Source:

(static) allow_unauthenticated_stream

Properties:
Name Type Description
allow_unauthenticated_stream Boolean

Stream unauthenticated data before integrity has been checked

Source:

(static) checksum_required

Properties:
Name Type Description
checksum_required Boolean

Do not throw error when armor is missing a checksum

Source:

(static) commentstring

Properties:
Name Type Description
commentstring String

A comment string to be included in armored messages

Source:

(static) compression

Properties:
Name Type Description
compression Integer

Default compression algorithm module:enums.compression

Source:

(static) debug

Properties:
Name Type Description
debug Boolean

If enabled, debug messages will be printed

Source:

(static) deflate_level

Properties:
Name Type Description
deflate_level Integer

Default zip/zlib compression level, between 1 and 9

Source:

(static) encryption_cipher

Properties:
Name Type Description
encryption_cipher Integer

Default encryption cipher module:enums.symmetric

Source:

(static) ignore_mdc_error

Properties:
Name Type Description
ignore_mdc_error Boolean

Fail on decrypt if message is not integrity protected

Source:

(static) integrity_protect

Use integrity protection for symmetric encryption

Properties:
Name Type Description
integrity_protect Boolean
Source:

(static) keyserver

Properties:
Name Type Description
keyserver String
Source:

(static) max_userid_length

Max userid string length (used for parsing)

Properties:
Name Type Description
max_userid_length Integer
Source:

(static) node_store

Properties:
Name Type Description
node_store String
Source:

(static) password_collision_check

Work-around for rare GPG decryption bug when encrypting with multiple passwords. Slower and slightly less secure

Properties:
Name Type Description
password_collision_check Boolean
Source:

(static) prefer_hash_algorithm

Properties:
Name Type Description
prefer_hash_algorithm Integer

Default hash algorithm module:enums.hash

Source:

(static) revocations_expire

Properties:
Name Type Description
revocations_expire Boolean

If true, expired revocation signatures are ignored

Source:

(static) rsa_blinding

Properties:
Name Type Description
rsa_blinding Boolean
Source:

(static) s2k_iteration_count_byte

RFC4880 3.7.1.3: Iteration Count Byte for S2K (String to Key)

Properties:
Name Type Description
s2k_iteration_count_byte Integer
Source:

(static) show_comment

Properties:
Name Type Description
show_comment Boolean

Whether to include module:config/config.commentstring in armored messages

Source:

(static) show_version

Properties:
Name Type Description
show_version Boolean

Whether to include module:config/config.versionstring in armored messages

Source:

(static) tolerant

Properties:
Name Type Description
tolerant Boolean

Ignore unsupported/unrecognizable packets instead of throwing an error

Source:

(static) use_native

Properties:
Name Type Description
use_native Boolean

Use native Node.js crypto/zlib and WebCrypto APIs when available

Source:

(static) versionstring

Properties:
Name Type Description
versionstring String

A version string to be included in armored messages

Source:

(static) zero_copy

Properties:
Name Type Description
Use Boolean

transferable objects between the Web Worker and main thread

Source: