-more debug messages
[oweals/gnunet.git] / src / namestore / namestore.h
index 98a9c5cd1ba5921c0bd43eed24546f86772d6f8b..5a42c14d70abec23f68ff76bc537aac37cf21cc1 100644 (file)
@@ -29,6 +29,7 @@
 /*
  * Collect message types here, move to protocols later
  */
+#define GNUNET_MESSAGE_TYPE_NAMESTORE_START 430
 #define GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME 431
 #define GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_NAME_RESPONSE 432
 #define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT 433
 #define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE_RESPONSE 436
 #define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE 437
 #define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_REMOVE_RESPONSE 438
+#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME 439
+#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE 440
 
-#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START 439
-#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_RESPONSE 440
-#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT 441
-#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP 442
+#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START 445
+#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_RESPONSE 446
+#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT 447
+#define GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP 448
 
 
+/**
+ * Convert a short hash to a string (for printing debug messages).
+ * This is one of the very few calls in the entire API that is
+ * NOT reentrant!
+ *
+ * @param hc the short hash code
+ * @return string form; will be overwritten by next call to GNUNET_h2s.
+ */
+const char *
+GNUNET_short_h2s (const struct GNUNET_CRYPTO_ShortHashCode * hc);
+
+
+/**
+ * Sign name and records
+ *
+ * @param key the private key
+ * @param expire block expiration
+ * @param name the name
+ * @param rd record data
+ * @param rd_count number of records
+ *
+ * @return the signature
+ */
 struct GNUNET_CRYPTO_RsaSignature *
-GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_RsaPrivateKey *key, const char *name, struct GNUNET_NAMESTORE_RecordData *rd, unsigned int rd_count);
+GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_RsaPrivateKey *key,
+    struct GNUNET_TIME_Absolute expire,
+    const char *name,
+    const struct GNUNET_NAMESTORE_RecordData *rd,
+    unsigned int rd_count);
+
+
+/**
+ * Compares if two records are equal
+ *
+ * @param a Record a
+ * @param b Record b
+ *
+ * @return GNUNET_YES or GNUNET_NO
+ */
+int
+GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
+                              const struct GNUNET_NAMESTORE_RecordData *b);
+
 
 GNUNET_NETWORK_STRUCT_BEGIN
 /**
  * A GNS record serialized for network transmission.
- * layout is [struct GNUNET_NAMESTORE_NetworkRecord][char[data_size] data]
+ *
+ * Layout is [struct GNUNET_NAMESTORE_NetworkRecord][char[data_size] data]
  */
 struct GNUNET_NAMESTORE_NetworkRecord
 {
@@ -90,6 +135,7 @@ struct StartMessage
 
 };
 
+
 /**
  * Generic namestore message with op id
  */
@@ -109,27 +155,33 @@ struct GNUNET_NAMESTORE_Header
 
 
 /**
- * Connect to namestore service
+ * Lookup a name in the namestore
  */
 struct LookupNameMessage
 {
   struct GNUNET_NAMESTORE_Header gns_header;
 
-  /* The zone */
-  GNUNET_HashCode zone;
+  /**
+   * The zone 
+   */
+  struct GNUNET_CRYPTO_ShortHashCode zone;
 
-  /* Requested record type */
+  /**
+   * Requested record type 
+   */
   uint32_t record_type;
 
-  /* Requested record type */
+  /**
+   * Length of the name
+   */
   uint32_t name_len;
+
+  /* 0-terminated name here */
 };
 
 
 /**
  * Lookup response
- * Memory layout:
- * [struct LookupNameResponseMessage][struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData][struct GNUNET_CRYPTO_RsaSignature]
  */
 struct LookupNameResponseMessage
 {
@@ -138,24 +190,50 @@ struct LookupNameResponseMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
+  /**
+   * Expiration time
+   */
   struct GNUNET_TIME_AbsoluteNBO expire;
 
+
+  /**
+   * Name length
+   */
   uint16_t name_len;
 
+  /**
+   * Bytes of serialized record data
+   */
   uint16_t rd_len;
 
+  /**
+   * Number of records contained
+   */
   uint16_t rd_count;
 
-  int32_t contains_sig;
+  /**
+   * Is the signature valid
+   * GNUNET_YES or GNUNET_NO
+   */
+  int16_t contains_sig;
+
+  /**
+   * All zeros if 'contains_sig' is GNUNET_NO.
+   */
+  struct GNUNET_CRYPTO_RsaSignature signature;
+
+  /**
+   * The public key for the name
+   */
+  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
 
-  /* Requested record type */
+  /* 0-terminated name and serialized record data */
+  /* rd_len bytes serialized record data */
 };
 
 
 /**
  * Put a record to the namestore
- * Memory layout:
- * [struct RecordPutMessage][struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData]
  */
 struct RecordPutMessage
 {
@@ -164,23 +242,43 @@ struct RecordPutMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
-  /* Contenct starts here */
+  /**
+   * Expiration time
+   */
+  struct GNUNET_TIME_AbsoluteNBO expire;
 
-  /* name length */
+  /**
+   * Name length
+   */
   uint16_t name_len;
 
-  /* Length of serialized rd data */
+  /**
+   * Length of serialized record data
+   */
   uint16_t rd_len;
 
-  /* Number of records contained */
+  /**
+   * Number of records contained 
+   */
   uint16_t rd_count;
 
-  /* Length of pubkey */
-  uint16_t key_len;
-
-  struct GNUNET_TIME_AbsoluteNBO expire;
+  /**
+   * always zero (for alignment)
+   */
+  uint16_t reserved;
 
+  /**
+   * The signature
+   */
   struct GNUNET_CRYPTO_RsaSignature signature;
+
+  /**
+   * The public key
+   */
+  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
+
+  /* name (0-terminated) followed by "rd_count" serialized records */
+
 };
 
 
