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 __saml_assertions_h__
  24 #define __saml_assertions_h__
  25
  26 #include <saml/exceptions.h>
  27 #include <saml/util/SAMLConstants.h>
  28 #include <xmltooling/ElementProxy.h>
  29 #include <xmltooling/SimpleElement.h>
  30 #include <xmltooling/XMLObjectBuilder.h>
  31 #include <xmltooling/signature/KeyInfo.h>
  32 #include <xmltooling/signature/Signature.h>
  33 #include <xmltooling/util/DateTime.h>
  34 #include <xmltooling/validation/ValidatingXMLObject.h>
  35
  36 #define DECL_SAML1OBJECTBUILDER(cname) \
  37     DECL_XMLOBJECTBUILDER(SAML_API,cname,opensaml::SAMLConstants::SAML1_NS,opensaml::SAMLConstants::SAML1_PREFIX)
  38
  39 namespace opensaml {
  40
  41     /**
  42      * @namespace saml1
  43      * SAML 1.x class namespace
  44      */
  45     namespace saml1 {
  46
  47         class SAML_API Assertion;
  48
  49         DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionIDReference,Reference,SAML 1.x AssertionIDReference element);
  50         DECL_XMLOBJECT_SIMPLE(SAML_API,Audience,Uri,SAML 1.x Audience element);
  51         DECL_XMLOBJECT_SIMPLE(SAML_API,ConfirmationMethod,Method,SAML 1.x ConfirmationMethod element);
  52
  53         BEGIN_XMLOBJECT(SAML_API,Condition,xmltooling::XMLObject,SAML 1.x Condition element);
  54         END_XMLOBJECT;
  55
  56         BEGIN_XMLOBJECT(SAML_API,AudienceRestrictionCondition,Condition,SAML 1.x AudienceRestrictionCondition element);
  57             DECL_TYPED_CHILDREN(Audience);
  58             /** AudienceRestrictionConditionType local name */
  59             static const XMLCh TYPE_NAME[];
  60         END_XMLOBJECT;
  61
  62         BEGIN_XMLOBJECT(SAML_API,DoNotCacheCondition,Condition,SAML 1.x DoNotCacheCondition element);
  63             /** DoNotCacheConditionType local name */
  64             static const XMLCh TYPE_NAME[];
  65         END_XMLOBJECT;
  66
  67         BEGIN_XMLOBJECT(SAML_API,Conditions,xmltooling::XMLObject,SAML 1.x Conditions element);
  68             DECL_XMLOBJECT_ATTRIB(NotBefore,NOTBEFORE,xmltooling::DateTime);
  69             DECL_XMLOBJECT_ATTRIB(NotOnOrAfter,NOTONORAFTER,xmltooling::DateTime);
  70             DECL_TYPED_CHILDREN(AudienceRestrictionCondition);
  71             DECL_TYPED_CHILDREN(DoNotCacheCondition);
  72             DECL_TYPED_CHILDREN(Condition);
  73             /** ConditionsType local name */
  74             static const XMLCh TYPE_NAME[];
  75         END_XMLOBJECT;
  76
  77         BEGIN_XMLOBJECT(SAML_API,NameIdentifier,xmltooling::SimpleElement,SAML 1.x NameIdentifier element);
  78             DECL_STRING_ATTRIB(NameQualifier,NAMEQUALIFIER);
  79             DECL_STRING_ATTRIB(Format,FORMAT);
  80             /** NameIdentifierType local name */
  81             static const XMLCh TYPE_NAME[];
  82         END_XMLOBJECT;
  83
  84         BEGIN_XMLOBJECT(SAML_API,SubjectConfirmationData,xmltooling::ElementProxy,SAML 1.x SubjectConfirmationData element);
  85         END_XMLOBJECT;
  86
  87         BEGIN_XMLOBJECT(SAML_API,SubjectConfirmation,xmltooling::XMLObject,SAML 1.x SubjectConfirmation element);
  88             DECL_TYPED_CHILDREN(ConfirmationMethod);
  89             DECL_XMLOBJECT_CHILD(SubjectConfirmationData);
  90             DECL_TYPED_FOREIGN_CHILD(KeyInfo,xmlsignature);
  91             /** SubjectConfirmationType local name */
  92             static const XMLCh TYPE_NAME[];
  93         END_XMLOBJECT;
  94
  95         BEGIN_XMLOBJECT(SAML_API,Subject,xmltooling::XMLObject,SAML 1.x Subject element);
  96             DECL_TYPED_CHILD(NameIdentifier);
  97             DECL_TYPED_CHILD(SubjectConfirmation);
  98             /** SubjectType local name */
  99             static const XMLCh TYPE_NAME[];
 100         END_XMLOBJECT;
 101
 102         BEGIN_XMLOBJECT(SAML_API,Statement,xmltooling::XMLObject,SAML 1.x Statement element);
 103         END_XMLOBJECT;
 104
 105         BEGIN_XMLOBJECT(SAML_API,SubjectStatement,Statement,SAML 1.x SubjectStatement element);
 106             DECL_TYPED_CHILD(Subject);
 107         END_XMLOBJECT;
 108
 109         BEGIN_XMLOBJECT(SAML_API,SubjectLocality,xmltooling::XMLObject,SAML 1.x SubjectLocality element);
 110             DECL_STRING_ATTRIB(IPAddress,IPADDRESS);
 111             DECL_STRING_ATTRIB(DNSAddress,DNSADDRESS);
 112             /** SubjectLocality local name */
 113             static const XMLCh TYPE_NAME[];
 114         END_XMLOBJECT;
 115
 116         BEGIN_XMLOBJECT(SAML_API,AuthorityBinding,xmltooling::XMLObject,SAML 1.x AuthorityBinding element);
 117             DECL_XMLOBJECT_ATTRIB(AuthorityKind,AUTHORITYKIND,xmltooling::QName);
 118             DECL_STRING_ATTRIB(Location,LOCATION);
 119             DECL_STRING_ATTRIB(Binding,BINDING);
 120             /** AuthorityBinding local name */
 121             static const XMLCh TYPE_NAME[];
 122         END_XMLOBJECT;
 123
 124         BEGIN_XMLOBJECT(SAML_API,AuthenticationStatement,SubjectStatement,SAML 1.x AuthenticationStatement element);
 125             DECL_STRING_ATTRIB(AuthenticationMethod,AUTHENTICATIONMETHOD);
 126             DECL_DATETIME_ATTRIB(AuthenticationInstant,AUTHENTICATIONINSTANT);
 127             DECL_TYPED_CHILD(SubjectLocality);
 128             DECL_TYPED_CHILDREN(AuthorityBinding);
 129             /** AuthenticationStatement local name */
 130             static const XMLCh TYPE_NAME[];
 131         END_XMLOBJECT;
 132
 133         BEGIN_XMLOBJECT(SAML_API,Advice,xmltooling::XMLObject,SAML 1.x Advice element);
 134             DECL_TYPED_CHILDREN(AssertionIDReference);
 135             DECL_TYPED_CHILDREN(Assertion);
 136             DECL_XMLOBJECT_CHILDREN(Other);
 137             /** AdviceType local name */
 138             static const XMLCh TYPE_NAME[];
 139         END_XMLOBJECT;
 140
 141         BEGIN_XMLOBJECT(SAML_API,Assertion,xmltooling::XMLObject,SAML 1.x Assertion element);
 142             DECL_INTEGER_ATTRIB(MinorVersion,MINORVERSION);
 143             DECL_STRING_ATTRIB(AssertionID,ASSERTIONID);
 144             DECL_STRING_ATTRIB(Issuer,ISSUER);
 145             DECL_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
 146             DECL_TYPED_CHILD(Conditions);
 147             DECL_TYPED_CHILD(Advice);
 148             DECL_TYPED_CHILDREN(Statement);
 149             DECL_TYPED_CHILDREN(SubjectStatement);
 150             DECL_TYPED_CHILDREN(AuthenticationStatement);
 151             DECL_TYPED_FOREIGN_CHILD(Signature,xmlsignature);
 152             /** AssertionType local name */
 153             static const XMLCh TYPE_NAME[];
 154         END_XMLOBJECT;
 155
 156         DECL_SAML1OBJECTBUILDER(Advice);
 157         DECL_SAML1OBJECTBUILDER(Assertion);
 158         DECL_SAML1OBJECTBUILDER(AssertionIDReference);
 159         DECL_SAML1OBJECTBUILDER(Audience);
 160         DECL_SAML1OBJECTBUILDER(AudienceRestrictionCondition);
 161         DECL_SAML1OBJECTBUILDER(AuthenticationStatement);
 162         DECL_SAML1OBJECTBUILDER(AuthorityBinding);
 163         DECL_SAML1OBJECTBUILDER(DoNotCacheCondition);
 164         DECL_SAML1OBJECTBUILDER(Conditions);
 165         DECL_SAML1OBJECTBUILDER(ConfirmationMethod);
 166         DECL_SAML1OBJECTBUILDER(NameIdentifier);
 167         DECL_SAML1OBJECTBUILDER(Subject);
 168         DECL_SAML1OBJECTBUILDER(SubjectConfirmation);
 169         DECL_SAML1OBJECTBUILDER(SubjectConfirmationData);
 170         DECL_SAML1OBJECTBUILDER(SubjectLocality);
 171
 172         /**
 173          * Registers builders and validators for Assertion classes into the runtime.
 174          */
 175         void SAML_API registerAssertionClasses();
 176     };
 177 };
 178
 179 #endif /* __saml_assertions_h__ */