fast-floe 0.3.4

High performance, spec-compliant Fast Lightweight Online Encryption (FLOE) implementation
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

#[cfg(not(any(
    feature = "rustcrypto",
    feature = "aws-lc-rs",
    feature = "boring",
    feature = "ring"
)))]
compile_error!("enable at least one FLOE provider: aws-lc-rs, boring, ring, or rustcrypto");

mod backends;
mod buffer;
mod error;
pub mod io;
mod key;
pub mod online;
mod parameters;
mod provider;
pub mod random_access;
mod state;
mod wire;

pub use error::{Error, LengthRequirement, Result};
pub use key::Key;
pub use online::{decrypt, decrypt_with_parameters, encrypt};
pub use parameters::{Parameters, SEGMENT_PREFIX_LENGTH, SegmentFraming, SegmentKind};
pub use provider::Provider;
pub use state::Header;

/// Framing, backend, and raw random-access primitives for experts.
///
/// These APIs expose more of the FLOE state machine and require callers
/// to preserve message-level invariants (and to know those invariants exist).
///
/// In particular, callers processing segments themselves must uphold the
/// obligations that higher-level APIs abstract away:
///
///   - Encrypt each position at most once
///   - Produce exactly one final segment
///   - Leave no gaps
///   - Never process positions beyond the final segment.
///
/// Prefer the higher-level APIs unless manual segment processing or parallel
/// access is required.
pub mod low_level {
    pub use crate::buffer::SegmentBuffer;
    pub use crate::parameters::{
        MessageLayout, SEGMENT_PAYLOAD_OFFSET, SegmentKind, SegmentLayout, Segments,
    };
    pub use crate::state::{
        DecryptionState, EncryptionState, SharedDecryptionContext, SharedEncryptionContext,
        start_decryption, start_decryption_inferred, start_encryption,
    };
}

pub(crate) use buffer::SegmentBuffer;
pub(crate) use parameters::{
    AEAD_IV_LENGTH, AEAD_MAX_SEGMENTS, AEAD_TAG_LENGTH, ENCODED_PARAMETERS_LENGTH, FLOE_IV_LENGTH,
    HEADER_LENGTH, HEADER_LENGTH_U64, HEADER_TAG_LENGTH, SEGMENT_OVERHEAD, SEGMENT_PAYLOAD_OFFSET,
    SegmentLayout, length_u32_to_usize, length_u64_to_usize_saturating, length_usize_to_u64,
};
pub(crate) use state::{
    DecryptionState, EncryptionState, start_decryption, start_decryption_inferred, start_encryption,
};

#[cfg(test)]
mod tests;