blob: 4a70d50e5e4a28880524bd73804e32321400652a (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
## AEAD
> **See also:** [Libsodium's documentation on its AEAD features](https://download.libsodium.org/doc/secret-key_cryptography/aead/chacha20-poly1305/xchacha20-poly1305_construction).
### crypto_aead_xchacha20poly1305_ietf_decrypt
Decrypt a message (and optional associated data) with XChaCha20-Poly1305.
**Parameters and their respective types**:
1. `{string|Buffer}` Ciphertext
2. `{string|Buffer}` nonce (must be 24 bytes)
3. `{CryptographyKey}` key
4. `{string|Buffer}` assocData
Returns a `Promise` that resolves to a `Buffer`.
Throws a `SodiumError` on decryption failure.
### crypto_aead_xchacha20poly1305_ietf_encrypt
Encrypt a message (and optional associated data) with XChaCha20-Poly1305.
**Parameters and their respective types**:
1. `{string|Buffer}` Plaintext
2. `{string|Buffer}` nonce (must be 24 bytes)
3. `{CryptographyKey}` key
4. `{string|Buffer}` assocData
Returns a `Promise` that resolves to a `Buffer`.
### crypto_aead_xchacha20poly1305_ietf_keygen
Returns a `CryptographyKey` object containing a key appropriate
for the `crypto_aead_xchacha20poly1305_ietf_` API.
### Example for crypto_aead_xchacha20poly1305_ietf_*
```javascript
const { SodiumPlus } = require('sodium-plus');
let sodium;
(async function () {
if (!sodium) sodium = await SodiumPlus.auto();
let plaintext = 'Your message goes here';
let key = await sodium.crypto_aead_xchacha20poly1305_ietf_keygen();
let nonce = await sodium.randombytes_buf(24);
let ciphertext = await sodium.crypto_aead_xchacha20poly1305_ietf_encrypt(
plaintext,
nonce,
key
);
console.log(ciphertext.toString('hex'));
let decrypted = await sodium.crypto_aead_xchacha20poly1305_ietf_decrypt(
ciphertext,
nonce,
key
);
console.log(decrypted.toString());
})();
```
|
