Skip to content

Commit ddffc61

Browse files
committed
Prepare for new release
Update Cargo version, README
1 parent fb92bbc commit ddffc61

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

Cargo.lock

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "aes_crypto"
3-
version = "1.2.1"
3+
version = "1.3.0"
44
authors = ["Sayantan Chakraborty <schakraborty.student@gmail.com>"]
55
edition = "2021"
66
license = "MIT"

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
This is a pure-Rust platform-agnostic [AES](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.197-upd1.pdf) library, that
22
is focused on reusability and optimal performance.
33

4-
This library guarantees the best performance on the `target_cpu` (if correctly specified). This currently has 6
4+
This library guarantees the best performance on the `target_cpu` (if correctly specified). This currently has 7
55
implementations, among which it automatically decides the best (most performant) using Cargo's `target_feature` flags.
66

77
# The implementations and their requirements are:
88

99
- AES-NI (with Vector AES for 2- and 4- blocks) => requires a Nightly Compiler, the `nightly` feature to be enabled, and
1010
compiling for x86(64) with the `avx512f` and `vaes` target_feature flags set.
1111
- AES-NI (with Vector AES for 2-blocks) => requires a Nightly Compiler, the `nightly` feature to be enabled, and
12-
compiling for x86(64) with the `vaes` target_feature flag set. (although `vaes` is an AVX-512 feature, some AlderLake
13-
CPUs have `vaes` without AVX-512 support)
12+
compiling for x86(64) with the `vaes` target_feature flag set.
1413
- AES-NI => requires compiling for x86(64) with the `sse4.1` and `aes` target_feature flags set.
1514
- AES-Neon => requires compiling for AArch64 or ARM64EC or ARM-v8 with the `aes` target_feature flag set (ARM-v8
1615
requires a Nightly compiler and the `nightly` feature to be enabled) .
@@ -19,6 +18,9 @@ implementations, among which it automatically decides the best (most performant)
1918
target-feature enabled)
2019
- Software AES => fallback implementation based on Rijmen and Daemen's `optimized` implementation (available
2120
on [their website](https://web.archive.org/web/20050828204927/http://www.iaik.tu-graz.ac.at/research/krypto/AES/old/%7Erijmen/rijndael/))
21+
- Constant-time Software AES => Much slower than Software AES, but is constant-time, which can be important in some scenarios.
22+
Enabled by the `constant-time` feature. It is worth noting that all the accelerated AES implementations are constant-time, so this
23+
only comes into play when no accelerated version is found.
2224

2325
If you are unsure about the target_feature flags to set, use `target_cpu=native` (if not cross-compiling) in
2426
the `RUSTFLAGS` environment variable, and use the `nightly` feature only if you are using a nightly compiler.

0 commit comments

Comments
 (0)