Skip to content

Commit ec31461

Browse files
authored
Merge pull request #60 from dalek-cryptography/update-readme
Update README to remove nightly recommendation.
2 parents 73771ba + c605e05 commit ec31461

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,18 @@ The traits are implemented using bitwise operations, and should execute in
1414
constant time provided that a) the bitwise operations are constant-time and b)
1515
the operations are not optimized into a branch.
1616

17-
To prevent the latter possibility, when using the `nightly` feature
18-
(recommended), the crate attempts to hide the value of a `Choice`'s inner `u8`
19-
from the optimizer, by passing it through an inline assembly block. For more
20-
information, see the _About_ section below.
17+
To prevent the latter possibility, the crate attempts to hide the value of a
18+
`Choice`'s inner `u8` from the optimizer, by passing it through either an
19+
inline assembly block or a volatile read. For more information, see the
20+
_About_ section below.
2121

2222
```toml
2323
[dependencies.subtle]
24-
version = "2.1"
25-
features = ["nightly"]
24+
version = "2.2"
2625
```
2726

28-
## Features
29-
30-
* The `nightly` feature enables the use of
31-
an optimization barrier to protect the `Choice` type.
32-
_Using the `nightly` feature is recommended for security_.
27+
Versions prior to `2.2` recommended use of the `nightly` feature to enable an
28+
optimization barrier; this is not required in versions `2.2` and above.
3329

3430
## Documentation
3531

@@ -56,5 +52,5 @@ effort is fundamentally limited.
5652

5753
**USE AT YOUR OWN RISK**
5854

59-
[docs]: https://doc.dalek.rs/subtle
55+
[docs]: https://docs.rs/subtle
6056
[rust-timing-shield]: https://www.chosenplaintext.ca/open-source/rust-timing-shield/security

0 commit comments

Comments
 (0)