docs/global.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    
<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
</dl>


    </div>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="AES_CBC_HMAC"><span class="type-signature">(constant) </span>AES_CBC_HMAC<span class="type-signature"></span></h4>


<div class="description">
    <p>AES_CBC_HMAC module. Sign and encrypt data using AES-CBC symetric encryption,
with HMAC for message authentication.</p>
<p>https://tools.ietf.org/html/rfc7518#section-5.2.2</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_aes_cbc_hmac.js.html">algs/aes_cbc_hmac.js</a>, <a href="algs_aes_cbc_hmac.js.html#line18">line 18</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="AES_GCM"><span class="type-signature">(constant) </span>AES_GCM<span class="type-signature"></span></h4>


<div class="description">
    <p>AES_GCM module. Sign and encrypt data using AES-GCM symetric encryption.</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_aes_gcm.js.html">algs/aes_gcm.js</a>, <a href="algs_aes_gcm.js.html#line15">line 15</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="algs"><span class="type-signature">(constant) </span>algs<span class="type-signature"></span></h4>


<div class="description">
    <p>All supported algorithms.</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_index.js.html">algs/index.js</a>, <a href="algs_index.js.html#line12">line 12</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="ECDH_AES"><span class="type-signature">(constant) </span>ECDH_AES<span class="type-signature"></span></h4>


<div class="description">
    <p>ECDH_AES module. Implements ECDH-ES+AES_GCM encryption and decryption.</p>
<p>https://tools.ietf.org/html/rfc7518#section-4.6</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecdh_aes.js.html">algs/ecdh_aes.js</a>, <a href="algs_ecdh_aes.js.html#line20">line 20</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="ECIES_BIE1"><span class="type-signature">(constant) </span>ECIES_BIE1<span class="type-signature"></span></h4>


<div class="description">
    <p>ECIES_BIE1 module. Implements Electrum-flavoured ECIES encryption and
decryption.</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecies_bie1.js.html">algs/ecies_bie1.js</a>, <a href="algs_ecies_bie1.js.html#line12">line 12</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="ES256K"><span class="type-signature">(constant) </span>ES256K<span class="type-signature"></span></h4>


<div class="description">
    <p>ES256K module. Implements ECDSA signatures on the secp256k1 curve. Uses 65
byte compact signatures.</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_es256k.js.html">algs/es256k.js</a>, <a href="algs_es256k.js.html#line9">line 9</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="ES256K_BSM"><span class="type-signature">(constant) </span>ES256K_BSM<span class="type-signature"></span></h4>


<div class="description">
    <p>ES256K_BSM module. Calculates a message digest using the Bitcoin Signed
Message algorithm, and uses 65 byte compact signatures.</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_es256k_bsm.js.html">algs/es256k_bsm.js</a>, <a href="algs_es256k_bsm.js.html#line9">line 9</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="HMAC"><span class="type-signature">(constant) </span>HMAC<span class="type-signature"></span></h4>


<div class="description">
    <p>HMAC module.</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_hmac.js.html">algs/hmac.js</a>, <a href="algs_hmac.js.html#line15">line 15</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="params"><span class="type-signature">(constant) </span>params<span class="type-signature"></span></h4>


<div class="description">
    <p>Algorithm parameters</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_aes_cbc_hmac.js.html">algs/aes_cbc_hmac.js</a>, <a href="algs_aes_cbc_hmac.js.html#line7">line 7</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="params"><span class="type-signature">(constant) </span>params<span class="type-signature"></span></h4>


<div class="description">
    <p>Algorithm parameters</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_aes_gcm.js.html">algs/aes_gcm.js</a>, <a href="algs_aes_gcm.js.html#line7">line 7</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="params"><span class="type-signature">(constant) </span>params<span class="type-signature"></span></h4>


<div class="description">
    <p>Algorithm parameters</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecdh_aes.js.html">algs/ecdh_aes.js</a>, <a href="algs_ecdh_aes.js.html#line10">line 10</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="params"><span class="type-signature">(constant) </span>params<span class="type-signature"></span></h4>


