mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-06-13 01:38:20 +08:00
817 lines
52 KiB
HTML
Vendored
817 lines
52 KiB
HTML
Vendored
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>encryption | Stacks.js 1.4.1 Library Reference</title>
|
|
<meta name="description" content="Documentation for Stacks.js 1.4.1 Library Reference">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<link rel="stylesheet" href="../assets/css/custom-style.css">
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">Stacks.js 1.4.1 Library Reference</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">Stacks.js 1.4.1 Library Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="encryption.html">encryption</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module encryption</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<a href="#stacksencryption" id="stacksencryption" style="color: inherit; text-decoration: none;">
|
|
<h1>@stacks/encryption</h1>
|
|
</a>
|
|
<p>Encryption functions used by Stacks.js packages.</p>
|
|
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
|
<h2>Installation</h2>
|
|
</a>
|
|
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> @</span><span style="color: #001080">stacks</span><span style="color: #000000">/</span><span style="color: #001080">cli</span>
|
|
</code></pre>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>References</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="encryption.html#nodecryptosha2hash" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Sha2<wbr>Hash</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="encryption.html#sha2hash" class="tsd-kind-icon">Sha2<wbr>Hash</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="encryption.html#webcryptosha2hash" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Sha2<wbr>Hash</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="encryption.html#createsha2hash" class="tsd-kind-icon">create<wbr>Sha2<wbr>Hash</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="encryption.html#getbase64outputlength" class="tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="encryption.html#hashsha256sync" class="tsd-kind-icon">hash<wbr>Sha256<wbr>Sync</a></li>
|
|
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="encryption.html#hashsha512sync" class="tsd-kind-icon">hash<wbr>Sha512<wbr>Sync</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.nodecryptoaescipher.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Aes<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.nodecryptohmacsha256.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Hmac<wbr>Sha256</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.nodecryptopbkdf2.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Pbkdf2</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.nodecryptoripemd160digest.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Ripemd160<wbr>Digest</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.ripemd160polyfilldigest.html" class="tsd-kind-icon">Ripemd160<wbr>Polyfill<wbr>Digest</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.webcryptoaescipher.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Aes<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.webcryptohmacsha256.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Hmac<wbr>Sha256</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.webcryptopartialpbkdf2.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Partial<wbr>Pbkdf2</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/encryption.webcryptopbkdf2.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Pbkdf2</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Interfaces</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.aescipher.html" class="tsd-kind-icon">Aes<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.encryptcontentoptions.html" class="tsd-kind-icon">Encrypt<wbr>Content<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.encryptionoptions.html" class="tsd-kind-icon">Encryption<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.hmac.html" class="tsd-kind-icon">Hmac</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.nodecryptolib.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Lib</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.pbkdf2.html" class="tsd-kind-icon">Pbkdf2</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.ripemd160digest.html" class="tsd-kind-icon">Ripemd160<wbr>Digest</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/encryption.webcryptolib.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Lib</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Type aliases</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="encryption.html#cipheralgorithm" class="tsd-kind-icon">Cipher<wbr>Algorithm</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="encryption.html#getrandombytes" class="tsd-kind-icon">Get<wbr>Random<wbr>Bytes</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="encryption.html#pbkdf2digests" class="tsd-kind-icon">Pbkdf2<wbr>Digests</a></li>
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="encryption.html#triplesecdecryptsignature" class="tsd-kind-icon">Triplesec<wbr>Decrypt<wbr>Signature</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Variables</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="encryption.html#no_crypto_lib" class="tsd-kind-icon">NO_<wbr>CRYPTO_<wbr>LIB</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#createcipher" class="tsd-kind-icon">create<wbr>Cipher</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#createhashripemd160" class="tsd-kind-icon">create<wbr>Hash<wbr>Ripemd160</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#createhmacsha256" class="tsd-kind-icon">create<wbr>Hmac<wbr>Sha256</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#createpbkdf2" class="tsd-kind-icon">create<wbr>Pbkdf2</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#getcryptolib" class="tsd-kind-icon">get<wbr>Crypto<wbr>Lib</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#hashripemd160" class="tsd-kind-icon">hash<wbr>Ripemd160</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="encryption.html#isnodecryptoavailable" class="tsd-kind-icon">is<wbr>Node<wbr>Crypto<wbr>Available</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="encryption.html#issubtlecryptoavailable" class="tsd-kind-icon">is<wbr>Subtle<wbr>Crypto<wbr>Available</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>References</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
|
|
<a name="nodecryptosha2hash" class="tsd-anchor"></a>
|
|
<h3>Node<wbr>Crypto<wbr>Sha2<wbr>Hash</h3>
|
|
Re-exports <a href="">NodeCryptoSha2Hash</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
|
|
<a name="sha2hash" class="tsd-anchor"></a>
|
|
<h3>Sha2<wbr>Hash</h3>
|
|
Re-exports <a href="">Sha2Hash</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
|
|
<a name="webcryptosha2hash" class="tsd-anchor"></a>
|
|
<h3>Web<wbr>Crypto<wbr>Sha2<wbr>Hash</h3>
|
|
Re-exports <a href="">WebCryptoSha2Hash</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
|
|
<a name="createsha2hash" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Sha2<wbr>Hash</h3>
|
|
Re-exports <a href="">createSha2Hash</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
|
|
<a name="getbase64outputlength" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Base64<wbr>Output<wbr>Length</h3>
|
|
Re-exports <a href="">getBase64OutputLength</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
|
|
<a name="hashsha256sync" class="tsd-anchor"></a>
|
|
<h3>hash<wbr>Sha256<wbr>Sync</h3>
|
|
Re-exports <a href="">hashSha256Sync</a>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module">
|
|
<a name="hashsha512sync" class="tsd-anchor"></a>
|
|
<h3>hash<wbr>Sha512<wbr>Sync</h3>
|
|
Re-exports <a href="">hashSha512Sync</a>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Type aliases</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="cipheralgorithm" class="tsd-anchor"></a>
|
|
<h3>Cipher<wbr>Algorithm</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Cipher<wbr>Algorithm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"aes-256-cbc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"aes-128-cbc"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/aesCipher.ts#L6">packages/encryption/src/aesCipher.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="getrandombytes" class="tsd-anchor"></a>
|
|
<h3>Get<wbr>Random<wbr>Bytes</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Get<wbr>Random<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Buffer</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoRandom.ts#L6">packages/encryption/src/cryptoRandom.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Optional function to generate cryptographically secure random bytes</p>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>count: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="pbkdf2digests" class="tsd-anchor"></a>
|
|
<h3>Pbkdf2<wbr>Digests</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Pbkdf2<wbr>Digests<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"sha512"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sha256"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/pbkdf2.ts#L3">packages/encryption/src/pbkdf2.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="triplesecdecryptsignature" class="tsd-anchor"></a>
|
|
<h3>Triplesec<wbr>Decrypt<wbr>Signature</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Triplesec<wbr>Decrypt<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> }</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, buff<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoUtils.ts#L34">packages/encryption/src/cryptoUtils.ts:34</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> }</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, buff<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>arg: <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5>cb: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, buff<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, buff<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>err: <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>buff: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Variables</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="no_crypto_lib" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> NO_<wbr>CRYPTO_<wbr>LIB</h3>
|
|
<div class="tsd-signature tsd-kind-icon">NO_<wbr>CRYPTO_<wbr>LIB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Crypto lib not found. Either the WebCrypto \"crypto.subtle\" or Node.js \"crypto\" module must be available."</span><span class="tsd-signature-symbol"> = 'Crypto lib not found. Either the WebCrypto "crypto.subtle" or Node.js "crypto" module must be available.'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoUtils.ts#L31">packages/encryption/src/cryptoUtils.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="createcipher" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Cipher</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Cipher<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/encryption.aescipher.html" class="tsd-signature-type" data-tsd-kind="Interface">AesCipher</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/aesCipher.ts#L109">packages/encryption/src/aesCipher.ts:109</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/encryption.aescipher.html" class="tsd-signature-type" data-tsd-kind="Interface">AesCipher</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="createhashripemd160" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Hash<wbr>Ripemd160</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Hash<wbr>Ripemd160<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/encryption.nodecryptoripemd160digest.html" class="tsd-signature-type" data-tsd-kind="Class">NodeCryptoRipemd160Digest</a><span class="tsd-signature-symbol"> | </span><a href="../classes/encryption.ripemd160polyfilldigest.html" class="tsd-signature-type" data-tsd-kind="Class">Ripemd160PolyfillDigest</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/hashRipemd160.ts#L48">packages/encryption/src/hashRipemd160.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/encryption.nodecryptoripemd160digest.html" class="tsd-signature-type" data-tsd-kind="Class">NodeCryptoRipemd160Digest</a><span class="tsd-signature-symbol"> | </span><a href="../classes/encryption.ripemd160polyfilldigest.html" class="tsd-signature-type" data-tsd-kind="Class">Ripemd160PolyfillDigest</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="createhmacsha256" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Hmac<wbr>Sha256</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Hmac<wbr>Sha256<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/encryption.hmac.html" class="tsd-signature-type" data-tsd-kind="Interface">Hmac</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/hmacSha256.ts#L47">packages/encryption/src/hmacSha256.ts:47</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/encryption.hmac.html" class="tsd-signature-type" data-tsd-kind="Interface">Hmac</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="createpbkdf2" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Pbkdf2</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Pbkdf2<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/encryption.pbkdf2.html" class="tsd-signature-type" data-tsd-kind="Interface">Pbkdf2</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/pbkdf2.ts#L160">packages/encryption/src/pbkdf2.ts:160</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/encryption.pbkdf2.html" class="tsd-signature-type" data-tsd-kind="Interface">Pbkdf2</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="decryptcontent" class="tsd-anchor"></a>
|
|
<h3>decrypt<wbr>Content</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>Content<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>privateKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/encryption.ts#L110">packages/encryption/src/encryption.ts:110</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Decrypts data encrypted with <code>encryptContent</code> with the
|
|
transit private key.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>encrypted content.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>privateKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> private<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the hex string of the ECDSA private
|
|
key to use for decryption. If not provided, will use user's appPrivateKey.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>decrypted content.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="encryptcontent" class="tsd-anchor"></a>
|
|
<h3>encrypt<wbr>Content</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Content<span class="tsd-signature-symbol">(</span>content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/encryption.encryptcontentoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EncryptContentOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/encryption.ts#L58">packages/encryption/src/encryption.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Encrypts the data provided with the app public key.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>data to encrypt</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/encryption.encryptcontentoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EncryptContentOptions</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Stringified ciphertext object</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getcryptolib" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Crypto<wbr>Lib</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Crypto<wbr>Lib<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/encryption.webcryptolib.html" class="tsd-signature-type" data-tsd-kind="Interface">WebCryptoLib</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/encryption.nodecryptolib.html" class="tsd-signature-type" data-tsd-kind="Interface">NodeCryptoLib</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoUtils.ts#L51">packages/encryption/src/cryptoUtils.ts:51</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/encryption.webcryptolib.html" class="tsd-signature-type" data-tsd-kind="Interface">WebCryptoLib</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/encryption.nodecryptolib.html" class="tsd-signature-type" data-tsd-kind="Interface">NodeCryptoLib</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="hashripemd160" class="tsd-anchor"></a>
|
|
<h3>hash<wbr>Ripemd160</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">hash<wbr>Ripemd160<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/hashRipemd160.ts#L62">packages/encryption/src/hashRipemd160.ts:62</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a name="isnodecryptoavailable" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Node<wbr>Crypto<wbr>Available</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Node<wbr>Crypto<wbr>Available<T><span class="tsd-signature-symbol">(</span>withFeature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>nodeCrypto<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__module</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoUtils.ts#L5">packages/encryption/src/cryptoUtils.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T</h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>withFeature: <span class="tsd-signature-symbol">(</span>nodeCrypto<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__module</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>nodeCrypto<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__module</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>nodeCrypto: <span class="tsd-signature-type">__module</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="issubtlecryptoavailable" class="tsd-anchor"></a>
|
|
<h3>is<wbr>Subtle<wbr>Crypto<wbr>Available</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Subtle<wbr>Crypto<wbr>Available<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/cryptoUtils.ts#L1">packages/encryption/src/cryptoUtils.ts:1</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Modules</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="auth.html">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html">bns</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="cli.html">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html">common</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="encryption.html">encryption</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="keychain.html">keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="network.html">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html">stacking</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="storage.html">storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="transactions.html">transactions</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-module">
|
|
<a href="auth.html" class="tsd-kind-icon">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html" class="tsd-kind-icon">bns</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="cli.html" class="tsd-kind-icon">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html" class="tsd-kind-icon">common</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-module">
|
|
<a href="encryption.html" class="tsd-kind-icon">encryption</a>
|
|
<ul>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
<a href="encryption.html#nodecryptosha2hash" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Sha2<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
<a href="encryption.html#sha2hash" class="tsd-kind-icon">Sha2<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
<a href="encryption.html#webcryptosha2hash" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Sha2<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
<a href="encryption.html#createsha2hash" class="tsd-kind-icon">create<wbr>Sha2<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
<a href="encryption.html#getbase64outputlength" class="tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
<a href="encryption.html#hashsha256sync" class="tsd-kind-icon">hash<wbr>Sha256<wbr>Sync</a>
|
|
</li>
|
|
<li class=" tsd-kind-reference tsd-parent-kind-module">
|
|
<a href="encryption.html#hashsha512sync" class="tsd-kind-icon">hash<wbr>Sha512<wbr>Sync</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.nodecryptoaescipher.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Aes<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.nodecryptohmacsha256.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Hmac<wbr>Sha256</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.nodecryptopbkdf2.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.nodecryptoripemd160digest.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Ripemd160<wbr>Digest</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.ripemd160polyfilldigest.html" class="tsd-kind-icon">Ripemd160<wbr>Polyfill<wbr>Digest</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.webcryptoaescipher.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Aes<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.webcryptohmacsha256.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Hmac<wbr>Sha256</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.webcryptopartialpbkdf2.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Partial<wbr>Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/encryption.webcryptopbkdf2.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/encryption.aescipher.html" class="tsd-kind-icon">Aes<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/encryption.encryptcontentoptions.html" class="tsd-kind-icon">Encrypt<wbr>Content<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/encryption.encryptionoptions.html" class="tsd-kind-icon">Encryption<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/encryption.hmac.html" class="tsd-kind-icon">Hmac</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/encryption.nodecryptolib.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Lib</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/encryption.pbkdf2.html" class="tsd-kind-icon">Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/encryption.ripemd160digest.html" class="tsd-kind-icon">Ripemd160<wbr>Digest</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/encryption.webcryptolib.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Lib</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="encryption.html#cipheralgorithm" class="tsd-kind-icon">Cipher<wbr>Algorithm</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="encryption.html#getrandombytes" class="tsd-kind-icon">Get<wbr>Random<wbr>Bytes</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="encryption.html#pbkdf2digests" class="tsd-kind-icon">Pbkdf2<wbr>Digests</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="encryption.html#triplesecdecryptsignature" class="tsd-kind-icon">Triplesec<wbr>Decrypt<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="encryption.html#no_crypto_lib" class="tsd-kind-icon">NO_<wbr>CRYPTO_<wbr>LIB</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#createcipher" class="tsd-kind-icon">create<wbr>Cipher</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#createhashripemd160" class="tsd-kind-icon">create<wbr>Hash<wbr>Ripemd160</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#createhmacsha256" class="tsd-kind-icon">create<wbr>Hmac<wbr>Sha256</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#createpbkdf2" class="tsd-kind-icon">create<wbr>Pbkdf2</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#getcryptolib" class="tsd-kind-icon">get<wbr>Crypto<wbr>Lib</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#hashripemd160" class="tsd-kind-icon">hash<wbr>Ripemd160</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a href="encryption.html#isnodecryptoavailable" class="tsd-kind-icon">is<wbr>Node<wbr>Crypto<wbr>Available</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="encryption.html#issubtlecryptoavailable" class="tsd-kind-icon">is<wbr>Subtle<wbr>Crypto<wbr>Available</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-module">
|
|
<a href="keychain.html" class="tsd-kind-icon">keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="network.html" class="tsd-kind-icon">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html" class="tsd-kind-icon">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html" class="tsd-kind-icon">stacking</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="storage.html" class="tsd-kind-icon">storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="transactions.html" class="tsd-kind-icon">transactions</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |