Skip to main content

GenericRsaPublicKey

Struct GenericRsaPublicKey 

Source
pub struct GenericRsaPublicKey<T, M>
where T: UnsignedModularInt, M: ModulusParams<Modulus = T>,
{ /* private fields */ }
Expand description

Represents the public part of an RSA key.

Implementations§

Source§

impl<T, M> GenericRsaPublicKey<T, M>
where T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source

pub fn from_components(n: T, e: T, n_params: M) -> Result<Self>

Create a public key from already-validated components and modulus parameters.

This is intended for alternate bigint backends that prepare their own modular arithmetic context outside the BoxedUint constructors.

Source§

impl<T, M> GenericRsaPublicKey<T, M>
where T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source

pub fn encrypt<R: CryptoRng + ?Sized, P: PaddingScheme>( &self, rng: &mut R, padding: P, msg: &[u8], ) -> Result<Vec<u8>>

Available on crate feature alloc only.

Encrypt the given message.

Source

pub fn verify<S: SignatureScheme>( &self, scheme: S, hashed: &[u8], sig: &[u8], ) -> Result<()>

Verify a signed message.

hashed must be the result of hashing the input using the hashing function passed in through hash.

If the message is valid Ok(()) is returned, otherwise an Err indicating failure.

Source§

impl GenericRsaPublicKey<BoxedUint, BoxedMontyParams>

Source

pub const MIN_PUB_EXPONENT: u64 = 2

Available on crate feature alloc only.

Minimum value of the public exponent e.

Source

pub const MAX_PUB_EXPONENT: u64

Available on crate feature alloc only.

Maximum value of the public exponent e.

Very large public exponents are a potential denial-of-service vector (a.k.a. “RSADoS”) because they increase the amount of work required for e.g. signature verification. See:

https://www.imperialviolet.org/2012/03/17/rsados.html

The particular constant below has been chosen to align with ring where this value was selected based on the history of this particular issue, API compatibility concerns, and benchmark-driven evaluation. See RustCrypto/RSA#155.

If for some reason you have a legitimate reason to use keys with public exponents larger than this value, use the special APIs:

Source

pub const MAX_SIZE: usize = 8192

Available on crate feature alloc only.

Maximum size of the modulus n in bits.

Source

pub fn new(n: BoxedUint, e: BoxedUint) -> Result<Self>

Available on crate feature alloc only.

Create a new public key from its components.

This function accepts public keys with a modulus size up to 8192-bits, i.e. RsaPublicKey::MAX_SIZE.

Source

pub fn new_with_max_size( n: BoxedUint, e: BoxedUint, max_size: usize, ) -> Result<Self>

Available on crate feature alloc only.

Create a new public key from its components.

Source

pub fn new_unchecked(n: BoxedUint, e: BoxedUint) -> Self

Available on crate feature alloc only.

Create a new public key, bypassing checks around the modulus and public exponent size.

This method is not recommended, and only intended for unusual use cases. Most applications should use RsaPublicKey::new or RsaPublicKey::new_with_max_size instead.

Trait Implementations§

Source§

impl AsRef<GenericRsaPublicKey<BoxedUint, BoxedMontyParams>> for RsaPrivateKey

Available on crate feature private-key only.
Source§

fn as_ref(&self) -> &RsaPublicKey

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<D, T, M> AsRef<GenericRsaPublicKey<T, M>> for GenericVerifyingKey<D, T, M>
where D: Digest, T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source§

fn as_ref(&self) -> &GenericRsaPublicKey<T, M>

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<D, T, M> AsRef<GenericRsaPublicKey<T, M>> for GenericVerifyingKey<D, T, M>
where D: Digest, T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source§

fn as_ref(&self) -> &GenericRsaPublicKey<T, M>

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<T, M> Clone for GenericRsaPublicKey<T, M>
where T: UnsignedModularInt + Clone, M: ModulusParams<Modulus = T> + Clone,

Source§

fn clone(&self) -> GenericRsaPublicKey<T, M>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T, M> Debug for GenericRsaPublicKey<T, M>
where T: UnsignedModularInt + Debug, M: ModulusParams<Modulus = T> + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&RsaPrivateKey> for GenericRsaPublicKey<BoxedUint, BoxedMontyParams>

Available on crate feature private-key only.
Source§

fn from(private_key: &RsaPrivateKey) -> Self

Converts to this type from the input type.
Source§

impl<D, T, M> From<GenericRsaPublicKey<T, M>> for GenericVerifyingKey<D, T, M>
where D: Digest + AssociatedOid, T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source§