<div class="description">
    <p>Algorithm parameters</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_hmac.js.html">algs/hmac.js</a>, <a href="algs_hmac.js.html#line7">line 7</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="assertKey"><span class="type-signature"></span>assertKey<span class="signature">(key, alg)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Asserts the key is valid.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>alg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_aes_cbc_hmac.js.html">algs/aes_cbc_hmac.js</a>, <a href="algs_aes_cbc_hmac.js.html#line96">line 96</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="assertKey"><span class="type-signature"></span>assertKey<span class="signature">(key, alg)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Asserts the key is valid.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>alg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_aes_gcm.js.html">algs/aes_gcm.js</a>, <a href="algs_aes_gcm.js.html#line84">line 84</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="assertKey"><span class="type-signature"></span>assertKey<span class="signature">(key, alg)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Asserts the key is valid.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>alg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecdh_aes.js.html">algs/ecdh_aes.js</a>, <a href="algs_ecdh_aes.js.html#line90">line 90</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="assertKey"><span class="type-signature"></span>assertKey<span class="signature">(key, alg)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Asserts the key is valid.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>alg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecies_bie1.js.html">algs/ecies_bie1.js</a>, <a href="algs_ecies_bie1.js.html#line108">line 108</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="assertKey"><span class="type-signature"></span>assertKey<span class="signature">(key, alg)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Asserts the key is valid.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>alg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_es256k.js.html">algs/es256k.js</a>, <a href="algs_es256k.js.html#line62">line 62</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="assertKey"><span class="type-signature"></span>assertKey<span class="signature">(key, alg)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Asserts the key is valid.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>alg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_es256k_bsm.js.html">algs/es256k_bsm.js</a>, <a href="algs_es256k_bsm.js.html#line83">line 83</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="assertKey"><span class="type-signature"></span>assertKey<span class="signature">(key, alg)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Asserts the key is valid.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>alg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_hmac.js.html">algs/hmac.js</a>, <a href="algs_hmac.js.html#line58">line 58</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="computeSharedSecret"><span class="type-signature"></span>computeSharedSecret<span class="signature">(privKey, pubKey)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
    

<div class="description">
    <p>Computes and returns a ECDH shared secret from the given keys.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>privKey</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubKey</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecdh_aes.js.html">algs/ecdh_aes.js</a>, <a href="algs_ecdh_aes.js.html#line103">line 103</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Buffer</span>


    </dd>
</dl>

    
    <h4 class="name" id="computeSharedSecret"><span class="type-signature"></span>computeSharedSecret<span class="signature">(privKey, pubKey)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
    

<div class="description">
    <p>Computes and returns a ECDH shared secret from the given keys.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>privKey</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubKey</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecies_bie1.js.html">algs/ecies_bie1.js</a>, <a href="algs_ecies_bie1.js.html#line121">line 121</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Buffer</span>


    </dd>
</dl>

    
    <h4 class="name" id="createMacMessage"><span class="type-signature"></span>createMacMessage<span class="signature">(opts)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
    

<div class="description">
    <p>Creates the MAC message as per https://tools.ietf.org/html/rfc7518#section-5.2.2</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>opts</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>additionalData</code></td>
            

            <td class="type">
            
                
<span class="param-type">Buffer</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>iv</code></td>
            

            <td class="type">
            
                
<span class="param-type">Buffer</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>encrypted</code></td>
            

            <td class="type">
            
                
<span class="param-type">Buffer</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_aes_cbc_hmac.js.html">algs/aes_cbc_hmac.js</a>, <a href="algs_aes_cbc_hmac.js.html#line125">line 125</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Buffer</span>


    </dd>
</dl>

    
    <h4 class="name" id="fromBsvPrivKey"><span class="type-signature"></span>fromBsvPrivKey<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>TODO</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util.js.html">util.js</a>, <a href="util.js.html#line21">line 21</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="fromBsvPubKey"><span class="type-signature"></span>fromBsvPubKey<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>TODO</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util.js.html">util.js</a>, <a href="util.js.html#line9">line 9</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="kdf"><span class="type-signature">(async) </span>kdf<span class="signature">(secret, alg, opts)</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Implements Concat KDF as defined in NIST.800-56A.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>secret</code></td>
            

            <td class="type">
            
                
<span class="param-type">Buffer</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>alg</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>opts</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecdh_aes.js.html">algs/ecdh_aes.js</a>, <a href="algs_ecdh_aes.js.html#line119">line 119</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="mergeKeyHeaders"><span class="type-signature"></span>mergeKeyHeaders<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>Helper function to merge key headers</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="envelope.js.html">envelope.js</a>, <a href="envelope.js.html#line456">line 456</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="messageDigest"><span class="type-signature"></span>messageDigest<span class="signature">(msg)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
    