@@ -192,26 +290,20 @@ struct RecordPutResponseMessage
   /**
    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_PUT_RESPONSE
    */
-  struct GNUNET_MessageHeader header;
-
-  /**
-   * Operation ID in NBO
-   */
-  uint32_t op_id;
-
-  /* Contenct starts here */
+  struct GNUNET_NAMESTORE_Header gns_header;
 
   /**
-   *  name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success
+   * result:
+   * GNUNET_SYSERR on failure
+   * GNUNET_OK on success
    */
-  uint16_t op_result;
+  int32_t op_result;
 };
 
 
 /**
  * Create a record and put it to the namestore
  * Memory layout:
- * [struct RecordCreateMessage][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData]
  */
 struct RecordCreateMessage
 {
@@ -220,25 +312,38 @@ struct RecordCreateMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
-  /* Contenct starts here */
+  struct GNUNET_TIME_AbsoluteNBO expire;
 
-  /* name length */
+  /**
+   * Name length
+   */
   uint16_t name_len;
 
-  /* Record data length */
+  /**
+   * Length of serialized record data
+   */
   uint16_t rd_len;
 
-  /* Record count */
+  /**
+   * Record count 
+   */
   uint16_t rd_count;
 
-  /* private key length */
+  /**
+   * private key length 
+   */
   uint16_t pkey_len;
+
+  /* followed by:
+   * GNUNET_CRYPTO_RsaPrivateKeyBinaryEncoded private key with length pkey_len
+   * name with length name_len
+   * serialized record data with length rd_len
+   * */
 };
 
 
 /**
  * Create a record to the namestore response
- * Memory layout:
  */
 struct RecordCreateResponseMessage
 {
@@ -247,20 +352,16 @@ struct RecordCreateResponseMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
-  /* Contenct starts here */
-
   /**
-   *  name length: GNUNET_NO (0) on error, GNUNET_OK (1) on success
+   *  name length: GNUNET_NO already exists, GNUNET_YES on success, GNUNET_SYSERR error
    */
-  uint16_t op_result;
-
-
+  int32_t op_result;
 };
 
+
 /**
  * Remove a record from the namestore
  * Memory layout:
- * [struct RecordRemoveMessage][char *name][struct GNUNET_NAMESTORE_RecordData]
  */
 struct RecordRemoveMessage
 {
@@ -269,27 +370,37 @@ struct RecordRemoveMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
-  /* Contenct starts here */
-
-  /* Name length */
+  /**
+   * Name length 
+   */
   uint16_t name_len;
 
-  /* Length of serialized rd data */
+  /**
+   * Length of serialized rd data 
+   */
   uint16_t rd_len;
 
-  /* Number of records contained */
+  /**
+   * Number of records contained 
+   */
   uint16_t rd_count;
 
-  /* Length of pubkey */
-  uint16_t key_len;
+  /**
+   * Length of private key
+   */
+  uint16_t pkey_len;
+
+  /* followed by:
+   * GNUNET_CRYPTO_RsaPrivateKeyBinaryEncoded private key with length pkey_len
+   * name with length name_len
+   * serialized record data with length rd_len
+   * */
 };
-GNUNET_NETWORK_STRUCT_END
 
 
 /**
  * Remove a record from the namestore response
  */
