- fix encryption/decryption visisbility
[oweals/gnunet.git] / src / include / gnunet_namestore_service.h
index 99fc7dcd1d65039559a3109aa6b454d4888d3ccb..c31c3689bc90ab2e6a07d0a8f68c0aa499ff49f7 100644 (file)
@@ -67,15 +67,21 @@ extern "C"
 #define GNUNET_NAMESTORE_TYPE_VPN 65539
 
 /**
- * Record type for zone revocation
+ * Record type for delegation to DNS.
  */
-#define GNUNET_NAMESTORE_TYPE_REV 65540
+#define GNUNET_NAMESTORE_TYPE_GNS2DNS 65540
 
 /**
  * Record type for a social place.
  */
 #define GNUNET_NAMESTORE_TYPE_PLACE 65541
 
+/**
+ * Record type for a phone (of CONVERSATION).
+ */
+#define GNUNET_NAMESTORE_TYPE_PHONE 65542
+
+
 /**
  * Entry in the queue.
  */
@@ -109,7 +115,8 @@ GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 /**
  * Disconnect from the namestore service (and free associated
- * resources).
+ * resources).  Must not be called from within operation callbacks of
+ * the API.
  *
  * @param h handle to the namestore
  */
@@ -122,9 +129,9 @@ GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h);
  * operation.
  *
  * @param cls closure
- * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
- *                GNUNET_NO if content was already there or not found
- *                GNUNET_YES (or other positive value) on success
+ * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
+ *                #GNUNET_NO if content was already there or not found
+ *                #GNUNET_YES (or other positive value) on success
  * @param emsg NULL on success, otherwise an error message
  */
 typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
@@ -137,7 +144,7 @@ typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
  */
 enum GNUNET_NAMESTORE_RecordFlags
 {
-  
+
   /**
    * No special options.
    */
@@ -176,7 +183,7 @@ enum GNUNET_NAMESTORE_RecordFlags
    * pass the '--private' option when removing a record from
    * the namestore, hence we don't require this particular option
    * to match upon removal).  See also
-   * 'GNUNET_NAMESTORE_records_cmp'.
+   * #GNUNET_NAMESTORE_records_cmp.
    */
 #define GNUNET_NAMESTORE_RF_RCMP_FLAGS (GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION)
 };
@@ -232,19 +239,19 @@ struct GNUNET_NAMESTORE_Block
   /**
    * Signature of the block.
    */
-  struct GNUNET_CRYPTO_EccSignature signature;
+  struct GNUNET_CRYPTO_EcdsaSignature signature;
 
   /**
    * Derived key used for signing; hash of this is the query.
    */
-  struct GNUNET_CRYPTO_EccPublicKey derived_key;
+  struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
 
   /**
    * Number of bytes signed; also specifies the number of bytes
    * of encrypted data that follow.
    */
   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
-  
+
   /**
    * Expiration time of the block.
    */
@@ -253,11 +260,13 @@ struct GNUNET_NAMESTORE_Block
   /* followed by encrypted data */
 };
 
+
+
 GNUNET_NETWORK_STRUCT_END
 
 /**
  * Store an item in the namestore.  If the item is already present,
- * it is replaced with the new record.  
+ * it is replaced with the new record.
  *
  * @param h handle to the namestore
  * @param block block to store
@@ -288,7 +297,7 @@ GNUNET_NAMESTORE_block_cache (struct GNUNET_NAMESTORE_Handle *h,
  */
 struct GNUNET_NAMESTORE_QueueEntry *
 GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h,
-                               const struct GNUNET_CRYPTO_EccPrivateKey *pkey,
+                               const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
                                const char *label,
                                unsigned int rd_count,
                                const struct GNUNET_NAMESTORE_RecordData *rd,
@@ -308,17 +317,18 @@ typedef void (*GNUNET_NAMESTORE_BlockProcessor) (void *cls,
 
 /**
  * Get a result for a particular key from the namestore.  The processor
- * will only be called once.  
+ * will only be called once.
  *
  * @param h handle to the namestore
  * @param derived_hash hash of zone key combined with name to lookup
+ *        then at the end once with NULL
  * @param proc function to call on the matching block, or with
  *        NULL if there is no matching block
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  * @return a handle that can be used to cancel
  */
 struct GNUNET_NAMESTORE_QueueEntry *
-GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h, 
+GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h,
                               const struct GNUNET_HashCode *derived_hash,
                               GNUNET_NAMESTORE_BlockProcessor proc, void *proc_cls);
 
