-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
29 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>generateKeypairJWK | typepki-webcrypto - v0.2.0</title><meta name="description" content="Documentation for typepki-webcrypto"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://kjur.github.io/typepki-webcrypto/">Home</a><a href="https://github.com/kjur/typepki-webcrypto/issues">Issue</a><a href="https://github.com/kjur/typepki-webcrypto">GitHub</a><a href="https://kjur.github.io/typepki">TypePKI</a><a href="https://kjur.github.io/jsrsasign">jsrsasign</a></div></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">typepki-webcrypto - v0.2.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">typepki-webcrypto</a></li><li><a href="generateKeypairJWK.html">generateKeypairJWK</a></li></ul><h1>Function generateKeypairJWK</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="generateKeypairJWK" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>KeypairJWK</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">alg</span>, <span class="tsd-kind-parameter">opt1</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">opt2</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">object</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#generateKeypairJWK" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>generate keypair as JWK keys</p> | ||
| </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">alg</span>: <span class="tsd-signature-type">"RSA"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"EC"</span></span><div class="tsd-comment tsd-typography"><p>key algorithm (RSA or EC)</p> | ||
| </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">opt1</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>RSA key length or EC curve name (P-{256,384,512}) RSA key length default is 2048 and EC curve name default is "P-256"</p> | ||
| </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">opt2</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>RSA public exponent as hexadecimal string. The default is "010001" (i.e. 65537)</p> | ||
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>Array of private key JWK and public key JWK.</p> | ||
| <div class="tsd-comment tsd-typography"><h4>See</h4><ul> | ||
| <li><a href="generateKeypairPEM.html" class="tsd-kind-function">generateKeypairPEM</a></li> | ||
| <li><a href="https://www.rfc-editor.org/rfc/rfc7517">https://www.rfc-editor.org/rfc/rfc7517</a></li> | ||
| </ul> | ||
| <h4>Description</h4><p>This function generates a RFC 7517 JSON Web Key (JWK) RSA | ||
| or EC key pair by W3C Web Crypto API.</p> | ||
| <h4>Example</h4><pre><code class="language-ts"><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">generateKeyPairJWK</span><span class="hl-1">(</span><span class="hl-3">"EC"</span><span class="hl-1">) -> [{</span><br/><span class="hl-1"> </span><span class="hl-4">kty:</span><span class="hl-1"> </span><span class="hl-3">"EC"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">crv:</span><span class="hl-1"> </span><span class="hl-3">"P-256"</span><br/><span class="hl-1"> </span><span class="hl-4">d</span><span class="hl-1">: </span><span class="hl-3">"..."</span><br/><span class="hl-1"> ...</span><br/><span class="hl-1">},{</span><br/><span class="hl-1"> </span><span class="hl-4">kty:</span><span class="hl-1"> </span><span class="hl-3">"EC"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">crv:</span><span class="hl-1"> </span><span class="hl-3">"P-256"</span><br/><span class="hl-1"> </span><span class="hl-4">x</span><span class="hl-1">: </span><span class="hl-3">"..."</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">y:</span><span class="hl-1"> </span><span class="hl-3">"..."</span><span class="hl-1">,</span><br/><span class="hl-1">}]</span> | ||
| </code><button>Copy</button></pre> | ||
| </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/kjur/typepki-webcrypto/blob/966dd79f113bf7a6aaf5243d3489f0eff4541f36/src/index.mts#L430">index.mts:430</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>typepki-webcrypto - v0.2.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.