blob: 04104ea596832dfa8d95883a74dd11496300add0 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/**
* 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_SECURITY_SEC_PUBLIC_INFO_MEMORY_HPP
#define NDN_SECURITY_SEC_PUBLIC_INFO_MEMORY_HPP
#include "../common.hpp"
#include "sec-public-info.hpp"
namespace ndn {
/**
* MemoryKeyMetaInfo extends IdentityStorage and implements its methods to store identity, public key and certificate objects in memory.
* The application must get the objects through its own means and add the objects to the MemoryKeyMetaInfo object.
* To use permanent file-based storage, see BasicKeyMetaInfo.
*/
class SecPublicInfoMemory : public SecPublicInfo {
public:
struct Error : public SecPublicInfo::Error { Error(const std::string &what) : SecPublicInfo::Error(what) {} };
/**
* The virtual Destructor.
*/
virtual
~SecPublicInfoMemory();
/**
* Check if the specified identity already exists.
* @param identityName The identity name.
* @return true if the identity exists, otherwise false.
*/
virtual bool
doesIdentityExist(const Name& identityName);
/**
* Add a new identity. An exception will be thrown if the identity already exists.
* @param identityName The identity name to be added.
*/
virtual void
addIdentity(const Name& identityName);
/**
* Revoke the identity.
* @return true if the identity was revoked, false if not.
*/
virtual bool
revokeIdentity();
/**
* Check if the specified key already exists.
* @param keyName The name of the key.
* @return true if the key exists, otherwise false.
*/
virtual bool
doesPublicKeyExist(const Name& keyName);
/**
* Add a public key to the identity storage.
* @param keyName The name of the public key to be added.
* @param keyType Type of the public key to be added.
* @param publicKeyDer A blob of the public key DER to be added.
*/
virtual void
addPublicKey(const Name& keyName, KeyType keyType, const PublicKey& publicKeyDer);
/**
* Get the public key DER blob from the identity storage.
* @param keyName The name of the requested public key.
* @return The DER Blob. If not found, return a Blob with a null pointer.
*/
virtual ptr_lib::shared_ptr<PublicKey>
getPublicKey(const Name& keyName);
/**
* Activate a key. If a key is marked as inactive, its private part will not be used in packet signing.
* @param keyName name of the key
*/
virtual void
activatePublicKey(const Name& keyName);
/**
* Deactivate a key. If a key is marked as inactive, its private part will not be used in packet signing.
* @param keyName name of the key
*/
virtual void
deactivatePublicKey(const Name& keyName);
/**
* Check if the specified certificate already exists.
* @param certificateName The name of the certificate.
* @return true if the certificate exists, otherwise false.
*/
virtual bool
doesCertificateExist(const Name& certificateName);
/**
* Add a certificate to the identity storage.
* @param certificate The certificate to be added. This makes a copy of the certificate.
*/
virtual void
addCertificate(const IdentityCertificate& certificate);
/**
* Get a certificate from the identity storage.
* @param certificateName The name of the requested certificate.
* @param allowAny If false, only a valid certificate will be returned, otherwise validity is disregarded.
* @return The requested certificate. If not found, return a shared_ptr with a null pointer.
*/
virtual ptr_lib::shared_ptr<IdentityCertificate>
getCertificate(const Name &certificateName);
/*****************************************
* Get/Set Default *
*****************************************/
/**
* Get the default identity.
* @param return The name of default identity, or an empty name if there is no default.
*/
virtual Name
getDefaultIdentity();
/**
* Get the default key name for the specified identity.
* @param identityName The identity name.
* @return The default key name.
*/
virtual Name
getDefaultKeyNameForIdentity(const Name& identityName);
/**
* Get the default certificate name for the specified key.
* @param keyName The key name.
* @return The default certificate name.
*/
virtual Name
getDefaultCertificateNameForKey(const Name& keyName);
virtual void
getAllIdentities(std::vector<Name> &nameList, bool isDefault);
virtual void
getAllKeyNames(std::vector<Name> &nameList, bool isDefault);
virtual void
getAllKeyNamesOfIdentity(const Name& identity, std::vector<Name> &nameList, bool isDefault);
virtual void
getAllCertificateNames(std::vector<Name> &nameList, bool isDefault);
virtual void
getAllCertificateNamesOfKey(const Name& keyName, std::vector<Name> &nameList, bool isDefault);
protected:
/**
* Set the default identity. If the identityName does not exist, then clear the default identity
* so that getDefaultIdentity() returns an empty name.
* @param identityName The default identity name.
*/
virtual void
setDefaultIdentityInternal(const Name& identityName);
/**
* Set the default key name for the specified identity.
* @param keyName The key name.
* @param identityNameCheck (optional) The identity name to check the keyName.
*/
virtual void
setDefaultKeyNameForIdentityInternal(const Name& keyName);
/**
* Set the default key name for the specified identity.
* @param keyName The key name.
* @param certificateName The certificate name.
*/
virtual void
setDefaultCertificateNameForKeyInternal(const Name& certificateName);
/**
* Delete a certificate.
* @param certificateName The certificate name.
*/
virtual void
deleteCertificateInfo(const Name &certificateName);
/**
* Delete a public key and related certificates.
* @param keyName The key name.
*/
virtual void
deletePublicKeyInfo(const Name &keyName);
/**
* Delete an identity and related public keys and certificates.
* @param identity The identity name.
*/
virtual void
deleteIdentityInfo(const Name &identity);
private:
class KeyRecord {
public:
KeyRecord(KeyType keyType, const PublicKey &key)
: keyType_(keyType), key_(key)
{
}
const KeyType getKeyType() const { return keyType_; }
const PublicKey& getKey() { return key_; }
private:
KeyType keyType_;
PublicKey key_;
};
std::vector<std::string> identityStore_; /**< A list of name URI. */
std::string defaultIdentity_; /**< The default identity in identityStore_, or "" if not defined. */
Name defaultKeyName_;
Name defaultCert_;
typedef std::map< std::string, ptr_lib::shared_ptr<KeyRecord> > KeyStore; /**< The map key is the keyName.toUri() */
typedef std::map< std::string, ptr_lib::shared_ptr<IdentityCertificate> > CertificateStore; /**< The map key is the certificateName.toUri() */
KeyStore keyStore_;
CertificateStore certificateStore_;
};
} // namespace ndn
#endif //NDN_SECURITY_SEC_PUBLIC_INFO_MEMORY_HPP