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