/rust/registry/src/index.crates.io-6f17d22bba15001f/ring-0.17.8/src/error.rs

Source (jump to first uncovered line)
// Copyright 2016 Brian Smith.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

//! Error reporting.

#[cfg(feature = "std")]
extern crate std;

/// An error with absolutely no details.
///
/// *ring* uses this unit type as the error type in most of its results
/// because (a) usually the specific reasons for a failure are obvious or are
/// not useful to know, and/or (b) providing more details about a failure might
/// provide a dangerous side channel, and/or (c) it greatly simplifies the
/// error handling logic.
///
/// `Result<T, ring::error::Unspecified>` is mostly equivalent to
/// `Result<T, ()>`. However, `ring::error::Unspecified` implements
/// [`std::error::Error`] and users of *ring* can implement
/// `From<ring::error::Unspecified>` to map this to their own error types, as
/// described in [“Error Handling” in the Rust Book]:
///
/// ```
/// use ring::rand::{self, SecureRandom};
///
/// enum Error {
///     CryptoError,
///
/// #  #[cfg(feature = "alloc")]
///     IOError(std::io::Error),
///     // [...]
/// }
///
/// impl From<ring::error::Unspecified> for Error {
///     fn from(_: ring::error::Unspecified) -> Self { Error::CryptoError }
/// }
///
/// fn eight_random_bytes() -> Result<[u8; 8], Error> {
///     let rng = rand::SystemRandom::new();
///     let mut bytes = [0; 8];
///
///     // The `From<ring::error::Unspecified>` implementation above makes this
///     // equivalent to
///     // `rng.fill(&mut bytes).map_err(|_| Error::CryptoError)?`.
///     rng.fill(&mut bytes)?;
///
///     Ok(bytes)
/// }
///
/// assert!(eight_random_bytes().is_ok());
/// ```
///
/// Experience with using and implementing other crypto libraries like has
/// shown that sophisticated error reporting facilities often cause significant
/// bugs themselves, both within the crypto library and within users of the
/// crypto library. This approach attempts to minimize complexity in the hopes
/// of avoiding such problems. In some cases, this approach may be too extreme,
/// and it may be important for an operation to provide some details about the
/// cause of a failure. Users of *ring* are encouraged to report such cases so
/// that they can be addressed individually.
///
/// [`std::error::Error`]: https://doc.rust-lang.org/std/error/trait.Error.html
/// [“Error Handling” in the Rust Book]:
///     https://doc.rust-lang.org/book/first-edition/error-handling.html#the-from-trait
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct Unspecified;

// This is required for the implementation of `std::error::Error`.
impl core::fmt::Display for Unspecified {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.write_str("ring::error::Unspecified")
    }
}

#[cfg(feature = "std")]
impl std::error::Error for Unspecified {}

impl From<untrusted::EndOfInput> for Unspecified {
    fn from(_: untrusted::EndOfInput) -> Self {
        Self
    }
}

impl From<core::array::TryFromSliceError> for Unspecified {
    fn from(_: core::array::TryFromSliceError) -> Self {
        Self
    }
}

