#ifndef NAMESTORE_H
#define NAMESTORE_H
-/*
- * Collect message types here, move to protocols later
+/**
+ * Maximum length of any name, including 0-termination.
+ */
+#define MAX_NAME_LEN 256
+
+/**
+ * Convert a UTF-8 string to UTF-8 lowercase
+ * @param src source string
+ * @return converted result
+ */
+char *
+GNUNET_NAMESTORE_normalize_string (const char *src);
+
+/**
+ * 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.
*/
-#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_PUT_RESPONSE 434
-#define GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_CREATE 435
-#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 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
-#define GNUNET_MESSAGE_TYPE_NAMESTORE_DISCONNECT 449
+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
- * @param b record
+ * @param a Record a
+ * @param b Record b
*
* @return GNUNET_YES or GNUNET_NO
*/
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
{
};
-/**
- * Connect to namestore service. FIXME: UNNECESSARY.
- */
-struct DisconnectMessage
-{
-
- /**
- * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_DISCONNECT
- */
- struct GNUNET_MessageHeader header;
-
- /**
- * Drop namestore?
- * GNUNET_YES or _NO in NBO
- */
- uint32_t drop;
-};
-
/**
* Generic namestore message with op id
/**
- * Connect to namestore service
+ * Lookup a name in the namestore
*/
struct LookupNameMessage
{
/**
* The zone
*/
- GNUNET_HashCode zone;
+ struct GNUNET_CRYPTO_ShortHashCode zone;
/**
* Requested record type
/**
* Lookup response
- * Memory layout:
- * [struct LookupNameResponseMessage][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData]
*/
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;
+ /**
+ * Is the signature valid
+ * GNUNET_YES or GNUNET_NO
+ */
int16_t contains_sig;
/**
struct GNUNET_CRYPTO_RsaSignature signature;
/**
- *
+ * The public key for the name
*/
struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
/* 0-terminated name and serialized record data */
+ /* rd_len bytes serialized record data */
};
/**
* Put a record to the namestore
- * Memory layout:
- * [struct RecordPutMessage][char *name][rc_count * struct GNUNET_NAMESTORE_RecordData]
*/
struct RecordPutMessage
{
struct GNUNET_NAMESTORE_Header gns_header;
/**
- *
+ * 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;
uint16_t reserved;
/**
- *
+ * The signature
*/
struct GNUNET_CRYPTO_RsaSignature signature;
/**
- *
+ * The public key
*/
struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
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
*/
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
{
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;
*/
uint16_t pkey_len;
- /* followed by: name and serialized record data --- PK??? */
+ /* 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
{
* name length: GNUNET_NO already exists, GNUNET_YES on success, GNUNET_SYSERR error
*/
int32_t op_result;
-
};
/**
* Remove a record from the namestore
* Memory layout:
- * [struct RecordRemoveMessage][char *name][struct GNUNET_NAMESTORE_RecordData]
*/
struct RecordRemoveMessage
{
uint16_t rd_count;
/**
- * Length of pubkey
+ * Length of private key
*/
- uint16_t key_len;
+ 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
+ * */
};
+/**
+ * Removal of the record succeeded.
+ */
+#define RECORD_REMOVE_RESULT_SUCCESS 0
+
+/**
+ * There are NO records for the given name.
+ */
+#define RECORD_REMOVE_RESULT_NO_RECORDS 1
+
+/**
+ * The specific record that was to be removed was
+ * not found.
+ */
+#define RECORD_REMOVE_RESULT_RECORD_NOT_FOUND 2
+
+/**
+ * Internal error, failed to sign the remaining records.
+ * (Note: not used?)
+ */
+#define RECORD_REMOVE_RESULT_FAILED_TO_SIGN 3
+
+/**
+ * Internal error, failed to store the updated record set
+ */
+#define RECORD_REMOVE_RESULT_FAILED_TO_PUT_UPDATE 4
+
+/**
+ * Internal error, failed to remove records from database
+ */
+#define RECORD_REMOVE_RESULT_FAILED_TO_REMOVE 5
+
+/**
+ * Internal error, failed to access database
+ */
+#define RECORD_REMOVE_RESULT_FAILED_ACCESS_DATABASE 6
+
+/**
+ * Internal error, failed to access database
+ */
+#define RECORD_REMOVE_RESULT_FAILED_INTERNAL_ERROR 7
+
+
/**
* Remove a record from the namestore response
*/
struct GNUNET_NAMESTORE_Header gns_header;
/**
- * result:
- * 0 : successful
- * 1 : no records for entry
- * 2 : Could not find record to remove
- * 3 : Failed to create new signature
- * 4 : Failed to put new set of records in database
+ * Result code (see RECORD_REMOVE_RESULT_*). In network byte order.
*/
int32_t op_result;
};
/**
- * Connect to namestore service
+ * 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
*/
- GNUNET_HashCode zone;
+ struct GNUNET_CRYPTO_ShortHashCode zone;
/**
* The hash of the public key of the target zone
*/
- GNUNET_HashCode value_zone;
+ struct GNUNET_CRYPTO_ShortHashCode value_zone;
};
/**
- * Connect to namestore service
+ * 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;
};
*/
struct GNUNET_NAMESTORE_Header gns_header;
- GNUNET_HashCode zone;
+ /**
+ * Zone hash
+ */
+ struct GNUNET_CRYPTO_ShortHashCode zone;
+ /**
+ * Which flags must be included
+ */
uint16_t must_have_flags;
+ /**
+ * Which flags must not be included
+ */
uint16_t must_not_have_flags;
-
};
struct GNUNET_CRYPTO_RsaSignature signature;
/**
- *
+ * The public key
*/
struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
projects / oweals / gnunet.git / blobdiff