<div class="description">
    <p>Creates a digest of the given message using the Bitcoin Signed Message
algorithm.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>msg</code></td>
            

            <td class="type">
            
                
<span class="param-type">Buffer</span>
|

<span class="param-type">String</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_es256k_bsm.js.html">algs/es256k_bsm.js</a>, <a href="algs_es256k_bsm.js.html#line63">line 63</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Buffer</span>


    </dd>
</dl>

    
    <h4 class="name" id="pubKeyBuf"><span class="type-signature"></span>pubKeyBuf<span class="signature">(key)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
    

<div class="description">
    <p>Converts a Key to a Buffer</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecdh_aes.js.html">algs/ecdh_aes.js</a>, <a href="algs_ecdh_aes.js.html#line153">line 153</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Buffer</span>


    </dd>
</dl>

    
    <h4 class="name" id="pubKeyBuf"><span class="type-signature"></span>pubKeyBuf<span class="signature">(key)</span><span class="type-signature"> &rarr; {Buffer}</span></h4>
    

<div class="description">
    <p>Converts a Key to a Buffer</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_ecies_bie1.js.html">algs/ecies_bie1.js</a>, <a href="algs_ecies_bie1.js.html#line140">line 140</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Buffer</span>


    </dd>
</dl>

    
    <h4 class="name" id="splitKey"><span class="type-signature"></span>splitKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    <p>Splits the key into two buffers - encryption key and mac key.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Key.html">Key</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="algs_aes_cbc_hmac.js.html">algs/aes_cbc_hmac.js</a>, <a href="algs_aes_cbc_hmac.js.html#line109">line 109</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="toBsvPrivKey"><span class="type-signature"></span>toBsvPrivKey<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>TODO</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util.js.html">util.js</a>, <a href="util.js.html#line46">line 46</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="toBsvPubKey"><span class="type-signature"></span>toBsvPubKey<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    <p>TODO</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util.js.html">util.js</a>, <a href="util.js.html#line35">line 35</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Envelope.html">Envelope</a></li><li><a href="Envelope.fromArray.html">fromArray</a></li><li><a href="Envelope.fromBuffer.html">fromBuffer</a></li><li><a href="Envelope.fromScript.html">fromScript</a></li><li><a href="Envelope.fromString.html">fromString</a></li><li><a href="Envelope.wrap.html">wrap</a></li><li><a href="Header.html">Header</a></li><li><a href="Header.wrap.html">wrap</a></li><li><a href="Key.html">Key</a></li><li><a href="Key.decode.html">decode</a></li><li><a href="Key.generate.html">generate</a></li><li><a href="Recipient.html">Recipient</a></li><li><a href="Recipient.fromArray.html">fromArray</a></li><li><a href="Recipient.wrap.html">wrap</a></li><li><a href="Signature.html">Signature</a></li><li><a href="Signature.fromArray.html">fromArray</a></li><li><a href="Signature.wrap.html">wrap</a></li></ul><h3>Global</h3><ul><li><a href="global.html#AES_CBC_HMAC">AES_CBC_HMAC</a></li><li><a href="global.html#AES_GCM">AES_GCM</a></li><li><a href="global.html#algs">algs</a></li><li><a href="global.html#assertKey">assertKey</a></li><li><a href="global.html#computeSharedSecret">computeSharedSecret</a></li><li><a href="global.html#createMacMessage">createMacMessage</a></li><li><a href="global.html#ECDH_AES">ECDH_AES</a></li><li><a href="global.html#ECIES_BIE1">ECIES_BIE1</a></li><li><a href="global.html#ES256K">ES256K</a></li><li><a href="global.html#ES256K_BSM">ES256K_BSM</a></li><li><a href="global.html#fromBsvPrivKey">fromBsvPrivKey</a></li><li><a href="global.html#fromBsvPubKey">fromBsvPubKey</a></li><li><a href="global.html#HMAC">HMAC</a></li><li><a href="global.html#kdf">kdf</a></li><li><a href="global.html#mergeKeyHeaders">mergeKeyHeaders</a></li><li><a href="global.html#messageDigest">messageDigest</a></li><li><a href="global.html#params">params</a></li><li><a href="global.html#pubKeyBuf">pubKeyBuf</a></li><li><a href="global.html#splitKey">splitKey</a></li><li><a href="global.html#toBsvPrivKey">toBsvPrivKey</a></li><li><a href="global.html#toBsvPubKey">toBsvPubKey</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>