@@ -327,13 +337,13 @@ GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h,
  * Process a record that was stored in the namestore.
  *
  * @param cls closure
- * @param zone private key of the zone
- * @param label label of the records
- * @param rd_count number of entries in @a rd array
+ * @param zone private key of the zone; NULL on disconnect
+ * @param label label of the records; NULL on disconnect
+ * @param rd_count number of entries in @a rd array, 0 if label was deleted
  * @param rd array of records with data to store
  */
 typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
-                                               const struct GNUNET_CRYPTO_EccPrivateKey *zone,
+                                               const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
                                                const char *label,
                                                unsigned int rd_count,
                                                const struct GNUNET_NAMESTORE_RecordData *rd);
@@ -348,14 +358,14 @@ typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
  * @param value_zone public key of the target zone (value), never NULL
  * @param proc function to call on the matching records, or with
  *        NULL (rd_count == 0) if there are no matching records
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  * @return a handle that can be used to
  *         cancel
  */
 struct GNUNET_NAMESTORE_QueueEntry *
-GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, 
-                              const struct GNUNET_CRYPTO_EccPrivateKey *zone,
-                              const struct GNUNET_CRYPTO_EccPublicKey *value_zone,
+GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
+                              const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
+                              const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
                               GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls);
 
 
@@ -401,7 +411,7 @@ GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
  */
 struct GNUNET_NAMESTORE_ZoneIterator *
 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
-                                      const struct GNUNET_CRYPTO_EccPrivateKey *zone,
+                                      const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
                                       GNUNET_NAMESTORE_RecordMonitor proc,
                                       void *proc_cls);
 
@@ -434,7 +444,7 @@ struct GNUNET_NAMESTORE_ZoneMonitor;
 
 
 /**
- * Function called once the monitor has caught up with the current 
+ * Function called once the monitor has caught up with the current
  * state of the database.  Will be called AGAIN after each disconnect
  * (record monitor called with 'NULL' for zone_key) once we're again
  * in sync.
@@ -456,12 +466,12 @@ typedef void (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
  * @param zone zone to monitor
  * @param monitor function to call on zone changes
  * @param sync_cb function called when we're in sync with the namestore
- * @param cls closure for @a monitor' and @a sync_cb
+ * @param cls closure for @a monitor and @a sync_cb
  * @return handle to stop monitoring
  */
 struct GNUNET_NAMESTORE_ZoneMonitor *
 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                                    const struct GNUNET_CRYPTO_EccPrivateKey *zone,
+                                    const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
                                     GNUNET_NAMESTORE_RecordMonitor monitor,
                                     GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb,
                                     void *cls);
@@ -524,7 +534,7 @@ GNUNET_NAMESTORE_records_deserialize (size_t len,
 
 
 /**
- * Convert the binary value @a data of a record of 
+ * Convert the binary value @a data of a record of
  * type @a type to a human-readable string.
  *
  * @param type type of the record
@@ -558,11 +568,11 @@ GNUNET_NAMESTORE_string_to_value (uint32_t type,
 /**
  * Convert a type name (i.e. "AAAA") to the corresponding number.
  *
- * @param typename name to convert
+ * @param dns_typename name to convert
  * @return corresponding number, UINT32_MAX on error
  */
 uint32_t
-GNUNET_NAMESTORE_typename_to_number (const char *typename);
+GNUNET_NAMESTORE_typename_to_number (const char *dns_typename);
 
 
 /**
@@ -577,7 +587,7 @@ GNUNET_NAMESTORE_number_to_typename (uint32_t type);
 
 /**
  * Test if a given record is expired.
- * 
+ *
  * @param rd record to test
  * @return #GNUNET_YES if the record is expired,
  *         #GNUNET_NO if not
@@ -604,59 +614,59 @@ GNUNET_NAMESTORE_normalize_string (const char *src);
  * @return string form; will be overwritten by next call to #GNUNET_NAMESTORE_z2s.
  */
 const char *
-GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z);
+GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EcdsaPublicKey *z);
 
 
 /**
  * Convert public key to the respective absolute domain name in the
- * ".zkey" pTLD. 
+ * ".zkey" pTLD.
  * This is one of the very few calls in the entire API that is
  * NOT reentrant!
- * 
- * @param pkey a public key with (x,y) on the eliptic curve 
- * @return string "Y.X.zkey" where X and Y are the coordinates of the public
+ *
+ * @param pkey a public key with a point on the eliptic curve
+ * @return string "X.zkey" where X is the coordinates of the public
  *         key in an encoding suitable for DNS labels.
  */
 const char *
