+
/*
This file is part of GNUnet
(C) 2012, 2013 Christian Grothoff (and other contributing authors)
#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.
*/
/**
* 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
*/
* 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,
*/
enum GNUNET_NAMESTORE_RecordFlags
{
-
+
/**
* No special options.
*/
GNUNET_NAMESTORE_RF_NONE = 0,
- /**
- * This peer is the authority for this record; it must thus
- * not be deleted (other records can be deleted if we run
- * out of space).
- */
- GNUNET_NAMESTORE_RF_AUTHORITY = 1,
-
/**
* This is a private record of this peer and it should
* thus not be handed out to other peers.
GNUNET_NAMESTORE_RF_PRIVATE = 2,
/**
- * This record was added by the system
- * and is pending user confimation
+ * This record was added automatically by the system
+ * and is pending user confimation.
*/
GNUNET_NAMESTORE_RF_PENDING = 4,
* 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)
};
{
/**
- * Binary value stored in the DNS record.
- * FIXME: goofy API: sometimes 'data' is individually
- * 'malloc'ed, sometimes it points into some existing
- * data area (so sometimes this should be a 'void *',
- * sometimes a 'const void *'). This is unclean. We
- * should go over the code and make sure that 'data'
- * is NEVER individually alloc'ed here but always points
- * to some "other" location.
+ * Binary value stored in the DNS record. Note: "data" must never
+ * be individually 'malloc'ed, but instead always points into some
+ * existing data area.
*/
const void *data;
/**
* Expiration time for the DNS record. Can be relative
- * or absolute, depending on 'flags'.
+ * or absolute, depending on 'flags'. Measured in the same
+ * unit as GNUnet time (microseconds).
*/
uint64_t expiration_time;
/**
* 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.
*/
/* 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
* @param cont continuation to call when done
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
* @return handle to abort the request
*/
struct GNUNET_NAMESTORE_QueueEntry *
* @param rd_count number of records in the 'rd' array
* @param rd array of records with data to store
* @param cont continuation to call when done
- * @param cont_cls closure for 'cont'
+ * @param cont_cls closure for @a cont
* @return handle to abort the request
*/
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,
/**
* 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);
* 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 '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);
* @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);
/**
* Starts a new zone iteration (used to periodically PUT all of our
- * records into our DHT). @a proc will be called once immediately, and
- * then again after #GNUNET_NAMESTORE_zone_iterator_next is invoked.
+ * records into our DHT). This MUST lock the struct GNUNET_NAMESTORE_Handle
+ * for any other calls than #GNUNET_NAMESTORE_zone_iterator_next and
+ * #GNUNET_NAMESTORE_zone_iteration_stop. @a proc will be called once
+ * immediately, and then again after
+ * #GNUNET_NAMESTORE_zone_iterator_next is invoked.
*
* @param h handle to the namestore
- * @param zone zone to access
+ * @param zone zone to access, NULL for all zones
* @param proc function to call on each name from the zone; it
* will be called repeatedly with a value (if available)
* and always once at the end with a name of NULL.
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
* @return an iterator handle to use for iteration
*/
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);
/**
- * Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start
+ * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start
* for the next record.
*
* @param it the iterator
/**
- * 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.
/**
- * Begin monitoring a zone for changes. Will first call the 'monitor' function
- * on all existing records in the selected zone(s), then calls 'sync_cb',
- * and then calls the 'monitor' whenever a record changes. If the namestore
- * disconnects, the 'monitor' function is called with a disconnect event; if
+ * Begin monitoring a zone for changes. Will first call the @a monitor function
+ * on all existing records in the selected zone(s), then calls @a sync_cb,
+ * and then calls the @a monitor whenever a record changes. If the namestore
+ * disconnects, the @a monitor function is called with a disconnect event; if
* the connection is re-established, the process begins from the start (all
* existing records, sync, then updates).
*
* @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 'monitor' and '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);
* Calculate how many bytes we will need to serialize the given
* records.
*
- * @param rd_count number of records in the rd array
+ * @param rd_count number of records in the @a rd array
* @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
- *
* @return the required size to serialize
- *
*/
size_t
GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
/**
* Serialize the given records to the given destination buffer.
*
- * @param rd_count number of records in the rd array
+ * @param rd_count number of records in the @a rd array
* @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
- * @param dest_size size of the destination array
+ * @param dest_size size of the destination array @a dst
* @param dest where to write the result
* @return the size of serialized records, -1 if records do not fit
*/
*
* @param len size of the serialized record data
* @param src the serialized record data
- * @param rd_count number of records in the rd array
+ * @param rd_count number of records in the @a dest array
* @param dest where to put the data
- *
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_NAMESTORE_records_deserialize (size_t len,
/**
- * Convert the 'value' of a record to a string.
+ * Convert the binary value @a data of a record of
+ * type @a type to a human-readable string.
*
* @param type type of the record
* @param data value in binary encoding
- * @param data_size number of bytes in data
+ * @param data_size number of bytes in @a data
* @return NULL on error, otherwise human-readable representation of the value
*/
char *
/**
- * Convert human-readable version of a 'value' of a record to the binary
- * representation.
+ * Convert human-readable version of the value @a s of a record
+ * of type @a type to the respective binary representation.
*
* @param type type of the record
* @param s human-readable string
* @param data set to value in binary encoding (will be allocated)
- * @param data_size set to number of bytes in data
- * @return GNUNET_OK on success
+ * @param data_size set to number of bytes in @a data
+ * @return #GNUNET_OK on success
*/
int
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);
/**
/**
* Test if a given record is expired.
- *
+ *
* @param rd record to test
* @return #GNUNET_YES if the record is expired,
* #GNUNET_NO if not
* @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.
+ * This is one of the very few calls in the entire API that is
+ * NOT reentrant!
+ *
+ * @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_EcdsaPublicKey *pkey);
+
+
+/**
+ * Convert an absolute domain name in the ".zkey" pTLD to the
+ * respective public key.
+ *
+ * @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 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_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);
* @param expire block expiration
* @param label the name for the records
* @param rd record data
- * @param rd_count number of records
+ * @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,
* @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);
* 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
/**
* 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 'rd'
+ * @param rd_count number of records given in @a rd
* @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);
projects / oweals / gnunet.git / blobdiff