polyjose 0.1.2

Pure-Rust JOSE: JWA, JWK, JWS, JWE and JWT per the RFCs, with no OpenSSL
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

#![forbid(unsafe_code)]
//! polyjose: JSON Object Signing and Encryption in pure Rust.
//!
//! - [`json`] RFC 8259 JSON with RFC 7493 (I-JSON) constraints
//! - [`jwa`]  RFC 7518 – algorithm identifiers
//! - [`header`] RFC 7515/7516 – the JOSE Header
//! - [`jwk`]  RFC 7517 – keys and key sets
//! - [`keys`] key generation and PEM/DER import and export (RFC 7468, RFC 5958, RFC 5280)
//! - [`jws`]  RFC 7515 – signatures
//! - [`jwe`]  RFC 7516 – encryption
//! - [`jwt`]  RFC 7519 – tokens and claims
//! - [`util`] base64url and other helpers

// Raw DEFLATE for JWE `zip: DEF` (ADR 0017), only with the off-by-default
// `deflate` feature; called by `jwe::zip` (RFC 7516 §4.1.3).
#[cfg(feature = "deflate")]
mod deflate;
/// Error type.
pub mod error;
/// The JOSE Header (RFC 7515 §4, RFC 7516 §4).
pub mod header;
/// JSON parser, value type and serializer (RFC 8259, RFC 7493).
pub mod json;
/// Algorithm identifiers (RFC 7518).
pub mod jwa;
/// JSON Web Encryption (RFC 7516).
pub mod jwe;
/// JSON Web Key (RFC 7517).
pub mod jwk;
/// JSON Web Signature (RFC 7515).
pub mod jws;
/// JSON Web Token (RFC 7519).
pub mod jwt;
/// Key generation and PEM/DER key import and export (RFC 7468, RFC 5958,
/// RFC 5280 §4.1, RFC 5915, RFC 8410, RFC 8017 App. A.1.1).
pub mod keys;
mod rng;
#[cfg(feature = "insecure-test-vectors")]
pub use rng::insecure_test_vectors;
// Test-only operation counters. Keep this exact two-line declaration: the
// RNG state scan (rng.rs) exempts the file only when it is declared so.
#[cfg(test)]
mod test_counters;
// Test-only fixtures (the vendored Wycheproof loader): never in a non-test
// build, and not reachable from the integration tests in `tests/`.
#[cfg(test)]
mod test_support;
/// base64url and helpers.
pub mod util;

pub use error::{Error, Result};

/// The crate README's examples (`README.md`, the crates.io page), compiled
/// and run as doctests so they can't drift from the API. Exists only under
/// `cfg(doctest)`: never in a normal or downstream build, and not public API.
#[cfg(doctest)]
#[doc = include_str!("../README.md")]
pub struct ReadmeDoctests;

/// Fuzzing-only entry points (feature 0012, ADR 0036 §1–§2). Compiled only
/// under cargo-fuzz's `--cfg fuzzing`, never in a normal, test, doc or
/// downstream build, and hidden from the docs: not public API.
#[cfg(all(fuzzing, feature = "deflate"))]
#[doc(hidden)]
pub mod fuzzing {
    /// The bounded raw DEFLATE inflate behind JWE `zip: DEF` (RFC 1951 §3.2,
    /// RFC 7516 §4.1.3, ADR 0017 §1), which the public API reaches only
    /// after a successful AEAD decryption.
    ///
    /// # Errors
    ///
    /// As the internal `deflate::inflate`: [`crate::Error::InvalidFormat`].
    pub fn inflate(input: &[u8], max_output: usize) -> crate::Result<zeroize::Zeroizing<Vec<u8>>> {
        crate::deflate::inflate(input, max_output)
    }
}