Revamped binding classes with security policy layer.
[shibboleth/cpp-opensaml.git] / saml / saml2 / core / Assertions.h
index a45b048..ae5018d 100644 (file)
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file Assertions.h
+ * @file saml/saml2/core/Assertions.h
  * 
  * XMLObjects representing the SAML 2.0 Assertions schema
  */
 #ifndef __saml2_assertions_h__
 #define __saml2_assertions_h__
 
-#include <saml/signature/SignableObject.h>
+#include <saml/RootObject.h>
 #include <saml/util/SAMLConstants.h>
 
 #include <xmltooling/AttributeExtensibleXMLObject.h>
 #include <xmltooling/ElementProxy.h>
-#include <xmltooling/SimpleElement.h>
 #include <xmltooling/XMLObjectBuilder.h>
 #include <xmltooling/encryption/Encryption.h>
 #include <xmltooling/signature/KeyResolver.h>
 #include <xmltooling/signature/Signature.h>
 #include <xmltooling/util/DateTime.h>
-#include <xmltooling/validation/ValidatingXMLObject.h>
 
 #define DECL_SAML2OBJECTBUILDER(cname) \
-    DECL_XMLOBJECTBUILDER(SAML_API,cname,opensaml::SAMLConstants::SAML20_NS,opensaml::SAMLConstants::SAML20_PREFIX)
+    DECL_XMLOBJECTBUILDER(SAML_API,cname,samlconstants::SAML20_NS,samlconstants::SAML20_PREFIX)
 
 namespace opensaml {
 
     /**
-     * @namespace saml2
+     * @namespace opensaml::saml2
      * SAML 2.0 assertion namespace
      */
     namespace saml2 {
         
         // Forward references
         class SAML_API Assertion;
+        class SAML_API EncryptedAssertion;
         
         DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionIDRef,AssertionID,SAML 2.0 AssertionIDRef element);
         DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionURIRef,AssertionURI,SAML 2.0 AssertionURIRef element);
