| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, pkey"><title>openssl::pkey - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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">☰</button><a class="sidebar-logo" href="../../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module pkey</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">openssl</a>::<wbr><a class="mod" href="#">pkey</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/openssl/pkey.rs.html#1-1185">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-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 href="#example">Example</a></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="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Id.html" title="openssl::pkey::Id struct">Id</a></div><div class="item-right docblock-short">An identifier of a kind of key.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PKey.html" title="openssl::pkey::PKey struct">PKey</a></div><div class="item-right docblock-short">A public or private key.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PKeyRef.html" title="openssl::pkey::PKeyRef struct">PKeyRef</a></div><div class="item-right docblock-short">Reference to <code>PKey</code>.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Params.html" title="openssl::pkey::Params enum">Params</a></div><div class="item-right docblock-short">A tag type indicating that a key only has parameters.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Private.html" title="openssl::pkey::Private enum">Private</a></div><div class="item-right docblock-short">A tag type indicating that a key has private components.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Public.html" title="openssl::pkey::Public enum">Public</a></div><div class="item-right docblock-short">A tag type indicating that a key only has public components.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.HasParams.html" title="openssl::pkey::HasParams trait">HasParams</a></div><div class="item-right docblock-short">A trait indicating that a key has parameters.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.HasPrivate.html" title="openssl::pkey::HasPrivate trait">HasPrivate</a></div><div class="item-right docblock-short">A trait indicating that a key has private components.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.HasPublic.html" title="openssl::pkey::HasPublic trait">HasPublic</a></div><div class="item-right docblock-short">A trait indicating that a key has public components.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="openssl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
