16 lines
12 KiB
HTML
16 lines
12 KiB
HTML
<!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."><title>webpki - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="webpki" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Crate webpki</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../webpki/index.html">webpki</a><span class="version">0.103.9</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#features" title="Features">Features</a></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>webpki</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/webpki/lib.rs.html#15-221">Source</a> </span></div><details class="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>
|
||
<h2 id="features"><a class="doc-anchor" href="#features">§</a>Features</h2><div><table><thead><tr><th>Feature</th><th>Description</th></tr></thead><tbody>
|
||
<tr><td><code>alloc</code></td><td>Enable features that require use of the heap. Currently all RSA signature algorithms require this feature.</td></tr>
|
||
<tr><td><code>std</code></td><td>Enable features that require libstd. Implies <code>alloc</code>.</td></tr>
|
||
<tr><td><code>ring</code></td><td>Enable use of the <em>ring</em> crate for cryptography.</td></tr>
|
||
<tr><td><code>aws-lc-rs</code></td><td>Enable use of the aws-lc-rs crate for cryptography. Previously this feature was named <code>aws_lc_rs</code>.</td></tr>
|
||
</tbody></table>
|
||
</div></div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="ring/index.html" title="mod webpki::ring">ring</a></dt><dd>Signature verification algorithm implementations using the <em>ring</em> crypto library.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.BorrowedCertRevocationList.html" title="struct webpki::BorrowedCertRevocationList">Borrowed<wbr>Cert<wbr>Revocation<wbr>List</a></dt><dd>Borrowed representation of a RFC 5280 profile Certificate Revocation List (CRL).</dd><dt><a class="struct" href="struct.BorrowedRevokedCert.html" title="struct webpki::BorrowedRevokedCert">Borrowed<wbr>Revoked<wbr>Cert</a></dt><dd>Borrowed representation of a RFC 5280 profile Certificate Revocation List (CRL) revoked
|
||
certificate entry.</dd><dt><a class="struct" href="struct.Cert.html" title="struct webpki::Cert">Cert</a></dt><dd>A parsed X509 certificate.</dd><dt><a class="struct" href="struct.CrlsRequired.html" title="struct webpki::CrlsRequired">Crls<wbr>Required</a></dt><dd>An opaque error indicating the caller must provide at least one CRL when building a
|
||
<a href="struct.RevocationOptions.html" title="struct webpki::RevocationOptions">RevocationOptions</a> instance.</dd><dt><a class="struct" href="struct.DerIterator.html" title="struct webpki::DerIterator">DerIterator</a></dt><dd>Iterator to parse a sequence of DER-encoded values of type <code>T</code>.</dd><dt><a class="struct" href="struct.EndEntityCert.html" title="struct webpki::EndEntityCert">EndEntity<wbr>Cert</a></dt><dd>An end-entity certificate.</dd><dt><a class="struct" href="struct.IntermediateIterator.html" title="struct webpki::IntermediateIterator">Intermediate<wbr>Iterator</a></dt><dd>Iterator over a path’s intermediate certificates.</dd><dt><a class="struct" href="struct.InvalidNameContext.html" title="struct webpki::InvalidNameContext">Invalid<wbr>Name<wbr>Context</a></dt><dd>Additional context for the <code>CertNotValidForName</code> error variant.</dd><dt><a class="struct" href="struct.KeyPurposeId.html" title="struct webpki::KeyPurposeId">KeyPurpose<wbr>Id</a></dt><dd>An OID value indicating an Extended Key Usage (EKU) key purpose.</dd><dt><a class="struct" href="struct.KeyPurposeIdIter.html" title="struct webpki::KeyPurposeIdIter">KeyPurpose<wbr>IdIter</a></dt><dd>Iterator over <a href="struct.KeyPurposeId.html" title="struct webpki::KeyPurposeId"><code>KeyPurposeId</code></a>s, for use in <a href="trait.ExtendedKeyUsageValidator.html" title="trait webpki::ExtendedKeyUsageValidator"><code>ExtendedKeyUsageValidator</code></a>.</dd><dt><a class="struct" href="struct.KeyUsage.html" title="struct webpki::KeyUsage">KeyUsage</a></dt><dd>The expected key usage of a certificate.</dd><dt><a class="struct" href="struct.OwnedCertRevocationList.html" title="struct webpki::OwnedCertRevocationList">Owned<wbr>Cert<wbr>Revocation<wbr>List</a></dt><dd>Owned representation of a RFC 5280 profile Certificate Revocation List (CRL).</dd><dt><a class="struct" href="struct.OwnedRevokedCert.html" title="struct webpki::OwnedRevokedCert">Owned<wbr>Revoked<wbr>Cert</a></dt><dd>Owned representation of a RFC 5280 profile Certificate Revocation List (CRL) revoked
|
||
certificate entry.</dd><dt><a class="struct" href="struct.RawPublicKeyEntity.html" title="struct webpki::RawPublicKeyEntity">RawPublic<wbr>KeyEntity</a></dt><dd>A Raw Public Key, used for connections using raw public keys as specified
|
||
in <a href="https://www.rfc-editor.org/rfc/rfc7250">RFC 7250</a>.</dd><dt><a class="struct" href="struct.RequiredEkuNotFoundContext.html" title="struct webpki::RequiredEkuNotFoundContext">Required<wbr>EkuNot<wbr>Found<wbr>Context</a></dt><dd>Additional context for the <code>RequiredEkuNotFoundContext</code> error variant.</dd><dt><a class="struct" href="struct.RevocationOptions.html" title="struct webpki::RevocationOptions">Revocation<wbr>Options</a></dt><dd>Describes how revocation checking is performed, if at all. Can be constructed with a
|
||
<a href="struct.RevocationOptionsBuilder.html" title="struct webpki::RevocationOptionsBuilder">RevocationOptionsBuilder</a> instance.</dd><dt><a class="struct" href="struct.RevocationOptionsBuilder.html" title="struct webpki::RevocationOptionsBuilder">Revocation<wbr>Options<wbr>Builder</a></dt><dd>Builds a RevocationOptions instance to control how revocation checking is performed.</dd><dt><a class="struct" href="struct.UnsupportedSignatureAlgorithmContext.html" title="struct webpki::UnsupportedSignatureAlgorithmContext">Unsupported<wbr>Signature<wbr>Algorithm<wbr>Context</a></dt><dd>Additional context for the <code>UnsupportedSignatureAlgorithm</code> error variant.</dd><dt><a class="struct" href="struct.UnsupportedSignatureAlgorithmForPublicKeyContext.html" title="struct webpki::UnsupportedSignatureAlgorithmForPublicKeyContext">Unsupported<wbr>Signature<wbr>Algorithm<wbr>ForPublic<wbr>KeyContext</a></dt><dd>Additional context for the <code>UnsupportedSignatureAlgorithmForPublicKey</code> error variant.</dd><dt><a class="struct" href="struct.VerifiedPath.html" title="struct webpki::VerifiedPath">Verified<wbr>Path</a></dt><dd>Path from end-entity certificate to trust anchor that’s been verified.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.CertRevocationList.html" title="enum webpki::CertRevocationList">Cert<wbr>Revocation<wbr>List</a></dt><dd>A RFC 5280 profile Certificate Revocation List (CRL).</dd><dt><a class="enum" href="enum.DerTypeId.html" title="enum webpki::DerTypeId">DerType<wbr>Id</a></dt><dd>Trailing data was found while parsing DER-encoded input for the named type.</dd><dt><a class="enum" href="enum.Error.html" title="enum webpki::Error">Error</a></dt><dd>An error that occurs during certificate validation or name validation.</dd><dt><a class="enum" href="enum.ExpirationPolicy.html" title="enum webpki::ExpirationPolicy">Expiration<wbr>Policy</a></dt><dd>Describes how to handle the nextUpdate field of the CRL (i.e. expiration).</dd><dt><a class="enum" href="enum.RevocationCheckDepth.html" title="enum webpki::RevocationCheckDepth">Revocation<wbr>Check<wbr>Depth</a></dt><dd>Describes how much of a certificate chain is checked for revocation status.</dd><dt><a class="enum" href="enum.RevocationReason.html" title="enum webpki::RevocationReason">Revocation<wbr>Reason</a></dt><dd>Identifies the reason a certificate was revoked.
|
||
See <a href="https://www.rfc-editor.org/rfc/rfc5280#section-5.3.1">RFC 5280 §5.3.1</a></dd><dt><a class="enum" href="enum.UnknownStatusPolicy.html" title="enum webpki::UnknownStatusPolicy">Unknown<wbr>Status<wbr>Policy</a></dt><dd>Describes how to handle the case where a certificate’s revocation status is unknown.</dd></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.ALL_VERIFICATION_ALGS.html" title="static webpki::ALL_VERIFICATION_ALGS">ALL_<wbr>VERIFICATION_<wbr>ALGS</a></dt><dd>An array of all the verification algorithms exported by this crate.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.ExtendedKeyUsageValidator.html" title="trait webpki::ExtendedKeyUsageValidator">Extended<wbr>KeyUsage<wbr>Validator</a></dt><dd>A trait for validating the Extended Key Usage (EKU) extensions of a certificate.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.anchor_from_trusted_cert.html" title="fn webpki::anchor_from_trusted_cert">anchor_<wbr>from_<wbr>trusted_<wbr>cert</a></dt><dd>Interprets the given pre-validated DER-encoded certificate as a <code>TrustAnchor</code>.</dd></dl></section></div></main></body></html> |