fn from(key: GenericRsaPublicKey<T, M>) -> Self

Converts to this type from the input type.
Source§

impl<D, T, M> From<GenericRsaPublicKey<T, M>> for GenericVerifyingKey<D, T, M>
where D: Digest, T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source§

fn from(key: GenericRsaPublicKey<T, M>) -> Self

Converts to this type from the input type.
Source§

impl<D, T, M> From<GenericVerifyingKey<D, T, M>> for GenericRsaPublicKey<T, M>
where D: Digest, T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source§

fn from(key: GenericVerifyingKey<D, T, M>) -> Self

Converts to this type from the input type.
Source§

impl<D, T, M> From<GenericVerifyingKey<D, T, M>> for GenericRsaPublicKey<T, M>
where D: Digest, T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source§

fn from(key: GenericVerifyingKey<D, T, M>) -> Self

Converts to this type from the input type.
Source§

impl From<RsaPrivateKey> for GenericRsaPublicKey<BoxedUint, BoxedMontyParams>

Available on crate feature private-key only.
Source§

fn from(private_key: RsaPrivateKey) -> Self

Converts to this type from the input type.
Source§

impl<T, M> Hash for GenericRsaPublicKey<T, M>
where T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T, M> PartialEq for GenericRsaPublicKey<T, M>
where T: UnsignedModularInt + PartialEq, M: ModulusParams<Modulus = T>,

Source§

fn eq(&self, other: &GenericRsaPublicKey<T, M>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T, M> PublicKeyParts<T> for GenericRsaPublicKey<T, M>
where T: UnsignedModularInt, M: ModulusParams<Modulus = T>,

Source§

type MontyParams = M

Montgomery parameter type matching this modulus type.
Source§

fn n(&self) -> &NonZero<T>

Returns the modulus of the key.
Source§

fn e(&self) -> &T

Returns the public exponent of the key.
Source§

fn n_params(&self) -> &M

Returns the parameters for montgomery operations.
Source§

fn size(&self) -> usize

Returns the modulus size in bytes. Raw signatures and ciphertexts for or by this public key will have the same size.
Source§

fn n_bits_precision(&self) -> u32

Returns precision (in bits) of n.
Source§

fn n_bytes(&self) -> Box<[u8]>

Available on crate feature alloc only.
Returns the big endian serialization of the modulus of the key
Source§

fn e_bytes(&self) -> Box<[u8]>

Available on crate feature alloc only.
Returns the big endian serialization of the public exponent of the key
Source§

impl<T, M> Eq for GenericRsaPublicKey<T, M>
where T: UnsignedModularInt + Eq, M: ModulusParams<Modulus = T>,

Auto Trait Implementations§

§

impl<T, M> Freeze for GenericRsaPublicKey<T, M>
where T: Freeze, M: Freeze,

§

impl<T, M> RefUnwindSafe for GenericRsaPublicKey<T, M>

§

impl<T, M> Send for GenericRsaPublicKey<T, M>
where T: Send, M: Send,

§

impl<T, M> Sync for GenericRsaPublicKey<T, M>
where T: Sync, M: Sync,

§

impl<T, M> Unpin for GenericRsaPublicKey<T, M>
where T: Unpin, M: Unpin,

§

impl<T, M> UnsafeUnpin for GenericRsaPublicKey<T, M>
where T: UnsafeUnpin, M: UnsafeUnpin,

§

impl<T, M> UnwindSafe for GenericRsaPublicKey<T, M>
where T: UnwindSafe, M: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DecodePublicKey for T
where T: for<'a> TryFrom<SubjectPublicKeyInfo<AnyRef<'a>, BitStringRef<'a>>, Error = Error>,

Source§

fn from_public_key_der(bytes: &[u8]) -> Result<T, Error>

Deserialize object from ASN.1 DER-encoded [SubjectPublicKeyInfo] (binary format). Read more
Source§

fn from_public_key_pem(s: &str) -> Result<Self, Error>

Available on crate feature pem only.
Deserialize PEM-encoded [SubjectPublicKeyInfo]. Read more
Source§

fn read_public_key_der_file(path: impl AsRef<Path>) -> Result<Self, Error>

Available on crate feature std only.
Load public key object from an ASN.1 DER-encoded file on the local filesystem (binary format). Read more
Source§

fn read_public_key_pem_file(path: impl AsRef<Path>) -> Result<Self, Error>

Available on crate features pem and std only.
Load public key object from a PEM-encoded file on the local filesystem. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,