-GNUNET_NETWORK_STRUCT_BEGIN
 struct RecordRemoveResponseMessage
 {
   /**
@@ -297,8 +408,6 @@ struct RecordRemoveResponseMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
-  /* Contenct starts here */
-
   /**
    *  result:
    *  0 : successful
@@ -307,15 +416,81 @@ struct RecordRemoveResponseMessage
    *  3 : Failed to create new signature
    *  4 : Failed to put new set of records in database
    */
-  uint16_t op_result;
+  int32_t op_result;
+};
+
+
+/**
+ * Lookup a name for a zone hash
+ */
+struct ZoneToNameMessage
+{
+  /**
+   * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
+   */
+  struct GNUNET_NAMESTORE_Header gns_header;
+
+  /**
+   * The hash of public key of the zone to look up in 
+   */
+  struct GNUNET_CRYPTO_ShortHashCode zone;
+
+  /**
+   * The  hash of the public key of the target zone  
+   */
+  struct GNUNET_CRYPTO_ShortHashCode value_zone;
+};
+
+/**
+ * Respone for zone to name lookup
+ */
+struct ZoneToNameResponseMessage
+{
+  /**
+   * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
+   */
+  struct GNUNET_NAMESTORE_Header gns_header;
+
+  /**
+   * Record block expiration
+   */
+  struct GNUNET_TIME_AbsoluteNBO expire;
+
+  /**
+   * Length of the name
+   */
+  uint16_t name_len;
+
+  /**
+   * Length of serialized record data
+   */
+  uint16_t rd_len;
+
+  /**
+   * Number of records contained
+   */
+  uint16_t rd_count;
+
+  /* result in NBO: GNUNET_OK on success, GNUNET_NO if there were no results, GNUNET_SYSERR on error */
+  int16_t res;
+
+  /**
+   * Signature
+   */
+  struct GNUNET_CRYPTO_RsaSignature signature;
+
+  /**
+   * Publik key
+   */
+  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded zone_key;
+
 };
-GNUNET_NETWORK_STRUCT_END
+
 
 
 /**
  * Start a zone iteration for the given zone
  */
-GNUNET_NETWORK_STRUCT_BEGIN
 struct ZoneIterationStartMessage
 {
   /**
@@ -323,19 +498,26 @@ struct ZoneIterationStartMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
-  /* Contenct starts here */
+  /**
+   * Zone hash
+   */
+  struct GNUNET_CRYPTO_ShortHashCode zone;
 
+  /**
+   * Which flags must be included
+   */
   uint16_t must_have_flags;
-  uint16_t must_not_have_flags;
 
-  GNUNET_HashCode zone;
+  /**
+   * Which flags must not be included
+   */
+  uint16_t must_not_have_flags;
 };
-GNUNET_NETWORK_STRUCT_END
+
 
 /**
  * Ask for next result of zone iteration for the given operation
  */
-GNUNET_NETWORK_STRUCT_BEGIN
 struct ZoneIterationNextMessage
 {
   /**
@@ -343,13 +525,11 @@ struct ZoneIterationNextMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 };
-GNUNET_NETWORK_STRUCT_END
 
 
 /**
  * Stop zone iteration for the given operation
  */
-GNUNET_NETWORK_STRUCT_BEGIN
 struct ZoneIterationStopMessage
 {
   /**
@@ -357,12 +537,12 @@ struct ZoneIterationStopMessage
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 };
-GNUNET_NETWORK_STRUCT_END
 
 /**
- * Ask for next result of zone iteration for the given operation
+ * Next result of zone iteration for the given operation
+ * // FIXME: use 'struct LookupResponseMessage' instead? (identical except
+ * for having 'contains_sig' instead of 'reserved', but fully compatible otherwise).
  */
-GNUNET_NETWORK_STRUCT_BEGIN
 struct ZoneIterationResponseMessage
 {
   /**
@@ -374,11 +554,31 @@ struct ZoneIterationResponseMessage
 
   uint16_t name_len;
 
-  uint16_t contains_sig;
-
   /* Record data length */
   uint16_t rd_len;
 
+  /**
+   * Number of records contained 
+   */
+  uint16_t rd_count;
+
+  /**
+   * always zero (for alignment)
+   */
+  uint16_t reserved;
+
+  /**
+   * All zeros if 'contains_sig' is GNUNET_NO.
+   */
+  struct GNUNET_CRYPTO_RsaSignature signature;
+
+  /**
+   * The public key
+   */
+  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
+
 };
 GNUNET_NETWORK_STRUCT_END