blob: cf3d72ca8aad5d34ff6e3bae7ec9b608a54370ad [file] [log] [blame]
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-cryptojs/rsa">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.2.0">
<title data-rh="true">RSA | Apache Milagro</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://milagro.apache.org/docs/cryptojs/rsa"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="RSA | Apache Milagro"><meta data-rh="true" name="description" content="Classes"><meta data-rh="true" property="og:description" content="Classes"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://milagro.apache.org/docs/cryptojs/rsa"><link data-rh="true" rel="alternate" href="https://milagro.apache.org/docs/cryptojs/rsa" hreflang="en"><link data-rh="true" rel="alternate" href="https://milagro.apache.org/docs/cryptojs/rsa" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache Milagro RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache Milagro Atom Feed">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css" integrity="sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM" crossorigin="anonymous">
<script src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/assets/css/styles.27cb1668.css">
<link rel="preload" href="/assets/js/runtime~main.b2dc6e47.js" as="script">
<link rel="preload" href="/assets/js/main.8eab308a.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/milagro.svg" alt="" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/milagro.svg" alt="" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache Milagro</b></a><a class="navbar__item navbar__link" href="/docs/milagro-intro">Docs</a><a class="navbar__item navbar__link" href="/docs/support">Support</a><a class="navbar__item navbar__link" href="/docs/contributor-guide">Contributing</a><a class="navbar__item navbar__link" href="/docs/downloads">Downloads</a></div><div class="navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/milagro-intro">About Milagro</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/amcl-overview">AMCL Library</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/amcl-overview">AMCL Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/amcl-c-api-2.0.0">AMCL C API 2.0.0</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/cryptojs/amcl-javascript-api">AMCL JavaScript API 1.0.0</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/amcl-javascript-api">AMCL JavaScript API</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/aes">AES</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/big">BIG</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/bls">BLS</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/bls192">BLS192</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/bls256">BLS256</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/dbig">DBIG</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecdh">ECDH</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecp">ECP</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecp2">ECP2</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecp4">ECP4</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecp8">ECP8</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ff">FF</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp">FP</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp2">FP2</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp4">FP4</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp8">FP8</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp12">FP12</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp16">FP16</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp24">FP24</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp48">FP48</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/gcm">GCM</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/hash256">HASH256</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/hash384">HASH384</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/hash512">HASH512</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/mpin">MPIN</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/mpin192">MPIN192</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/mpin256">MPIN256</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/pair">PAIR</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/pair192">PAIR192</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/pair256">PAIR256</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/rand">RAND</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/cryptojs/rsa">RSA</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/sha3">SHA3</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/unit64">UInt64</a></li></ul></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/d-ta-overview">D-TA</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/mpc-api-0.1">MPC Library</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/zkp-mfa-overview">ZKP-MFA Clients/Servers</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributor-guide">Project Info</a></div></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">AMCL Library</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">AMCL JavaScript API 1.0.0</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">RSA</span><meta itemprop="position" content="3"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>RSA</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="classes">Classes<a class="hash-link" href="#classes" title="Direct link to heading"></a></h2><dl><dt><a href="#RSA">RSA</a></dt><dd></dd><dt><a href="#rsa_private_key">rsa_private_key</a></dt><dd></dd><dt><a href="#rsa_public_key">rsa_public_key</a></dt><dd></dd></dl><a name="RSA"></a><h2 class="anchor anchorWithStickyNavbar_LWe7" id="rsa">RSA<a class="hash-link" href="#rsa" title="Direct link to heading"></a></h2><p><strong>Kind</strong>: global class<br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><ul><li><a href="#RSA">RSA</a><ul><li><a href="#new_RSA_new">new RSA()</a></li><li><a href="#RSA.bytestohex">.bytestohex(b)</a></li><li><a href="#RSA.bytestostring">.bytestostring(b)</a></li><li><a href="#RSA.stringtobytes">.stringtobytes(s)</a></li><li><a href="#RSA.hashit">.hashit(sha, A, n)</a></li><li><a href="#RSA.KEY_PAIR">.KEY_PAIR(rng, e, PRIV, PUB)</a></li><li><a href="#RSA.PKCS15">.PKCS15(rng, e, PRIV, PUB)</a></li><li><a href="#RSA.OAEP_ENCODE">.OAEP_ENCODE(sha, m, rng, P)</a></li><li><a href="#RSA.OAEP_DECODE">.OAEP_DECODE(sha, P, f)</a></li><li><a href="#RSA.PRIVATE_KEY_KILL">.PRIVATE_KEY_KILL(PRIV)</a></li><li><a href="#RSA.ENCRYPT">.ENCRYPT(PUB, F, G)</a></li><li><a href="#RSA.DECRYPT">.DECRYPT(PRIV, G, F)</a></li></ul></li></ul><a name="new_RSA_new"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="new-rsa">new RSA()<a class="hash-link" href="#new-rsa" title="Direct link to heading"></a></h3><p>Creates an instance of RSA</p><a name="RSA.bytestohex"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsabytestohexb-">RSA.bytestohex(b) ⇒<a class="hash-link" href="#rsabytestohexb-" title="Direct link to heading"></a></h3><p>Convert byte array to hex string</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>Returns</strong>: s hex string<br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>b</td><td>byte array</td></tr></tbody></table><a name="RSA.bytestostring"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsabytestostringb-">RSA.bytestostring(b) ⇒<a class="hash-link" href="#rsabytestostringb-" title="Direct link to heading"></a></h3><p>Convert byte array to string</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>Returns</strong>: s string<br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>b</td><td>byte array</td></tr></tbody></table><a name="RSA.stringtobytes"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsastringtobytess-">RSA.stringtobytes(s) ⇒<a class="hash-link" href="#rsastringtobytess-" title="Direct link to heading"></a></h3><p>Convert a string to byte array</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>Returns</strong>: b byte array<br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>s</td><td>string</td></tr></tbody></table><a name="RSA.hashit"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsahashitsha-a-n-">RSA.hashit(sha, A, n) ⇒<a class="hash-link" href="#rsahashitsha-a-n-" title="Direct link to heading"></a></h3><p>General purpose hash function</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>Returns</strong>: R hash value<br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>sha</td><td>is the hash type</td></tr><tr><td>A</td><td>byte array</td></tr><tr><td>n</td><td>Integer</td></tr></tbody></table><a name="RSA.KEY_PAIR"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsakey_pairrng-e-priv-pub">RSA.KEY_PAIR(rng, e, PRIV, PUB)<a class="hash-link" href="#rsakey_pairrng-e-priv-pub" title="Direct link to heading"></a></h3><p>RSA Key Pair Generator</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>rng</td><td>is a pointer to a cryptographically secure random number generator</td></tr><tr><td>e</td><td>the encryption exponent</td></tr><tr><td>PRIV</td><td>the output RSA private key</td></tr><tr><td>PUB</td><td>the output RSA public key</td></tr></tbody></table><a name="RSA.PKCS15"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsapkcs15rng-e-priv-pub-">RSA.PKCS15(rng, e, PRIV, PUB) ⇒<a class="hash-link" href="#rsapkcs15rng-e-priv-pub-" title="Direct link to heading"></a></h3><p>PKCS V1.5 padding of a message prior to RSA signature</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>Returns</strong>: true or false<br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>rng</td><td>is a pointer to a cryptographically secure random number generator</td></tr><tr><td>e</td><td>the encryption exponent</td></tr><tr><td>PRIV</td><td>the output RSA private key</td></tr><tr><td>PUB</td><td>the output RSA public key</td></tr></tbody></table><a name="RSA.OAEP_ENCODE"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsaoaep_encodesha-m-rng-p-">RSA.OAEP_ENCODE(sha, m, rng, P) ⇒<a class="hash-link" href="#rsaoaep_encodesha-m-rng-p-" title="Direct link to heading"></a></h3><p>OAEP padding of a message prior to RSA encryption</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>Returns</strong>: f is the output encoding, ready for RSA encryption<br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>sha</td><td>is the hash type</td></tr><tr><td>m</td><td>is the input message</td></tr><tr><td>rng</td><td>is a pointer to a cryptographically secure random number generator</td></tr><tr><td>P</td><td>are input encoding parameter string (could be NULL)</td></tr></tbody></table><a name="RSA.OAEP_DECODE"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsaoaep_decodesha-p-f-">RSA.OAEP_DECODE(sha, P, f) ⇒<a class="hash-link" href="#rsaoaep_decodesha-p-f-" title="Direct link to heading"></a></h3><p>OAEP unpadding of a message after RSA decryption</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>Returns</strong>: r is the unpadded message<br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>sha</td><td>is the hash type</td></tr><tr><td>P</td><td>are input encoding parameter string (could be NULL)</td></tr><tr><td>f</td><td>is the padded message</td></tr></tbody></table><a name="RSA.PRIVATE_KEY_KILL"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsaprivate_key_killpriv">RSA.PRIVATE_KEY_KILL(PRIV)<a class="hash-link" href="#rsaprivate_key_killpriv" title="Direct link to heading"></a></h3><p>Destroy an RSA private Key</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>PRIV</td><td>the input RSA private key. Destroyed on output.</td></tr></tbody></table><a name="RSA.ENCRYPT"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsaencryptpub-f-g">RSA.ENCRYPT(PUB, F, G)<a class="hash-link" href="#rsaencryptpub-f-g" title="Direct link to heading"></a></h3><p>RSA encryption of suitably padded plaintext</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>PUB</td><td>the input RSA public key</td></tr><tr><td>F</td><td>is input padded message</td></tr><tr><td>G</td><td>is the output ciphertext</td></tr></tbody></table><a name="RSA.DECRYPT"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rsadecryptpriv-g-f">RSA.DECRYPT(PRIV, G, F)<a class="hash-link" href="#rsadecryptpriv-g-f" title="Direct link to heading"></a></h3><p>RSA decryption of ciphertext</p><p><strong>Kind</strong>: static method of <a href="#RSA"><code>RSA</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}RSA{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>PRIV</td><td>the input RSA private key</td></tr><tr><td>G</td><td>is the input ciphertext</td></tr><tr><td>F</td><td>is output plaintext (requires unpadding)</td></tr></tbody></table><a name="rsa_private_key"></a><h2 class="anchor anchorWithStickyNavbar_LWe7" id="rsa_private_key">rsa_private_key<a class="hash-link" href="#rsa_private_key" title="Direct link to heading"></a></h2><p><strong>Kind</strong>: global class<br>
<strong>this</strong>: <code>{&quot;{&quot;}rsa_private_key{&quot;}&quot;}</code> </p><a name="new_rsa_private_key_new"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="new-rsa_private_keyn">new rsa_private_key(n)<a class="hash-link" href="#new-rsa_private_keyn" title="Direct link to heading"></a></h3><p>Creates an instance of rsa_private_key</p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>n</td><td>FF length</td></tr></tbody></table><a name="rsa_public_key"></a><h2 class="anchor anchorWithStickyNavbar_LWe7" id="rsa_public_key">rsa_public_key<a class="hash-link" href="#rsa_public_key" title="Direct link to heading"></a></h2><p><strong>Kind</strong>: global class<br>
<strong>this</strong>: <code>{&quot;{&quot;}rsa_private_key{&quot;}&quot;}</code> </p><a name="new_rsa_public_key_new"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="new-rsa_public_keym">new rsa_public_key(m)<a class="hash-link" href="#new-rsa_public_keym" title="Direct link to heading"></a></h3><p>Creates an instance of rsa_public_key</p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>m</td><td>FF length</td></tr></tbody></table></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/cryptojs/rand"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">RAND</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/cryptojs/sha3"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">SHA3</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#classes" class="table-of-contents__link toc-highlight">Classes</a></li><li><a href="#rsa" class="table-of-contents__link toc-highlight">RSA</a><ul><li><a href="#new-rsa" class="table-of-contents__link toc-highlight">new RSA()</a></li><li><a href="#rsabytestohexb-" class="table-of-contents__link toc-highlight">RSA.bytestohex(b) ⇒</a></li><li><a href="#rsabytestostringb-" class="table-of-contents__link toc-highlight">RSA.bytestostring(b) ⇒</a></li><li><a href="#rsastringtobytess-" class="table-of-contents__link toc-highlight">RSA.stringtobytes(s) ⇒</a></li><li><a href="#rsahashitsha-a-n-" class="table-of-contents__link toc-highlight">RSA.hashit(sha, A, n) ⇒</a></li><li><a href="#rsakey_pairrng-e-priv-pub" class="table-of-contents__link toc-highlight">RSA.KEY_PAIR(rng, e, PRIV, PUB)</a></li><li><a href="#rsapkcs15rng-e-priv-pub-" class="table-of-contents__link toc-highlight">RSA.PKCS15(rng, e, PRIV, PUB) ⇒</a></li><li><a href="#rsaoaep_encodesha-m-rng-p-" class="table-of-contents__link toc-highlight">RSA.OAEP_ENCODE(sha, m, rng, P) ⇒</a></li><li><a href="#rsaoaep_decodesha-p-f-" class="table-of-contents__link toc-highlight">RSA.OAEP_DECODE(sha, P, f) ⇒</a></li><li><a href="#rsaprivate_key_killpriv" class="table-of-contents__link toc-highlight">RSA.PRIVATE_KEY_KILL(PRIV)</a></li><li><a href="#rsaencryptpub-f-g" class="table-of-contents__link toc-highlight">RSA.ENCRYPT(PUB, F, G)</a></li><li><a href="#rsadecryptpriv-g-f" class="table-of-contents__link toc-highlight">RSA.DECRYPT(PRIV, G, F)</a></li></ul></li><li><a href="#rsa_private_key" class="table-of-contents__link toc-highlight">rsa_private_key</a><ul><li><a href="#new-rsa_private_keyn" class="table-of-contents__link toc-highlight">new rsa_private_key(n)</a></li></ul></li><li><a href="#rsa_public_key" class="table-of-contents__link toc-highlight">rsa_public_key</a><ul><li><a href="#new-rsa_public_keym" class="table-of-contents__link toc-highlight">new rsa_public_key(m)</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/img/milagro.svg" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/milagro.svg" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></div><div class="footer__copyright">Copyright © 2022 The Apache Software Foundation. Apache Milagro, Milagro, Apache, the Apache feather, and the Apache Milagro project logo are either registered trademarks or trademarks of the Apache Software Foundation.</div></div></div></footer></div>
<script src="/assets/js/runtime~main.b2dc6e47.js"></script>
<script src="/assets/js/main.8eab308a.js"></script>
</body>
</html>