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