41 lines
6.6 KiB
HTML
41 lines
6.6 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="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-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="openssl" 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="../sidebar-items.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"><!--[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="#">Module pkey</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../openssl/index.html">openssl</a><span class="version">0.10.75</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" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">openssl</a></div><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-1222">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 user’s public key. The encrypted information can
|
||
only be deciphered using that user’s 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<u8> = 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><dl class="item-table"><dt><a class="struct" href="struct.Id.html" title="struct openssl::pkey::Id">Id</a></dt><dd>An identifier of a kind of key.</dd><dt><a class="struct" href="struct.PKey.html" title="struct openssl::pkey::PKey">PKey</a></dt><dd>A public or private key.</dd><dt><a class="struct" href="struct.PKeyRef.html" title="struct openssl::pkey::PKeyRef">PKeyRef</a></dt><dd>Reference to <code>PKey</code>.</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.Params.html" title="enum openssl::pkey::Params">Params</a></dt><dd>A tag type indicating that a key only has parameters.</dd><dt><a class="enum" href="enum.Private.html" title="enum openssl::pkey::Private">Private</a></dt><dd>A tag type indicating that a key has private components.</dd><dt><a class="enum" href="enum.Public.html" title="enum openssl::pkey::Public">Public</a></dt><dd>A tag type indicating that a key only has public components.</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.HasParams.html" title="trait openssl::pkey::HasParams">HasParams</a></dt><dd>A trait indicating that a key has parameters.</dd><dt><a class="trait" href="trait.HasPrivate.html" title="trait openssl::pkey::HasPrivate">HasPrivate</a></dt><dd>A trait indicating that a key has private components.</dd><dt><a class="trait" href="trait.HasPublic.html" title="trait openssl::pkey::HasPublic">HasPublic</a></dt><dd>A trait indicating that a key has public components.</dd></dl></section></div></main></body></html> |