diff options
author | Linus Nordberg <linus@nordberg.se> | 2014-05-27 11:28:54 +0200 |
---|---|---|
committer | Linus Nordberg <linus@nordberg.se> | 2014-05-27 11:28:54 +0200 |
commit | 3aff6840c5252dfdd2f34af20e12cc4f9aae5d64 (patch) | |
tree | 34e5d687a1821e911ceaea9472e1190a0dbc6085 | |
parent | ac839ba049d96f2f0a1caaac033defe42cc10624 (diff) |
Improve basic description of plop.
-rw-r--r-- | src/plop.erl | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/src/plop.erl b/src/plop.erl index 9a75465..0b48304 100644 --- a/src/plop.erl +++ b/src/plop.erl @@ -1,12 +1,18 @@ %%% @doc Server holding log entries in a database and hashes in a %%% Merkle tree. A backend for things like Certificate Transparency %%% (RFC 6962). -%%% -%%% When you submit data for insertion in the log, the data and a hash -%%% of it is stored in a way that [mumble FIXME and FIXME]. In return -%%% you will get a proof of your entry being included in the log. This -%%% proof can later, together with the public key of the log, be used -%%% to prove that your entry is indeed present in the log. + +%%% When you submit data for insertion in the log, it's stored in an +%%% append only database with an accompanying Merkle tree. The leaves +%%% of the tree hold hashes of submitted data and makes it possible +%%% for anyone to verify wether a given piece of data is or is not +%%% present in the log. + +%%% In return you will get a signed timestamp which is a promise that +%%% your entry will be present in the log within a certain time period +%%% (the MMD). This signed timestamp can later, together with the +%%% public key of the log, be used to ensure that your entry is indeed +%%% present in the log. -module(plop). -behaviour(gen_server). |