rscrypto 0.1.1

Pure Rust cryptography, hardware-accelerated: BLAKE3, SHA-2/3, AES-GCM, ChaCha20-Poly1305, Ed25519, X25519, HMAC, HKDF, Argon2, CRC. no_std, WASM, ten CPU architectures.
Documentation 
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! Backend dispatch introspection for AEAD primitives.
//!
//! This mirrors the checksum/hash introspection surfaces so AEAD dispatch can be
//! audited and benchmarked without reaching into private internals.
//!
//! # Examples
//!
//! ```
//! use rscrypto::aead::introspect::{DispatchInfo, xchacha20poly1305_backend};
//!
//! let info = DispatchInfo::current();
//! assert!(!format!("{info}").is_empty());
//! assert!(!xchacha20poly1305_backend().is_empty());
//! ```

#[cfg(any(
  feature = "aes-gcm",
  feature = "aes-gcm-siv",
  feature = "chacha20poly1305",
  feature = "xchacha20poly1305",
  feature = "aegis256",
  feature = "ascon-aead"
))]
use crate::aead::targets::{AeadPrimitive, select_backend};
pub use crate::platform::DispatchInfo;

#[cfg(any(
  feature = "aes-gcm",
  feature = "aes-gcm-siv",
  feature = "chacha20poly1305",
  feature = "xchacha20poly1305",
  feature = "aegis256",
  feature = "ascon-aead"
))]
#[inline]
fn backend_for(primitive: AeadPrimitive) -> &'static str {
  select_backend(primitive, crate::platform::arch(), crate::platform::caps()).name()
}

/// Returns the backend selected for `Aes256Gcm` on the current machine.
#[cfg(feature = "aes-gcm")]
#[inline]
#[must_use]
pub fn aes256gcm_backend() -> &'static str {
  backend_for(AeadPrimitive::Aes256Gcm)
}

/// Returns the backend selected for `Aes256GcmSiv` on the current machine.
#[cfg(feature = "aes-gcm-siv")]
#[inline]
#[must_use]
pub fn aes256gcmsiv_backend() -> &'static str {
  backend_for(AeadPrimitive::Aes256GcmSiv)
}

/// Returns the backend selected for `ChaCha20Poly1305` on the current machine.
#[cfg(feature = "chacha20poly1305")]
#[inline]
#[must_use]
pub fn chacha20poly1305_backend() -> &'static str {
  backend_for(AeadPrimitive::ChaCha20Poly1305)
}

/// Returns the backend selected for `XChaCha20Poly1305` on the current machine.
#[cfg(feature = "xchacha20poly1305")]
#[inline]
#[must_use]
pub fn xchacha20poly1305_backend() -> &'static str {
  backend_for(AeadPrimitive::XChaCha20Poly1305)
}

/// Returns the backend selected for `Aegis256` on the current machine.
#[cfg(feature = "aegis256")]
#[inline]
#[must_use]
pub fn aegis256_backend() -> &'static str {
  backend_for(AeadPrimitive::Aegis256)
}

/// Returns the backend selected for `AsconAead128` on the current machine.
#[cfg(feature = "ascon-aead")]
#[inline]
#[must_use]
pub fn ascon_aead128_backend() -> &'static str {
  backend_for(AeadPrimitive::AsconAead128)
}

#[cfg(test)]
mod tests {
  use super::DispatchInfo;

  #[test]
  fn dispatch_info_display_not_empty() {
    let info = DispatchInfo::current();
    let s = alloc::format!("{info}");
    assert!(!s.is_empty());
  }

  #[test]
  fn dispatch_info_debug_not_empty() {
    let info = DispatchInfo::current();
    let s = alloc::format!("{info:?}");
    assert!(!s.is_empty());
    assert!(s.contains("DispatchInfo"));
  }

  #[test]
  fn backend_for_current_platform_is_not_empty() {
    #[cfg(feature = "xchacha20poly1305")]
    assert!(!super::xchacha20poly1305_backend().is_empty());
    #[cfg(feature = "chacha20poly1305")]
    assert!(!super::chacha20poly1305_backend().is_empty());
    #[cfg(feature = "aes-gcm")]
    assert!(!super::aes256gcm_backend().is_empty());
    #[cfg(feature = "aes-gcm-siv")]
    assert!(!super::aes256gcmsiv_backend().is_empty());
    #[cfg(feature = "aegis256")]
    assert!(!super::aegis256_backend().is_empty());
    #[cfg(feature = "ascon-aead")]
    assert!(!super::ascon_aead128_backend().is_empty());
  }
}