- fixed string to address parsing
[oweals/gnunet.git] / src / include / gnunet_namestore_service.h
index fbc2a4b3c5982875cbec7331745e174af5f41b2a..a484601a5a29d75e142172b55f1c210539c125fa 100644 (file)
@@ -43,6 +43,11 @@ extern "C"
 #endif
 #endif
 
+/**
+ * Record type indicating any record/'*'
+ */
+#define GNUNET_NAMESTORE_TYPE_ANY 0
+
 /**
  * Record type for GNS zone transfer ("PKEY").
  */
@@ -53,6 +58,11 @@ extern "C"
  */
 #define GNUNET_NAMESTORE_TYPE_PSEU 65537
 
+/**
+ * Record type for GNS legacy hostnames ("LEHO").
+ */
+#define GNUNET_NAMESTORE_TYPE_LEHO 65538
+
 /**
  * Entry in the queue.
  */
@@ -133,7 +143,13 @@ enum GNUNET_NAMESTORE_RecordFlags
    * This is a private record of this peer and it should
    * thus not be handed out to other peers.
    */
-  GNUNET_NAMESTORE_RF_PRIVATE = 2
+  GNUNET_NAMESTORE_RF_PRIVATE = 2,
+
+  /**
+   * This record was added by the system
+   * and is pending user confimation
+   */
+  GNUNET_NAMESTORE_RF_PENDING = 4
 
 };
 
@@ -180,7 +196,7 @@ struct GNUNET_NAMESTORE_RecordData
  * @param h handle to the namestore
  * @param zone_key public key of the zone
  * @param name name that is being mapped (at most 255 characters long)
- * @param expire when does the corresponding block in the DHT expire (until
+ * @param freshness when does the corresponding block in the DHT expire (until
  *               when should we never do a DHT lookup for the same name again)?
  * @param rd_count number of entries in 'rd' array
  * @param rd array of records with data to store
@@ -193,7 +209,7 @@ struct GNUNET_NAMESTORE_QueueEntry *
 GNUNET_NAMESTORE_record_put (struct GNUNET_NAMESTORE_Handle *h,
                             const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
                             const char *name,
-                            struct GNUNET_TIME_Absolute expire,
+                            struct GNUNET_TIME_Absolute freshness,
                             unsigned int rd_count,
                             const struct GNUNET_NAMESTORE_RecordData *rd,
                             const struct GNUNET_CRYPTO_RsaSignature *signature,
@@ -215,7 +231,7 @@ GNUNET_NAMESTORE_record_put (struct GNUNET_NAMESTORE_Handle *h,
  */
 int
 GNUNET_NAMESTORE_verify_signature (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *public_key,
-                                   const struct GNUNET_TIME_Absolute expire,
+                                   const struct GNUNET_TIME_Absolute freshness,
                                    const char *name,
                                    unsigned int rd_count,
                                    const struct GNUNET_NAMESTORE_RecordData *rd,
@@ -229,7 +245,6 @@ GNUNET_NAMESTORE_verify_signature (const struct GNUNET_CRYPTO_RsaPublicKeyBinary
  *
  * @param h handle to the namestore
  * @param pkey private key of the zone
- * @param expire block expiration time
  * @param name name that is being mapped (at most 255 characters long)
  * @param rd record data to store
  * @param cont continuation to call when done
@@ -255,7 +270,7 @@ GNUNET_NAMESTORE_record_create (struct GNUNET_NAMESTORE_Handle *h,
  * @param h handle to the namestore
  * @param pkey private key of the zone
  * @param name name that is being mapped (at most 255 characters long)
- * @param rd record data
+ * @param rd record data, remove specific record,  NULL to remove the name and all records
  * @param cont continuation to call when done
  * @param cont_cls closure for cont
  * @return handle to abort the request
@@ -287,7 +302,7 @@ GNUNET_NAMESTORE_record_remove (struct GNUNET_NAMESTORE_Handle *h,
  */
 typedef void (*GNUNET_NAMESTORE_RecordProcessor) (void *cls,
                                                  const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
-                                                 struct GNUNET_TIME_Absolute expire,                       
+                                                 struct GNUNET_TIME_Absolute freshness,                            
                                                  const char *name,
                                                  unsigned int rd_len,
                                                  const struct GNUNET_NAMESTORE_RecordData *rd,
@@ -310,7 +325,7 @@ typedef void (*GNUNET_NAMESTORE_RecordProcessor) (void *cls,
  */
 struct GNUNET_NAMESTORE_QueueEntry *
 GNUNET_NAMESTORE_lookup_record (struct GNUNET_NAMESTORE_Handle *h, 
-                             const GNUNET_HashCode *zone,
+                             const struct GNUNET_CRYPTO_ShortHashCode *zone,
                              const char *name,
                              uint32_t record_type,
                              GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls);
@@ -331,17 +346,15 @@ GNUNET_NAMESTORE_lookup_record (struct GNUNET_NAMESTORE_Handle *h,
  */
 struct GNUNET_NAMESTORE_QueueEntry *
 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, 
-                              const GNUNET_HashCode *zone,
-                              const GNUNET_HashCode *value_zone,
+                              const struct GNUNET_CRYPTO_ShortHashCode *zone,
+                              const struct GNUNET_CRYPTO_ShortHashCode *value_zone,
                               GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls);
 
 
 
 /**
  * Starts a new zone iteration (used to periodically PUT all of our
- * records into our DHT). This MUST lock the GNUNET_NAMESTORE_Handle
- * for any other calls than GNUNET_NAMESTORE_zone_iterator_next and
- * GNUNET_NAMESTORE_zone_iteration_stop.  "proc" will be called once
+ * records into our DHT). "proc" will be called once
  * immediately, and then again after
  * "GNUNET_NAMESTORE_zone_iterator_next" is invoked.
  *
@@ -357,7 +370,7 @@ GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
  */
 struct GNUNET_NAMESTORE_ZoneIterator *
 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
-                                      const GNUNET_HashCode *zone,
+                                      const struct GNUNET_CRYPTO_ShortHashCode *zone,
                                       enum GNUNET_NAMESTORE_RecordFlags must_have_flags,
                                       enum GNUNET_NAMESTORE_RecordFlags must_not_have_flags,
                                       GNUNET_NAMESTORE_RecordProcessor proc,
@@ -444,6 +457,14 @@ GNUNET_NAMESTORE_records_deserialize (size_t len,
                                      struct GNUNET_NAMESTORE_RecordData *dest);
 
 
+/**
+ * Checks if a name is wellformed
+ *
+ * @param name the name to check
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ */
+int
+GNUNET_NAMESTORE_check_name (const char * name);
 
 /**
  * Convert the 'value' of a record to a string.