kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-01-13 09:40:00 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
f572477ca0e5bc5e862c8a4e2fcc276655ee55a3
stacks.js/docs/interfaces/encryption.encryptionoptions.html
Alexander Graebe f572477ca0 feat: add regtest to list of available networks 
fixes #1041
2021-06-28 10:27:07 -07:00

333 lines
14 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>EncryptionOptions | 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>
<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>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</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.encryptionoptions.html">EncryptionOptions</a>
</li>
</ul>
<h1>Interface EncryptionOptions</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">EncryptionOptions</span>
<ul class="tsd-hierarchy">
<li>
<a href="encryption.encryptcontentoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EncryptContentOptions</a>
</li>
<li>
<a href="storage.putfileoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PutFileOptions</a>
</li>
</ul>
</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="encryption.encryptionoptions.html#ciphertextencoding" class="tsd-kind-icon">cipher<wbr>Text<wbr>Encoding</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="encryption.encryptionoptions.html#sign" class="tsd-kind-icon">sign</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="encryption.encryptionoptions.html#wasstring" class="tsd-kind-icon">was<wbr>String</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ciphertextencoding" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cipher<wbr>Text<wbr>Encoding</h3>
<div class="tsd-signature tsd-kind-icon">cipher<wbr>Text<wbr>Encoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CipherTextEncoding</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/encryption.ts#L27">packages/encryption/src/encryption.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>String encoding format for the cipherText buffer.
Currently defaults to &#39;hex&#39; for legacy backwards-compatibility.
Only used if the <code>encrypt</code> option is also used.
Note: in the future this should default to &#39;base64&#39; for the significant
file size reduction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sign" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> sign</h3>
<div class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/encryption.ts#L19">packages/encryption/src/encryption.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If set to <code>true</code> the data is signed using ECDSA on SHA256 hashes with the user&#39;s
app private key. If a string is specified, it is used as the private key instead
of the user&#39;s app private key.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>false</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="wasstring" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> was<wbr>String</h3>
<div class="tsd-signature tsd-kind-icon">was<wbr>String<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/encryption/src/encryption.ts#L34">packages/encryption/src/encryption.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies if the original unencrypted content is a ASCII or UTF-8 string.
For example stringified JSON.
If true, then when the ciphertext is decrypted, it will be returned as
a <code>string</code> type variable, otherwise will be returned as a Buffer.</p>
</div>
</div>
</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-class tsd-parent-kind-module">
<a href="../classes/encryption.nodecryptosha2hash.html" class="tsd-kind-icon">Node<wbr>Crypto<wbr>Sha2<wbr>Hash</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/encryption.webcryptosha2hash.html" class="tsd-kind-icon">Web<wbr>Crypto<wbr>Sha2<wbr>Hash</a>
</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="current tsd-kind-interface tsd-parent-kind-module">
<a href="encryption.encryptionoptions.html" class="tsd-kind-icon">Encryption<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="encryption.encryptionoptions.html#ciphertextencoding" class="tsd-kind-icon">cipher<wbr>Text<wbr>Encoding</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="encryption.encryptionoptions.html#sign" class="tsd-kind-icon">sign</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="encryption.encryptionoptions.html#wasstring" class="tsd-kind-icon">was<wbr>String</a>
</li>
</ul>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="encryption.sha2hash.html" class="tsd-kind-icon">Sha2<wbr>Hash</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-function 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-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#getbase64outputlength" class="tsd-kind-icon">get<wbr>Base64<wbr>Output<wbr>Length</a>
</li>
<li class=" tsd-kind-function 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-function 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-function tsd-parent-kind-module tsd-is-external">
<a href="../modules/encryption.html#randombytes" class="tsd-kind-icon">random<wbr>Bytes</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>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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