blob: fee3c64b18f074c5ca54d88f9ce04307a7b554d0 [file] [log] [blame]
/**
* Copyright (C) 2013 Regents of the University of California.
* @author: Jeff Thompson <jefft0@remap.ucla.edu>
* See COPYING for copyright and distribution information.
*/
#ifndef NDN_KEY_H
#define NDN_KEY_H
#include "name.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef enum {
ndn_KeyLocatorType_KEY = 1,
ndn_KeyLocatorType_CERTIFICATE = 2,
ndn_KeyLocatorType_KEYNAME = 3
} ndn_KeyLocatorType;
typedef enum {
ndn_KeyNameType_PUBLISHER_PUBLIC_KEY_DIGEST = 1,
ndn_KeyNameType_PUBLISHER_CERTIFICATE_DIGEST = 2,
ndn_KeyNameType_PUBLISHER_ISSUER_KEY_DIGEST = 3,
ndn_KeyNameType_PUBLISHER_ISSUER_CERTIFICATE_DIGEST = 4
} ndn_KeyNameType;
/**
* An ndn_KeyLocator holds the type of key locator and related data.
*/
struct ndn_KeyLocator {
ndn_KeyLocatorType type; /**< -1 for none */
unsigned char *keyData; /**< A pointer to a pre-allocated buffer for the key data as follows:
* If type is ndn_KeyLocatorType_KEY, the key data.
* If type is ndn_KeyLocatorType_CERTIFICATE, the certificate data.
* If type is ndn_KeyLocatorType_KEYNAME and keyNameType is ndn_KeyNameType_PUBLISHER_PUBLIC_KEY_DIGEST, the publisher public key digest.
* If type is ndn_KeyLocatorType_KEYNAME and keyNameType is ndn_KeyNameType_PUBLISHER_CERTIFICATE_DIGEST, the publisher certificate digest.
* If type is ndn_KeyLocatorType_KEYNAME and keyNameType is ndn_KeyNameType_PUBLISHER_ISSUER_KEY_DIGEST, the publisher issuer key digest.
* If type is ndn_KeyLocatorType_KEYNAME and keyNameType is ndn_KeyNameType_PUBLISHER_ISSUER_CERTIFICATE_DIGEST, the publisher issuer certificate digest.
*/
unsigned int keyDataLength; /**< The length of keyData. */
struct ndn_Name keyName; /**< The key name (only used if type is ndn_KeyLocatorType_KEYNAME.) */
ndn_KeyNameType keyNameType; /**< The type of data for keyName, -1 for none. (only used if type is ndn_KeyLocatorType_KEYNAME.) */
};
/**
* Initialize an ndn_KeyLocator struct with the pre-allocated nameComponents, and defaults for all the values.
* @param self A pointer to the ndn_KeyLocator struct.
* @param keyNameComponents The pre-allocated array of ndn_NameComponent.
* @param maxKeyNameComponents The number of elements in the allocated keyNameComponents array.
*/
static inline void ndn_KeyLocator_initialize
(struct ndn_KeyLocator *self, struct ndn_NameComponent *keyNameComponents, unsigned int maxKeyNameComponents) {
self->type = (ndn_KeyLocatorType)-1;
self->keyData = 0;
self->keyDataLength = 0;
ndn_Name_initialize(&self->keyName, keyNameComponents, maxKeyNameComponents);
self->keyNameType = (ndn_KeyNameType)-1;
}
#ifdef __cplusplus
}
#endif
#endif