@@ -80,19 +79,35 @@ namespace opensaml {
         BEGIN_XMLOBJECT(SAML_API,EncryptedID,EncryptedElementType,SAML 2.0 EncryptedID element);
         END_XMLOBJECT;
 
-        BEGIN_XMLOBJECT(SAML_API,BaseID,xmltooling::XMLObject,SAML 2.0 BaseIDAbstractType abstract type);
+        BEGIN_XMLOBJECT(SAML_API,BaseID,xmltooling::XMLObject,SAML 2.0 BaseID abstract element);
             DECL_STRING_ATTRIB(NameQualifier,NAMEQUALIFIER);
             DECL_STRING_ATTRIB(SPNameQualifier,SPNAMEQUALIFIER);
         END_XMLOBJECT;
 
-        BEGIN_XMLOBJECT(SAML_API,NameIDType,xmltooling::SimpleElement,SAML 2.0 NameIDType type);
+        BEGIN_XMLOBJECT(SAML_API,NameIDType,xmltooling::XMLObject,SAML 2.0 NameIDType type);
             DECL_STRING_ATTRIB(NameQualifier,NAMEQUALIFIER);
             DECL_STRING_ATTRIB(SPNameQualifier,SPNAMEQUALIFIER);
             DECL_STRING_ATTRIB(Format,FORMAT);
             DECL_STRING_ATTRIB(SPProvidedID,SPPROVIDEDID);
-            DECL_XMLOBJECT_CONTENT(Name);
+            DECL_SIMPLE_CONTENT(Name);
             /** NameIDType local name */
             static const XMLCh TYPE_NAME[];
+            /** Unspecified name format ID */
+            static const XMLCh UNSPECIFIED[];
+            /** Email address name format ID */
+            static const XMLCh EMAIL[];
+            /** X.509 subject name format ID */
+            static const XMLCh X509_SUBJECT[];
+            /** Windows domain qualified name format ID */
+            static const XMLCh WIN_DOMAIN_QUALIFIED[];
+            /** Kerberos principal name format ID */
+            static const XMLCh KERBEROS[];
+            /** Entity identifier name format ID */
+            static const XMLCh ENTITY[];
+            /** Persistent identifier name format ID */
+            static const XMLCh PERSISTENT[];
+            /** Transient identifier name format ID */
+            static const XMLCh TRANSIENT[];
         END_XMLOBJECT;
 
         BEGIN_XMLOBJECT(SAML_API,NameID,NameIDType,SAML 2.0 NameID element);
@@ -139,7 +154,7 @@ namespace opensaml {
             DECL_STRING_ATTRIB(Recipient,RECIPIENT);
             DECL_STRING_ATTRIB(InResponseTo,INRESPONSETO);
             DECL_STRING_ATTRIB(Address,ADDRESS);
-            DECL_XMLOBJECT_CONTENT(Data);
+            DECL_SIMPLE_CONTENT(Data);
         END_XMLOBJECT;
 
         BEGIN_XMLOBJECT(SAML_API,KeyInfoConfirmationDataType,xmltooling::AttributeExtensibleXMLObject,SAML 2.0 KeyInfoConfirmationDataType type);
@@ -162,6 +177,12 @@ namespace opensaml {
             DECL_TYPED_CHILD(KeyInfoConfirmationDataType);
             /** SubjectConfirmationType local name */
             static const XMLCh TYPE_NAME[];
+            /** Bearer confirmation method */
+            static const XMLCh BEARER[];
+            /** Holder of key confirmation method */
+            static const XMLCh HOLDER_KEY[];
+            /** Sender vouches confirmation method */
+            static const XMLCh SENDER_VOUCHES[];
         END_XMLOBJECT;
 
         BEGIN_XMLOBJECT(SAML_API,Subject,xmltooling::XMLObject,SAML 2.0 Subject element);
@@ -205,18 +226,26 @@ namespace opensaml {
             static const XMLCh TYPE_NAME[];
         END_XMLOBJECT;
 
-        BEGIN_XMLOBJECT(SAML_API,Action,xmltooling::SimpleElement,SAML 2.0 Action element);
+        BEGIN_XMLOBJECT(SAML_API,Action,xmltooling::XMLObject,SAML 2.0 Action element);
             DECL_STRING_ATTRIB(Namespace,NAMESPACE);
-            DECL_XMLOBJECT_CONTENT(Action);
+            DECL_SIMPLE_CONTENT(Action);
             /** ActionType local name */
             static const XMLCh TYPE_NAME[];
+            /** Read/Write/Execute/Delete/Control Action Namespace */
+            static const XMLCh RWEDC_NEG_ACTION_NAMESPACE[];
+            /** Read/Write/Execute/Delete/Control with Negation Action Namespace */
+            static const XMLCh RWEDC_ACTION_NAMESPACE[];
+            /** Get/Head/Put/Post Action Namespace */
+            static const XMLCh GHPP_ACTION_NAMESPACE[];
+            /** UNIX File Permissions Action Namespace */
+            static const XMLCh UNIX_ACTION_NAMESPACE[];
         END_XMLOBJECT;
 
         BEGIN_XMLOBJECT(SAML_API,Evidence,xmltooling::XMLObject,SAML 2.0 Evidence element);
             DECL_TYPED_CHILDREN(AssertionIDRef);
             DECL_TYPED_CHILDREN(AssertionURIRef);
             DECL_TYPED_CHILDREN(Assertion);
-            //DECL_TYPED_CHILDREN(EncryptedAssertion);
+            DECL_TYPED_CHILDREN(EncryptedAssertion);
             /** EvidenceType local name */
             static const XMLCh TYPE_NAME[];
         END_XMLOBJECT;
@@ -246,6 +275,12 @@ namespace opensaml {
             DECL_XMLOBJECT_CHILDREN(AttributeValue);
             /** AttributeType local name */
             static const XMLCh TYPE_NAME[];
+            /** Unspecified attribute name format ID */
+            static const XMLCh UNSPECIFIED[];
+            /** URI reference attribute name format ID */
+            static const XMLCh URI_REFERENCE[];
+            /** Basic attribute name format ID */
+            static const XMLCh BASIC[];
         END_XMLOBJECT;
 
         BEGIN_XMLOBJECT(SAML_API,EncryptedAttribute,EncryptedElementType,SAML 2.0 EncryptedAttribute element);
@@ -271,12 +306,29 @@ namespace opensaml {
             static const XMLCh TYPE_NAME[];
         END_XMLOBJECT;
 
-        BEGIN_XMLOBJECT(SAML_API,Assertion,SignableObject,SAML 2.0 Assertion element);
-            DECL_STRING_ATTRIB(Version,VER);
-            DECL_STRING_ATTRIB(ID,ID);
-            DECL_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
-            DECL_TYPED_CHILD(Issuer);
-            DECL_TYPED_FOREIGN_CHILD(Signature,xmlsignature);
+        /**
+         * SAML 2.0 assertion or protocol message.
+         */
+        class SAML_API RootObject : virtual public opensaml::RootObject
+        {
+        protected:
+            RootObject() {}
+        public:
+            virtual ~RootObject() {}
+            
+            /** Gets the Version attribute. */
+            virtual const XMLCh* getVersion() const=0;
+            
+            /** Gets the Issuer. */
+            virtual Issuer* getIssuer() const=0;
+        };
+
+        BEGIN_XMLOBJECT(SAML_API,Assertion,saml2::RootObject,SAML 2.0 Assertion element);
+            DECL_INHERITED_STRING_ATTRIB(Version,VER);
+            DECL_INHERITED_STRING_ATTRIB(ID,ID);
+            DECL_INHERITED_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
+            DECL_INHERITED_TYPED_CHILD(Issuer);
+            DECL_INHERITED_TYPED_FOREIGN_CHILD(Signature,xmlsignature);
             DECL_TYPED_CHILD(Subject);
             DECL_TYPED_CHILD(Conditions);
             DECL_TYPED_CHILD(Advice);
@@ -335,10 +387,10 @@ namespace opensaml {
             /** Singleton builder. */
             static NameIDType* buildNameIDType(const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL) {
                 const NameIDTypeBuilder* b = dynamic_cast<const NameIDTypeBuilder*>(
-                    XMLObjectBuilder::getBuilder(xmltooling::QName(SAMLConstants::SAML20_NS,NameIDType::TYPE_NAME))
+                    XMLObjectBuilder::getBuilder(xmltooling::QName(samlconstants::SAML20_NS,NameIDType::TYPE_NAME))
                     );
                 if (b) {
-                    xmltooling::QName schemaType(SAMLConstants::SAML20_NS,NameIDType::TYPE_NAME,SAMLConstants::SAML20_PREFIX);
+                    xmltooling::QName schemaType(samlconstants::SAML20_NS,NameIDType::TYPE_NAME,samlconstants::SAML20_PREFIX);
                     return b->buildObject(nsURI, localName, prefix, &schemaType);
                 }
                 throw xmltooling::XMLObjectException("Unable to obtain typed builder for NameIDType.");
@@ -357,10 +409,10 @@ namespace opensaml {
             /** Default builder. */
             virtual KeyInfoConfirmationDataType* buildObject() const {
                 xmltooling::QName schemaType(
-                    SAMLConstants::SAML20_NS,KeyInfoConfirmationDataType::TYPE_NAME,SAMLConstants::SAML20_PREFIX
+                    samlconstants::SAML20_NS,KeyInfoConfirmationDataType::TYPE_NAME,samlconstants::SAML20_PREFIX
                     );
                 return buildObject(
-                    SAMLConstants::SAML20_NS,KeyInfoConfirmationDataType::LOCAL_NAME,SAMLConstants::SAML20_PREFIX,&schemaType
+                    samlconstants::SAML20_NS,KeyInfoConfirmationDataType::LOCAL_NAME,samlconstants::SAML20_PREFIX,&schemaType
                     );
             }
             /** Builder that allows element/type override. */
@@ -371,7 +423,7 @@ namespace opensaml {
             /** Singleton builder. */
             static KeyInfoConfirmationDataType* buildKeyInfoConfirmationDataType() {
                 const KeyInfoConfirmationDataTypeBuilder* b = dynamic_cast<const KeyInfoConfirmationDataTypeBuilder*>(
-                    XMLObjectBuilder::getBuilder(xmltooling::QName(SAMLConstants::SAML20_NS,KeyInfoConfirmationDataType::TYPE_NAME))
+                    XMLObjectBuilder::getBuilder(xmltooling::QName(samlconstants::SAML20_NS,KeyInfoConfirmationDataType::TYPE_NAME))
                     );
                 if (b)
                     return b->buildObject();
@@ -380,7 +432,7 @@ namespace opensaml {
         };
         
         /**
-         * Registers builders and validators for Assertion classes into the runtime.
+         * Registers builders and validators for SAML 2.0 Assertion classes into the runtime.
          */
         void SAML_API registerAssertionClasses();
     };