# Module ring::signature [−] [src]

Public key signatures: signing and verification.

Use the `verify` function to verify signatures, passing a reference to the algorithm that identifies the algorithm. See the documentation for `verify` for examples.

For signature verification, this API treats each combination of parameters as a separate algorithm. For example, instead of having a single "RSA" algorithm with a verification function that takes a bunch of parameters, there are `RSA_PKCS1_2048_8192_SHA256`, `RSA_PKCS1_2048_8192_SHA384`, etc., which encode sets of parameter choices into objects. This is designed to reduce the risks of algorithm agility and to provide consistency with ECDSA and EdDSA.

Currently this module does not support digesting the message to be signed separately from the public key operation, as it is currently being optimized for Ed25519 and for the implementation of protocols that do not requiring signing large messages. An interface for efficiently supporting larger messages may be added later.

# Algorithm Details

## `ECDSA_*_ASN1` Details: ASN.1-encoded ECDSA Signatures

The signature is a ASN.1 DER-encoded `Ecdsa-Sig-Value` as described in RFC 3279 Section 2.2.3. This is the form of ECDSA signature used in X.509-related structures and in TLS's `ServerKeyExchange` messages.

The public key is encoding in uncompressed form using the Octet-String-to-Elliptic-Curve-Point algorithm in SEC 1: Elliptic Curve Cryptography, Version 2.0.

During verification, the public key is validated using the ECC Partial Public-Key Validation Routine from Section 5.6.2.3.3 of NIST Special Publication 800-56A, revision 2 and Appendix A.3 of the NSA's Suite B implementer's guide to FIPS 186-3. Note that, as explained in the NSA guide, ECC Partial Public-Key Validation is equivalent to ECC Full Public-Key Validation for prime-order curves like this one.

## `ECDSA_*_FIXED` Details: Fixed-length (PKCS#11-style) ECDSA Signatures

The signature is r||*s*, where || denotes concatenation, and where both r and s are both big-endian-encoded values that are left-padded to the maximum length. A P-256 signature will be 64 bytes long (two 32-byte components) and a P-384 signature will be 96 bytes long (two 48-byte components). This is the form of ECDSA signature used PKCS#11 and DNSSEC.

The public key is encoding in uncompressed form using the Octet-String-to-Elliptic-Curve-Point algorithm in SEC 1: Elliptic Curve Cryptography, Version 2.0.

During verification, the public key is validated using the ECC Partial Public-Key Validation Routine from Section 5.6.2.3.3 of NIST Special Publication 800-56A, revision 2 and Appendix A.3 of the NSA's Suite B implementer's guide to FIPS 186-3. Note that, as explained in the NSA guide, ECC Partial Public-Key Validation is equivalent to ECC Full Public-Key Validation for prime-order curves like this one.

## `RSA_PKCS1_*` Details: RSA PKCS#1 1.5 Signatures

The signature is an RSASSA-PKCS1-v1_5 signature as described in RFC 3447 Section 8.2.

The public key is encoded as an ASN.1 `RSAPublicKey` as described in RFC 3447 Appendix-A.1.1. The public key modulus length, rounded up to the nearest (larger) multiple of 8 bits, must be in the range given in the name of the algorithm. The public exponent must be an odd integer of 2-33 bits, inclusive.

## `RSA_PSS_*` Details: RSA PSS Signatures

The signature is an RSASSA-PSS signature as described in RFC 3447 Section 8.1.

The public key is encoded as an ASN.1 `RSAPublicKey` as described in RFC 3447 Appendix-A.1.1. The public key modulus length, rounded up to the nearest (larger) multiple of 8 bits, must be in the range given in the name of the algorithm. The public exponent must be an odd integer of 2-33 bits, inclusive.

During verification, signatures will only be accepted if the MGF1 digest algorithm is the same as the message digest algorithm and if the salt length is the same length as the message digest. This matches the requirements in TLS 1.3 and other recent specifications.

During signing, the message digest algorithm will be used as the MGF1 digest algorithm. The salt will be the same length as the message digest. This matches the requirements in TLS 1.3 and other recent specifications. Additionally, the entire salt is randomly generated separately for each signature using the secure random number generator passed to `sign()`.

