From 922bed5ac575b444ea773f953511020865f015a5 Mon Sep 17 00:00:00 2001 From: Vincent Hanquez Date: Fri, 2 Dec 2016 15:03:19 +0000 Subject: [PATCH] add some documentation to ECIES --- Crypto/PubKey/ECIES.hs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Crypto/PubKey/ECIES.hs b/Crypto/PubKey/ECIES.hs index e26cf14..cd3aac8 100644 --- a/Crypto/PubKey/ECIES.hs +++ b/Crypto/PubKey/ECIES.hs @@ -7,6 +7,18 @@ -- -- IES with Elliptic curve -- +-- This is a simple cryptographic system between 2 parties using Elliptic Curve. +-- +-- The sending party create a shared secret using the receiver public key, and use the shared secret +-- to generate cryptographic material for an symmetric encryption scheme (preferably authenticated encryption). +-- +-- The receiving party receive the temporary ephemeral public key which is combined to its secret key +-- to create the shared secret which just like on the sending is used to generate cryptographic material. +-- +-- This module doesn't provide any symmetric data encryption capability or any mean to derive +-- cryptographic key material for a symmetric key from the shared secret. +-- this is left to the user for now. +-- module Crypto.PubKey.ECIES ( deriveEncrypt , deriveDecrypt