Struct jaws::algorithms::rsa::pkcs1v15::VerifyingKey

pub struct VerifyingKey<D>
where
    D: Digest,
{ /* private fields */ }

Verifying key for RSASSA-PKCS1-v1_5 signatures as described in RFC8017 § 8.2.

Implementations

impl<D> VerifyingKey<D>

where D: Digest + AssociatedOid,

pub fn new(key: RsaPublicKey) -> VerifyingKey<D>

Create a new verifying key with a prefix for the digest D.

Examples found in repository

examples/rfc7515a2.rs (line 118)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // This key is from RFC 7515, Appendix A.2. Provide your own key instead!
    // The key here is stored as a PKCS#8 PEM file, but you can leverage
    // RustCrypto to load a variety of other formats.
    let key = rsa::RsaPrivateKey::from_pkcs8_pem(include_str!(concat!(
        env!("CARGO_MANIFEST_DIR"),
        "/examples/rfc7515a2.pem"
    )))
    .unwrap();

    // We will sign the JWT with the RS256 algorithm: RSA with SHA-256.
    // RsaPkcs1v15 is really an alias to the digital signature algorithm
    // implementation in the `rsa` crate, but provided in JAWS to make
    // it clear which types are compatible with JWTs.
    let alg = rsa::pkcs1v15::SigningKey::<Sha256>::new(key);

    // Claims can combine registered and custom fields. The claims object
    // can be any type which implements [serde::Serialize].
    let claims: Claims<serde_json::Value, (), String, (), ()> = Claims {
        registered: RegisteredClaims {
            subject: "1234567890".to_string().into(),
            ..Default::default()
        },
        claims: json!({
            "name": "John Doe",
            "admin": true,
        }),
    };

    // Create a token with the default headers, and no custom headers.
    // The unit type can be used here because it implements [serde::Serialize],
    // but a custom type could be passed if we wanted to have custom header
    // fields.
    let mut token = Token::compact((), claims);
    // We can modify the headers freely before signing the JWT. In this case,
    // we provide the `typ` header, which is optional in the JWT spec.
    *token.header_mut().r#type() = Some("JWT".to_string());

    // We can also ask that some fields be derived from the signing key, for example,
    // this will derive the JWK field in the header from the signing key.
    token.header_mut().key().derived();

    println!("Initial JWT");

    // Initially the JWT has no defined signature:
    println!("JWT:");
    println!("{}", token.formatted());

    // Sign the token with the algorithm, and print the result.
    let signed = token.sign(&alg).unwrap();

    println!("Signed JWT");

    println!("JWT:");
    println!("{}", signed.formatted());
    println!("Token: {}", signed.rendered().unwrap());

    // We can't modify the token after signing it (that would change the signature)
    // but we can access fields and read from them:
    println!(
        "Type: {:?}, Algorithm: {:?}",
        signed.header().r#type(),
        signed.header().algorithm(),
    );

    // We can also verify tokens.
    let token: Token<Claims<serde_json::Value>, Unverified<()>, Compact> =
        signed.rendered().unwrap().parse().unwrap();

    println!("Parsed JWT");

    // Unverified tokens can be printed for debugging, but there is deliberately
    // no access to the payload, only to the header fields.
    println!("JWT:");
    println!("{}", token.formatted());

    // We can use the JWK to verify that the token is signed with the correct key.
    let hdr = token.header();
    let jwk = hdr.key().unwrap();
    let key = rsa_jwk_reader::rsa_pub(&serde_json::to_value(jwk).unwrap());

    assert_eq!(&key, alg.verifying_key().as_ref());

    let alg: rsa::pkcs1v15::VerifyingKey<Sha256> = rsa::pkcs1v15::VerifyingKey::new(key);

    // We can't access the claims until we verify the token.
    let verified = token.verify(&alg).unwrap();

    println!("Verified JWT");
    println!("JWT:");
    println!("{}", verified.formatted());
    println!(
        "Payload: \n{}",
        serde_json::to_string_pretty(&verified.payload()).unwrap()
    );

    Ok(())
}

pub fn new_with_prefix(key: RsaPublicKey) -> VerifyingKey<D>

👎Deprecated since 0.9.0: use VerifyingKey::new instead

Create a new verifying key with a prefix for the digest D.

impl<D> VerifyingKey<D>

where D: Digest,

pub fn new_unprefixed(key: RsaPublicKey) -> VerifyingKey<D>

Create a new verifying key from an RSA public key with an empty prefix.

Note: unprefixed signatures are uncommon

In most cases you’ll want to use VerifyingKey::new instead.

Trait Implementations

impl<D> AsRef<RsaPublicKey> for VerifyingKey<D>

where D: Digest,

fn as_ref(&self) -> &RsaPublicKey

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

impl<D> AssociatedAlgorithmIdentifier for VerifyingKey<D>

where D: Digest,

type Params = AnyRef<'static>

Algorithm parameters.

const ALGORITHM_IDENTIFIER: AlgorithmIdentifier<AnyRef<'static>> = pkcs1::ALGORITHM_ID

AlgorithmIdentifier for this structure.

