| <!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>RSA · Apache Milagro</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Classes"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="RSA · Apache Milagro"/><meta property="og:type" content="website"/><meta property="og:url" content="https://milagro.apache.org/"/><meta property="og:description" content="## Classes"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://milagro.apache.org/blog/atom.xml" title="Apache Milagro Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://milagro.apache.org/blog/feed.xml" title="Apache Milagro Blog RSS Feed"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/milagro.svg" alt="Apache Milagro"/><h2 class="headerTitleWithLogo">Apache Milagro</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/milagro-intro" target="_self">Docs</a></li><li class="siteNavGroupActive"><a href="/docs/support" target="_self">Support</a></li><li class="siteNavGroupActive"><a href="/docs/contributor-guide" target="_self">Contributing</a></li><li class="siteNavGroupActive"><a href="/docs/downloads" target="_self">Downloads</a></li><li class=""><a href="/blog/" target="_self">Status</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>AMCL JavaScript API 1.0.0</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">About Milagro<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/milagro-intro">Milagro Introduction</a></li><li class="navListItem"><a class="navItem" href="/docs/milagro-crypto">Milagro Crypto</a></li><li class="navListItem"><a class="navItem" href="/docs/milagro-protocols">Milagro Protocols</a></li><li class="navListItem"><a class="navItem" href="/docs/milagro-design">Milagro Design</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">AMCL Library<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/amcl-overview">AMCL Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/amcl-c-api-2.0.0">AMCL C API 2.0.0</a></li><div class="navGroup subNavGroup"><h4 class="navGroupSubcategoryTitle">AMCL JavaScript API 1.0.0</h4><ul><li class="navListItem"><a class="navItem" href="/docs/cryptojs/aes">AES</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/big">BIG</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/bls">BLS</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/bls192">BLS192</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/bls256">BLS256</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/dbig">DBIG</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/ecdh">ECDH</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/ecp">ECP</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/ecp2">ECP2</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/ecp4">ECP4</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/ecp8">ECP8</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/ff">FF</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/fp">FP</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/fp2">FP2</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/fp4">FP4</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/fp8">FP8</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/fp12">FP12</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/fp16">FP16</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/fp24">FP24</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/fp48">FP48</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/gcm">GCM</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/hash256">HASH256</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/hash384">HASH384</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/hash512">HASH512</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/mpin">MPIN</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/mpin192">MPIN192</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/mpin256">MPIN256</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/pair">PAIR</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/pair192">PAIR192</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/pair256">PAIR256</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/rand">RAND</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/cryptojs/rsa">RSA</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/sha3">SHA3</a></li><li class="navListItem"><a class="navItem" href="/docs/cryptojs/unit64">UInt64</a></li></ul></div></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">D-TA<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/d-ta-overview">D-TA Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/dta-details/quickstart">Quick Start</a></li><li class="navListItem"><a class="navItem" href="/docs/dta-details/api">API</a></li><li class="navListItem"><a class="navItem" href="/docs/dta-details/configuration">Configuration</a></li><li class="navListItem"><a class="navItem" href="/docs/dta-details/identity-documents">Identity Documents</a></li><li class="navListItem"><a class="navItem" href="/docs/dta-details/encrypted-envelope">Encrypted Envelope</a></li><li class="navListItem"><a class="navItem" href="/docs/dta-details/ipfs">IPFS</a></li><li class="navListItem"><a class="navItem" href="/docs/dta-details/plugins-overview">Plugins Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/dta-details/authentication">Authentication</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">MPC Library<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/mpc-api-0.1">Multi-Party Computation Library 0.1</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">ZKP-MFA Clients/Servers<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/zkp-mfa-overview">ZKP-MFA Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/zkp-mfa-api">ZKP-MFA API</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Project Info<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/contributor-guide">Contributor's Guide</a></li><li class="navListItem"><a class="navItem" href="/docs/downloads">Downloads</a></li><li class="navListItem"><a class="navItem" href="/docs/support">Support</a></li></ul></div></div></section></div><script> |
| var coll = document.getElementsByClassName('collapsible'); |
| var checkActiveCategory = true; |
| for (var i = 0; i < coll.length; i++) { |
| var links = coll[i].nextElementSibling.getElementsByTagName('*'); |
| if (checkActiveCategory){ |
| for (var j = 0; j < links.length; j++) { |
| if (links[j].classList.contains('navListItemActive')){ |
| coll[i].nextElementSibling.classList.toggle('hide'); |
| coll[i].childNodes[1].classList.toggle('rotate'); |
| checkActiveCategory = false; |
| break; |
| } |
| } |
| } |
| |
| coll[i].addEventListener('click', function() { |
| var arrow = this.childNodes[1]; |
| arrow.classList.toggle('rotate'); |
| var content = this.nextElementSibling; |
| content.classList.toggle('hide'); |
| }); |
| } |
| |
| document.addEventListener('DOMContentLoaded', function() { |
| createToggler('#navToggler', '#docsNav', 'docsSliderActive'); |
| createToggler('#tocToggler', 'body', 'tocActive'); |
| |
| var headings = document.querySelector('.toc-headings'); |
| headings && headings.addEventListener('click', function(event) { |
| var el = event.target; |
| while(el !== headings){ |
| if (el.tagName === 'A') { |
| document.body.classList.remove('tocActive'); |
| break; |
| } else{ |
| el = el.parentNode; |
| } |
| } |
| }, false); |
| |
| function createToggler(togglerSelector, targetSelector, className) { |
| var toggler = document.querySelector(togglerSelector); |
| var target = document.querySelector(targetSelector); |
| |
| if (!toggler) { |
| return; |
| } |
| |
| toggler.onclick = function(event) { |
| event.preventDefault(); |
| |
| target.classList.toggle(className); |
| }; |
| } |
| }); |
| </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">RSA</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="classes"></a><a href="#classes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Classes</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> |
| <p><a name="RSA"></a></p> |
| <h2><a class="anchor" aria-hidden="true" id="rsa"></a><a href="#rsa" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA</h2> |
| <p><strong>Kind</strong>: global class<br> |
| <strong>this</strong>: <code>{RSA}</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> |
| <p><a name="new_RSA_new"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="new-rsa"></a><a href="#new-rsa" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>new RSA()</h3> |
| <p>Creates an instance of RSA</p> |
| <p><a name="RSA.bytestohex"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsabytestohexb-"></a><a href="#rsabytestohexb-" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.bytestohex(b) ⇒</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>{RSA}</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> |
| <p><a name="RSA.bytestostring"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsabytestostringb-"></a><a href="#rsabytestostringb-" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.bytestostring(b) ⇒</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>{RSA}</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> |
| <p><a name="RSA.stringtobytes"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsastringtobytess-"></a><a href="#rsastringtobytess-" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.stringtobytes(s) ⇒</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>{RSA}</code></p> |
| <table> |
| <thead> |
| <tr><th>Param</th><th>Description</th></tr> |
| </thead> |
| <tbody> |
| <tr><td>s</td><td>string</td></tr> |
| </tbody> |
| </table> |
| <p><a name="RSA.hashit"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsahashitsha-a-n-"></a><a href="#rsahashitsha-a-n-" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.hashit(sha, A, n) ⇒</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>{RSA}</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> |
| <p><a name="RSA.KEY_PAIR"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsakey_pairrng-e-priv-pub"></a><a href="#rsakey_pairrng-e-priv-pub" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.KEY_PAIR(rng, e, PRIV, PUB)</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>{RSA}</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> |
| <p><a name="RSA.PKCS15"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsapkcs15rng-e-priv-pub-"></a><a href="#rsapkcs15rng-e-priv-pub-" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.PKCS15(rng, e, PRIV, PUB) ⇒</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>{RSA}</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> |
| <p><a name="RSA.OAEP_ENCODE"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsaoaep_encodesha-m-rng-p-"></a><a href="#rsaoaep_encodesha-m-rng-p-" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.OAEP_ENCODE(sha, m, rng, P) ⇒</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>{RSA}</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> |
| <p><a name="RSA.OAEP_DECODE"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsaoaep_decodesha-p-f-"></a><a href="#rsaoaep_decodesha-p-f-" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.OAEP_DECODE(sha, P, f) ⇒</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>{RSA}</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> |
| <p><a name="RSA.PRIVATE_KEY_KILL"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsaprivate_key_killpriv"></a><a href="#rsaprivate_key_killpriv" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.PRIVATE_KEY_KILL(PRIV)</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>{RSA}</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> |
| <p><a name="RSA.ENCRYPT"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsaencryptpub-f-g"></a><a href="#rsaencryptpub-f-g" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.ENCRYPT(PUB, F, G)</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>{RSA}</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> |
| <p><a name="RSA.DECRYPT"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="rsadecryptpriv-g-f"></a><a href="#rsadecryptpriv-g-f" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RSA.DECRYPT(PRIV, G, F)</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>{RSA}</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> |
| <p><a name="rsa_private_key"></a></p> |
| <h2><a class="anchor" aria-hidden="true" id="rsa_private_key"></a><a href="#rsa_private_key" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>rsa_private_key</h2> |
| <p><strong>Kind</strong>: global class<br> |
| <strong>this</strong>: <code>{rsa_private_key}</code> <br> |
| <a name="new_rsa_private_key_new"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="new-rsa_private_keyn"></a><a href="#new-rsa_private_keyn" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>new rsa_private_key(n)</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> |
| <p><a name="rsa_public_key"></a></p> |
| <h2><a class="anchor" aria-hidden="true" id="rsa_public_key"></a><a href="#rsa_public_key" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>rsa_public_key</h2> |
| <p><strong>Kind</strong>: global class<br> |
| <strong>this</strong>: <code>{rsa_private_key}</code> <br> |
| <a name="new_rsa_public_key_new"></a></p> |
| <h3><a class="anchor" aria-hidden="true" id="new-rsa_public_keym"></a><a href="#new-rsa_public_keym" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>new rsa_public_key(m)</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> |
| </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/cryptojs/rand"><span class="arrow-prev">← </span><span>RAND</span></a><a class="docs-next button" href="/docs/cryptojs/sha3"><span>SHA3</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#classes">Classes</a></li><li><a href="#rsa">RSA</a><ul class="toc-headings"><li><a href="#new-rsa">new RSA()</a></li><li><a href="#rsabytestohexb-">RSA.bytestohex(b) ⇒</a></li><li><a href="#rsabytestostringb-">RSA.bytestostring(b) ⇒</a></li><li><a href="#rsastringtobytess-">RSA.stringtobytes(s) ⇒</a></li><li><a href="#rsahashitsha-a-n-">RSA.hashit(sha, A, n) ⇒</a></li><li><a href="#rsakey_pairrng-e-priv-pub">RSA.KEY_PAIR(rng, e, PRIV, PUB)</a></li><li><a href="#rsapkcs15rng-e-priv-pub-">RSA.PKCS15(rng, e, PRIV, PUB) ⇒</a></li><li><a href="#rsaoaep_encodesha-m-rng-p-">RSA.OAEP_ENCODE(sha, m, rng, P) ⇒</a></li><li><a href="#rsaoaep_decodesha-p-f-">RSA.OAEP_DECODE(sha, P, f) ⇒</a></li><li><a href="#rsaprivate_key_killpriv">RSA.PRIVATE_KEY_KILL(PRIV)</a></li><li><a href="#rsaencryptpub-f-g">RSA.ENCRYPT(PUB, F, G)</a></li><li><a href="#rsadecryptpriv-g-f">RSA.DECRYPT(PRIV, G, F)</a></li></ul></li><li><a href="#rsa_private_key">rsa_private_key</a><ul class="toc-headings"><li><a href="#new-rsa_private_keyn">new rsa_private_key(n)</a></li></ul></li><li><a href="#rsa_public_key">rsa_public_key</a><ul class="toc-headings"><li><a href="#new-rsa_public_keym">new rsa_public_key(m)</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/milagro.svg" alt="Apache Milagro" width="50" height="100"/></a><div><h5>Docs</h5><a href="/docs/milagro-intro.html">Milagro Intro</a><a href="/docs/amcl-overview.html">Apache Milagro Crypto Library</a><a href="/docs/d-ta-overview.html">Decentralized Trust Authority</a><a href="/docs/zkp-mfa-overview.html">Zero Knowledge Proof MFA</a></div><div><h5>Community</h5><a href="../docs/support">Support</a><a href="../docs/contributor-guide">Contributing</a><a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=115529045" target="_blank" rel="noreferrer noopener">Developer Wiki</a><a href="https://twitter.com/apachemilagro?lang=en" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Status</a><a href="https://github.com/apache/incubator-milagro-crypto-c">GitHub</a><a class="github-button" href="https://github.com/apache/incubator-milagro" data-icon="octicon-star" data-count-href="/apache/incubator-milagro-crypto/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><a href="https://apache.org" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Apache Incubator" width="170" height="45"/></a><section class="copyright"><div>Apache Milagro is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</div></section><p></p><section class="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.</section></footer></div></body></html> |
