blob: 36a05471ee57ea9266adb4c56d15f01560ae18e9 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="webpki: Web PKI X.509 Certificate Validation."><meta name="keywords" content="rust, rustlang, rust-lang, webpki"><title>webpki - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../webpki/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../webpki/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate webpki</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.21.4</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#statics">Statics</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">webpki</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/webpki/webpki.rs.html#15-272">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>webpki: Web PKI X.509 Certificate Validation.</p>
<p>See <code>EndEntityCert</code>’s documentation for a description of the certificate
processing steps necessary for a TLS connection.</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="trust_anchor_util/index.html" title="webpki::trust_anchor_util mod">trust_anchor_util</a></div><div class="item-right docblock-short">Utilities for efficiently embedding trust anchors in programs.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DNSName.html" title="webpki::DNSName struct">DNSName</a></div><div class="item-right docblock-short">A DNS Name suitable for use in the TLS Server Name Indication (SNI)
extension and/or for use as the reference hostname for which to verify a
certificate.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DNSNameRef.html" title="webpki::DNSNameRef struct">DNSNameRef</a></div><div class="item-right docblock-short">A reference to a DNS Name suitable for use in the TLS Server Name Indication
(SNI) extension and/or for use as the reference hostname for which to verify
a certificate.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EndEntityCert.html" title="webpki::EndEntityCert struct">EndEntityCert</a></div><div class="item-right docblock-short">An end-entity certificate.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InvalidDNSNameError.html" title="webpki::InvalidDNSNameError struct">InvalidDNSNameError</a></div><div class="item-right docblock-short">An error indicating that a <code>DNSNameRef</code> could not built because the input
is not a syntactically-valid DNS Name.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SignatureAlgorithm.html" title="webpki::SignatureAlgorithm struct">SignatureAlgorithm</a></div><div class="item-right docblock-short">A signature algorithm.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TLSClientTrustAnchors.html" title="webpki::TLSClientTrustAnchors struct">TLSClientTrustAnchors</a></div><div class="item-right docblock-short">Trust anchors which may be used for authenticating clients.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TLSServerTrustAnchors.html" title="webpki::TLSServerTrustAnchors struct">TLSServerTrustAnchors</a></div><div class="item-right docblock-short">Trust anchors which may be used for authenticating servers.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Time.html" title="webpki::Time struct">Time</a></div><div class="item-right docblock-short">The time type.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TrustAnchor.html" title="webpki::TrustAnchor struct">TrustAnchor</a></div><div class="item-right docblock-short">A trust anchor (a.k.a. root CA).</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="webpki::Error enum">Error</a></div><div class="item-right docblock-short">An error that occurs during certificate validation or name validation.</div></div></div><h2 id="statics" class="small-section-header"><a href="#statics">Statics</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="static" href="static.ECDSA_P256_SHA256.html" title="webpki::ECDSA_P256_SHA256 static">ECDSA_P256_SHA256</a></div><div class="item-right docblock-short">ECDSA signatures using the P-256 curve and SHA-256.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.ECDSA_P256_SHA384.html" title="webpki::ECDSA_P256_SHA384 static">ECDSA_P256_SHA384</a></div><div class="item-right docblock-short">ECDSA signatures using the P-256 curve and SHA-384. Deprecated.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.ECDSA_P384_SHA256.html" title="webpki::ECDSA_P384_SHA256 static">ECDSA_P384_SHA256</a></div><div class="item-right docblock-short">ECDSA signatures using the P-384 curve and SHA-256. Deprecated.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.ECDSA_P384_SHA384.html" title="webpki::ECDSA_P384_SHA384 static">ECDSA_P384_SHA384</a></div><div class="item-right docblock-short">ECDSA signatures using the P-384 curve and SHA-384.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.ED25519.html" title="webpki::ED25519 static">ED25519</a></div><div class="item-right docblock-short">ED25519 signatures according to RFC 8410</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.RSA_PKCS1_2048_8192_SHA256.html" title="webpki::RSA_PKCS1_2048_8192_SHA256 static">RSA_PKCS1_2048_8192_SHA256</a></div><div class="item-right docblock-short">RSA PKCS#1 1.5 signatures using SHA-256 for keys of 2048-8192 bits.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.RSA_PKCS1_2048_8192_SHA384.html" title="webpki::RSA_PKCS1_2048_8192_SHA384 static">RSA_PKCS1_2048_8192_SHA384</a></div><div class="item-right docblock-short">RSA PKCS#1 1.5 signatures using SHA-384 for keys of 2048-8192 bits.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.RSA_PKCS1_2048_8192_SHA512.html" title="webpki::RSA_PKCS1_2048_8192_SHA512 static">RSA_PKCS1_2048_8192_SHA512</a></div><div class="item-right docblock-short">RSA PKCS#1 1.5 signatures using SHA-512 for keys of 2048-8192 bits.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.RSA_PKCS1_3072_8192_SHA384.html" title="webpki::RSA_PKCS1_3072_8192_SHA384 static">RSA_PKCS1_3072_8192_SHA384</a></div><div class="item-right docblock-short">RSA PKCS#1 1.5 signatures using SHA-384 for keys of 3072-8192 bits.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.RSA_PSS_2048_8192_SHA256_LEGACY_KEY.html" title="webpki::RSA_PSS_2048_8192_SHA256_LEGACY_KEY static">RSA_PSS_2048_8192_SHA256_LEGACY_KEY</a></div><div class="item-right docblock-short">RSA PSS signatures using SHA-256 for keys of 2048-8192 bits and of
type rsaEncryption; see <a href="https://tools.ietf.org/html/rfc4055#section-1.2">RFC 4055 Section 1.2</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.RSA_PSS_2048_8192_SHA384_LEGACY_KEY.html" title="webpki::RSA_PSS_2048_8192_SHA384_LEGACY_KEY static">RSA_PSS_2048_8192_SHA384_LEGACY_KEY</a></div><div class="item-right docblock-short">RSA PSS signatures using SHA-384 for keys of 2048-8192 bits and of
type rsaEncryption; see <a href="https://tools.ietf.org/html/rfc4055#section-1.2">RFC 4055 Section 1.2</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.RSA_PSS_2048_8192_SHA512_LEGACY_KEY.html" title="webpki::RSA_PSS_2048_8192_SHA512_LEGACY_KEY static">RSA_PSS_2048_8192_SHA512_LEGACY_KEY</a></div><div class="item-right docblock-short">RSA PSS signatures using SHA-512 for keys of 2048-8192 bits and of
type rsaEncryption; see <a href="https://tools.ietf.org/html/rfc4055#section-1.2">RFC 4055 Section 1.2</a>.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="webpki" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>