saml/saml1/core/Assertions.h

   1 /*
   2  *  Copyright 2001-2007 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/Assertion.h>
  27 #include <saml/util/SAMLConstants.h>
  28
  29 #include <xmltooling/ElementProxy.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
  35 #define DECL_SAML1OBJECTBUILDER(cname) \
  36     DECL_XMLOBJECTBUILDER(SAML_API,cname,samlconstants::SAML1_NS,samlconstants::SAML1_PREFIX)
  37
  38 namespace opensaml {
  39
  40     /**
  41      * @namespace opensaml::saml1
  42      * SAML 1.x assertion namespace
  43      */
  44     namespace saml1 {
  45
  46         // Forward references
  47         class SAML_API Assertion;
  48
  49         DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionIDReference,AssertionID,SAML 1.x AssertionIDReference element);
  50         DECL_XMLOBJECT_SIMPLE(SAML_API,Audience,AudienceURI,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_DATETIME_ATTRIB(NotBefore,NOTBEFORE);
  69             DECL_DATETIME_ATTRIB(NotOnOrAfter,NOTONORAFTER);
  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::XMLObject,SAML 1.x NameIdentifier element);
  78             DECL_STRING_ATTRIB(NameQualifier,NAMEQUALIFIER);
  79             DECL_STRING_ATTRIB(Format,FORMAT);
  80             DECL_SIMPLE_CONTENT(Name);
  81             /** NameIdentifierType local name */
  82             static const XMLCh TYPE_NAME[];
  83             /** Unspecified name format ID */
  84             static const XMLCh UNSPECIFIED[];
  85             /** Email address name format ID */
  86             static const XMLCh EMAIL[];
  87             /** X.509 subject name format ID */
  88             static const XMLCh X509_SUBJECT[];
  89             /** Windows domain qualified name format ID */
  90             static const XMLCh WIN_DOMAIN_QUALIFIED[];
  91         END_XMLOBJECT;
  92
  93         BEGIN_XMLOBJECT(SAML_API,SubjectConfirmationData,xmltooling::ElementProxy,SAML 1.x SubjectConfirmationData element);
  94         END_XMLOBJECT;
  95
  96         BEGIN_XMLOBJECT(SAML_API,SubjectConfirmation,xmltooling::XMLObject,SAML 1.x SubjectConfirmation element);
  97             DECL_TYPED_CHILDREN(ConfirmationMethod);
  98             DECL_XMLOBJECT_CHILD(SubjectConfirmationData);
  99             DECL_TYPED_FOREIGN_CHILD(KeyInfo,xmlsignature);
 100             /** SubjectConfirmationType local name */
 101             static const XMLCh TYPE_NAME[];
 102             /** Deprecated SAML 1.0 Artifact confirmation method */
 103             static const XMLCh ARTIFACT01[];
 104             /** Artifact confirmation method */
 105             static const XMLCh ARTIFACT[];
 106             /** Bearer confirmation method */
 107             static const XMLCh BEARER[];
 108             /** Holder of key confirmation method */
 109             static const XMLCh HOLDER_KEY[];
 110             /** Sender vouches confirmation method */
 111             static const XMLCh SENDER_VOUCHES[];
 112         END_XMLOBJECT;
 113
 114         BEGIN_XMLOBJECT(SAML_API,Subject,xmltooling::XMLObject,SAML 1.x Subject element);
 115             DECL_TYPED_CHILD(NameIdentifier);
 116             DECL_TYPED_CHILD(SubjectConfirmation);
 117             /** SubjectType local name */
 118             static const XMLCh TYPE_NAME[];
 119         END_XMLOBJECT;
 120
 121         BEGIN_XMLOBJECT(SAML_API,Statement,xmltooling::XMLObject,SAML 1.x Statement element);
 122         END_XMLOBJECT;
 123
 124         BEGIN_XMLOBJECT(SAML_API,SubjectStatement,Statement,SAML 1.x SubjectStatement element);
 125             DECL_TYPED_CHILD(Subject);
 126         END_XMLOBJECT;
 127
 128         BEGIN_XMLOBJECT(SAML_API,SubjectLocality,xmltooling::XMLObject,SAML 1.x SubjectLocality element);
 129             DECL_STRING_ATTRIB(IPAddress,IPADDRESS);
 130             DECL_STRING_ATTRIB(DNSAddress,DNSADDRESS);
 131             /** SubjectLocalityType local name */
 132             static const XMLCh TYPE_NAME[];
 133         END_XMLOBJECT;
 134
 135         BEGIN_XMLOBJECT(SAML_API,AuthorityBinding,xmltooling::XMLObject,SAML 1.x AuthorityBinding element);
 136             DECL_XMLOBJECT_ATTRIB(AuthorityKind,AUTHORITYKIND,xmltooling::QName);
 137             DECL_STRING_ATTRIB(Location,LOCATION);
 138             DECL_STRING_ATTRIB(Binding,BINDING);
 139             /** AuthorityBindingType local name */
 140             static const XMLCh TYPE_NAME[];
 141         END_XMLOBJECT;
 142
 143         BEGIN_XMLOBJECT(SAML_API,AuthenticationStatement,SubjectStatement,SAML 1.x AuthenticationStatement element);
 144             DECL_STRING_ATTRIB(AuthenticationMethod,AUTHENTICATIONMETHOD);
 145             DECL_DATETIME_ATTRIB(AuthenticationInstant,AUTHENTICATIONINSTANT);
 146             DECL_TYPED_CHILD(SubjectLocality);
 147             DECL_TYPED_CHILDREN(AuthorityBinding);
 148             /** AuthenticationStatementType local name */
 149             static const XMLCh TYPE_NAME[];
 150         END_XMLOBJECT;
 151
 152         BEGIN_XMLOBJECT(SAML_API,Action,xmltooling::XMLObject,SAML 1.x Action element);
 153             DECL_STRING_ATTRIB(Namespace,NAMESPACE);
 154             DECL_SIMPLE_CONTENT(Action);
 155             /** ActionType local name */
 156             static const XMLCh TYPE_NAME[];
 157             /** Read/Write/Execute/Delete/Control Action Namespace */
 158             static const XMLCh RWEDC_NEG_ACTION_NAMESPACE[];
 159             /** Read/Write/Execute/Delete/Control with Negation Action Namespace */
 160             static const XMLCh RWEDC_ACTION_NAMESPACE[];
 161             /** Get/Head/Put/Post Action Namespace */
 162             static const XMLCh GHPP_ACTION_NAMESPACE[];
 163             /** UNIX File Permissions Action Namespace */
 164             static const XMLCh UNIX_ACTION_NAMESPACE[];
 165         END_XMLOBJECT;
 166
 167         BEGIN_XMLOBJECT(SAML_API,Evidence,xmltooling::XMLObject,SAML 1.x Evidence element);
 168             DECL_TYPED_CHILDREN(AssertionIDReference);
 169             DECL_TYPED_CHILDREN(Assertion);
 170             /** EvidenceType local name */
 171             static const XMLCh TYPE_NAME[];
 172         END_XMLOBJECT;
 173
 174         BEGIN_XMLOBJECT(SAML_API,AuthorizationDecisionStatement,SubjectStatement,SAML 1.x AuthorizationDecisionStatement element);
 175             DECL_STRING_ATTRIB(Resource,RESOURCE);
 176             DECL_STRING_ATTRIB(Decision,DECISION);
 177             DECL_TYPED_CHILDREN(Action);
 178             DECL_TYPED_CHILD(Evidence);
 179             /** AuthorizationDecisionStatementType local name */
 180             static const XMLCh TYPE_NAME[];
 181             /** Permit Decision */
 182             static const XMLCh DECISION_PERMIT[];
 183             /** Deny Decision */
 184             static const XMLCh DECISION_DENY[];
 185             /** Indeterminate Decision */
 186             static const XMLCh DECISION_INDETERMINATE[];
 187         END_XMLOBJECT;
 188
 189         BEGIN_XMLOBJECT(SAML_API,AttributeDesignator,xmltooling::XMLObject,SAML 1.x AttributeDesignator element);
 190             DECL_STRING_ATTRIB(AttributeName,ATTRIBUTENAME);
 191             DECL_STRING_ATTRIB(AttributeNamespace,ATTRIBUTENAMESPACE);
 192             /** AttributeDesignatorType local name */
 193             static const XMLCh TYPE_NAME[];
 194         END_XMLOBJECT;
 195
 196         BEGIN_XMLOBJECT(SAML_API,Attribute,AttributeDesignator,SAML 1.x Attribute element);
 197             DECL_XMLOBJECT_CHILDREN(AttributeValue);
 198             /** AttributeType local name */
 199             static const XMLCh TYPE_NAME[];
 200         END_XMLOBJECT;
 201
 202         BEGIN_XMLOBJECT(SAML_API,AttributeValue,xmltooling::ElementProxy,SAML 1.x AttributeValue element);
 203         END_XMLOBJECT;
 204
 205         BEGIN_XMLOBJECT(SAML_API,AttributeStatement,SubjectStatement,SAML 1.x AttributeStatement element);
 206             DECL_TYPED_CHILDREN(Attribute);
 207             /** AttributeStatementType local name */
 208             static const XMLCh TYPE_NAME[];
 209         END_XMLOBJECT;
 210
 211         BEGIN_XMLOBJECT(SAML_API,Advice,xmltooling::ElementExtensibleXMLObject,SAML 1.x Advice element);
 212             DECL_TYPED_CHILDREN(AssertionIDReference);
 213             DECL_TYPED_CHILDREN(Assertion);
 214             /** AdviceType local name */
 215             static const XMLCh TYPE_NAME[];
 216         END_XMLOBJECT;
 217
 218         BEGIN_XMLOBJECT(SAML_API,Assertion,opensaml::Assertion,SAML 1.x Assertion element);
 219             DECL_INTEGER_ATTRIB(MinorVersion,MINORVERSION);
 220             DECL_STRING_ATTRIB(AssertionID,ASSERTIONID);
 221             DECL_STRING_ATTRIB(Issuer,ISSUER);
 222             DECL_INHERITED_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
 223             DECL_TYPED_CHILD(Conditions);
 224             DECL_TYPED_CHILD(Advice);
 225             DECL_TYPED_CHILDREN(Statement);
 226             DECL_TYPED_CHILDREN(SubjectStatement);
 227             DECL_TYPED_CHILDREN(AuthenticationStatement);
 228             DECL_TYPED_CHILDREN(AttributeStatement);
 229             DECL_TYPED_CHILDREN(AuthorizationDecisionStatement);
 230             /** AssertionType local name */
 231             static const XMLCh TYPE_NAME[];
 232         END_XMLOBJECT;
 233
 234         DECL_SAML1OBJECTBUILDER(Action);
 235         DECL_SAML1OBJECTBUILDER(Advice);
 236         DECL_SAML1OBJECTBUILDER(Assertion);
 237         DECL_SAML1OBJECTBUILDER(AssertionIDReference);
 238         DECL_SAML1OBJECTBUILDER(Attribute);
 239         DECL_SAML1OBJECTBUILDER(AttributeDesignator);
 240         DECL_SAML1OBJECTBUILDER(AttributeStatement);
 241         DECL_SAML1OBJECTBUILDER(AttributeValue);
 242         DECL_SAML1OBJECTBUILDER(Audience);
 243         DECL_SAML1OBJECTBUILDER(AudienceRestrictionCondition);
 244         DECL_SAML1OBJECTBUILDER(AuthenticationStatement);
 245         DECL_SAML1OBJECTBUILDER(AuthorizationDecisionStatement);
 246         DECL_SAML1OBJECTBUILDER(AuthorityBinding);
 247         DECL_SAML1OBJECTBUILDER(Conditions);
 248         DECL_SAML1OBJECTBUILDER(ConfirmationMethod);
 249         DECL_SAML1OBJECTBUILDER(DoNotCacheCondition);
 250         DECL_SAML1OBJECTBUILDER(Evidence);
 251         DECL_SAML1OBJECTBUILDER(NameIdentifier);
 252         DECL_SAML1OBJECTBUILDER(Subject);
 253         DECL_SAML1OBJECTBUILDER(SubjectConfirmation);
 254         DECL_SAML1OBJECTBUILDER(SubjectConfirmationData);
 255         DECL_SAML1OBJECTBUILDER(SubjectLocality);
 256
 257         /**
 258          * Builder for Condition extension objects.
 259          *
 260          * This is customized to force the schema type to be specified.
 261          */
 262         class SAML_API ConditionBuilder : public xmltooling::XMLObjectBuilder {
 263         public:
 264             virtual ~ConditionBuilder() {}
 265             /** Builder that allows element/type override. */
 266 #ifdef HAVE_COVARIANT_RETURNS
 267             virtual Condition* buildObject(
 268 #else
 269             virtual xmltooling::XMLObject* buildObject(
 270 #endif
 271                 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const xmltooling::QName* schemaType=NULL
 272                 ) const;
 273
 274             /** Singleton builder. */
 275             static Condition* buildCondition(const xmltooling::QName& schemaType) {
 276                 const ConditionBuilder* b = dynamic_cast<const ConditionBuilder*>(
 277                     XMLObjectBuilder::getBuilder(xmltooling::QName(samlconstants::SAML1_NS,Condition::LOCAL_NAME))
 278                     );
 279                 if (b) {
 280 #ifdef HAVE_COVARIANT_RETURNS
 281                     return b->buildObject(samlconstants::SAML1_NS, Condition::LOCAL_NAME, samlconstants::SAML1_PREFIX, &schemaType);
 282 #else
 283                     return dynamic_cast<Condition*>(b->buildObject(samlconstants::SAML1_NS, Condition::LOCAL_NAME, samlconstants::SAML1_PREFIX, &schemaType));
 284 #endif
 285                 }
 286                 throw xmltooling::XMLObjectException("Unable to obtain typed builder for Condition.");
 287             }
 288         };
 289
 290         /**
 291          * Builder for Statement extension objects.
 292          *
 293          * This is customized to force the schema type to be specified.
 294          */
 295         class SAML_API StatementBuilder : public xmltooling::XMLObjectBuilder {
 296         public:
 297             virtual ~StatementBuilder() {}
 298             /** Builder that allows element/type override. */
 299 #ifdef HAVE_COVARIANT_RETURNS
 300             virtual Statement* buildObject(
 301 #else
 302             virtual xmltooling::XMLObject* buildObject(
 303 #endif
 304                 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const xmltooling::QName* schemaType=NULL
 305                 ) const;
 306
 307             /** Singleton builder. */
 308             static Statement* buildStatement(const xmltooling::QName& schemaType) {
 309                 const StatementBuilder* b = dynamic_cast<const StatementBuilder*>(
 310                     XMLObjectBuilder::getBuilder(xmltooling::QName(samlconstants::SAML1_NS,Statement::LOCAL_NAME))
 311                     );
 312                 if (b) {
 313 #ifdef HAVE_COVARIANT_RETURNS
 314                     return b->buildObject(samlconstants::SAML1_NS, Statement::LOCAL_NAME, samlconstants::SAML1_PREFIX, &schemaType);
 315 #else
 316                     return dynamic_cast<Statement*>(b->buildObject(samlconstants::SAML1_NS, Statement::LOCAL_NAME, samlconstants::SAML1_PREFIX, &schemaType));
 317 #endif
 318                 }
 319                 throw xmltooling::XMLObjectException("Unable to obtain typed builder for Statement.");
 320             }
 321         };
 322
 323         /**
 324          * Registers builders and validators for SAML 1.x Assertion classes into the runtime.
 325          */
 326         void SAML_API registerAssertionClasses();
 327     };
 328 };
 329
 330 #endif /* __saml1_assertions_h__ */