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