Debian Codegraph @

crypto/keystore/README

raw
1 keystore: Best-effort/defense-in-depth security for storing keys in memory
2
3 The keystore module provides a means of securely storing private information,
4 ideally through the assistance of operating system key storage facilities. The
5 purpose of this feature is to store private data without keeping it in the
6 process's address space, so that bugs which can lead to reading process memory
7 cannot recover the key while it's not actively in use.
8
9 On platforms without a suitable feature, a fallback implementation stores the
10 secrets in the process heap, providing no security. This is an opportunistic API
11 which allows your program to take advantage of these features if available.
12
13 This is a low-level module which implements cryptographic primitives. Direct use
14 of cryptographic primitives is not recommended for non-experts, as incorrect use
15 of these primitives can easily lead to the introduction of security
16 vulnerabilities. Non-experts are advised to use the high-level operations
17 available in the top-level [[crypto::]] module.
18
19 Be advised that Hare's cryptography implementations have not been audited.