impl<D> Clone for VerifyingKey<D>

where D: Digest,

fn clone(&self) -> VerifyingKey<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D> Debug for VerifyingKey<D>

where D: Debug + Digest,

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

Formats the value using the given formatter.

impl<D> DigestVerifier<D, Signature> for VerifyingKey<D>

where D: Digest,

fn verify_digest(&self, digest: D, signature: &Signature) -> Result<(), Error>

Verify the signature against the given Digest output.

impl<D> EncodePublicKey for VerifyingKey<D>

where D: Digest,

fn to_public_key_der(&self) -> Result<Document, Error>

Serialize a [Document] containing a SPKI-encoded public key.

fn to_public_key_pem(&self, line_ending: LineEnding) -> Result<String, Error>

Serialize this public key as PEM-encoded SPKI with the given LineEnding.

fn write_public_key_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write ASN.1 DER-encoded public key to the given path

fn write_public_key_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding ) -> Result<(), Error>

Write ASN.1 DER-encoded public key to the given path

impl<D> From<RsaPublicKey> for VerifyingKey<D>

where D: Digest,

fn from(key: RsaPublicKey) -> VerifyingKey<D>

Converts to this type from the input type.

impl JWKeyType for VerifyingKey<Sha256>

const KEY_TYPE: &'static str = "RSA"

The string used to identify the JWK type in the kty field.

impl JWKeyType for VerifyingKey<Sha512>

const KEY_TYPE: &'static str = "RSA"

The string used to identify the JWK type in the kty field.

impl JWKeyType for VerifyingKey<Sha384>

const KEY_TYPE: &'static str = "RSA"

The string used to identify the JWK type in the kty field.

impl JoseAlgorithm for VerifyingKey<Sha256>

const IDENTIFIER: AlgorithmIdentifier = crate::algorithms::AlgorithmIdentifier::RS256

The identifier for this algorithm when used in a JWT registered header.

type Signature = Signature

The type of the signature, which must support encoding.

impl JoseAlgorithm for VerifyingKey<Sha512>

const IDENTIFIER: AlgorithmIdentifier = crate::algorithms::AlgorithmIdentifier::RS512

The identifier for this algorithm when used in a JWT registered header.

type Signature = Signature

The type of the signature, which must support encoding.

impl JoseAlgorithm for VerifyingKey<Sha384>

const IDENTIFIER: AlgorithmIdentifier = crate::algorithms::AlgorithmIdentifier::RS384

The identifier for this algorithm when used in a JWT registered header.

type Signature = Signature

The type of the signature, which must support encoding.

impl JoseDigestAlgorithm for VerifyingKey<Sha256>

type Digest = CoreWrapper<CtVariableCoreWrapper<Sha256VarCore, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, OidSha256>>

The digest algorithm used by this signature.

impl JoseDigestAlgorithm for VerifyingKey<Sha512>

type Digest = CoreWrapper<CtVariableCoreWrapper<Sha512VarCore, UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>, OidSha512>>

The digest algorithm used by this signature.

impl JoseDigestAlgorithm for VerifyingKey<Sha384>

type Digest = CoreWrapper<CtVariableCoreWrapper<Sha512VarCore, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B0>, B0>, B0>, OidSha384>>

The digest algorithm used by this signature.

impl<D> PrehashVerifier<Signature> for VerifyingKey<D>

where D: Digest,

fn verify_prehash( &self, prehash: &[u8], signature: &Signature ) -> Result<(), Error>

Use Self to verify that the provided signature for a given message prehash is authentic.

impl SerializeJWK for VerifyingKey<Sha256>

fn parameters(&self) -> Vec<(String, Value)>

Return a list of parameters to be serialized in the JWK.

impl SerializeJWK for VerifyingKey<Sha512>

fn parameters(&self) -> Vec<(String, Value)>

Return a list of parameters to be serialized in the JWK.

impl SerializeJWK for VerifyingKey<Sha384>

fn parameters(&self) -> Vec<(String, Value)>

Return a list of parameters to be serialized in the JWK.

impl<D> SignatureAlgorithmIdentifier for VerifyingKey<D>

where D: Digest + RsaSignatureAssociatedOid,

type Params = AnyRef<'static>

Algorithm parameters.

const SIGNATURE_ALGORITHM_IDENTIFIER: AlgorithmIdentifier<AnyRef<'static>> = _

AlgorithmIdentifier for the corresponding singature system.

impl<D> TryFrom<SubjectPublicKeyInfo<AnyRef<'_>, BitStringRef<'_>>> for VerifyingKey<D>

where D: Digest + AssociatedOid,

type Error = Error

The type returned in the event of a conversion error.

fn try_from( spki: SubjectPublicKeyInfo<AnyRef<'_>, BitStringRef<'_>> ) -> Result<VerifyingKey<D>, Error>

Performs the conversion.

impl<D> Verifier<Signature> for VerifyingKey<D>

where D: Digest,

fn verify(&self, msg: &[u8], signature: &Signature) -> Result<(), Error>

Use Self to verify that the provided signature for a given message bytestring is authentic.