-GNUNET_NAMESTORE_pkey_to_zkey (const struct GNUNET_CRYPTO_EccPublicKey *pkey);
+GNUNET_NAMESTORE_pkey_to_zkey (const struct GNUNET_CRYPTO_EcdsaPublicKey *pkey);
 
 
 /**
  * Convert an absolute domain name in the ".zkey" pTLD to the
  * respective public key.
- * 
- * @param zkey string "Y.X.zkey" where X and Y are the coordinates of the public
+ *
+ * @param zkey string "X.zkey" where X is the public
  *         key in an encoding suitable for DNS labels.
- * @param pkey set to a public key with (x,y) on the eliptic curve 
+ * @param pkey set to a public key on the eliptic curve
  * @return #GNUNET_SYSERR if @a zkey has the wrong syntax
  */
 int
 GNUNET_NAMESTORE_zkey_to_pkey (const char *zkey,
-                              struct GNUNET_CRYPTO_EccPublicKey *pkey);
+                              struct GNUNET_CRYPTO_EcdsaPublicKey *pkey);
 
 
 /**
  * Calculate the DHT query for a given @a label in a given @a zone.
- * 
+ *
  * @param zone private key of the zone
  * @param label label of the record
  * @param query hash to use for the query
  */
 void
-GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKey *zone,
+GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
                                         const char *label,
                                         struct GNUNET_HashCode *query);
 
 
 /**
  * Calculate the DHT query for a given @a label in a given @a zone.
- * 
+ *
  * @param pub public key of the zone
  * @param label label of the record
  * @param query hash to use for the query
  */
 void
-GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey *pub,
+GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EcdsaPublicKey *pub,
                                        const char *label,
                                        struct GNUNET_HashCode *query);
 
@@ -671,7 +681,7 @@ GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey
  * @param rd_count number of records in @a rd
  */
 struct GNUNET_NAMESTORE_Block *
-GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key,
+GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EcdsaPrivateKey *key,
                               struct GNUNET_TIME_Absolute expire,
                               const char *label,
                               const struct GNUNET_NAMESTORE_RecordData *rd,
@@ -697,12 +707,12 @@ GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block);
  * @param label the name for the records
  * @param proc function to call with the result
  * @param proc_cls closure for @a proc
- * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was 
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
  *        not well-formed
  */
 int
 GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block,
-                               const struct GNUNET_CRYPTO_EccPublicKey *zone_key,
+                               const struct GNUNET_CRYPTO_EcdsaPublicKey *zone_key,
                                const char *label,
                                GNUNET_NAMESTORE_RecordCallback proc,
                                void *proc_cls);
@@ -712,7 +722,7 @@ GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block,
  * Compares if two records are equal
  *
  * @param a a record
- * @param b another record 
+ * @param b another record
  * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
  */
 int
@@ -722,15 +732,15 @@ GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
 
 /**
  * Returns the expiration time of the given block of records. The block
- * expiration time is the expiration time of the block with smallest
+ * expiration time is the expiration time of the record with smallest
  * expiration time.
  *
  * @param rd_count number of records given in @a rd
- * @param rd array of records 
+ * @param rd array of records
  * @return absolute expiration time
  */
 struct GNUNET_TIME_Absolute
-GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count, 
+GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count,
                                             const struct GNUNET_NAMESTORE_RecordData *rd);