kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-05-13 03:50:45 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
0719b1c752adf60c13bbe86b6cd24a93adddff35
stacks.js/docs/interfaces/encryption.aescipher.html
Reed Rosenbluth 0719b1c752 chore: update root package version, build docs
2021-05-12 10:23:59 -04:00

408 lines
20 KiB
HTML
Vendored
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AesCipher | 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="../modules/encryption.html">encryption</a>
</li>
<li>
<a href="encryption.aescipher.html">AesCipher</a>
</li>
</ul>
<h1>Interface AesCipher</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AesCipher</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/encryption.nodecryptoaescipher.html" class="tsd-signature-type" data-tsd-kind="Class">NodeCryptoAesCipher</a></li>
<li><a href="../classes/encryption.webcryptoaescipher.html" class="tsd-signature-type" data-tsd-kind="Class">WebCryptoAesCipher</a></li>
</ul>
</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>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="encryption.aescipher.html#decrypt" class="tsd-kind-icon">decrypt</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="encryption.aescipher.html#encrypt" class="tsd-kind-icon">encrypt</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="decrypt" class="tsd-anchor"></a>
<h3>decrypt</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">decrypt<span class="tsd-signature-symbol">(</span>algorithm<span class="tsd-signature-symbol">: </span><a href="../modules/encryption.html#cipheralgorithm" class="tsd-signature-type" data-tsd-kind="Type alias">CipherAlgorithm</a>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, iv<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</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#L11">packages/encryption/src/aesCipher.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>algorithm: <a href="../modules/encryption.html#cipheralgorithm" class="tsd-signature-type" data-tsd-kind="Type alias">CipherAlgorithm</a></h5>
</li>
<li>
<h5>key: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>iv: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>data: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="encrypt" class="tsd-anchor"></a>
<h3>encrypt</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">encrypt<span class="tsd-signature-symbol">(</span>algorithm<span class="tsd-signature-symbol">: </span><a href="../modules/encryption.html#cipheralgorithm" class="tsd-signature-type" data-tsd-kind="Type alias">CipherAlgorithm</a>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, iv<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</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#L9">packages/encryption/src/aesCipher.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>algorithm: <a href="../modules/encryption.html#cipheralgorithm" class="tsd-signature-type" data-tsd-kind="Type alias">CipherAlgorithm</a></h5>
</li>
<li>
<h5>key: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>iv: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>data: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</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="../modules/auth.html">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html">common</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/encryption.html">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/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="../modules/auth.html" class="tsd-kind-icon">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html" class="tsd-kind-icon">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html" class="tsd-kind-icon">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html" class="tsd-kind-icon">common</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/encryption.html" class="tsd-kind-icon">encryption</a>
<ul>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/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="../modules/encryption.html#sha2hash" class="tsd-kind-icon">Sha2<wbr>Hash</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/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="../modules/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="../modules/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="../modules/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="../modules/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="current tsd-kind-interface tsd-parent-kind-module">
<a href="encryption.aescipher.html" class="tsd-kind-icon">Aes<wbr>Cipher</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="encryption.aescipher.html#decrypt" class="tsd-kind-icon">decrypt</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="encryption.aescipher.html#encrypt" class="tsd-kind-icon">encrypt</a>
</li>
</ul>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="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="encryption.encryptionoptions.html" class="tsd-kind-icon">Encryption<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="encryption.hmac.html" class="tsd-kind-icon">Hmac</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="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="encryption.pbkdf2.html" class="tsd-kind-icon">Pbkdf2</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="encryption.ripemd160digest.html" class="tsd-kind-icon">Ripemd160<wbr>Digest</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="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="../modules/encryption.html#cipheralgorithm" class="tsd-kind-icon">Cipher<wbr>Algorithm</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/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="../modules/encryption.html#pbkdf2digests" class="tsd-kind-icon">Pbkdf2<wbr>Digests</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/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="../modules/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="../modules/encryption.html#createcipher" class="tsd-kind-icon">create<wbr>Cipher</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/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="../modules/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="../modules/encryption.html#createpbkdf2" class="tsd-kind-icon">create<wbr>Pbkdf2</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/encryption.html#decryptcontent" class="tsd-kind-icon">decrypt<wbr>Content</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/encryption.html#encryptcontent" class="tsd-kind-icon">encrypt<wbr>Content</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/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="../modules/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="../modules/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="../modules/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="../modules/keychain.html" class="tsd-kind-icon">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html" class="tsd-kind-icon">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html" class="tsd-kind-icon">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html" class="tsd-kind-icon">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/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-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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-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>
Reference in New Issue View Git Blame Copy Permalink