aboutsummaryrefslogtreecommitdiffstats
path: root/library/sodium-plus/docs/SodiumPlus/key-derivation.md
blob: 72ae3c3c43014dcee06066399d381027ad7f5382 (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
## Key derivation

> **See also**: [Libsodium's documentation on its key derivation features](https://download.libsodium.org/doc/key_derivation).

### crypto_kdf_derive_from_key

Derive a subkey from a master key.

**Parameters and their respective types**:

1. `{number}` output length (typically you want `32`)
2. `{number}` subkey ID
3. `{string|Buffer}` context (must be a string/buffer of length 8)
4. `{CryptographyKey}` master key

Returns a `Promise` that resolves to a `CryptographyKey`.

### crypto_kdf_keygen

Returns a `CryptographyKey` object containing a key appropriate
for the `crypto_kdf` API.

### Example for crypto_kdf

```javascript
const { SodiumPlus } = require('sodium-plus');
let sodium;

(async function () {
    if (!sodium) sodium = await SodiumPlus.auto();
    let masterKey = await sodium.crypto_kdf_keygen();
    let context = 'Sodium++';

    let subkey1 = await sodium.crypto_kdf_derive_from_key(32, 1, context, masterKey);
    let subkey2 = await sodium.crypto_kdf_derive_from_key(32, 2, context, masterKey);
    let subkey3 = await sodium.crypto_kdf_derive_from_key(32, 3, context, masterKey);
    
    console.log({
        'master-key': masterKey.getBuffer().toString('hex'),
        'subkey1': subkey1.getBuffer().toString('hex'),
        'subkey2': subkey2.getBuffer().toString('hex'),
        'subkey3': subkey3.getBuffer().toString('hex')
    });
})();
```