Struct ring::error::KeyRejected

pub struct KeyRejected(&'static str);

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.

Tuple Fields

0: &'static str

Implementations

impl KeyRejected

pub(crate) fn inconsistent_components() -> Self

pub(crate) fn invalid_component() -> Self

pub(crate) fn invalid_encoding() -> Self

pub(crate) fn rng_failed() -> Self

pub(crate) fn public_key_is_missing() -> Self

pub(crate) fn too_small() -> Self

pub(crate) fn too_large() -> Self

pub(crate) fn version_not_supported() -> Self

pub(crate) fn wrong_algorithm() -> Self

pub(crate) fn private_modulus_len_not_multiple_of_512_bits() -> Self

pub(crate) fn unexpected_error() -> Self

Trait Implementations

impl Clone for KeyRejected

fn clone(&self) -> KeyRejected

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyRejected

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for KeyRejected

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<KeyRejected> for Unspecified

fn from(_: KeyRejected) -> Self

Converts to this type from the input type.

impl Copy for KeyRejected