viff

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 diff
     1.1 --- a/doc/implementation.txt	Thu Sep 18 22:30:00 2008 +0200
     1.2 +++ b/doc/implementation.txt	Sun Sep 21 12:07:50 2008 +0200
     1.3 @@ -13,6 +13,7 @@
     1.4     matrix
     1.5     runtime
     1.6     active
     1.7 +   paillier
     1.8     comparison
     1.9     prss
    1.10     config
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/doc/paillier.txt	Sun Sep 21 12:07:50 2008 +0200
     2.3 @@ -0,0 +1,12 @@
     2.4 +
     2.5 +Paillier Crypto System
     2.6 +======================
     2.7 +
     2.8 +.. automodule:: viff.paillier
     2.9 +
    2.10 +   .. autoclass:: PaillierRuntime
    2.11 +      :members:
    2.12 +
    2.13 +   .. autofunction:: encrypt
    2.14 +
    2.15 +   .. autofunction:: decrypt
     3.1 --- a/viff/paillier.py	Thu Sep 18 22:30:00 2008 +0200
     3.2 +++ b/viff/paillier.py	Sun Sep 21 12:07:50 2008 +0200
     3.3 @@ -15,6 +15,15 @@
     3.4  # You should have received a copy of the GNU Lesser General Public
     3.5  # License along with VIFF. If not, see <http://www.gnu.org/licenses/>.
     3.6  
     3.7 +"""Paillier crypto system.
     3.8 +
     3.9 +The :class:`PaillierRuntime` is a special twoplayer runtime based on
    3.10 +the homomorphic Paillier crypto system.
    3.11 +
    3.12 +From the paper "Public-Key Cryptosystems Based on Composite Degree
    3.13 +Residuosity Classes" by Pascal Paillier in EUROCRYPT 1999, 223-238.
    3.14 +"""
    3.15 +
    3.16  from twisted.internet.defer import Deferred, gatherResults
    3.17  import gmpy
    3.18  
    3.19 @@ -56,6 +65,7 @@
    3.20  
    3.21  
    3.22  class PaillierRuntime(BasicRuntime):
    3.23 +    """Twoplayer runtime based on the Paillier crypto system."""
    3.24  
    3.25      def add_player(self, player, protocol):
    3.26          BasicRuntime.add_player(self, player, protocol)