security: Consistent exception handling.
Change-Id: Ia29963e96028e591e9c4fc4a68a472f794b17e52
diff --git a/src/security/sec-public-info-memory.hpp b/src/security/sec-public-info-memory.hpp
index 04104ea..16001c8 100644
--- a/src/security/sec-public-info-memory.hpp
+++ b/src/security/sec-public-info-memory.hpp
@@ -14,130 +14,49 @@
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.
+ * @brief SecPublicInfoMemory extends SecPublicInfo and implements its methods to store identity, public key and certificate objects in memory.
*/
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);
@@ -157,48 +76,21 @@
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);