aboutsummaryrefslogtreecommitdiff
path: root/core/crypto/README.md
blob: 1e4e41fb8b17cf4baa4081d6333fed2b69cd2839 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# crypto

A cryptography library for the Odin language.

## Supported

This package offers various algorithms implemented in Odin, along with
useful helpers such as access to the system entropy source, and a
constant-time byte comparison.

## Implementation considerations

- The crypto packages are not thread-safe.
- Best-effort is make to mitigate timing side-channels on reasonable
  architectures.  Architectures that are known to be unreasonable include
  but are not limited to i386, i486, and WebAssembly.
- The packages attempt to santize sensitive data, however this is, and
  will remain a "best-effort" implementation decision.  As Thomas Pornin
  puts it "In general, such memory cleansing is a fool's quest."
- All of these packages have not received independent third party review.

## License

This library is made available under the BSD-3 license.