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 saml/saml1/core/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 #include <xmltooling/validation/ValidatorSuite.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 opensaml::saml1
  46      * SAML 1.x assertion namespace
  47      */
  48     namespace saml1 {
  49
  50         // Forward references
  51         class SAML_API Assertion;
  52
  53         DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionIDReference,AssertionID,SAML 1.x AssertionIDReference element);
  54         DECL_XMLOBJECT_SIMPLE(SAML_API,Audience,AudienceURI,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_DATETIME_ATTRIB(NotBefore,NOTBEFORE);
  73             DECL_DATETIME_ATTRIB(NotOnOrAfter,NOTONORAFTER);
  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         BEGIN_XMLOBJECT2(SAML_API,SubjectConfirmationData,xmltooling::ElementProxy,xmltooling::AttributeExtensibleXMLObject,SAML 1.x SubjectConfirmationData element);
  90         END_XMLOBJECT;
  91
  92         BEGIN_XMLOBJECT(SAML_API,SubjectConfirmation,xmltooling::XMLObject,SAML 1.x SubjectConfirmation element);
  93             DECL_TYPED_CHILDREN(ConfirmationMethod);
  94             DECL_XMLOBJECT_CHILD(SubjectConfirmationData);
  95             DECL_TYPED_FOREIGN_CHILD(KeyInfo,xmlsignature);
  96             /** SubjectConfirmationType local name */
  97             static const XMLCh TYPE_NAME[];
  98         END_XMLOBJECT;
  99
 100         BEGIN_XMLOBJECT(SAML_API,Subject,xmltooling::XMLObject,SAML 1.x Subject element);
 101             DECL_TYPED_CHILD(NameIdentifier);
 102             DECL_TYPED_CHILD(SubjectConfirmation);
 103             /** SubjectType local name */
 104             static const XMLCh TYPE_NAME[];
 105         END_XMLOBJECT;
 106
 107         BEGIN_XMLOBJECT(SAML_API,Statement,xmltooling::XMLObject,SAML 1.x Statement element);
 108         END_XMLOBJECT;
 109
 110         BEGIN_XMLOBJECT(SAML_API,SubjectStatement,Statement,SAML 1.x SubjectStatement element);
 111             DECL_TYPED_CHILD(Subject);
 112         END_XMLOBJECT;
 113
 114         BEGIN_XMLOBJECT(SAML_API,SubjectLocality,xmltooling::XMLObject,SAML 1.x SubjectLocality element);
 115             DECL_STRING_ATTRIB(IPAddress,IPADDRESS);
 116             DECL_STRING_ATTRIB(DNSAddress,DNSADDRESS);
 117             /** SubjectLocalityType local name */
 118             static const XMLCh TYPE_NAME[];
 119         END_XMLOBJECT;
 120
 121         BEGIN_XMLOBJECT(SAML_API,AuthorityBinding,xmltooling::XMLObject,SAML 1.x AuthorityBinding element);
 122             DECL_XMLOBJECT_ATTRIB(AuthorityKind,AUTHORITYKIND,xmltooling::QName);
 123             DECL_STRING_ATTRIB(Location,LOCATION);
 124             DECL_STRING_ATTRIB(Binding,BINDING);
 125             /** AuthorityBindingType local name */
 126             static const XMLCh TYPE_NAME[];
 127         END_XMLOBJECT;
 128
 129         BEGIN_XMLOBJECT(SAML_API,AuthenticationStatement,SubjectStatement,SAML 1.x AuthenticationStatement element);
 130             DECL_STRING_ATTRIB(AuthenticationMethod,AUTHENTICATIONMETHOD);
 131             DECL_DATETIME_ATTRIB(AuthenticationInstant,AUTHENTICATIONINSTANT);
 132             DECL_TYPED_CHILD(SubjectLocality);
 133             DECL_TYPED_CHILDREN(AuthorityBinding);
 134             /** AuthenticationStatementType local name */
 135             static const XMLCh TYPE_NAME[];
 136         END_XMLOBJECT;
 137
 138         BEGIN_XMLOBJECT(SAML_API,Action,xmltooling::SimpleElement,SAML 1.x Action element);
 139             DECL_STRING_ATTRIB(Namespace,NAMESPACE);
 140             DECL_XMLOBJECT_CONTENT(Action);
 141             /** ActionType local name */
 142             static const XMLCh TYPE_NAME[];
 143         END_XMLOBJECT;
 144
 145         BEGIN_XMLOBJECT(SAML_API,Evidence,xmltooling::XMLObject,SAML 1.x Evidence element);
 146             DECL_TYPED_CHILDREN(AssertionIDReference);
 147             DECL_TYPED_CHILDREN(Assertion);
 148             /** EvidenceType local name */
 149             static const XMLCh TYPE_NAME[];
 150         END_XMLOBJECT;
 151
 152         BEGIN_XMLOBJECT(SAML_API,AuthorizationDecisionStatement,SubjectStatement,SAML 1.x AuthorizationDecisionStatement element);
 153             DECL_STRING_ATTRIB(Resource,RESOURCE);
 154             DECL_STRING_ATTRIB(Decision,DECISION);
 155             DECL_TYPED_CHILDREN(Action);
 156             DECL_TYPED_CHILD(Evidence);
 157             /** AuthorizationDecisionStatementType local name */
 158             static const XMLCh TYPE_NAME[];
 159             /** Permit Decision */
 160             static const XMLCh DECISION_PERMIT[];
 161             /** Deny Decision */
 162             static const XMLCh DECISION_DENY[];
 163             /** Indeterminate Decision */
 164             static const XMLCh DECISION_INDETERMINATE[];
 165         END_XMLOBJECT;
 166
 167         BEGIN_XMLOBJECT(SAML_API,AttributeDesignator,xmltooling::XMLObject,SAML 1.x AttributeDesignator element);
 168             DECL_STRING_ATTRIB(AttributeName,ATTRIBUTENAME);
 169             DECL_STRING_ATTRIB(AttributeNamespace,ATTRIBUTENAMESPACE);
 170             /** AttributeDesignatorType local name */
 171             static const XMLCh TYPE_NAME[];
 172         END_XMLOBJECT;
 173
 174         BEGIN_XMLOBJECT(SAML_API,Attribute,AttributeDesignator,SAML 1.x Attribute element);
 175             DECL_XMLOBJECT_CHILDREN(AttributeValue);
 176             /** AttributeType local name */
 177             static const XMLCh TYPE_NAME[];
 178         END_XMLOBJECT;
 179
 180         BEGIN_XMLOBJECT2(SAML_API,AttributeValue,xmltooling::ElementProxy,xmltooling::AttributeExtensibleXMLObject,SAML 1.x AttributeValue element);
 181         END_XMLOBJECT;
 182
 183         BEGIN_XMLOBJECT(SAML_API,AttributeStatement,SubjectStatement,SAML 1.x AttributeStatement element);
 184             DECL_TYPED_CHILDREN(Attribute);
 185             /** AttributeStatementType local name */
 186             static const XMLCh TYPE_NAME[];
 187         END_XMLOBJECT;
 188
 189         BEGIN_XMLOBJECT(SAML_API,Advice,xmltooling::XMLObject,SAML 1.x Advice element);
 190             DECL_TYPED_CHILDREN(AssertionIDReference);
 191             DECL_TYPED_CHILDREN(Assertion);
 192             DECL_XMLOBJECT_CHILDREN(Other);
 193             /** AdviceType local name */
 194             static const XMLCh TYPE_NAME[];
 195         END_XMLOBJECT;
 196
 197         BEGIN_XMLOBJECT(SAML_API,Assertion,SignableObject,SAML 1.x Assertion element);
 198             DECL_INTEGER_ATTRIB(MinorVersion,MINORVERSION);
 199             DECL_STRING_ATTRIB(AssertionID,ASSERTIONID);
 200             DECL_STRING_ATTRIB(Issuer,ISSUER);
 201             DECL_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
 202             DECL_TYPED_CHILD(Conditions);
 203             DECL_TYPED_CHILD(Advice);
 204             DECL_TYPED_CHILDREN(Statement);
 205             DECL_TYPED_CHILDREN(SubjectStatement);
 206             DECL_TYPED_CHILDREN(AuthenticationStatement);
 207             DECL_TYPED_CHILDREN(AttributeStatement);
 208             DECL_TYPED_CHILDREN(AuthorizationDecisionStatement);
 209             DECL_TYPED_FOREIGN_CHILD(Signature,xmlsignature);
 210             /** AssertionType local name */
 211             static const XMLCh TYPE_NAME[];
 212         END_XMLOBJECT;
 213
 214         DECL_SAML1OBJECTBUILDER(Action);
 215         DECL_SAML1OBJECTBUILDER(Advice);
 216         DECL_SAML1OBJECTBUILDER(Assertion);
 217         DECL_SAML1OBJECTBUILDER(AssertionIDReference);
 218         DECL_SAML1OBJECTBUILDER(Attribute);
 219         DECL_SAML1OBJECTBUILDER(AttributeDesignator);
 220         DECL_SAML1OBJECTBUILDER(AttributeStatement);
 221         DECL_SAML1OBJECTBUILDER(AttributeValue);
 222         DECL_SAML1OBJECTBUILDER(Audience);
 223         DECL_SAML1OBJECTBUILDER(AudienceRestrictionCondition);
 224         DECL_SAML1OBJECTBUILDER(AuthenticationStatement);
 225         DECL_SAML1OBJECTBUILDER(AuthorizationDecisionStatement);
 226         DECL_SAML1OBJECTBUILDER(AuthorityBinding);
 227         DECL_SAML1OBJECTBUILDER(Conditions);
 228         DECL_SAML1OBJECTBUILDER(ConfirmationMethod);
 229         DECL_SAML1OBJECTBUILDER(DoNotCacheCondition);
 230         DECL_SAML1OBJECTBUILDER(Evidence);
 231         DECL_SAML1OBJECTBUILDER(NameIdentifier);
 232         DECL_SAML1OBJECTBUILDER(Subject);
 233         DECL_SAML1OBJECTBUILDER(SubjectConfirmation);
 234         DECL_SAML1OBJECTBUILDER(SubjectConfirmationData);
 235         DECL_SAML1OBJECTBUILDER(SubjectLocality);
 236
 237         /**
 238          * Registers builders and validators for SAML 1.x Assertion classes into the runtime.
 239          */
 240         void SAML_API registerAssertionClasses();
 241
 242         /**
 243          * Validator suite for SAML 1.x Assertion schema validation.
 244          */
 245         extern SAML_API xmltooling::ValidatorSuite AssertionSchemaValidators;
 246     };
 247 };
 248
 249 #endif /* __saml1_assertions_h__ */