mpvrc/openssl/pkey/index.html

42 lines
No EOL
7 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="Public/private key processing."><title>openssl::pkey - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="openssl" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../openssl/index.html">openssl</a><span class="version">0.10.68</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module pkey</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate openssl</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">openssl</a></span><h1>Module <span>pkey</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/openssl/pkey.rs.html#1-1202">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Public/private key processing.</p>
<p>Asymmetric public key algorithms solve the problem of establishing and sharing
secret keys to securely send and receive messages.
This system uses a pair of keys: a public key, which can be freely
distributed, and a private key, which is kept to oneself. An entity may
encrypt information using a users public key. The encrypted information can
only be deciphered using that users private key.</p>
<p>This module offers support for five popular algorithms:</p>
<ul>
<li>
<p>RSA</p>
</li>
<li>
<p>DSA</p>
</li>
<li>
<p>Diffie-Hellman</p>
</li>
<li>
<p>Elliptic Curves</p>
</li>
<li>
<p>HMAC</p>
</li>
</ul>
<p>These algorithms rely on hard mathematical problems - namely integer factorization,
discrete logarithms, and elliptic curve relationships - that currently do not
yield efficient solutions. This property ensures the security of these
cryptographic algorithms.</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<p>Generate a 2048-bit RSA public/private key pair and print the public key.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::rsa::Rsa;
<span class="kw">use </span>openssl::pkey::PKey;
<span class="kw">use </span>std::str;
<span class="kw">let </span>rsa = Rsa::generate(<span class="number">2048</span>).unwrap();
<span class="kw">let </span>pkey = PKey::from_rsa(rsa).unwrap();
<span class="kw">let </span>pub_key: Vec&lt;u8&gt; = pkey.public_key_to_pem().unwrap();
<span class="macro">println!</span>(<span class="string">"{:?}"</span>, str::from_utf8(pub_key.as_slice()).unwrap());</code></pre></div>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Id.html" title="struct openssl::pkey::Id">Id</a></div><div class="desc docblock-short">An identifier of a kind of key.</div></li><li><div class="item-name"><a class="struct" href="struct.PKey.html" title="struct openssl::pkey::PKey">PKey</a></div><div class="desc docblock-short">A public or private key.</div></li><li><div class="item-name"><a class="struct" href="struct.PKeyRef.html" title="struct openssl::pkey::PKeyRef">PKeyRef</a></div><div class="desc docblock-short">Reference to <code>PKey</code>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Params.html" title="enum openssl::pkey::Params">Params</a></div><div class="desc docblock-short">A tag type indicating that a key only has parameters.</div></li><li><div class="item-name"><a class="enum" href="enum.Private.html" title="enum openssl::pkey::Private">Private</a></div><div class="desc docblock-short">A tag type indicating that a key has private components.</div></li><li><div class="item-name"><a class="enum" href="enum.Public.html" title="enum openssl::pkey::Public">Public</a></div><div class="desc docblock-short">A tag type indicating that a key only has public components.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.HasParams.html" title="trait openssl::pkey::HasParams">HasParams</a></div><div class="desc docblock-short">A trait indicating that a key has parameters.</div></li><li><div class="item-name"><a class="trait" href="trait.HasPrivate.html" title="trait openssl::pkey::HasPrivate">HasPrivate</a></div><div class="desc docblock-short">A trait indicating that a key has private components.</div></li><li><div class="item-name"><a class="trait" href="trait.HasPublic.html" title="trait openssl::pkey::HasPublic">HasPublic</a></div><div class="desc docblock-short">A trait indicating that a key has public components.</div></li></ul></section></div></main></body></html>