/// An error parsing or validating a key.
///
/// The `Display` implementation will return a string that will help you better
/// understand why a key was rejected change which errors are reported in which
/// situations while minimizing the likelihood that any applications will be
/// broken.
///
/// Here is an incomplete list of reasons a key may be unsupported:
///
/// * Invalid or Inconsistent Components: A component of the key has an invalid
///   value, or the mathematical relationship between two (or more) components
///   required for a valid key does not hold.
///
/// * The encoding of the key is invalid. Perhaps the key isn't in the correct
///   format; e.g. it may be Base64 ("PEM") encoded, in which case   the Base64
///   encoding needs to be undone first.
///
/// * The encoding includes a versioning mechanism and that mechanism indicates
///   that the key is encoded in a version of the encoding that isn't supported.
///   This might happen for multi-prime RSA keys (keys with more than two
///   private   prime factors), which aren't supported, for example.
///
/// * Too small or too Large: One of the primary components of the key is too
///   small or two large. Too-small keys are rejected for security reasons. Some
///   unnecessarily large keys are rejected for performance reasons.
///
///  * Wrong algorithm: The key is not valid for the algorithm in which it was
///    being used.
///
///  * Unexpected errors: Report this as a bug.
#[derive(Copy, Clone, Debug)]
pub struct KeyRejected(&'static str);

impl KeyRejected {
    pub(crate) fn inconsistent_components() -> Self {
        Self("InconsistentComponents")
    }

    pub(crate) fn invalid_component() -> Self {
        Self("InvalidComponent")
    }

    #[inline]
    pub(crate) fn invalid_encoding() -> Self {
        Self("InvalidEncoding")
    }

    // XXX: See the comment at the call site.
    pub(crate) fn rng_failed() -> Self {
        Self("RNG failed")
    }

    pub(crate) fn public_key_is_missing() -> Self {
        Self("PublicKeyIsMissing")
    }

    #[cfg(feature = "alloc")]
    pub(crate) fn too_small() -> Self {
        Self("TooSmall")
    }

    #[cfg(feature = "alloc")]
    pub(crate) fn too_large() -> Self {
        Self("TooLarge")
    }

    pub(crate) fn version_not_supported() -> Self {
        Self("VersionNotSupported")
    }

    pub(crate) fn wrong_algorithm() -> Self {
        Self("WrongAlgorithm")
    }

    #[cfg(feature = "alloc")]
    pub(crate) fn private_modulus_len_not_multiple_of_512_bits() -> Self {
        Self("PrivateModulusLenNotMultipleOf512Bits")
    }

    pub(crate) fn unexpected_error() -> Self {
        Self("UnexpectedError")
    }
}

#[cfg(feature = "std")]
impl std::error::Error for KeyRejected {}

impl core::fmt::Display for KeyRejected {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        f.write_str(self.0)
    }
}

impl From<KeyRejected> for Unspecified {
    fn from(_: KeyRejected) -> Self {
        Self
    }
}

