291 lines
9.3 KiB
HTML
291 lines
9.3 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>wolfcrypt: the wolfSSL Crypto Engine — wolfcrypt Python 3.14.0-1 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="index" title="Index"
|
||
href="genindex.html"/>
|
||
<link rel="search" title="Search" href="search.html"/>
|
||
<link rel="top" title="wolfcrypt Python 3.14.0-1 documentation" href="#"/>
|
||
<link rel="next" title="Symmetric Key Algorithms" href="symmetric.html"/>
|
||
|
||
|
||
<script src="_static/js/modernizr.min.js"></script>
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav" role="document">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search">
|
||
|
||
|
||
|
||
<a href="#" class="icon icon-home"> wolfcrypt Python
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
3.14.0-1
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="symmetric.html">Symmetric Key Algorithms</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="asymmetric.html">Asymmetric Key Algorithms</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="digest.html">Message Digests</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="mac.html">Message Authentication Codes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="random.html">Random Number Generation</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="#">wolfcrypt Python</a>
|
||
|
||
</nav>
|
||
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="#">Docs</a> »</li>
|
||
|
||
<li>wolfcrypt: the wolfSSL Crypto Engine</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="wolfcrypt-the-wolfssl-crypto-engine">
|
||
<h1>wolfcrypt: the wolfSSL Crypto Engine<a class="headerlink" href="#wolfcrypt-the-wolfssl-crypto-engine" title="Permalink to this headline">¶</a></h1>
|
||
<a class="reference external image-reference" href="https://travis-ci.org/wolfSSL/wolfcrypt-py"><img alt="https://travis-ci.org/wolfSSL/wolfcrypt-py.svg?branch=master" src="https://travis-ci.org/wolfSSL/wolfcrypt-py.svg?branch=master" /></a>
|
||
<p><strong>wolfCrypt Python</strong>, a.k.a. <code class="docutils literal notranslate"><span class="pre">wolfcrypt</span></code> is a Python module that encapsulates
|
||
<strong>wolfSSL’s wolfCrypt API</strong>.</p>
|
||
<p><a class="reference external" href="https://wolfssl.com/wolfSSL/Products-wolfcrypt.html">wolfCrypt</a> is a
|
||
lightweight, portable, C-language-based crypto library
|
||
targeted at IoT, embedded, and RTOS environments primarily because of its size,
|
||
speed, and feature set. It works seamlessly in desktop, enterprise, and cloud
|
||
environments as well. It is the crypto engine behind <a class="reference external" href="https://wolfssl.com/wolfSSL/Products-wolfssl.html">wolfSSl’s embedded ssl
|
||
library</a>.</p>
|
||
<div class="section" id="installation">
|
||
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
|
||
<p>We provide Python wheels (prebuilt binaries) for OSX 64 bits and Linux 64 bits:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install wolfcrypt
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="testing">
|
||
<h2>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">wolfcrypt.hashes</span> <span class="kn">import</span> <span class="n">Sha256</span>
|
||
<span class="gp">>>> </span><span class="n">Sha256</span><span class="p">(</span><span class="s1">'wolfcrypt'</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
|
||
<span class="go">b'96e02e7b1cbcd6f104fe1fdb4652027a5505b68652b70095c6318f9dce0d1844'</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="summary">
|
||
<h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="symmetric.html">Symmetric Key Algorithms</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="asymmetric.html">Asymmetric Key Algorithms</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="digest.html">Message Digests</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="mac.html">Message Authentication Codes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="random.html">Random Number Generation</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="licensing">
|
||
<h2>Licensing<a class="headerlink" href="#licensing" title="Permalink to this headline">¶</a></h2>
|
||
<p>wolfSSL’s software is available under two distinct licensing models:
|
||
open source and standard commercial licensing. Please see the relevant
|
||
section below for information on each type of license.</p>
|
||
<div class="section" id="open-source">
|
||
<h3>Open Source<a class="headerlink" href="#open-source" title="Permalink to this headline">¶</a></h3>
|
||
<p>wolfCrypt and wolfSSL software are free software downloads and may be modified
|
||
to the needs of the user as long as the user adheres to version two of the GPL
|
||
License. The GPLv2 license can be found on the <a class="reference external" href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">gnu.org website</a>.</p>
|
||
</div>
|
||
<div class="section" id="commercial-licensing">
|
||
<h3>Commercial Licensing<a class="headerlink" href="#commercial-licensing" title="Permalink to this headline">¶</a></h3>
|
||
<p>Businesses and enterprises who wish to incorporate wolfSSL products into
|
||
proprietary appliances or other commercial software products for
|
||
re-distribution must license commercial versions. Licenses are generally issued
|
||
for one product and include unlimited royalty-free distribution. Custom
|
||
licensing terms are also available at <a class="reference external" href="mailto:licensing%40wolfssl.com">licensing<span>@</span>wolfssl<span>.</span>com</a>.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<div class="articleComments">
|
||
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="symmetric.html" class="btn btn-neutral float-right" title="Symmetric Key Algorithms" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2018, wolfSSL Inc. All rights reserved.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT:'./',
|
||
VERSION:'3.14.0-1',
|
||
COLLAPSE_INDEX:false,
|
||
FILE_SUFFIX:'.html',
|
||
HAS_SOURCE: true,
|
||
SOURCELINK_SUFFIX: '.txt'
|
||
};
|
||
</script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.StickyNav.enable();
|
||
});
|
||
</script>
|
||
|
||
|
||
</body>
|
||
</html> |