https://issues.shibboleth.net/jira/browse/SSPCPP-339

[shibboleth/cpp-sp.git] / shibsp / attribute / resolver / AttributeExtractor.h

diff --git a/shibsp/attribute/resolver/AttributeExtractor.h b/shibsp/attribute/resolver/AttributeExtractor.h
index 7975f8c..08889b8 100644 (file)
--- a/shibsp/attribute/resolver/AttributeExtractor.h
+++ b/shibsp/attribute/resolver/AttributeExtractor.h
@@ -1,22 +1,26 @@
-/*
- *  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 shibsp/attribute/resolver/AttributeExtractor.h
- * 
+ *
  * A service that extracts and decodes attributes from XML objects.
  */
 
@@ -24,8 +28,21 @@
 #define __shibsp_extractor_h__
 
 #include <shibsp/base.h>
+
+#include <string>
+#include <vector>
 #include <xmltooling/Lockable.h>
-#include <saml/saml2/metadata/Metadata.h>
+
+namespace xmltooling {
+    class XMLTOOL_API XMLObject;
+};
+
+namespace opensaml {
+    namespace saml2md {
+        class SAML_API RoleDescriptor;
+        class SAML_API SPSSODescriptor;
+    };
+};
 
 namespace shibsp {
 
@@ -39,26 +56,46 @@ namespace shibsp {
     {
         MAKE_NONCOPYABLE(AttributeExtractor);
     protected:
-        AttributeExtractor() {}
+        AttributeExtractor();
     public:
-        virtual ~AttributeExtractor() {}
+        virtual ~AttributeExtractor();
 
         /**
+         * @deprecated
          * Extracts the attributes found in an XMLObject.
-         * 
+         *
          * @param application   Application performing the extraction
          * @param issuer        source of object, if known
          * @param xmlObject     object to extract
-         * @param attributes    a map to populate with the extracted attributes, keyed by id
-         * 
+         * @param attributes    an array to populate with the extracted attributes
+         *
          * @throws AttributeExtractionException thrown if there is a problem extracting attributes
          */
         virtual void extractAttributes(
             const Application& application,
             const opensaml::saml2md::RoleDescriptor* issuer,
             const xmltooling::XMLObject& xmlObject,
-            std::multimap<std::string,Attribute*>& attributes
-            ) const=0;
+            std::vector<Attribute*>& attributes
+            ) const;
+
+        /**
+         * Extracts the attributes found in an XMLObject.
+         *
+         * @param application   Application performing the extraction
+         * @param request       request triggering the extraction, if any
+         * @param issuer        source of object, if known
+         * @param xmlObject     object to extract
+         * @param attributes    an array to populate with the extracted attributes
+         *
+         * @throws AttributeExtractionException thrown if there is a problem extracting attributes
+         */
+        virtual void extractAttributes(
+            const Application& application,
+            const xmltooling::GenericRequest* request,
+            const opensaml::saml2md::RoleDescriptor* issuer,
+            const xmltooling::XMLObject& xmlObject,
+            std::vector<Attribute*>& attributes
+            ) const;
 
         /**
          * Populates an array with the set of Attribute IDs that might be generated.
@@ -66,6 +103,16 @@ namespace shibsp {
          * @param attributes    array to populate
          */
         virtual void getAttributeIds(std::vector<std::string>& attributes) const=0;
+
+        /**
+         * Generates and/or modifies metadata reflecting the extractor,
+         * typically attribute-related requirements.
+         *
+         * <p>The default implementation does nothing.
+         *
+         * @param role          metadata role to decorate
+         */
+        virtual void generateMetadata(opensaml::saml2md::SPSSODescriptor& role) const;
     };
 
     /**
@@ -75,6 +122,21 @@ namespace shibsp {
 
     /** AttributeExtractor based on an XML mapping schema. */
     #define XML_ATTRIBUTE_EXTRACTOR "XML"
+
+    /** AttributeExtractor for SAML assertion information. */
+    #define ASSERTION_ATTRIBUTE_EXTRACTOR "Assertion"
+
+    /** AttributeExtractor for SAML metadata information. */
+    #define METADATA_ATTRIBUTE_EXTRACTOR "Metadata"
+
+    /** AttributeExtractor for DelegationRestriction information. */
+    #define DELEGATION_ATTRIBUTE_EXTRACTOR "Delegation"
+
+    /** AttributeExtractor for KeyInfo information. */
+    #define KEYDESCRIPTOR_ATTRIBUTE_EXTRACTOR "KeyDescriptor"
+
+    /** AttributeExtractor based on chaining together other extractors. */
+    #define CHAINING_ATTRIBUTE_EXTRACTOR "Chaining"
 };
 
 #endif /* __shibsp_extractor_h__ */