Line	Count	Source (jump to first uncovered line)
1		// Copyright 2016 Brian Smith.
2		//
3		// Permission to use, copy, modify, and/or distribute this software for any
4		// purpose with or without fee is hereby granted, provided that the above
5		// copyright notice and this permission notice appear in all copies.
6		//
7		// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
8		// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9		// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
10		// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11		// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
12		// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
13		// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14
15		//! Error reporting.
16
17		#[cfg(feature = "std")]
18		extern crate std;
19
20		/// An error with absolutely no details.
21		///
22		/// ring uses this unit type as the error type in most of its results
23		/// because (a) usually the specific reasons for a failure are obvious or are
24		/// not useful to know, and/or (b) providing more details about a failure might
25		/// provide a dangerous side channel, and/or (c) it greatly simplifies the
26		/// error handling logic.
27		///
28		/// `Result<T, ring::error::Unspecified>` is mostly equivalent to
29		/// `Result<T, ()>`. However, `ring::error::Unspecified` implements
30		/// [`std::error::Error`] and users of ring can implement
31		/// `From<ring::error::Unspecified>` to map this to their own error types, as
32		/// described in [“Error Handling” in the Rust Book]:
33		///
34		/// ```
35		/// use ring::rand::{self, SecureRandom};
36		///
37		/// enum Error {
38		/// CryptoError,
39		///
40		/// # #[cfg(feature = "alloc")]
41		/// IOError(std::io::Error),
42		/// // [...]
43		/// }
44		///
45		/// impl From<ring::error::Unspecified> for Error {
46		/// fn from(_: ring::error::Unspecified) -> Self { Error::CryptoError }
47		/// }
48		///
49		/// fn eight_random_bytes() -> Result<[u8; 8], Error> {
50		/// let rng = rand::SystemRandom::new();
51		/// let mut bytes = [0; 8];
52		///
53		/// // The `From<ring::error::Unspecified>` implementation above makes this
54		/// // equivalent to
55		/// // `rng.fill(&mut bytes).map_err(\|_\| Error::CryptoError)?`.
56		/// rng.fill(&mut bytes)?;
57		///
58		/// Ok(bytes)
59		/// }
60		///
61		/// assert!(eight_random_bytes().is_ok());
62		/// ```
63		///
64		/// Experience with using and implementing other crypto libraries like has
65		/// shown that sophisticated error reporting facilities often cause significant
66		/// bugs themselves, both within the crypto library and within users of the
67		/// crypto library. This approach attempts to minimize complexity in the hopes
68		/// of avoiding such problems. In some cases, this approach may be too extreme,
69		/// and it may be important for an operation to provide some details about the
70		/// cause of a failure. Users of ring are encouraged to report such cases so
71		/// that they can be addressed individually.
72		///
73		/// [`std::error::Error`]: https://doc.rust-lang.org/std/error/trait.Error.html
74		/// [“Error Handling” in the Rust Book]:
75		/// https://doc.rust-lang.org/book/first-edition/error-handling.html#the-from-trait
76		#[derive(Clone, Copy, Debug, PartialEq)]
77		pub struct Unspecified;
78
79		// This is required for the implementation of `std::error::Error`.
80		impl core::fmt::Display for Unspecified {
81	0	fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
82	0	f.write_str("ring::error::Unspecified")
83	0	}
84		}
85
86		#[cfg(feature = "std")]
87		impl std::error::Error for Unspecified {}
88
89		impl From<untrusted::EndOfInput> for Unspecified {
90	0	fn from(_: untrusted::EndOfInput) -> Self {
91	0	Self
92	0	}
93		}
94
95		impl From<core::array::TryFromSliceError> for Unspecified {
96	0	fn from(_: core::array::TryFromSliceError) -> Self {
97	0	Self
98	0	}
99		}
100
101		/// An error parsing or validating a key.
102		///
103		/// The `Display` implementation will return a string that will help you better
104		/// understand why a key was rejected change which errors are reported in which
105		/// situations while minimizing the likelihood that any applications will be
106		/// broken.
107		///
108		/// Here is an incomplete list of reasons a key may be unsupported:
109		///
110		/// * Invalid or Inconsistent Components: A component of the key has an invalid
111		/// value, or the mathematical relationship between two (or more) components
112		/// required for a valid key does not hold.
113		///
114		/// * The encoding of the key is invalid. Perhaps the key isn't in the correct
115		/// format; e.g. it may be Base64 ("PEM") encoded, in which case the Base64
116		/// encoding needs to be undone first.
117		///
118		/// * The encoding includes a versioning mechanism and that mechanism indicates
119		/// that the key is encoded in a version of the encoding that isn't supported.
120		/// This might happen for multi-prime RSA keys (keys with more than two
121		/// private prime factors), which aren't supported, for example.
122		///
123		/// * Too small or too Large: One of the primary components of the key is too
124		/// small or two large. Too-small keys are rejected for security reasons. Some
125		/// unnecessarily large keys are rejected for performance reasons.
126		///
127		/// * Wrong algorithm: The key is not valid for the algorithm in which it was
128		/// being used.
129		///
130		/// * Unexpected errors: Report this as a bug.
131		#[derive(Copy, Clone, Debug)]
132		pub struct KeyRejected(&'static str);
133
134		impl KeyRejected {
135	0	pub(crate) fn inconsistent_components() -> Self {
136	0	Self("InconsistentComponents")
137	0	}
138
139	0	pub(crate) fn invalid_component() -> Self {
140	0	Self("InvalidComponent")
141	0	}
142
143		#[inline]
144	0	pub(crate) fn invalid_encoding() -> Self {
145	0	Self("InvalidEncoding")
146	0	}
147
148		// XXX: See the comment at the call site.
149	0	pub(crate) fn rng_failed() -> Self {
150	0	Self("RNG failed")
151	0	}
152
153	0	pub(crate) fn public_key_is_missing() -> Self {
154	0	Self("PublicKeyIsMissing")
155	0	}
156
157		#[cfg(feature = "alloc")]
158	0	pub(crate) fn too_small() -> Self {
159	0	Self("TooSmall")
160	0	}
161
162		#[cfg(feature = "alloc")]
163	0	pub(crate) fn too_large() -> Self {
164	0	Self("TooLarge")
165	0	}
166
167	0	pub(crate) fn version_not_supported() -> Self {
168	0	Self("VersionNotSupported")
169	0	}
170
171	0	pub(crate) fn wrong_algorithm() -> Self {
172	0	Self("WrongAlgorithm")
173	0	}
174
175		#[cfg(feature = "alloc")]
176	0	pub(crate) fn private_modulus_len_not_multiple_of_512_bits() -> Self {
177	0	Self("PrivateModulusLenNotMultipleOf512Bits")
178	0	}
179
180	0	pub(crate) fn unexpected_error() -> Self {
181	0	Self("UnexpectedError")
182	0	}
183		}
184
185		#[cfg(feature = "std")]
186		impl std::error::Error for KeyRejected {}
187
188		impl core::fmt::Display for KeyRejected {
189	0	fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
190	0	f.write_str(self.0)
191	0	}
192		}
193
194		impl From<KeyRejected> for Unspecified {
195	0	fn from(_: KeyRejected) -> Self {
196	0	Self
197	0	}
198		}

Coverage Report

Created: 2025-02-21 07:11