# Examples

## Signing and verifying with Ed25519

    extern crate ring;
    extern crate untrusted;

    use ring::{rand, signature};

    // Generate a key pair in PKCS#8 (v2) format.
    let rng = rand::SystemRandom::new();
    let pkcs8_bytes = signature::Ed25519KeyPair::generate_pkcs8(&rng)?;

    // Normally the application would store the PKCS#8 file persistently. Later
    // it would read the PKCS#8 file from persistent storage to use it.

    let key_pair =
       signature::Ed25519KeyPair::from_pkcs8(
                untrusted::Input::from(&pkcs8_bytes))?;

    // Sign the message "hello, world".
    const MESSAGE: &'static [u8] = b"hello, world";
    let sig = key_pair.sign(MESSAGE);

    // Normally an application would extract the bytes of the signature and
    // send them in a protocol message to the peer(s). Here we just get the
    // public key key directly from the key pair.
    let peer_public_key_bytes = key_pair.public_key_bytes();
    let sig_bytes = sig.as_ref();

    // Verify the signature of the message using the public key. Normally the
    // verifier of the message would parse the inputs to `signature::verify`
    // out of the protocol message(s) sent by the signer.
    let peer_public_key = untrusted::Input::from(peer_public_key_bytes);
    let msg = untrusted::Input::from(MESSAGE);
    let sig = untrusted::Input::from(sig_bytes);

    signature::verify(&signature::ED25519, peer_public_key, msg, sig)?;

## Signing and verifying with RSA (PKCS#1 1.5 padding)

RSA signing (but not verification) requires the `rsa_signing` feature to be enabled.

By default OpenSSL writes RSA public keys in SubjectPublicKeyInfo format, not RSAPublicKey format, and Base64-encodes them (“PEM” format).

To convert the PEM SubjectPublicKeyInfo format (“BEGIN PUBLIC KEY”) to the binary RSAPublicKey format needed by `verify()`, use:

    openssl rsa -pubin \
                -in public_key.pem \
                -inform PEM \
                -RSAPublicKey_out \
                -outform DER \
                -out public_key.der

To extract the RSAPublicKey-formatted public key from an ASN.1 (binary) DER-encoded RSAPrivateKey format private key file, use:

    openssl rsa -in private_key.der \
                -inform DER \
                -RSAPublicKey_out \
                -outform DER \
                -out public_key.der

    extern crate ring;
    extern crate untrusted;

    use ring::{rand, signature};

    // Create an `RSAKeyPair` from the DER-encoded bytes. This example uses
    // a 2048-bit key, but larger keys are also supported.
    let key_bytes_der =
       untrusted::Input::from(
            include_bytes!("src/rsa/signature_rsa_example_private_key.der"));
    let key_pair = signature::RSAKeyPair::from_der(key_bytes_der)?;

    // Create a signing state.
    let key_pair = std::sync::Arc::new(key_pair);
    let mut signing_state = signature::RSASigningState::new(key_pair)?;

    // Sign the message "hello, world", using PKCS#1 v1.5 padding and the
    // SHA256 digest algorithm.
    const MESSAGE: &'static [u8] = b"hello, world";
    let rng = rand::SystemRandom::new();
    let mut signature = vec![0; signing_state.key_pair().public_modulus_len()];
    signing_state.sign(&signature::RSA_PKCS1_SHA256, &rng, MESSAGE,
                       &mut signature)?;

    // Verify the signature.
    let public_key_bytes_der =
        untrusted::Input::from(
            include_bytes!("src/rsa/signature_rsa_example_public_key.der"));
    let message = untrusted::Input::from(MESSAGE);
    let signature = untrusted::Input::from(&signature);
    signature::verify(&signature::RSA_PKCS1_2048_8192_SHA256,
                      public_key_bytes_der, message, signature)?;

## Modules

primitive | Lower-level verification primitives. Usage of `ring::signature::verify()` is preferred when the public key and signature are encoded in standard formats, as it also handles the parsing.

## Structs

