add note for the uniqueness of the GNS userSecret

4 files changed, 5 insertions, 1 deletions

diff --git a/src/escrow/escrow_api.c b/src/escrow/escrow_api.c
index 1c81a7f6e..ddbf6a2b7 100644
--- a/src/escrow/escrow_api.c
+++ b/src/escrow/escrow_api.c
@@ -232,6 +232,7 @@ handle_start_escrow_result (void *cls)
  * @param h the handle for the escrow component
  * @param ego the identity ego to put in escrow
  * @param userSecret the user secret (e.g. for derivation of escrow identities)
+ *                   for GNS escrow, this has to be UNIQUE in the whole network!
  * @param method the escrow method to use
  * @param cb function to call with the escrow anchor on completion
  * @param cb_cls closure for @a cb
diff --git a/src/escrow/plugin_escrow_gns.c b/src/escrow/plugin_escrow_gns.c
index 985449625..79b2519fa 100644
--- a/src/escrow/plugin_escrow_gns.c
+++ b/src/escrow/plugin_escrow_gns.c
@@ -996,7 +996,8 @@ continue_start (void *cls)
  * 
  * @param h the handle for the escrow component
  * @param ego the identity ego containing the private key
- * @param userSecret the user secret (e.g. for derivation of escrow identities)
+ * @param userSecret the user secret (used for derivation of escrow identities)
+ *                   this has to be UNIQUE in the whole network!
  * @param cb the function called upon completion
  * @param op_id unique ID of the respective ESCROW_Operation
  * 
diff --git a/src/include/gnunet_escrow_lib.h b/src/include/gnunet_escrow_lib.h
index dabd0d83d..069328151 100644
--- a/src/include/gnunet_escrow_lib.h
+++ b/src/include/gnunet_escrow_lib.h
@@ -281,6 +281,7 @@ GNUNET_ESCROW_fini (
  * @param h the handle for the escrow component
  * @param ego the identity ego to put in escrow
  * @param userSecret the user secret (e.g. for derivation of escrow identities)
+ *                   for GNS escrow, this has to be UNIQUE in the whole network!
  * @param method the escrow method to use
  * @param cb function to call with the escrow anchor on completion
  * @param cb_cls closure for @a cb
diff --git a/src/include/gnunet_escrow_plugin.h b/src/include/gnunet_escrow_plugin.h
index 4387ff613..b54506970 100644
--- a/src/include/gnunet_escrow_plugin.h
+++ b/src/include/gnunet_escrow_plugin.h
@@ -50,6 +50,7 @@ extern "C" {
  * @param h the handle for the escrow component
  * @param ego the identity ego containing the private key
  * @param userSecret the user secret (e.g. for derivation of escrow identities)
+ *                   for GNS escrow, this has to be UNIQUE in the whole network!
  * @param cb the function called upon completion
  * @param op_id unique ID of the respective ESCROW_Operation
  *