wolfcrypt-py/_modules/wolfcrypt/hashes.html

509 lines
36 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.hashes &mdash; 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="../../index.html"/>
<link rel="up" title="Module code" href="../index.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="../../index.html" 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="../../index.html">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="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
<li>wolfcrypt.hashes</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for wolfcrypt.hashes</h1><div class="highlight"><pre>
<span></span><span class="c1"># hashes.py</span>
<span class="c1">#</span>
<span class="c1"># Copyright (C) 2006-2018 wolfSSL Inc.</span>
<span class="c1">#</span>
<span class="c1"># This file is part of wolfSSL. (formerly known as CyaSSL)</span>
<span class="c1">#</span>
<span class="c1"># wolfSSL is free software; you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation; either version 2 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span class="c1">#</span>
<span class="c1"># wolfSSL is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program; if not, write to the Free Software</span>
<span class="c1"># Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA</span>
<span class="c1"># pylint: disable=no-member,no-name-in-module, no-self-use</span>
<span class="kn">from</span> <span class="nn">wolfcrypt._ffi</span> <span class="k">import</span> <span class="n">ffi</span> <span class="k">as</span> <span class="n">_ffi</span>
<span class="kn">from</span> <span class="nn">wolfcrypt._ffi</span> <span class="k">import</span> <span class="n">lib</span> <span class="k">as</span> <span class="n">_lib</span>
<span class="kn">from</span> <span class="nn">wolfcrypt.utils</span> <span class="k">import</span> <span class="n">t2b</span><span class="p">,</span> <span class="n">b2h</span>
<span class="kn">from</span> <span class="nn">wolfcrypt.exceptions</span> <span class="k">import</span> <span class="n">WolfCryptError</span>
<div class="viewcode-block" id="_Hash"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes._Hash">[docs]</a><span class="k">class</span> <span class="nc">_Hash</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A **PEP 247: Cryptographic Hash Functions** compliant</span>
<span class="sd"> **Hash Function Interface**.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">string</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_type</span><span class="p">)</span>
<span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init</span><span class="p">()</span>
<span class="k">if</span> <span class="n">ret</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
<span class="k">raise</span> <span class="n">WolfCryptError</span><span class="p">(</span><span class="s2">&quot;Hash init error (</span><span class="si">%d</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="n">ret</span><span class="p">)</span>
<span class="k">if</span> <span class="n">string</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">string</span><span class="p">)</span>
<div class="viewcode-block" id="_Hash.new"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes._Hash.new">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">new</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">string</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new hashing object and returns it. The optional</span>
<span class="sd"> **string** parameter, if supplied, will be immediately</span>
<span class="sd"> hashed into the object&#39;s starting state, as if</span>
<span class="sd"> obj.update(string) was called.</span>
<span class="sd"> &quot;&quot;&quot;</span></div>
<span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">string</span><span class="p">)</span>
<div class="viewcode-block" id="_Hash.copy"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes._Hash.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns a separate copy of this hashing object. An update</span>
<span class="sd"> to this copy won&#39;t affect the original object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">copy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">_ffi</span><span class="o">.</span><span class="n">memmove</span><span class="p">(</span><span class="n">copy</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span> <span class="c1"># pylint: disable=protected-access</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_native_size</span><span class="p">)</span>
</div>
<span class="k">return</span> <span class="n">copy</span>
<div class="viewcode-block" id="_Hash.update"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes._Hash.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">string</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Hashes **string** into the current state of the hashing</span>
<span class="sd"> object. update() can be called any number of times during</span>
<span class="sd"> a hashing object&#39;s lifetime.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">string</span> <span class="o">=</span> <span class="n">t2b</span><span class="p">(</span><span class="n">string</span><span class="p">)</span>
<span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_update</span><span class="p">(</span><span class="n">string</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ret</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># pragma: no cover</span></div>
<span class="k">raise</span> <span class="n">WolfCryptError</span><span class="p">(</span><span class="s2">&quot;Hash update error (</span><span class="si">%d</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="n">ret</span><span class="p">)</span>
<div class="viewcode-block" id="_Hash.digest"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes._Hash.digest">[docs]</a> <span class="k">def</span> <span class="nf">digest</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns the hash value of this hashing object as a string</span>
<span class="sd"> containing 8-bit data. The object is not altered in any</span>
<span class="sd"> way by this function; you can continue updating the object</span>
<span class="sd"> after calling this function.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="s2">&quot;byte[</span><span class="si">%d</span><span class="s2">]&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">digest_size</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">:</span>
<span class="n">obj</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_type</span><span class="p">)</span>
<span class="n">_ffi</span><span class="o">.</span><span class="n">memmove</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_native_size</span><span class="p">)</span>
<span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_final</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ret</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
<span class="k">raise</span> <span class="n">WolfCryptError</span><span class="p">(</span><span class="s2">&quot;Hash finalize error (</span><span class="si">%d</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="n">ret</span><span class="p">)</span>
</div>
<span class="k">return</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">buffer</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">digest_size</span><span class="p">)[:]</span>
<div class="viewcode-block" id="_Hash.hexdigest"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes._Hash.hexdigest">[docs]</a> <span class="k">def</span> <span class="nf">hexdigest</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns the hash value of this hashing object as a string</span>
<span class="sd"> containing hexadecimal digits. Lowercase letters are used</span>
<span class="sd"> for the digits &#39;a&#39; through &#39;f&#39;. Like the .digest() method,</span>
<span class="sd"> this method doesn&#39;t alter the object.</span>
<span class="sd"> &quot;&quot;&quot;</span></div></div>
<span class="k">return</span> <span class="n">b2h</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">digest</span><span class="p">())</span>
<div class="viewcode-block" id="Sha"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes.Sha">[docs]</a><span class="k">class</span> <span class="nc">Sha</span><span class="p">(</span><span class="n">_Hash</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> **SHA-1** is a cryptographic hash function standardized by **NIST**.</span>
<span class="sd"> It produces an [ **160-bit | 20 bytes** ] message digest.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">digest_size</span> <span class="o">=</span> <span class="mi">20</span>
<span class="n">_native_type</span> <span class="o">=</span> <span class="s2">&quot;wc_Sha *&quot;</span>
<span class="n">_native_size</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">sizeof</span><span class="p">(</span><span class="s2">&quot;wc_Sha&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_InitSha</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_ShaUpdate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_final</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">):</span></div>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_ShaFinal</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">)</span>
<div class="viewcode-block" id="Sha256"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes.Sha256">[docs]</a><span class="k">class</span> <span class="nc">Sha256</span><span class="p">(</span><span class="n">_Hash</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> **SHA-256** is a cryptographic hash function from the</span>
<span class="sd"> **SHA-2 family** and is standardized by **NIST**.</span>
<span class="sd"> It produces a [ **256-bit | 32 bytes** ] message digest.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">digest_size</span> <span class="o">=</span> <span class="mi">32</span>
<span class="n">_native_type</span> <span class="o">=</span> <span class="s2">&quot;wc_Sha256 *&quot;</span>
<span class="n">_native_size</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">sizeof</span><span class="p">(</span><span class="s2">&quot;wc_Sha256&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_InitSha256</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_Sha256Update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_final</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">):</span></div>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_Sha256Final</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">)</span>
<div class="viewcode-block" id="Sha384"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes.Sha384">[docs]</a><span class="k">class</span> <span class="nc">Sha384</span><span class="p">(</span><span class="n">_Hash</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> **SHA-384** is a cryptographic hash function from the</span>
<span class="sd"> **SHA-2 family** and is standardized by **NIST**.</span>
<span class="sd"> It produces a [ **384-bit | 48 bytes** ] message digest.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">digest_size</span> <span class="o">=</span> <span class="mi">48</span>
<span class="n">_native_type</span> <span class="o">=</span> <span class="s2">&quot;wc_Sha384 *&quot;</span>
<span class="n">_native_size</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">sizeof</span><span class="p">(</span><span class="s2">&quot;wc_Sha384&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_InitSha384</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_Sha384Update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_final</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">):</span></div>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_Sha384Final</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">)</span>
<div class="viewcode-block" id="Sha512"><a class="viewcode-back" href="../../digest.html#wolfcrypt.hashes.Sha512">[docs]</a><span class="k">class</span> <span class="nc">Sha512</span><span class="p">(</span><span class="n">_Hash</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> **SHA-512** is a cryptographic hash function from the</span>
<span class="sd"> **SHA-2 family** and is standardized by **NIST**.</span>
<span class="sd"> It produces a [ **512-bit | 64 bytes** ] message digest.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">digest_size</span> <span class="o">=</span> <span class="mi">64</span>
<span class="n">_native_type</span> <span class="o">=</span> <span class="s2">&quot;wc_Sha512 *&quot;</span>
<span class="n">_native_size</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">sizeof</span><span class="p">(</span><span class="s2">&quot;wc_Sha512&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_InitSha512</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_Sha512Update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_final</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">):</span></div>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_Sha512Final</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">)</span>
<span class="c1"># Hmac types</span>
<span class="n">_TYPE_SHA</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">_TYPE_SHA256</span> <span class="o">=</span> <span class="mi">2</span>
<span class="n">_TYPE_SHA384</span> <span class="o">=</span> <span class="mi">5</span>
<span class="n">_TYPE_SHA512</span> <span class="o">=</span> <span class="mi">4</span>
<span class="n">_HMAC_TYPES</span> <span class="o">=</span> <span class="p">[</span><span class="n">_TYPE_SHA</span><span class="p">,</span> <span class="n">_TYPE_SHA256</span><span class="p">,</span> <span class="n">_TYPE_SHA384</span><span class="p">,</span> <span class="n">_TYPE_SHA512</span><span class="p">]</span>
<div class="viewcode-block" id="_Hmac"><a class="viewcode-back" href="../../mac.html#wolfcrypt.hashes._Hmac">[docs]</a><span class="k">class</span> <span class="nc">_Hmac</span><span class="p">(</span><span class="n">_Hash</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A **PEP 247: Cryptographic Hash Functions** compliant</span>
<span class="sd"> **Keyed Hash Function Interface**.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">digest_size</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">_native_type</span> <span class="o">=</span> <span class="s2">&quot;Hmac *&quot;</span>
<span class="n">_native_size</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">sizeof</span><span class="p">(</span><span class="s2">&quot;Hmac&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">string</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="c1"># pylint: disable=W0231</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">t2b</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span> <span class="o">=</span> <span class="n">_ffi</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_type</span><span class="p">)</span>
<span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_type</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ret</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
<span class="k">raise</span> <span class="n">WolfCryptError</span><span class="p">(</span><span class="s2">&quot;Hmac init error (</span><span class="si">%d</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="n">ret</span><span class="p">)</span>
<span class="k">if</span> <span class="n">string</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">string</span><span class="p">)</span>
<div class="viewcode-block" id="_Hmac.new"><a class="viewcode-back" href="../../mac.html#wolfcrypt.hashes._Hmac.new">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">new</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">string</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="c1"># pylint: disable=W0221</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new hashing object and returns it. **key** is</span>
<span class="sd"> a required parameter containing a string giving the key</span>
<span class="sd"> to use. The optional **string** parameter, if supplied,</span>
<span class="sd"> will be immediately hashed into the object&#39;s starting</span>
<span class="sd"> state, as if obj.update(string) was called.</span>
<span class="sd"> &quot;&quot;&quot;</span></div>
<span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">string</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hmac</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_HmacSetKey</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span> <span class="n">hmac</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_HmacUpdate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_native_object</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_final</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">):</span></div>
<span class="k">return</span> <span class="n">_lib</span><span class="o">.</span><span class="n">wc_HmacFinal</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">ret</span><span class="p">)</span>
<div class="viewcode-block" id="HmacSha"><a class="viewcode-back" href="../../mac.html#wolfcrypt.hashes.HmacSha">[docs]</a><span class="k">class</span> <span class="nc">HmacSha</span><span class="p">(</span><span class="n">_Hmac</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A HMAC function using **SHA-1** as it&#39;s cryptographic</span>
<span class="sd"> hash function.</span>
<span class="sd"> It produces a [ **512-bit | 64 bytes** ] message digest.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_type</span> <span class="o">=</span> <span class="n">_TYPE_SHA</span></div>
<span class="n">digest_size</span> <span class="o">=</span> <span class="n">Sha</span><span class="o">.</span><span class="n">digest_size</span>
<div class="viewcode-block" id="HmacSha256"><a class="viewcode-back" href="../../mac.html#wolfcrypt.hashes.HmacSha256">[docs]</a><span class="k">class</span> <span class="nc">HmacSha256</span><span class="p">(</span><span class="n">_Hmac</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A HMAC function using **SHA-256** as it&#39;s cryptographic</span>
<span class="sd"> hash function.</span>
<span class="sd"> It produces a [ **512-bit | 64 bytes** ] message digest.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_type</span> <span class="o">=</span> <span class="n">_TYPE_SHA256</span></div>
<span class="n">digest_size</span> <span class="o">=</span> <span class="n">Sha256</span><span class="o">.</span><span class="n">digest_size</span>
<div class="viewcode-block" id="HmacSha384"><a class="viewcode-back" href="../../mac.html#wolfcrypt.hashes.HmacSha384">[docs]</a><span class="k">class</span> <span class="nc">HmacSha384</span><span class="p">(</span><span class="n">_Hmac</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A HMAC function using **SHA-384** as it&#39;s cryptographic</span>
<span class="sd"> hash function.</span>
<span class="sd"> It produces a [ **512-bit | 64 bytes** ] message digest.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_type</span> <span class="o">=</span> <span class="n">_TYPE_SHA384</span></div>
<span class="n">digest_size</span> <span class="o">=</span> <span class="n">Sha384</span><span class="o">.</span><span class="n">digest_size</span>
<div class="viewcode-block" id="HmacSha512"><a class="viewcode-back" href="../../mac.html#wolfcrypt.hashes.HmacSha512">[docs]</a><span class="k">class</span> <span class="nc">HmacSha512</span><span class="p">(</span><span class="n">_Hmac</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A HMAC function using **SHA-512** as it&#39;s cryptographic</span>
<span class="sd"> hash function.</span>
<span class="sd"> It produces a [ **512-bit | 64 bytes** ] message digest.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_type</span> <span class="o">=</span> <span class="n">_TYPE_SHA512</span></div>
<span class="n">digest_size</span> <span class="o">=</span> <span class="n">Sha512</span><span class="o">.</span><span class="n">digest_size</span>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>