Merge branch '1.x' of ssh://authdev.it.ohio-state.edu/~scantor/git/cpp-xmltooling...

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

diff --git a/xmltooling/security/Credential.h b/xmltooling/security/Credential.h
index 42b20d4..fcc9c64 100644 (file)
--- a/xmltooling/security/Credential.h
+++ b/xmltooling/security/Credential.h
@@ -1,34 +1,39 @@
-/*
- *  Copyright 2001-2007 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
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you 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
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
  * @file xmltooling/security/Credential.h
- * 
- * Wraps keys and related functionality. 
+ *
+ * Wraps keys and related functionality.
  */
 
 #if !defined(__xmltooling_cred_h__) && !defined(XMLTOOLING_NO_XMLSEC)
 #define __xmltooling_cred_h__
 
 #include <xmltooling/base.h>
-#include <xsec/enc/XSECCryptoKey.hpp>
 
 #include <set>
 #include <string>
 
+class XSECCryptoKey;
+
 namespace xmlsignature {
     class XMLTOOL_API KeyInfo;
 };
@@ -48,25 +53,53 @@ 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_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 NULL if indeterminate
+         * @return  the Credential algorithm, or nullptr if indeterminate
          */
         virtual const char* getAlgorithm() const=0;
 
         /**
-         * Returns the size of the key.
+         * Returns the size of the key in bits.
          *
          * @return  the key size, or 0 if indeterminate
          */
@@ -74,32 +107,32 @@ namespace xmltooling {
 
         /**
          * 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.
          *
          * <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 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 a KeyInfo object, which must be freed by the caller
          */
@@ -108,12 +141,10 @@ namespace xmltooling {
         /**
          * Get the credential context information, which provides additional information
          * specific to the context in which the credential was resolved.
-         * 
+         *
          * @return resolution context of the credential
          */
-        virtual const CredentialContext* getCredentalContext() const {
-            return NULL;
-        }
+        virtual const CredentialContext* getCredentalContext() const;
     };
 };