Skip to content

Capitalize crate name #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc --no-deps --all-features
```

### Tests and Fuzzing
The [wiki](https://github.com/orion-rs/orion/wiki/Testing-suite) has details on how orion is tested. To run all tests:
The [wiki](https://github.com/orion-rs/orion/wiki/Testing-suite) has details on how Orion is tested. To run all tests:
```
cargo test
```
Expand Down
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The following are threats, which are considered out-of-scope for Orion.
[1] Wiping sensitive memory is performed on a best-effort approach. However, sensitive memory being wiped or not leaked, cannot be guaranteed. See more in the [wiki](https://github.com/orion-rs/orion/wiki/Security#memory).

### Supported versions
Currently, only the latest version, released on [crates.io](https://crates.io/crates/orion), recieves testing and is supported with security fixes.
Currently, only the latest version, released on [crates.io](https://crates.io/crates/orion), receives testing and is supported with security fixes.

There is no guarantee that a version, containing a security fix, will be SemVer-compatible to the previous one.

Expand All @@ -30,7 +30,7 @@ Backporting security fixes to older versions will be considered on an ad hoc bas
Any version which is affected by a security issue, will be yanked. Even though we try to provide it, there is no guarantee that a SemVer-compatible version, containing a fix, will be available at the time of yanking.

### Recommended best practices
The are recommendations on how to use Orion correctly:
These are recommendations on how to use Orion correctly:

- Use `cargo audit` to ensure the current version has no published security vulnerabilities
- Never use `opt-level=0`, always build in release mode
Expand Down
2 changes: 1 addition & 1 deletion src/high_level/pwhash.rs
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ impl_ct_partialeq_trait!(PasswordHash, unprotected_as_bytes);

#[cfg(feature = "serde")]
/// `PasswordHash` serializes as would a [`String`](std::string::String). Note that
/// the serialized type likely does not have the same protections that orion
/// the serialized type likely does not have the same protections that Orion
/// provides, such as constant-time operations. A good rule of thumb is to only
/// serialize these types for storage. Don't operate on the serialized types.
impl Serialize for PasswordHash {
Expand Down
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@
//! [`orion::kex`] offers ephemeral key exchange using X25519 and BLAKE2b.
//!
//! ### A note on `no_std`:
//! When orion is used in a `no_std` context, the high-level API is not available, since it relies on access to the systems random number generator.
//! When Orion is used in a `no_std` context, the high-level API is not available, since it relies on access to the systems random number generator.
//!
//! More information about orion is available in the [wiki].
//! More information about Orion is available in the [wiki].
//!
//! [`orion::aead`]: crate::aead
//! [`orion::pwhash`]: crate::pwhash
Expand Down Expand Up @@ -86,7 +86,7 @@ mod typedefs;
/// Utilities such as constant-time comparison.
pub mod util;

/// Errors for orion's cryptographic operations.
/// Errors for Orion's cryptographic operations.
pub mod errors;

/// \[__**Caution**__\] Low-level API.
Expand Down
2 changes: 1 addition & 1 deletion src/typedefs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ macro_rules! impl_serde_traits (($name:ident, $bytes_function:ident) => (

#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
/// This type tries to serialize as a `&[u8]` would. Note that the serialized
/// type likely does not have the same protections that orion provides, such
/// type likely does not have the same protections that Orion provides, such
/// as constant-time operations. A good rule of thumb is to only serialize
/// these types for storage. Don't operate on the serialized types.
impl serde::Serialize for $name {
Expand Down
2 changes: 1 addition & 1 deletion src/util/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ pub(crate) mod u64x4;
/// # About:
/// This function can be used to generate cryptographic keys, salts or other
/// values that rely on strong randomness. Please note that most keys and other
/// types used throughout orion, implement their own `generate()` function and
/// types used throughout Orion, implement their own `generate()` function and
/// it is strongly preferred to use those, compared to [`secure_rand_bytes()`].
///
/// This uses [`getrandom`].
Expand Down
2 changes: 1 addition & 1 deletion tests/aead/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ fn wycheproof_test_runner(
let is_tag_same = dst_ct_out[input.len()..].as_ref() == tag;
let is_decrypted_same = dst_pt_out[..].as_ref() == input;
// In this case a test vector reported as invalid by Wycheproof would be
// accepted by orion.
// accepted by Orion.
if is_ct_same && is_decrypted_same && is_tag_same {
panic!("Un-allowed test result! {:?}", tcid);
}
Expand Down
2 changes: 1 addition & 1 deletion tests/mac/nist_cavp_hmac.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ fn test_nist_cavp() {
match test_case {
Some(ref tc) => {
if current_variant.is_empty() {
// We've found a test case and parse it, but Orion
// We've found a test case and parsed it, but Orion
// doesn't support the variant.
continue;
}
Expand Down