Convert from NULL macro to nullptr.

[shibboleth/cpp-xmltooling.git] / xmltooling / security / Credential.h

diff --git a/xmltooling/security/Credential.h b/xmltooling/security/Credential.h
index c8d7756..0d2362f 100644 (file)
--- a/xmltooling/security/Credential.h
+++ b/xmltooling/security/Credential.h
@@ -1,6 +1,6 @@
 /*
- *  Copyright 2001-2007 Internet2
- * 
+ *  Copyright 2001-2010 Internet2
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -16,8 +16,8 @@
 
 /**
  * @file xmltooling/security/Credential.h
- * 
- * Wraps keys and related functionality. 
+ *
+ * Wraps keys and related functionality.
  */
 
 #if !defined(__xmltooling_cred_h__) && !defined(XMLTOOLING_NO_XMLSEC)
@@ -25,7 +25,10 @@
 
 #include <xmltooling/base.h>
 
-#include <xsec/enc/XSECCryptoKey.hpp>
+#include <set>
+#include <string>
+
+class XSECCryptoKey;
 
 namespace xmlsignature {
     class XMLTOOL_API KeyInfo;
@@ -33,6 +36,9 @@ namespace xmlsignature {
 
 namespace xmltooling {
 
+    class XMLTOOL_API CredentialCriteria;
+    class XMLTOOL_API CredentialContext;
+
     /**
      * Wraps keys and related functionality.
      *
@@ -43,54 +49,98 @@ namespace xmltooling {
     {
         MAKE_NONCOPYABLE(Credential);
     protected:
-        Credential() {}
-        
+        Credential();
+
     public:
-        virtual ~Credential() {}
-        
+        virtual ~Credential();
+
+        /**
+         * Bitmask constants for limiting resolution process inside a CredentialResolver.
+         */
         enum ResolveTypes {
-            RESOLVE_KEYS = 1
+            RESOLVE_KEYS = 1,
+            RESOLVE_NAMES = 2
+        };
+
+        /**
+         * Bitmask of use cases for credentials.
+         */
+        enum UsageTypes {
+            UNSPECIFIED_CREDENTIAL = 0,
+            SIGNING_CREDENTIAL = 1,
+            TLS_CREDENTIAL = 2,
+            ENCRYPTION_CREDENTIAL = 4
         };
 
         /**
+         * Bitmask of supported KeyInfo content to generate.
+         */
+        enum KeyInfoTypes {
+            KEYINFO_KEY_VALUE = 1,
+            KEYINFO_KEY_NAME = 2
+        };
+
+        /**
+         * Get credential usage types.
+         *
+         * @return the usage bitmask
+         */
+        virtual unsigned int getUsage() const=0;
+
+        /**
+         * Returns an algorithm identifier for the Credential.
+         *
+         * @return  the Credential algorithm, or nullptr if indeterminate
+         */
+        virtual const char* getAlgorithm() const=0;
+
+        /**
+         * Returns the size of the key.
+         *
+         * @return  the key size, or 0 if indeterminate
+         */
+        virtual unsigned int getKeySize() const=0;
+
+        /**
          * Returns a secret or private key to use for signing or decryption operations.
-         * 
+         *
          * @return  a secret or private key
          */
         virtual XSECCryptoKey* getPrivateKey() const=0;
 
         /**
          * Returns a secret or public key to use for verification or encryption operations.
-         * 
+         *
          * @return  a secret or public key
          */
         virtual XSECCryptoKey* getPublicKey() const=0;
-        
+
         /**
-         * Returns names representing the Credential, generally when the Credential itself merely
-         * points to a Credential rather than containing one.
-         * 
-         * @param results   array to populate with names
-         * @return  the number of names returned
+         * Returns names representing the Credential.
+         *
+         * <p>Names should be unique in the context of the comparisons against CredentialCriteria
+         * that deployments expect to see.
+         *
+         * @return  a sorted set of names
          */
-        virtual std::vector<std::string>::size_type getKeyNames(std::vector<std::string>& results) const=0;
-        
+        virtual const std::set<std::string>& getKeyNames() const=0;
+
         /**
          * Returns a ds:KeyInfo object representing the Credential for use in
          * communicating with other entities.
-         * 
+         *
          * @param compact   true iff the communication medium is such that only compact forms should be included
-         * @return reference to a KeyInfo object
+         * @return a KeyInfo object, which must be freed by the caller
          */
-        virtual const xmlsignature::KeyInfo* getKeyInfo(bool compact=false) const=0;
+        virtual xmlsignature::KeyInfo* getKeyInfo(bool compact=false) const=0;
 
         /**
-         * Compares the public key inside the Credential to a second public key.
+         * Get the credential context information, which provides additional information
+         * specific to the context in which the credential was resolved.
          *
-         * @param key   the public key to compare
-         * @return true iff the keys are equal
+         * @return resolution context of the credential
          */
-        virtual bool isEqual(XSECCryptoKey& key) const;
+        virtual const CredentialContext* getCredentalContext() const;
     };
 };