Skip to content

Commit

Permalink
[Release 1.7.0] sets rsa padding in encrypt, uses rsa padding value i…
Browse files Browse the repository at this point in the history 
…n decrypt
  • Loading branch information
UnumID Admin committed Nov 5, 2021
1 parent 8bbe132 commit 0cb79af
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/classes/cryptoerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/types/CryptoError.ts#L5">src/types/CryptoError.ts:5</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/types/CryptoError.ts#L5">src/types/CryptoError.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -153,7 +153,7 @@ <h3>code</h3>
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</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">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/types/CryptoError.ts#L5">src/types/CryptoError.ts:5</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/types/CryptoError.ts#L5">src/types/CryptoError.ts:5</a></li>
</ul>
</aside>
</section>
Expand Down
41 changes: 27 additions & 14 deletions docs/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3>decrypt</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/decrypt.ts#L20">src/decrypt.ts:20</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/decrypt.ts#L21">src/decrypt.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -147,7 +147,7 @@ <h3>decrypt<wbr>Bytes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/decrypt.ts#L44">src/decrypt.ts:44</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/decrypt.ts#L46">src/decrypt.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -187,13 +187,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</s
<a name="encrypt" class="tsd-anchor"></a>
<h3>encrypt</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">encrypt<span class="tsd-signature-symbol">(</span>did<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span>, encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;base58&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;pem&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EncryptedData</span></li>
<li class="tsd-signature tsd-kind-icon">encrypt<span class="tsd-signature-symbol">(</span>did<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span>, encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;base58&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;pem&quot;</span>, rsaPadding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RSAPadding</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EncryptedData</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/encrypt.ts#L25">src/encrypt.ts:25</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/encrypt.ts#L31">src/encrypt.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -229,6 +229,16 @@ <h5>encoding: <span class="tsd-signature-type">&quot;base58&quot;</span><span cl
<p>the encoding used for the publicKey (&#39;base58&#39; or &#39;pem&#39;, default &#39;pem&#39;)</p>
</div>
</li>
<li>
<h5>rsaPadding: <span class="tsd-signature-type">RSAPadding</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>padding to use for RSA encryption (PKCS1 v1.5 or OAEP).
Necessary because web crypto only supports OAEP padding for decryption,
and cannot decrypt data encrypted with PKCS1 v1.5 padding.
Defaults to PKCS to preserve backwards compatibility,
as older public keys (from before we used web crypto) do not specify a padding.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EncryptedData</span></h4>
<p>contains the encrypted data as a base58 string plus RSA-encrypted/base58-encoded
Expand All @@ -240,13 +250,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Encrypted
<a name="encryptbytes" class="tsd-anchor"></a>
<h3>encrypt<wbr>Bytes</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Bytes<span class="tsd-signature-symbol">(</span>did<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BinaryLike</span>, encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;base58&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;pem&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EncryptedData</span></li>
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Bytes<span class="tsd-signature-symbol">(</span>did<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BinaryLike</span>, encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;base58&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;pem&quot;</span>, rsaPadding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RSAPadding</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EncryptedData</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/encrypt.ts#L46">src/encrypt.ts:46</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/encrypt.ts#L59">src/encrypt.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -280,6 +290,9 @@ <h5>encoding: <span class="tsd-signature-type">&quot;base58&quot;</span><span cl
<p>the encoding used for the publicKey (&#39;base58&#39; or &#39;pem&#39;, default &#39;pem&#39;)</p>
</div>
</li>
<li>
<h5>rsaPadding: <span class="tsd-signature-type">RSAPadding</span><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EncryptedData</span></h4>
<p>contains the encrypted data as a base58 string plus RSA-encrypted/base58-encoded
Expand All @@ -297,7 +310,7 @@ <h3>generate<wbr>Ecc<wbr>Key<wbr>Pair</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/generateEccKeyPair.ts#L6">src/generateEccKeyPair.ts:6</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/generateEccKeyPair.ts#L6">src/generateEccKeyPair.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -320,7 +333,7 @@ <h3>generate<wbr>Rsa<wbr>Key<wbr>Pair</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/generateRsaKeyPair.ts#L6">src/generateRsaKeyPair.ts:6</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/generateRsaKeyPair.ts#L6">src/generateRsaKeyPair.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -343,7 +356,7 @@ <h3>sign</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/sign.ts#L18">src/sign.ts:18</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/sign.ts#L18">src/sign.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -389,7 +402,7 @@ <h3>sign<wbr>Bytes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/sign.ts#L42">src/sign.ts:42</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/sign.ts#L42">src/sign.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -434,7 +447,7 @@ <h3>validate<wbr>Public<wbr>Key</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/validatePublicKey.ts#L10">src/validatePublicKey.ts:10</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/validatePublicKey.ts#L10">src/validatePublicKey.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -467,7 +480,7 @@ <h3>verify</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/verify.ts#L19">src/verify.ts:19</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/verify.ts#L19">src/verify.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -519,7 +532,7 @@ <h3>verify<wbr>Bytes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/verify.ts#L62">src/verify.ts:62</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/verify.ts#L62">src/verify.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -570,7 +583,7 @@ <h3>verify<wbr>String</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/e0c1330/src/verify.ts#L40">src/verify.ts:40</a></li>
<li>Defined in <a href="https://github.com/UnumID/library-crypto-typescript/blob/8bbe132/src/verify.ts#L40">src/verify.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@unumid/library-crypto",
"version": "1.6.0",
"version": "1.7.0",
"description": "A TypeScript library for Unum ID crypto operations",
"main": "build/index.js",
"repository": "[email protected]:UnumID/Library-Crypto-TypeScript",
Expand Down

0 comments on commit 0cb79af

Please sign in to comment.