saml/saml1/core/Assertions.h

   1 /*
   2  *  Copyright 2001-2006 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file Assertions.h
  19  *
  20  * XMLObjects representing the SAML 1.x Assertions schema
  21  */
  22
  23 #ifndef __saml1_assertions_h__
  24 #define __saml1_assertions_h__
  25
  26 #include <saml/exceptions.h>
  27 #include <saml/signature/SignableObject.h>
  28 #include <saml/util/SAMLConstants.h>
  29
  30 #include <xmltooling/AttributeExtensibleXMLObject.h>
  31 #include <xmltooling/ElementProxy.h>
  32 #include <xmltooling/SimpleElement.h>
  33 #include <xmltooling/XMLObjectBuilder.h>
  34 #include <xmltooling/signature/KeyInfo.h>
  35 #include <xmltooling/signature/Signature.h>
  36 #include <xmltooling/util/DateTime.h>
  37 #include <xmltooling/validation/ValidatingXMLObject.h>
  38
  39 #define DECL_SAML1OBJECTBUILDER(cname) \
  40     DECL_XMLOBJECTBUILDER(SAML_API,cname,opensaml::SAMLConstants::SAML1_NS,opensaml::SAMLConstants::SAML1_PREFIX)
  41
  42 namespace opensaml {
  43
  44     /**
  45      * @namespace saml1
  46      * SAML 1.x class namespace
  47      */
  48     namespace saml1 {
  49
  50         // Forward references
  51         class SAML_API Assertion;
  52
  53         DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionIDReference,Reference,SAML 1.x AssertionIDReference element);
  54         DECL_XMLOBJECT_SIMPLE(SAML_API,Audience,Uri,SAML 1.x Audience element);
  55         DECL_XMLOBJECT_SIMPLE(SAML_API,ConfirmationMethod,Method,SAML 1.x ConfirmationMethod element);
  56
  57         BEGIN_XMLOBJECT(SAML_API,Condition,xmltooling::XMLObject,SAML 1.x Condition element);
  58         END_XMLOBJECT;
  59
  60         BEGIN_XMLOBJECT(SAML_API,AudienceRestrictionCondition,Condition,SAML 1.x AudienceRestrictionCondition element);
  61             DECL_TYPED_CHILDREN(Audience);
  62             /** AudienceRestrictionConditionType local name */
  63             static const XMLCh TYPE_NAME[];
  64         END_XMLOBJECT;
  65
  66         BEGIN_XMLOBJECT(SAML_API,DoNotCacheCondition,Condition,SAML 1.x DoNotCacheCondition element);
  67             /** DoNotCacheConditionType local name */
  68             static const XMLCh TYPE_NAME[];
  69         END_XMLOBJECT;
  70
  71         BEGIN_XMLOBJECT(SAML_API,Conditions,xmltooling::XMLObject,SAML 1.x Conditions element);
  72             DECL_XMLOBJECT_ATTRIB(NotBefore,NOTBEFORE,xmltooling::DateTime);
  73             DECL_XMLOBJECT_ATTRIB(NotOnOrAfter,NOTONORAFTER,xmltooling::DateTime);
  74             DECL_TYPED_CHILDREN(AudienceRestrictionCondition);
  75             DECL_TYPED_CHILDREN(DoNotCacheCondition);
  76             DECL_TYPED_CHILDREN(Condition);
  77             /** ConditionsType local name */
  78             static const XMLCh TYPE_NAME[];
  79         END_XMLOBJECT;
  80
  81         BEGIN_XMLOBJECT(SAML_API,NameIdentifier,xmltooling::SimpleElement,SAML 1.x NameIdentifier element);
  82             DECL_STRING_ATTRIB(NameQualifier,NAMEQUALIFIER);
  83             DECL_STRING_ATTRIB(Format,FORMAT);
  84             DECL_XMLOBJECT_CONTENT(Name);
  85             /** NameIdentifierType local name */
  86             static const XMLCh TYPE_NAME[];
  87         END_XMLOBJECT;
  88
  89         /** SAML 1.x SubjectConfirmationData element */
  90         class SAML_API SubjectConfirmationData : public virtual xmltooling::ElementProxy,
  91             public virtual xmltooling::AttributeExtensibleXMLObject,
  92             public virtual xmltooling::ValidatingXMLObject
  93         {
  94         protected:
  95             SubjectConfirmationData() {}
  96         public:
  97             virtual ~SubjectConfirmationData() {}
  98             /** Type-specific clone method. */
  99             virtual SubjectConfirmationData* cloneSubjectConfirmationData() const=0;
 100             /** Element local name. */
 101             static const XMLCh LOCAL_NAME[];
 102         };
 103
 104         BEGIN_XMLOBJECT(SAML_API,SubjectConfirmation,xmltooling::XMLObject,SAML 1.x SubjectConfirmation element);
 105             DECL_TYPED_CHILDREN(ConfirmationMethod);
 106             DECL_XMLOBJECT_CHILD(SubjectConfirmationData);
 107             DECL_TYPED_FOREIGN_CHILD(KeyInfo,xmlsignature);
 108             /** SubjectConfirmationType local name */
 109             static const XMLCh TYPE_NAME[];
 110         END_XMLOBJECT;
 111
 112         BEGIN_XMLOBJECT(SAML_API,Subject,xmltooling::XMLObject,SAML 1.x Subject element);
 113             DECL_TYPED_CHILD(NameIdentifier);
 114             DECL_TYPED_CHILD(SubjectConfirmation);
 115             /** SubjectType local name */
 116             static const XMLCh TYPE_NAME[];
 117         END_XMLOBJECT;
 118
 119         BEGIN_XMLOBJECT(SAML_API,Statement,xmltooling::XMLObject,SAML 1.x Statement element);
 120         END_XMLOBJECT;
 121
 122         BEGIN_XMLOBJECT(SAML_API,SubjectStatement,Statement,SAML 1.x SubjectStatement element);
 123             DECL_TYPED_CHILD(Subject);
 124         END_XMLOBJECT;
 125
 126         BEGIN_XMLOBJECT(SAML_API,SubjectLocality,xmltooling::XMLObject,SAML 1.x SubjectLocality element);
 127             DECL_STRING_ATTRIB(IPAddress,IPADDRESS);
 128             DECL_STRING_ATTRIB(DNSAddress,DNSADDRESS);
 129             /** SubjectLocalityType local name */
 130             static const XMLCh TYPE_NAME[];
 131         END_XMLOBJECT;
 132
 133         BEGIN_XMLOBJECT(SAML_API,AuthorityBinding,xmltooling::XMLObject,SAML 1.x AuthorityBinding element);
 134             DECL_XMLOBJECT_ATTRIB(AuthorityKind,AUTHORITYKIND,xmltooling::QName);
 135             DECL_STRING_ATTRIB(Location,LOCATION);
 136             DECL_STRING_ATTRIB(Binding,BINDING);
 137             /** AuthorityBindingType local name */
 138             static const XMLCh TYPE_NAME[];
 139         END_XMLOBJECT;
 140
 141         BEGIN_XMLOBJECT(SAML_API,AuthenticationStatement,SubjectStatement,SAML 1.x AuthenticationStatement element);
 142             DECL_STRING_ATTRIB(AuthenticationMethod,AUTHENTICATIONMETHOD);
 143             DECL_DATETIME_ATTRIB(AuthenticationInstant,AUTHENTICATIONINSTANT);
 144             DECL_TYPED_CHILD(SubjectLocality);
 145             DECL_TYPED_CHILDREN(AuthorityBinding);
 146             /** AuthenticationStatementType local name */
 147             static const XMLCh TYPE_NAME[];
 148         END_XMLOBJECT;
 149
 150         BEGIN_XMLOBJECT(SAML_API,Action,xmltooling::SimpleElement,SAML 1.x Action element);
 151             DECL_STRING_ATTRIB(Namespace,NAMESPACE);
 152             DECL_XMLOBJECT_CONTENT(Value);
 153             /** ActionType local name */
 154             static const XMLCh TYPE_NAME[];
 155         END_XMLOBJECT;
 156
 157         BEGIN_XMLOBJECT(SAML_API,Evidence,xmltooling::XMLObject,SAML 1.x Evidence element);
 158             DECL_TYPED_CHILDREN(AssertionIDReference);
 159             DECL_TYPED_CHILDREN(Assertion);
 160             /** EvidenceType local name */
 161             static const XMLCh TYPE_NAME[];
 162         END_XMLOBJECT;
 163
 164         BEGIN_XMLOBJECT(SAML_API,AuthorizationDecisionStatement,SubjectStatement,SAML 1.x AuthorizationDecisionStatement element);
 165             DECL_STRING_ATTRIB(Resource,RESOURCE);
 166             DECL_STRING_ATTRIB(Decision,DECISION);
 167             DECL_TYPED_CHILDREN(Action);
 168             DECL_TYPED_CHILD(Evidence);
 169             /** AuthorizationDecisionStatementType local name */
 170             static const XMLCh TYPE_NAME[];
 171             /** Permit Decision */
 172             static const XMLCh DECISION_PERMIT[];
 173             /** Deny Decision */
 174             static const XMLCh DECISION_DENY[];
 175             /** Indeterminate Decision */
 176             static const XMLCh DECISION_INDETERMINATE[];
 177         END_XMLOBJECT;
 178
 179         BEGIN_XMLOBJECT(SAML_API,AttributeDesignator,xmltooling::XMLObject,SAML 1.x AttributeDesignator element);
 180             DECL_STRING_ATTRIB(AttributeName,ATTRIBUTENAME);
 181             DECL_STRING_ATTRIB(AttributeNamespace,ATTRIBUTENAMESPACE);
 182             /** AttributeDesignatorType local name */
 183             static const XMLCh TYPE_NAME[];
 184         END_XMLOBJECT;
 185
 186         BEGIN_XMLOBJECT(SAML_API,Attribute,AttributeDesignator,SAML 1.x Attribute element);
 187             DECL_XMLOBJECT_CHILDREN(AttributeValue);
 188             /** AttributeType local name */
 189             static const XMLCh TYPE_NAME[];
 190         END_XMLOBJECT;
 191
 192         /** SAML 1.x AttributeValue element */
 193         class SAML_API AttributeValue : public virtual xmltooling::ElementProxy,
 194             public virtual xmltooling::AttributeExtensibleXMLObject,
 195             public virtual xmltooling::ValidatingXMLObject
 196         {
 197         protected:
 198             AttributeValue() {}
 199         public:
 200             virtual ~AttributeValue() {}
 201             /** Type-specific clone method. */
 202             virtual AttributeValue* cloneAttributeValue() const=0;
 203             /** Element local name. */
 204             static const XMLCh LOCAL_NAME[];
 205         };
 206
 207         BEGIN_XMLOBJECT(SAML_API,AttributeStatement,SubjectStatement,SAML 1.x AttributeStatement element);
 208             DECL_TYPED_CHILDREN(Attribute);
 209             /** AttributeStatementType local name */
 210             static const XMLCh TYPE_NAME[];
 211         END_XMLOBJECT;
 212
 213         BEGIN_XMLOBJECT(SAML_API,Advice,xmltooling::XMLObject,SAML 1.x Advice element);
 214             DECL_TYPED_CHILDREN(AssertionIDReference);
 215             DECL_TYPED_CHILDREN(Assertion);
 216             DECL_XMLOBJECT_CHILDREN(Other);
 217             /** AdviceType local name */
 218             static const XMLCh TYPE_NAME[];
 219         END_XMLOBJECT;
 220
 221         BEGIN_XMLOBJECT(SAML_API,Assertion,SignableObject,SAML 1.x Assertion element);
 222             DECL_INTEGER_ATTRIB(MinorVersion,MINORVERSION);
 223             DECL_STRING_ATTRIB(AssertionID,ASSERTIONID);
 224             DECL_STRING_ATTRIB(Issuer,ISSUER);
 225             DECL_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
 226             DECL_TYPED_CHILD(Conditions);
 227             DECL_TYPED_CHILD(Advice);
 228             DECL_TYPED_CHILDREN(Statement);
 229             DECL_TYPED_CHILDREN(SubjectStatement);
 230             DECL_TYPED_CHILDREN(AuthenticationStatement);
 231             DECL_TYPED_CHILDREN(AttributeStatement);
 232             DECL_TYPED_CHILDREN(AuthorizationDecisionStatement);
 233             DECL_TYPED_FOREIGN_CHILD(Signature,xmlsignature);
 234             /** AssertionType local name */
 235             static const XMLCh TYPE_NAME[];
 236         END_XMLOBJECT;
 237
 238         DECL_SAML1OBJECTBUILDER(Action);
 239         DECL_SAML1OBJECTBUILDER(Advice);
 240         DECL_SAML1OBJECTBUILDER(Assertion);
 241         DECL_SAML1OBJECTBUILDER(AssertionIDReference);
 242         DECL_SAML1OBJECTBUILDER(Attribute);
 243         DECL_SAML1OBJECTBUILDER(AttributeDesignator);
 244         DECL_SAML1OBJECTBUILDER(AttributeStatement);
 245         DECL_SAML1OBJECTBUILDER(AttributeValue);
 246         DECL_SAML1OBJECTBUILDER(Audience);
 247         DECL_SAML1OBJECTBUILDER(AudienceRestrictionCondition);
 248         DECL_SAML1OBJECTBUILDER(AuthenticationStatement);
 249         DECL_SAML1OBJECTBUILDER(AuthorizationDecisionStatement);
 250         DECL_SAML1OBJECTBUILDER(AuthorityBinding);
 251         DECL_SAML1OBJECTBUILDER(Conditions);
 252         DECL_SAML1OBJECTBUILDER(ConfirmationMethod);
 253         DECL_SAML1OBJECTBUILDER(DoNotCacheCondition);
 254         DECL_SAML1OBJECTBUILDER(Evidence);
 255         DECL_SAML1OBJECTBUILDER(NameIdentifier);
 256         DECL_SAML1OBJECTBUILDER(Subject);
 257         DECL_SAML1OBJECTBUILDER(SubjectConfirmation);
 258         DECL_SAML1OBJECTBUILDER(SubjectConfirmationData);
 259         DECL_SAML1OBJECTBUILDER(SubjectLocality);
 260
 261         /**
 262          * Registers builders and validators for Assertion classes into the runtime.
 263          */
 264         void SAML_API registerAssertionClasses();
 265     };
 266 };
 267
 268 #endif /* __saml1_assertions_h__ */