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/ValidatorSuite.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 opensaml::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             /** Unspecified name format ID */\r
  87             static const XMLCh UNSPECIFIED[];\r
  88             /** Email address name format ID */\r
  89             static const XMLCh EMAIL[];\r
  90             /** X.509 subject name format ID */\r
  91             static const XMLCh X509_SUBJECT[];\r
  92             /** Windows domain qualified name format ID */\r
  93             static const XMLCh WIN_DOMAIN_QUALIFIED[];\r
  94         END_XMLOBJECT;
  95
  96         BEGIN_XMLOBJECT2(SAML_API,SubjectConfirmationData,xmltooling::ElementProxy,xmltooling::AttributeExtensibleXMLObject,SAML 1.x SubjectConfirmationData element);
  97         END_XMLOBJECT;
  98
  99         BEGIN_XMLOBJECT(SAML_API,SubjectConfirmation,xmltooling::XMLObject,SAML 1.x SubjectConfirmation element);
 100             DECL_TYPED_CHILDREN(ConfirmationMethod);
 101             DECL_XMLOBJECT_CHILD(SubjectConfirmationData);
 102             DECL_TYPED_FOREIGN_CHILD(KeyInfo,xmlsignature);
 103             /** SubjectConfirmationType local name */
 104             static const XMLCh TYPE_NAME[];
 105             /** Deprecated SAML 1.0 Artifact confirmation method */
 106             static const XMLCh ARTIFACT01[];\r
 107             /** Artifact confirmation method */
 108             static const XMLCh ARTIFACT[];\r
 109             /** Bearer confirmation method */
 110             static const XMLCh BEARER[];\r
 111             /** Holder of key confirmation method */\r
 112             static const XMLCh HOLDER_KEY[];\r
 113             /** Sender vouches confirmation method */\r
 114             static const XMLCh SENDER_VOUCHES[];\r
 115         END_XMLOBJECT;
 116
 117         BEGIN_XMLOBJECT(SAML_API,Subject,xmltooling::XMLObject,SAML 1.x Subject element);
 118             DECL_TYPED_CHILD(NameIdentifier);
 119             DECL_TYPED_CHILD(SubjectConfirmation);
 120             /** SubjectType local name */
 121             static const XMLCh TYPE_NAME[];
 122         END_XMLOBJECT;
 123
 124         BEGIN_XMLOBJECT(SAML_API,Statement,xmltooling::XMLObject,SAML 1.x Statement element);
 125         END_XMLOBJECT;
 126
 127         BEGIN_XMLOBJECT(SAML_API,SubjectStatement,Statement,SAML 1.x SubjectStatement element);
 128             DECL_TYPED_CHILD(Subject);
 129         END_XMLOBJECT;
 130
 131         BEGIN_XMLOBJECT(SAML_API,SubjectLocality,xmltooling::XMLObject,SAML 1.x SubjectLocality element);
 132             DECL_STRING_ATTRIB(IPAddress,IPADDRESS);
 133             DECL_STRING_ATTRIB(DNSAddress,DNSADDRESS);
 134             /** SubjectLocalityType local name */
 135             static const XMLCh TYPE_NAME[];
 136         END_XMLOBJECT;
 137
 138         BEGIN_XMLOBJECT(SAML_API,AuthorityBinding,xmltooling::XMLObject,SAML 1.x AuthorityBinding element);
 139             DECL_XMLOBJECT_ATTRIB(AuthorityKind,AUTHORITYKIND,xmltooling::QName);
 140             DECL_STRING_ATTRIB(Location,LOCATION);
 141             DECL_STRING_ATTRIB(Binding,BINDING);
 142             /** AuthorityBindingType local name */
 143             static const XMLCh TYPE_NAME[];
 144         END_XMLOBJECT;
 145
 146         BEGIN_XMLOBJECT(SAML_API,AuthenticationStatement,SubjectStatement,SAML 1.x AuthenticationStatement element);
 147             DECL_STRING_ATTRIB(AuthenticationMethod,AUTHENTICATIONMETHOD);
 148             DECL_DATETIME_ATTRIB(AuthenticationInstant,AUTHENTICATIONINSTANT);
 149             DECL_TYPED_CHILD(SubjectLocality);
 150             DECL_TYPED_CHILDREN(AuthorityBinding);
 151             /** AuthenticationStatementType local name */
 152             static const XMLCh TYPE_NAME[];
 153         END_XMLOBJECT;
 154
 155         BEGIN_XMLOBJECT(SAML_API,Action,xmltooling::SimpleElement,SAML 1.x Action element);
 156             DECL_STRING_ATTRIB(Namespace,NAMESPACE);
 157             DECL_XMLOBJECT_CONTENT(Action);
 158             /** ActionType local name */
 159             static const XMLCh TYPE_NAME[];
 160             /** Read/Write/Execute/Delete/Control Action Namespace */
 161             static const XMLCh RWEDC_NEG_ACTION_NAMESPACE[];\r
 162             /** Read/Write/Execute/Delete/Control with Negation Action Namespace */
 163             static const XMLCh RWEDC_ACTION_NAMESPACE[];\r
 164             /** Get/Head/Put/Post Action Namespace */
 165             static const XMLCh GHPP_ACTION_NAMESPACE[];\r
 166             /** UNIX File Permissions Action Namespace */
 167             static const XMLCh UNIX_ACTION_NAMESPACE[];\r
 168         END_XMLOBJECT;
 169
 170         BEGIN_XMLOBJECT(SAML_API,Evidence,xmltooling::XMLObject,SAML 1.x Evidence element);
 171             DECL_TYPED_CHILDREN(AssertionIDReference);
 172             DECL_TYPED_CHILDREN(Assertion);
 173             /** EvidenceType local name */
 174             static const XMLCh TYPE_NAME[];
 175         END_XMLOBJECT;
 176
 177         BEGIN_XMLOBJECT(SAML_API,AuthorizationDecisionStatement,SubjectStatement,SAML 1.x AuthorizationDecisionStatement element);
 178             DECL_STRING_ATTRIB(Resource,RESOURCE);
 179             DECL_STRING_ATTRIB(Decision,DECISION);
 180             DECL_TYPED_CHILDREN(Action);
 181             DECL_TYPED_CHILD(Evidence);
 182             /** AuthorizationDecisionStatementType local name */
 183             static const XMLCh TYPE_NAME[];
 184             /** Permit Decision */
 185             static const XMLCh DECISION_PERMIT[];
 186             /** Deny Decision */
 187             static const XMLCh DECISION_DENY[];
 188             /** Indeterminate Decision */
 189             static const XMLCh DECISION_INDETERMINATE[];
 190         END_XMLOBJECT;
 191
 192         BEGIN_XMLOBJECT(SAML_API,AttributeDesignator,xmltooling::XMLObject,SAML 1.x AttributeDesignator element);
 193             DECL_STRING_ATTRIB(AttributeName,ATTRIBUTENAME);
 194             DECL_STRING_ATTRIB(AttributeNamespace,ATTRIBUTENAMESPACE);
 195             /** AttributeDesignatorType local name */
 196             static const XMLCh TYPE_NAME[];
 197         END_XMLOBJECT;
 198
 199         BEGIN_XMLOBJECT(SAML_API,Attribute,AttributeDesignator,SAML 1.x Attribute element);
 200             DECL_XMLOBJECT_CHILDREN(AttributeValue);
 201             /** AttributeType local name */
 202             static const XMLCh TYPE_NAME[];
 203         END_XMLOBJECT;
 204
 205         BEGIN_XMLOBJECT2(SAML_API,AttributeValue,xmltooling::ElementProxy,xmltooling::AttributeExtensibleXMLObject,SAML 1.x AttributeValue element);
 206         END_XMLOBJECT;
 207
 208         BEGIN_XMLOBJECT(SAML_API,AttributeStatement,SubjectStatement,SAML 1.x AttributeStatement element);
 209             DECL_TYPED_CHILDREN(Attribute);
 210             /** AttributeStatementType local name */
 211             static const XMLCh TYPE_NAME[];
 212         END_XMLOBJECT;
 213
 214         BEGIN_XMLOBJECT(SAML_API,Advice,xmltooling::XMLObject,SAML 1.x Advice element);
 215             DECL_TYPED_CHILDREN(AssertionIDReference);
 216             DECL_TYPED_CHILDREN(Assertion);
 217             DECL_XMLOBJECT_CHILDREN(Other);
 218             /** AdviceType local name */
 219             static const XMLCh TYPE_NAME[];
 220         END_XMLOBJECT;
 221
 222         BEGIN_XMLOBJECT(SAML_API,Assertion,SignableObject,SAML 1.x Assertion element);
 223             DECL_INTEGER_ATTRIB(MinorVersion,MINORVERSION);
 224             DECL_STRING_ATTRIB(AssertionID,ASSERTIONID);
 225             DECL_STRING_ATTRIB(Issuer,ISSUER);
 226             DECL_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
 227             DECL_TYPED_CHILD(Conditions);
 228             DECL_TYPED_CHILD(Advice);
 229             DECL_TYPED_CHILDREN(Statement);
 230             DECL_TYPED_CHILDREN(SubjectStatement);
 231             DECL_TYPED_CHILDREN(AuthenticationStatement);
 232             DECL_TYPED_CHILDREN(AttributeStatement);
 233             DECL_TYPED_CHILDREN(AuthorizationDecisionStatement);
 234             DECL_TYPED_FOREIGN_CHILD(Signature,xmlsignature);
 235             /** AssertionType local name */
 236             static const XMLCh TYPE_NAME[];
 237         END_XMLOBJECT;
 238
 239         DECL_SAML1OBJECTBUILDER(Action);
 240         DECL_SAML1OBJECTBUILDER(Advice);
 241         DECL_SAML1OBJECTBUILDER(Assertion);
 242         DECL_SAML1OBJECTBUILDER(AssertionIDReference);
 243         DECL_SAML1OBJECTBUILDER(Attribute);
 244         DECL_SAML1OBJECTBUILDER(AttributeDesignator);
 245         DECL_SAML1OBJECTBUILDER(AttributeStatement);
 246         DECL_SAML1OBJECTBUILDER(AttributeValue);
 247         DECL_SAML1OBJECTBUILDER(Audience);
 248         DECL_SAML1OBJECTBUILDER(AudienceRestrictionCondition);
 249         DECL_SAML1OBJECTBUILDER(AuthenticationStatement);
 250         DECL_SAML1OBJECTBUILDER(AuthorizationDecisionStatement);
 251         DECL_SAML1OBJECTBUILDER(AuthorityBinding);
 252         DECL_SAML1OBJECTBUILDER(Conditions);
 253         DECL_SAML1OBJECTBUILDER(ConfirmationMethod);
 254         DECL_SAML1OBJECTBUILDER(DoNotCacheCondition);
 255         DECL_SAML1OBJECTBUILDER(Evidence);
 256         DECL_SAML1OBJECTBUILDER(NameIdentifier);
 257         DECL_SAML1OBJECTBUILDER(Subject);
 258         DECL_SAML1OBJECTBUILDER(SubjectConfirmation);
 259         DECL_SAML1OBJECTBUILDER(SubjectConfirmationData);
 260         DECL_SAML1OBJECTBUILDER(SubjectLocality);
 261
 262         /**
 263          * Registers builders and validators for SAML 1.x Assertion classes into the runtime.
 264          */
 265         void SAML_API registerAssertionClasses();
 266     };
 267 };
 268
 269 #endif /* __saml1_assertions_h__ */