ECDSAVerificationAlgorithm | An ECDSA verification algorithm.
Ed25519KeyPair | An Ed25519 key pair, for signing.
EdDSAParameters | Parameters for EdDSA signing and verification.
PKCS8Document | A generated PKCS#8 document.
RSAKeyPair | An RSA key pair, used for signing. Feature: `rsa_signing`.
RSAParameters | Parameters for RSA verification.
RSASigningState | State used for RSA Signing. Feature: `rsa_signing`.
Signature | A public key signature returned from a signing operation.

## Constants

ED25519_PKCS8_V2_LEN | The length of a Ed25519 PKCS#8 (v2) private key generated by `Ed25519KeyPair::generate_pkcs8()`. Ed25519 PKCS#8 files generated by other software may have different lengths, and `Ed25519KeyPair::generate_pkcs8()` may generate files of a different length in the future.
ED25519_PUBLIC_KEY_LEN | The length of an Ed25519 public key.

## Statics

ECDSA_P256_SHA256_ASN1 | Verification of ASN.1 DER-encoded ECDSA signatures using the P-256 curve and SHA-256.
ECDSA_P256_SHA256_FIXED | Verification of fixed-length (PKCS#11 style) ECDSA signatures using the P-256 curve and SHA-256.
ECDSA_P256_SHA384_ASN1 | Not recommended. Verification of ASN.1 DER-encoded ECDSA signatures using the P-256 curve and SHA-384.
ECDSA_P384_SHA256_ASN1 | Not recommended. Verification of ASN.1 DER-encoded ECDSA signatures using the P-384 curve and SHA-256.
ECDSA_P384_SHA384_ASN1 | Verification of ASN.1 DER-encoded ECDSA signatures using the P-384 curve and SHA-384.
ECDSA_P384_SHA384_FIXED | Verification of fixed-length (PKCS#11 style) ECDSA signatures using the P-384 curve and SHA-384.
ED25519 | Verification of Ed25519 signatures.
RSA_PKCS1_2048_8192_SHA1 | Verification of signatures using RSA keys of 2048-8192 bits, PKCS#1.5 padding, and SHA-1.
RSA_PKCS1_2048_8192_SHA256 | Verification of signatures using RSA keys of 2048-8192 bits, PKCS#1.5 padding, and SHA-256.
RSA_PKCS1_2048_8192_SHA384 | Verification of signatures using RSA keys of 2048-8192 bits, PKCS#1.5 padding, and SHA-384.
RSA_PKCS1_2048_8192_SHA512 | Verification of signatures using RSA keys of 2048-8192 bits, PKCS#1.5 padding, and SHA-512.
RSA_PKCS1_3072_8192_SHA384 | Verification of signatures using RSA keys of 3072-8192 bits, PKCS#1.5 padding, and SHA-384.
RSA_PKCS1_SHA256 | PKCS#1 1.5 padding using SHA-256 for RSA signatures. Feature: `rsa_signing`.
RSA_PKCS1_SHA384 | PKCS#1 1.5 padding using SHA-384 for RSA signatures. Feature: `rsa_signing`.
RSA_PKCS1_SHA512 | PKCS#1 1.5 padding using SHA-512 for RSA signatures. Feature: `rsa_signing`.
RSA_PSS_2048_8192_SHA256 | Verification of signatures using RSA keys of 2048-8192 bits, PSS padding, and SHA-256.
RSA_PSS_2048_8192_SHA384 | Verification of signatures using RSA keys of 2048-8192 bits, PSS padding, and SHA-384.
RSA_PSS_2048_8192_SHA512 | Verification of signatures using RSA keys of 2048-8192 bits, PSS padding, and SHA-512.
RSA_PSS_SHA256 | RSA PSS padding using SHA-256 for RSA signatures.
RSA_PSS_SHA384 | RSA PSS padding using SHA-384 for RSA signatures.
RSA_PSS_SHA512 | RSA PSS padding using SHA-512 for RSA signatures.

## Traits

RSAEncoding | An RSA signature encoding as described in RFC 3447 Section 8.
VerificationAlgorithm | A signature verification algorithm.

## Functions

verify | Verify the signature `signature` of message `msg` with the public key `public_key` using the algorithm `alg`.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)