This object contains global configuration values.
- Source:
- See:
-
- module:config/config
Members
(static) aeadChunkSizeByte
Chunk Size Byte for Authenticated Encryption with Additional Data (AEAD) mode Only has an effect when aeadProtect is set to true. Must be an integer value from 0 to 56.
Properties:
| Name | Type | Description |
|---|---|---|
aeadChunkSizeByte |
Integer |
- Source:
(static) aeadMode
Default Authenticated Encryption with Additional Data (AEAD) encryption mode Only has an effect when aeadProtect is set to true.
Properties:
| Name | Type | Description |
|---|---|---|
aeadMode |
Integer | Default AEAD mode module:enums.aead |
- Source:
(static) aeadProtect
Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption. Note: not all OpenPGP implementations are compatible with this option. FUTURE OPENPGP.JS VERSIONS MAY BREAK COMPATIBILITY WHEN USING THIS OPTION
Properties:
| Name | Type | Description |
|---|---|---|
aeadProtect |
Boolean |
- Source:
- See:
(static) allowInsecureDecryptionWithSigningKeys
Allow decryption using RSA keys without encrypt flag.
This setting is potentially insecure, but it is needed to get around an old openpgpjs bug
where key flags were ignored when selecting a key for encryption.
Properties:
| Name | Type | Description |
|---|---|---|
allowInsecureDecryptionWithSigningKeys |
Boolean |
- Source:
(static) allowUnauthenticatedStream
Properties:
| Name | Type | Description |
|---|---|---|
allowUnauthenticatedStream |
Boolean | Stream unauthenticated data before integrity has been checked |
- Source:
(static) checksumRequired
Properties:
| Name | Type | Description |
|---|---|---|
checksumRequired |
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) deflateLevel
Properties:
| Name | Type | Description |
|---|---|---|
deflateLevel |
Integer | Default zip/zlib compression level, between 1 and 9 |
- Source:
(static) encryptionCipher
Properties:
| Name | Type | Description |
|---|---|---|
encryptionCipher |
Integer | Default encryption cipher module:enums.symmetric |
- Source:
(static) ignoreMdcError
Properties:
| Name | Type | Description |
|---|---|---|
ignoreMdcError |
Boolean | Fail on decrypt if message is not integrity protected |
- Source:
(static) integrityProtect
Use integrity protection for symmetric encryption
Properties:
| Name | Type | Description |
|---|---|---|
integrityProtect |
Boolean |
- Source:
(static) keyserver
Properties:
| Name | Type | Description |
|---|---|---|
keyserver |
String |
- Source:
(static) knownNotations
Contains notatations that are considered "known". Known notations do not trigger validation error when the notation is marked as critical.
Properties:
| Name | Type | Description |
|---|---|---|
knownNotations |
Array |
- Source:
(static) maxUseridLength
Max userid string length (used for parsing)
Properties:
| Name | Type | Description |
|---|---|---|
maxUseridLength |
Integer |
- Source:
(static) minBytesForWebCrypto
Properties:
| Name | Type | Description |
|---|---|---|
minBytesForWebCrypto |
Integer | The minimum amount of bytes for which to use native WebCrypto APIs when available |
- Source:
(static) minRsaBits
Properties:
| Name | Type | Description |
|---|---|---|
minRsaBits |
Number | Minimum RSA key size allowed for key generation |
- Source:
(static) nodeStore
Properties:
| Name | Type | Description |
|---|---|---|
nodeStore |
String |
- Source:
(static) passwordCollisionCheck
Work-around for rare GPG decryption bug when encrypting with multiple passwords. Slower and slightly less secure
Properties:
| Name | Type | Description |
|---|---|---|
passwordCollisionCheck |
Boolean |
- Source:
(static) preferHashAlgorithm
Properties:
| Name | Type | Description |
|---|---|---|
preferHashAlgorithm |
Integer | Default hash algorithm module:enums.hash |
- Source:
(static) rejectHashAlgorithms
Properties:
| Name | Type | Description |
|---|---|---|
reject_hash_algorithms |
Set.<Integer> | Reject insecure hash algorithms module:enums.hash |
- Source:
(static) rejectMessageHashAlgorithms
Properties:
| Name | Type | Description |
|---|---|---|
reject_message_hash_algorithms |
Set.<Integer> | Reject insecure message hash algorithms module:enums.hash |
- Source:
(static) revocationsExpire
Properties:
| Name | Type | Description |
|---|---|---|
revocationsExpire |
Boolean | If true, expired revocation signatures are ignored |
- Source:
(static) s2kIterationCountByte
RFC4880 3.7.1.3: Iteration Count Byte for S2K (String to Key)
Properties:
| Name | Type | Description |
|---|---|---|
s2kIterationCountByte |
Integer |
- Source:
(static) showComment
Properties:
| Name | Type | Description |
|---|---|---|
showComment |
Boolean | Whether to include module:config/config.commentString in armored messages |
- Source:
(static) showVersion
Properties:
| Name | Type | Description |
|---|---|---|
showVersion |
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) useIndutnyElliptic
Properties:
| Name | Type | Description |
|---|---|---|
useIndutnyElliptic |
Boolean | Whether to use the indutny/elliptic library. When false, certain curves will not be supported. |
- Source:
(static) v5Keys
Use V5 keys. Note: not all OpenPGP implementations are compatible with this option. FUTURE OPENPGP.JS VERSIONS MAY BREAK COMPATIBILITY WHEN USING THIS OPTION
Properties:
| Name | Type | Description |
|---|---|---|
v5Keys |
Boolean |
- Source:
(static) versionString
Properties:
| Name | Type | Description |
|---|---|---|
versionString |
String | A version string to be included in armored messages |
- Source: