Files
google-apis-rs/webpki/trait.CertRevocationList.html
2024-03-05 21:06:01 +01:00

29 lines
11 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="Operations over a RFC 5280 profile Certificate Revocation List (CRL) required for revocation checking. Implemented by `OwnedCertRevocationList` and `BorrowedCertRevocationList`."><title>CertRevocationList in 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="sidebar-items.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 trait"><!--[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><h2 class="location"><a href="#">CertRevocationList</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.find_serial">find_serial</a></li><li><a href="#tymethod.issuer">issuer</a></li><li><a href="#tymethod.verify_signature">verify_signature</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate webpki</a></h2></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>Trait <a href="index.html">webpki</a>::<wbr><a class="trait" href="#">CertRevocationList</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/crl.rs.html#32-47">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait CertRevocationList: Sealed {
// Required methods
fn <a href="#tymethod.issuer" class="fn">issuer</a>(&amp;self) -&gt; &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>] <a href="#" class="tooltip" data-notable-ty="&amp;[u8]"></a>;
<span class="item-spacer"></span> fn <a href="#tymethod.find_serial" class="fn">find_serial</a>(
&amp;self,
serial: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.BorrowedRevokedCert.html" title="struct webpki::BorrowedRevokedCert">BorrowedRevokedCert</a>&lt;'_&gt;&gt;, <a class="enum" href="enum.Error.html" title="enum webpki::Error">Error</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.verify_signature" class="fn">verify_signature</a>(
&amp;self,
supported_sig_algs: &amp;[&amp;<a class="struct" href="struct.SignatureAlgorithm.html" title="struct webpki::SignatureAlgorithm">SignatureAlgorithm</a>],
issuer_spki: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="enum" href="enum.Error.html" title="enum webpki::Error">Error</a>&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Operations over a RFC 5280<sup id="fnref1"><a href="#fn1">1</a></sup> 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>.</p>
<div class="footnotes"><hr><ol><li id="fn1"><p><a href="https://www.rfc-editor.org/rfc/rfc5280#section-5">https://www.rfc-editor.org/rfc/rfc5280#section-5</a>&nbsp;<a href="#fnref1"></a></p></li></ol></div></div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.issuer" class="method"><a class="src rightside" href="../src/webpki/crl.rs.html#34">source</a><h4 class="code-header">fn <a href="#tymethod.issuer" class="fn">issuer</a>(&amp;self) -&gt; &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>] <a href="#" class="tooltip" data-notable-ty="&amp;[u8]"></a></h4></section></summary><div class="docblock"><p>Return the DER encoded issuer of the CRL.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.find_serial" class="method"><a class="src rightside" href="../src/webpki/crl.rs.html#38">source</a><h4 class="code-header">fn <a href="#tymethod.find_serial" class="fn">find_serial</a>(
&amp;self,
serial: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.BorrowedRevokedCert.html" title="struct webpki::BorrowedRevokedCert">BorrowedRevokedCert</a>&lt;'_&gt;&gt;, <a class="enum" href="enum.Error.html" title="enum webpki::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Try to find a revoked certificate in the CRL by DER encoded serial number. This
may yield an error if the CRL has malformed revoked certificates.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.verify_signature" class="method"><a class="src rightside" href="../src/webpki/crl.rs.html#42-46">source</a><h4 class="code-header">fn <a href="#tymethod.verify_signature" class="fn">verify_signature</a>(
&amp;self,
supported_sig_algs: &amp;[&amp;<a class="struct" href="struct.SignatureAlgorithm.html" title="struct webpki::SignatureAlgorithm">SignatureAlgorithm</a>],
issuer_spki: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="enum" href="enum.Error.html" title="enum webpki::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Verify the CRL signature using the issuers subject public key information (SPKI)
and a list of supported signature algorithms.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-CertRevocationList-for-BorrowedCertRevocationList%3C'_%3E" class="impl"><a class="src rightside" href="../src/webpki/crl.rs.html#310-342">source</a><a href="#impl-CertRevocationList-for-BorrowedCertRevocationList%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CertRevocationList.html" title="trait webpki::CertRevocationList">CertRevocationList</a> for <a class="struct" href="struct.BorrowedCertRevocationList.html" title="struct webpki::BorrowedCertRevocationList">BorrowedCertRevocationList</a>&lt;'_&gt;</h3></section><section id="impl-CertRevocationList-for-OwnedCertRevocationList" class="impl"><a class="src rightside" href="../src/webpki/crl.rs.html#70-97">source</a><a href="#impl-CertRevocationList-for-OwnedCertRevocationList" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CertRevocationList.html" title="trait webpki::CertRevocationList">CertRevocationList</a> for <a class="struct" href="struct.OwnedCertRevocationList.html" title="struct webpki::OwnedCertRevocationList">OwnedCertRevocationList</a></h3></section></div><script src="../trait.impl/webpki/crl/trait.CertRevocationList.js" async></script><script type="text/json" id="notable-traits-data">{"&[u8]":"<h3>Notable traits for <code>&amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.76.0/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.76.0/std/primitive.u8.html\">u8</a>]</div>"}</script></section></div></main></body></html>