changeset 938:cd0872be37aa

Tiny bit of documentation for viff.paillier (issue45).
author Martin Geisler <mg@daimi.au.dk>
date Sun, 21 Sep 2008 12:07:50 +0200
parents a682033dc047
children 368bbbe30615
files doc/implementation.txt doc/paillier.txt viff/paillier.py
diffstat 3 files changed, 23 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/implementation.txt	Thu Sep 18 22:30:00 2008 +0200
+++ b/doc/implementation.txt	Sun Sep 21 12:07:50 2008 +0200
@@ -13,6 +13,7 @@
    matrix
    runtime
    active
+   paillier
    comparison
    prss
    config
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/paillier.txt	Sun Sep 21 12:07:50 2008 +0200
@@ -0,0 +1,12 @@
+
+Paillier Crypto System
+======================
+
+.. automodule:: viff.paillier
+
+   .. autoclass:: PaillierRuntime
+      :members:
+
+   .. autofunction:: encrypt
+
+   .. autofunction:: decrypt
--- a/viff/paillier.py	Thu Sep 18 22:30:00 2008 +0200
+++ b/viff/paillier.py	Sun Sep 21 12:07:50 2008 +0200
@@ -15,6 +15,15 @@
 # You should have received a copy of the GNU Lesser General Public
 # License along with VIFF. If not, see <http://www.gnu.org/licenses/>.
 
+"""Paillier crypto system.
+
+The :class:`PaillierRuntime` is a special twoplayer runtime based on
+the homomorphic Paillier crypto system.
+
+From the paper "Public-Key Cryptosystems Based on Composite Degree
+Residuosity Classes" by Pascal Paillier in EUROCRYPT 1999, 223-238.
+"""
+
 from twisted.internet.defer import Deferred, gatherResults
 import gmpy
 
@@ -56,6 +65,7 @@
 
 
 class PaillierRuntime(BasicRuntime):
+    """Twoplayer runtime based on the Paillier crypto system."""
 
     def add_player(self, player, protocol):
         BasicRuntime.add_player(self, player, protocol)