blob: 6cf2a1bcddbe62693cb53998e4891872e98e8181 [file] [log] [blame]
/**
* @author: Jeff Thompson
* See COPYING for copyright and distribution information.
*/
#ifndef NDN_KEY_HPP
#define NDN_KEY_HPP
#include <vector>
#include "c/key.h"
#include "name.hpp"
namespace ndn {
class KeyLocator {
public:
KeyLocator()
: type_((ndn_KeyLocatorType)-1), keyNameType_((ndn_KeyNameType)-1)
{
}
/**
* Set the keyLocatorStruct to point to the values in this key locator, without copying any memory.
* WARNING: The resulting pointers in keyLocatorStruct are invalid after a further use of this object which could reallocate memory.
* @param keyLocatorStruct a C ndn_KeyLocator struct where the name components array is already allocated.
*/
void get(struct ndn_KeyLocator &keyLocatorStruct) const;
/**
* Clear this key locator, and set the values by copying from the ndn_KeyLocator struct.
* @param keyLocatorStruct a C ndn_KeyLocator struct
*/
void set(const struct ndn_KeyLocator &keyLocatorStruct);
ndn_KeyLocatorType getType() const { return type_; }
const std::vector<unsigned char> &getKeyData() const { return keyData_; }
const Name &getKeyName() const { return keyName_; }
Name &getKeyName() { return keyName_; }
ndn_KeyNameType getKeyNameType() const { return keyNameType_; }
void setType(ndn_KeyLocatorType type) { type_ = type; }
void setKeyData(const std::vector<unsigned char> &keyData) { keyData_ = keyData; }
void setKeyData(const unsigned char *keyData, unsigned int keyDataLength)
{
setVector(keyData_, keyData, keyDataLength);
}
/**
* @deprecated Use getKeyData().
*/
const std::vector<unsigned char> &getKeyOrCertificate() const { return getKeyData(); }
/**
* @deprecated Use setKeyData.
*/
void setKeyOrCertificate(const std::vector<unsigned char> &keyData) { setKeyData(keyData); }
/**
* @deprecated Use setKeyData.
*/
void setKeyOrCertificate(const unsigned char *keyData, unsigned int keyDataLength) { setKeyData(keyData, keyDataLength); }
void setKeyNameType(ndn_KeyNameType keyNameType) { keyNameType_ = keyNameType; }
private:
ndn_KeyLocatorType type_; /**< -1 for none */
std::vector<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.
*/
Name keyName_; /**< The key name (only used if type_ is ndn_KeyLocatorType_KEYNAME.) */
ndn_KeyNameType keyNameType_; /**< The type of data for keyName_ (only used if type_ is ndn_KeyLocatorType_KEYNAME.) */
};
}
#endif