OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-28 12:51:55 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/webpki/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

28 lines
15 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../webpki/index.html">webpki</a><span class="version">0.101.6</span></h2></div><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#statics">Statics</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../webpki/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">webpki</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/webpki/lib.rs.html#15-94">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></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 href="#features">Features</a></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>
</tbody></table>
</div></div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AddrParseError.html" title="struct webpki::AddrParseError">AddrParseError</a></div><div class="desc docblock-short">An error indicating that an <code>IpAddrRef</code> could not built because
the input could not be parsed as an IP address.</div></li><li><div class="item-name"><a class="struct" href="struct.BorrowedCertRevocationList.html" title="struct webpki::BorrowedCertRevocationList">BorrowedCertRevocationList</a></div><div class="desc docblock-short">Borrowed representation of a RFC 5280 profile Certificate Revocation List (CRL).</div></li><li><div class="item-name"><a class="struct" href="struct.BorrowedRevokedCert.html" title="struct webpki::BorrowedRevokedCert">BorrowedRevokedCert</a></div><div class="desc docblock-short">Borrowed representation of a RFC 5280 profile Certificate Revocation List (CRL) revoked
certificate entry.</div></li><li><div class="item-name"><a class="struct" href="struct.Cert.html" title="struct webpki::Cert">Cert</a></div><div class="desc docblock-short">A parsed X509 certificate.</div></li><li><div class="item-name"><a class="struct" href="struct.DnsName.html" title="struct webpki::DnsName">DnsName</a></div><div class="desc docblock-short">Requires the <code>alloc</code> feature.
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></li><li><div class="item-name"><a class="struct" href="struct.DnsNameRef.html" title="struct webpki::DnsNameRef">DnsNameRef</a></div><div class="desc 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></li><li><div class="item-name"><a class="struct" href="struct.EndEntityCert.html" title="struct webpki::EndEntityCert">EndEntityCert</a></div><div class="desc docblock-short">An end-entity certificate.</div></li><li><div class="item-name"><a class="struct" href="struct.InvalidDnsNameError.html" title="struct webpki::InvalidDnsNameError">InvalidDnsNameError</a></div><div class="desc docblock-short">An error indicating that a <code>DnsNameRef</code> could not built because the input
is not a syntactically-valid DNS Name.</div></li><li><div class="item-name"><a class="struct" href="struct.InvalidSubjectNameError.html" title="struct webpki::InvalidSubjectNameError">InvalidSubjectNameError</a></div><div class="desc docblock-short">An error indicating that a <code>SubjectNameRef</code> could not built
because the input is not a syntactically-valid DNS Name or IP
address.</div></li><li><div class="item-name"><a class="struct" href="struct.KeyUsage.html" title="struct webpki::KeyUsage">KeyUsage</a></div><div class="desc docblock-short">The expected key usage of a certificate.</div></li><li><div class="item-name"><a class="struct" href="struct.OwnedCertRevocationList.html" title="struct webpki::OwnedCertRevocationList">OwnedCertRevocationList</a></div><div class="desc docblock-short">Owned representation of a RFC 5280 profile Certificate Revocation List (CRL).</div></li><li><div class="item-name"><a class="struct" href="struct.OwnedRevokedCert.html" title="struct webpki::OwnedRevokedCert">OwnedRevokedCert</a></div><div class="desc docblock-short">Owned representation of a RFC 5280 profile Certificate Revocation List (CRL) revoked
certificate entry.</div></li><li><div class="item-name"><a class="struct" href="struct.SignatureAlgorithm.html" title="struct webpki::SignatureAlgorithm">SignatureAlgorithm</a></div><div class="desc docblock-short">A signature algorithm.</div></li><li><div class="item-name"><a class="struct" href="struct.Time.html" title="struct webpki::Time">Time</a></div><div class="desc docblock-short">The time type.</div></li><li><div class="item-name"><a class="struct" href="struct.TlsClientTrustAnchors.html" title="struct webpki::TlsClientTrustAnchors">TlsClientTrustAnchors</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">Trust anchors which may be used for authenticating clients.</div></li><li><div class="item-name"><a class="struct" href="struct.TlsServerTrustAnchors.html" title="struct webpki::TlsServerTrustAnchors">TlsServerTrustAnchors</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">Trust anchors which may be used for authenticating servers.</div></li><li><div class="item-name"><a class="struct" href="struct.TrustAnchor.html" title="struct webpki::TrustAnchor">TrustAnchor</a></div><div class="desc docblock-short">A trust anchor (a.k.a. root CA).</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.EndEntityOrCa.html" title="enum webpki::EndEntityOrCa">EndEntityOrCa</a></div><div class="desc docblock-short">An enumeration indicating whether a <a href="struct.Cert.html" title="struct webpki::Cert"><code>Cert</code></a> is a leaf end-entity cert, or a linked
list node from the CA <code>Cert</code> to a child <code>Cert</code> it issued.</div></li><li><div class="item-name"><a class="enum" href="enum.Error.html" title="enum webpki::Error">Error</a></div><div class="desc docblock-short">An error that occurs during certificate validation or name validation.</div></li><li><div class="item-name"><a class="enum" href="enum.IpAddr.html" title="enum webpki::IpAddr">IpAddr</a></div><div class="desc docblock-short">Either a IPv4 or IPv6 address, plus its owned string representation</div></li><li><div class="item-name"><a class="enum" href="enum.IpAddrRef.html" title="enum webpki::IpAddrRef">IpAddrRef</a></div><div class="desc docblock-short">Either a IPv4 or IPv6 address, plus its borrowed string representation</div></li><li><div class="item-name"><a class="enum" href="enum.RevocationReason.html" title="enum webpki::RevocationReason">RevocationReason</a></div><div class="desc docblock-short">Identifies the reason a certificate was revoked.
See RFC 5280 §5.3.1</div></li><li><div class="item-name"><a class="enum" href="enum.SubjectNameRef.html" title="enum webpki::SubjectNameRef">SubjectNameRef</a></div><div class="desc docblock-short">A DNS name or IP address, which borrows its text representation.</div></li></ul><h2 id="statics" class="section-header"><a href="#statics">Statics</a></h2><ul class="item-table"><li><div class="item-name"><a class="static" href="static.ECDSA_P256_SHA256.html" title="static webpki::ECDSA_P256_SHA256">ECDSA_P256_SHA256</a></div><div class="desc docblock-short">ECDSA signatures using the P-256 curve and SHA-256.</div></li><li><div class="item-name"><a class="static" href="static.ECDSA_P256_SHA384.html" title="static webpki::ECDSA_P256_SHA384">ECDSA_P256_SHA384</a></div><div class="desc docblock-short">ECDSA signatures using the P-256 curve and SHA-384. Deprecated.</div></li><li><div class="item-name"><a class="static" href="static.ECDSA_P384_SHA256.html" title="static webpki::ECDSA_P384_SHA256">ECDSA_P384_SHA256</a></div><div class="desc docblock-short">ECDSA signatures using the P-384 curve and SHA-256. Deprecated.</div></li><li><div class="item-name"><a class="static" href="static.ECDSA_P384_SHA384.html" title="static webpki::ECDSA_P384_SHA384">ECDSA_P384_SHA384</a></div><div class="desc docblock-short">ECDSA signatures using the P-384 curve and SHA-384.</div></li><li><div class="item-name"><a class="static" href="static.ED25519.html" title="static webpki::ED25519">ED25519</a></div><div class="desc docblock-short">ED25519 signatures according to RFC 8410</div></li><li><div class="item-name"><a class="static" href="static.RSA_PKCS1_2048_8192_SHA256.html" title="static webpki::RSA_PKCS1_2048_8192_SHA256">RSA_PKCS1_2048_8192_SHA256</a></div><div class="desc docblock-short">RSA PKCS#1 1.5 signatures using SHA-256 for keys of 2048-8192 bits.</div></li><li><div class="item-name"><a class="static" href="static.RSA_PKCS1_2048_8192_SHA384.html" title="static webpki::RSA_PKCS1_2048_8192_SHA384">RSA_PKCS1_2048_8192_SHA384</a></div><div class="desc docblock-short">RSA PKCS#1 1.5 signatures using SHA-384 for keys of 2048-8192 bits.</div></li><li><div class="item-name"><a class="static" href="static.RSA_PKCS1_2048_8192_SHA512.html" title="static webpki::RSA_PKCS1_2048_8192_SHA512">RSA_PKCS1_2048_8192_SHA512</a></div><div class="desc docblock-short">RSA PKCS#1 1.5 signatures using SHA-512 for keys of 2048-8192 bits.</div></li><li><div class="item-name"><a class="static" href="static.RSA_PKCS1_3072_8192_SHA384.html" title="static webpki::RSA_PKCS1_3072_8192_SHA384">RSA_PKCS1_3072_8192_SHA384</a></div><div class="desc docblock-short">RSA PKCS#1 1.5 signatures using SHA-384 for keys of 3072-8192 bits.</div></li><li><div class="item-name"><a class="static" href="static.RSA_PSS_2048_8192_SHA256_LEGACY_KEY.html" title="static webpki::RSA_PSS_2048_8192_SHA256_LEGACY_KEY">RSA_PSS_2048_8192_SHA256_LEGACY_KEY</a></div><div class="desc 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></li><li><div class="item-name"><a class="static" href="static.RSA_PSS_2048_8192_SHA384_LEGACY_KEY.html" title="static webpki::RSA_PSS_2048_8192_SHA384_LEGACY_KEY">RSA_PSS_2048_8192_SHA384_LEGACY_KEY</a></div><div class="desc 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></li><li><div class="item-name"><a class="static" href="static.RSA_PSS_2048_8192_SHA512_LEGACY_KEY.html" title="static webpki::RSA_PSS_2048_8192_SHA512_LEGACY_KEY">RSA_PSS_2048_8192_SHA512_LEGACY_KEY</a></div><div class="desc 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></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.CertRevocationList.html" title="trait webpki::CertRevocationList">CertRevocationList</a></div><div class="desc docblock-short">Operations over a RFC 5280 profile Certificate Revocation List (CRL) required
for revocation checking. Implemented by <a href="struct.OwnedCertRevocationList.html" title="struct webpki::OwnedCertRevocationList"><code>OwnedCertRevocationList</code></a> and
<a href="struct.BorrowedCertRevocationList.html" title="struct webpki::BorrowedCertRevocationList"><code>BorrowedCertRevocationList</code></a>.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink