/rust/registry/src/index.crates.io-1949cf8c6b5b557f/signature-3.0.0/src/error.rs

Source
//! Signature error types

use core::fmt::{self, Debug, Display};

#[cfg(feature = "alloc")]
use alloc::boxed::Box;

/// Result type.
///
/// A result with the `signature` crate's [`Error`] type.
pub type Result<T> = core::result::Result<T, Error>;

/// Signature errors.
///
/// This type is deliberately opaque as to avoid sidechannel leakage which
/// could potentially be used recover signing private keys or forge signatures
/// (e.g. [BB'06]).
///
/// When the `alloc` feature is enabled, it supports an optional [`core::error::Error::source`],
/// which can be used by things like remote signers (e.g. HSM, KMS) to report I/O or auth errors.
///
/// [BB'06]: https://en.wikipedia.org/wiki/Daniel_Bleichenbacher
#[derive(Default)]
#[non_exhaustive]
pub struct Error {
    /// Source of the error (if applicable).
    #[cfg(feature = "alloc")]
    source: Option<Box<dyn core::error::Error + Send + Sync + 'static>>,
}

impl Error {
    /// Create a new error with no associated source
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Create a new error with an associated source.
    ///
    /// **NOTE:** The "source" should **NOT** be used to propagate cryptographic
    /// errors e.g. signature parsing or verification errors. The intended use
    /// cases are for propagating errors related to external signers, e.g.
    /// communication/authentication errors with HSMs, KMS, etc.
    #[cfg(feature = "alloc")]
    pub fn from_source(
        source: impl Into<Box<dyn core::error::Error + Send + Sync + 'static>>,
    ) -> Self {
        Self {
            source: Some(source.into()),
        }
    }
}

impl Debug for Error {
    #[cfg(not(feature = "alloc"))]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("signature::Error {}")
    }

    #[cfg(feature = "alloc")]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("signature::Error { source: ")?;

        if let Some(source) = &self.source {
            write!(f, "Some({source})")?;
        } else {
            f.write_str("None")?;
        }

        f.write_str(" }")
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("signature error")
    }
}

#[cfg(feature = "alloc")]
impl From<Box<dyn core::error::Error + Send + Sync + 'static>> for Error {
    fn from(source: Box<dyn core::error::Error + Send + Sync + 'static>) -> Error {
        Self::from_source(source)
    }
}

impl core::error::Error for Error {
    fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
        #[cfg(not(feature = "alloc"))]
        {
            None
        }
        #[cfg(feature = "alloc")]
        #[allow(trivial_casts)]
        {
            self.source
                .as_ref()
                .map(|source| source.as_ref() as &(dyn core::error::Error + 'static))
        }
    }
}

Line	Count	Source
1		//! Signature error types
2
3		use core::fmt::{self, Debug, Display};
4
5		#[cfg(feature = "alloc")]
6		use alloc::boxed::Box;
7
8		/// Result type.
9		///
10		/// A result with the `signature` crate's [`Error`] type.
11		pub type Result<T> = core::result::Result<T, Error>;
12
13		/// Signature errors.
14		///
15		/// This type is deliberately opaque as to avoid sidechannel leakage which
16		/// could potentially be used recover signing private keys or forge signatures
17		/// (e.g. [BB'06]).
18		///
19		/// When the `alloc` feature is enabled, it supports an optional [`core::error::Error::source`],
20		/// which can be used by things like remote signers (e.g. HSM, KMS) to report I/O or auth errors.
21		///
22		/// [BB'06]: https://en.wikipedia.org/wiki/Daniel_Bleichenbacher
23		#[derive(Default)]
24		#[non_exhaustive]
25		pub struct Error {
26		/// Source of the error (if applicable).
27		#[cfg(feature = "alloc")]
28		source: Option<Box<dyn core::error::Error + Send + Sync + 'static>>,
29		}
30
31		impl Error {
32		/// Create a new error with no associated source
33		#[must_use]
34	0	pub fn new() -> Self {
35	0	Self::default()
36	0	}
37
38		/// Create a new error with an associated source.
39		///
40		/// NOTE: The "source" should NOT be used to propagate cryptographic
41		/// errors e.g. signature parsing or verification errors. The intended use
42		/// cases are for propagating errors related to external signers, e.g.
43		/// communication/authentication errors with HSMs, KMS, etc.
44		#[cfg(feature = "alloc")]
45	0	pub fn from_source(
46	0	source: impl Into<Box<dyn core::error::Error + Send + Sync + 'static>>,
47	0	) -> Self {
48	0	Self {
49	0	source: Some(source.into()),
50	0	}
51	0	}
52		}
53
54		impl Debug for Error {
55		#[cfg(not(feature = "alloc"))]
56		fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
57		f.write_str("signature::Error {}")
58		}
59
60		#[cfg(feature = "alloc")]
61	0	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
62	0	f.write_str("signature::Error { source: ")?;
63
64	0	if let Some(source) = &self.source {
65	0	write!(f, "Some({source})")?;
66		} else {
67	0	f.write_str("None")?;
68		}
69
70	0	f.write_str(" }")
71	0	}
72		}
73
74		impl Display for Error {
75	0	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
76	0	f.write_str("signature error")
77	0	}
78		}
79
80		#[cfg(feature = "alloc")]
81		impl From<Box<dyn core::error::Error + Send + Sync + 'static>> for Error {
82	0	fn from(source: Box<dyn core::error::Error + Send + Sync + 'static>) -> Error {
83	0	Self::from_source(source)
84	0	}
85		}
86
87		impl core::error::Error for Error {
88	0	fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
89		#[cfg(not(feature = "alloc"))]
90		{
91		None
92		}
93		#[cfg(feature = "alloc")]
94		#[allow(trivial_casts)]
95		{
96	0	self.source
97	0	.as_ref()
98	0	.map(\|source\| source.as_ref() as &(dyn core::error::Error + 'static))
99		}
100	0	}
101		}

Coverage Report

Created: 2026-11-12 06:16