blob: a6d2695e6170c780fcb3836d54d9dbd34949e7c1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Fri Aug 12 15:29:42 EDT 2016 -->
<title>Paillier</title>
<meta name="date" content="2016-08-12">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Paillier";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Paillier.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/pirk/encryption/ModPowAbstraction.html" title="class in org.apache.pirk.encryption"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/pirk/encryption/PrimeGenerator.html" title="class in org.apache.pirk.encryption"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/pirk/encryption/Paillier.html" target="_top">Frames</a></li>
<li><a href="Paillier.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.pirk.encryption</div>
<h2 title="Class Paillier" class="title">Class Paillier</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.pirk.encryption.Paillier</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Paillier</span>
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable</pre>
<div class="block">Implementation of the Paillier cryptosystem
<p>
The algorithm is as follows:
<p>
Let N=pq, be a RSA modulus where p,q are large primes of roughly the same length
<p>
The plaintext space is the additive group Z/NZ and the ciphertext space is the multiplicative group (Z/N^2 Z)*.
<p>
Public key: N, Private key: The factorization of N=pq.
<p>
Let lambda(N) be the Carmichael function of N (the exponent of the multiplicative group of units modulo N):
<p>
lambda(N) = lcm(p-1,q-1) = (p-1)(q-1)/gcd(p-1,q-1)
<p>
Encryption E(m) for a message m is as follows:
<p>
- Given N and m
<p>
- Select a random value r in (Z/NZ)*
<p>
- E(m) = (1 + mN)r^N mod N^2
<p>
Decryption D(c) for a ciphertext c is as follows:
<p>
- Given N, its factorization N=pq, and ciphertext c
<p>
- Set w = lambda(N)^-1 mod N
<p>
- Set x = c^(lambda(N))mod N^2
<p>
- Set y = (x-1)/N
<p>
- D(c) = yw mod N
<p>
Ref: Paillier, Pascal. "Public-Key Cryptosystems Based on Composite Degree Residuosity Classes." EUROCRYPT'99.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.pirk.encryption.Paillier">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#Paillier(java.math.BigInteger,%20java.math.BigInteger,%20int)">Paillier</a></strong>(java.math.BigInteger&nbsp;pInput,
java.math.BigInteger&nbsp;qInput,
int&nbsp;bitLengthInput)</code>
<div class="block">Constructor with all parameters p,q, and bitLengthInput specified</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#Paillier(int,%20int)">Paillier</a></strong>(int&nbsp;bitLengthInput,
int&nbsp;certainty)</code>
<div class="block">Constructor to generate keys given the desired bitLength and prime certainty value</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#Paillier(int,%20int,%20int)">Paillier</a></strong>(int&nbsp;bitLengthInput,
int&nbsp;certainty,
int&nbsp;ensureBitSet)</code>
<div class="block">Constructor to generate keys given the desired bitLength and prime certainty value</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/pirk/encryption/Paillier.html" title="class in org.apache.pirk.encryption">Paillier</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#clone()">clone</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#decrypt(java.math.BigInteger)">decrypt</a></strong>(java.math.BigInteger&nbsp;c)</code>
<div class="block">Method to decrypt a given ciphertext</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#encrypt(java.math.BigInteger)">encrypt</a></strong>(java.math.BigInteger&nbsp;m)</code>
<div class="block">Encrypt - generate r</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#encrypt(java.math.BigInteger,%20java.math.BigInteger)">encrypt</a></strong>(java.math.BigInteger&nbsp;m,
java.math.BigInteger&nbsp;r)</code>
<div class="block">Encrypt - use provided r</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#getBitLength()">getBitLength</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#getLambdaN()">getLambdaN</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#getN()">getN</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#getNSquared()">getNSquared</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#getP()">getP</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/encryption/Paillier.html#getQ()">getQ</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Paillier(java.math.BigInteger, java.math.BigInteger, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Paillier</h4>
<pre>public&nbsp;Paillier(java.math.BigInteger&nbsp;pInput,
java.math.BigInteger&nbsp;qInput,
int&nbsp;bitLengthInput)
throws <a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Constructor with all parameters p,q, and bitLengthInput specified
<p>
Only used, at this point, for testing purposes</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code></dd></dl>
</li>
</ul>
<a name="Paillier(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Paillier</h4>
<pre>public&nbsp;Paillier(int&nbsp;bitLengthInput,
int&nbsp;certainty)
throws <a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Constructor to generate keys given the desired bitLength and prime certainty value
<p>
The probability that the new BigInteger values represents primes will exceed (1 - (1/2)^certainty). The execution time of this constructor is proportional
to the value of this parameter.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code></dd></dl>
</li>
</ul>
<a name="Paillier(int, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Paillier</h4>
<pre>public&nbsp;Paillier(int&nbsp;bitLengthInput,
int&nbsp;certainty,
int&nbsp;ensureBitSet)
throws <a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Constructor to generate keys given the desired bitLength and prime certainty value
<p>
Can optionally, ensure a certain bit is set in the modulus (if ensureBitSet != 0)
<p>
The probability that the new BigInteger values represents primes will exceed (1 - (1/2)^certainty). The execution time of this constructor is proportional
to the value of this parameter.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getP()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getP</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getP()</pre>
</li>
</ul>
<a name="getQ()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQ</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getQ()</pre>
</li>
</ul>
<a name="getN()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getN</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getN()</pre>
</li>
</ul>
<a name="getNSquared()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNSquared</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getNSquared()</pre>
</li>
</ul>
<a name="getLambdaN()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLambdaN</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getLambdaN()</pre>
</li>
</ul>
<a name="getBitLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBitLength</h4>
<pre>public&nbsp;int&nbsp;getBitLength()</pre>
</li>
</ul>
<a name="encrypt(java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encrypt</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;encrypt(java.math.BigInteger&nbsp;m)
throws <a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Encrypt - generate r</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code></dd></dl>
</li>
</ul>
<a name="encrypt(java.math.BigInteger, java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encrypt</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;encrypt(java.math.BigInteger&nbsp;m,
java.math.BigInteger&nbsp;r)
throws <a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></pre>
<div class="block">Encrypt - use provided r</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/pirk/utils/PIRException.html" title="class in org.apache.pirk.utils">PIRException</a></code></dd></dl>
</li>
</ul>
<a name="decrypt(java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decrypt</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;decrypt(java.math.BigInteger&nbsp;c)</pre>
<div class="block">Method to decrypt a given ciphertext</div>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../../org/apache/pirk/encryption/Paillier.html" title="class in org.apache.pirk.encryption">Paillier</a>&nbsp;clone()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Paillier.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/pirk/encryption/ModPowAbstraction.html" title="class in org.apache.pirk.encryption"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/pirk/encryption/PrimeGenerator.html" title="class in org.apache.pirk.encryption"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/pirk/encryption/Paillier.html" target="_top">Frames</a></li>
<li><a href="Paillier.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>