new S2K(configopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
config |
Object |
<optional> |
Full configuration, defaults to openpgp.config |
- Source:
Members
algorithm :module:enums.hash|0
Hash function identifier, or 0 for gnu-dummy keys
Type:
- Source:
c :Integer
Type:
- Integer
- Source:
salt :Uint8Array
Eight bytes of salt in a binary string.
Type:
- Uint8Array
- Source:
type :String
enums.s2k identifier or 'gnu-dummy'
Type:
- String
- Source:
Methods
(async) produceKey(passphrase) → {Promise.<Uint8Array>}
Produces a key using the specified passphrase and the defined hashAlgorithm
Parameters:
| Name | Type | Description |
|---|---|---|
passphrase |
String | Passphrase containing user input |
- Source:
Returns:
Produced key with a length corresponding to. hashAlgorithm hash length
- Type
- Promise.<Uint8Array>
read(bytes) → {Integer}
Parsing function for a string-to-key specifier (RFC 4880 3.7).
Parameters:
| Name | Type | Description |
|---|---|---|
bytes |
Uint8Array | Payload of string-to-key specifier |
- Source:
Returns:
Actual length of the object.
- Type
- Integer
write() → {Uint8Array}
Serializes s2k information
- Source:
Returns:
Binary representation of s2k.
- Type
- Uint8Array