2 * Copyright 2001-2009 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file saml/saml1/core/Assertions.h
20 * XMLObjects representing the SAML 1.x Assertions schema.
23 #ifndef __saml1_assertions_h__
24 #define __saml1_assertions_h__
26 #include <saml/Assertion.h>
27 #include <saml/util/SAMLConstants.h>
29 #include <xmltooling/ElementProxy.h>
30 #include <xmltooling/ConcreteXMLObjectBuilder.h>
32 #define DECL_SAML1OBJECTBUILDER(cname) \
33 DECL_XMLOBJECTBUILDER(SAML_API,cname,samlconstants::SAML1_NS,samlconstants::SAML1_PREFIX)
35 namespace xmltooling {
36 class XMLTOOL_API DateTime;
39 namespace xmlsignature {
40 class XMLTOOL_API KeyInfo;
41 class XMLTOOL_API Signature;
47 * @namespace opensaml::saml1
48 * SAML 1.x assertion namespace
53 class SAML_API Assertion;
55 DECL_XMLOBJECT_SIMPLE(SAML_API,AssertionIDReference,AssertionID,SAML 1.x AssertionIDReference element);
56 DECL_XMLOBJECT_SIMPLE(SAML_API,Audience,AudienceURI,SAML 1.x Audience element);
57 DECL_XMLOBJECT_SIMPLE(SAML_API,ConfirmationMethod,Method,SAML 1.x ConfirmationMethod element);
59 BEGIN_XMLOBJECT(SAML_API,Condition,xmltooling::XMLObject,SAML 1.x Condition element);
62 BEGIN_XMLOBJECT(SAML_API,AudienceRestrictionCondition,Condition,SAML 1.x AudienceRestrictionCondition element);
63 DECL_TYPED_CHILDREN(Audience);
64 /** AudienceRestrictionConditionType local name */
65 static const XMLCh TYPE_NAME[];
68 BEGIN_XMLOBJECT(SAML_API,DoNotCacheCondition,Condition,SAML 1.x DoNotCacheCondition element);
69 /** DoNotCacheConditionType local name */
70 static const XMLCh TYPE_NAME[];
73 BEGIN_XMLOBJECT(SAML_API,Conditions,xmltooling::XMLObject,SAML 1.x Conditions element);
74 DECL_DATETIME_ATTRIB(NotBefore,NOTBEFORE);
75 DECL_DATETIME_ATTRIB(NotOnOrAfter,NOTONORAFTER);
76 DECL_TYPED_CHILDREN(AudienceRestrictionCondition);
77 DECL_TYPED_CHILDREN(DoNotCacheCondition);
78 DECL_TYPED_CHILDREN(Condition);
79 /** ConditionsType local name */
80 static const XMLCh TYPE_NAME[];
83 BEGIN_XMLOBJECT(SAML_API,NameIdentifier,xmltooling::XMLObject,SAML 1.x NameIdentifier element);
84 DECL_STRING_ATTRIB(NameQualifier,NAMEQUALIFIER);
85 DECL_STRING_ATTRIB(Format,FORMAT);
86 DECL_SIMPLE_CONTENT(Name);
87 /** NameIdentifierType local name */
88 static const XMLCh TYPE_NAME[];
89 /** Unspecified name format ID */
90 static const XMLCh UNSPECIFIED[];
91 /** Email address name format ID */
92 static const XMLCh EMAIL[];
93 /** X.509 subject name format ID */
94 static const XMLCh X509_SUBJECT[];
95 /** Windows domain qualified name format ID */
96 static const XMLCh WIN_DOMAIN_QUALIFIED[];
99 BEGIN_XMLOBJECT(SAML_API,SubjectConfirmationData,xmltooling::ElementProxy,SAML 1.x SubjectConfirmationData element);
102 BEGIN_XMLOBJECT(SAML_API,SubjectConfirmation,xmltooling::XMLObject,SAML 1.x SubjectConfirmation element);
103 DECL_TYPED_CHILDREN(ConfirmationMethod);
104 DECL_XMLOBJECT_CHILD(SubjectConfirmationData);
105 DECL_TYPED_FOREIGN_CHILD(KeyInfo,xmlsignature);
106 /** SubjectConfirmationType local name */
107 static const XMLCh TYPE_NAME[];
108 /** Deprecated SAML 1.0 Artifact confirmation method */
109 static const XMLCh ARTIFACT01[];
110 /** Artifact confirmation method */
111 static const XMLCh ARTIFACT[];
112 /** Bearer confirmation method */
113 static const XMLCh BEARER[];
114 /** Holder of key confirmation method */
115 static const XMLCh HOLDER_KEY[];
116 /** Sender vouches confirmation method */
117 static const XMLCh SENDER_VOUCHES[];
120 BEGIN_XMLOBJECT(SAML_API,Subject,xmltooling::XMLObject,SAML 1.x Subject element);
121 DECL_TYPED_CHILD(NameIdentifier);
122 DECL_TYPED_CHILD(SubjectConfirmation);
123 /** SubjectType local name */
124 static const XMLCh TYPE_NAME[];
127 BEGIN_XMLOBJECT(SAML_API,Statement,xmltooling::XMLObject,SAML 1.x Statement element);
130 BEGIN_XMLOBJECT(SAML_API,SubjectStatement,Statement,SAML 1.x SubjectStatement element);
131 DECL_TYPED_CHILD(Subject);
134 BEGIN_XMLOBJECT(SAML_API,SubjectLocality,xmltooling::XMLObject,SAML 1.x SubjectLocality element);
135 DECL_STRING_ATTRIB(IPAddress,IPADDRESS);
136 DECL_STRING_ATTRIB(DNSAddress,DNSADDRESS);
137 /** SubjectLocalityType local name */
138 static const XMLCh TYPE_NAME[];
141 BEGIN_XMLOBJECT(SAML_API,AuthorityBinding,xmltooling::XMLObject,SAML 1.x AuthorityBinding element);
142 DECL_XMLOBJECT_ATTRIB(AuthorityKind,AUTHORITYKIND,xmltooling::QName);
143 DECL_STRING_ATTRIB(Location,LOCATION);
144 DECL_STRING_ATTRIB(Binding,BINDING);
145 /** AuthorityBindingType local name */
146 static const XMLCh TYPE_NAME[];
149 BEGIN_XMLOBJECT(SAML_API,AuthenticationStatement,SubjectStatement,SAML 1.x AuthenticationStatement element);
150 DECL_STRING_ATTRIB(AuthenticationMethod,AUTHENTICATIONMETHOD);
151 DECL_DATETIME_ATTRIB(AuthenticationInstant,AUTHENTICATIONINSTANT);
152 DECL_TYPED_CHILD(SubjectLocality);
153 DECL_TYPED_CHILDREN(AuthorityBinding);
154 /** AuthenticationStatementType local name */
155 static const XMLCh TYPE_NAME[];
158 BEGIN_XMLOBJECT(SAML_API,Action,xmltooling::XMLObject,SAML 1.x Action element);
159 DECL_STRING_ATTRIB(Namespace,NAMESPACE);
160 DECL_SIMPLE_CONTENT(Action);
161 /** ActionType local name */
162 static const XMLCh TYPE_NAME[];
163 /** Read/Write/Execute/Delete/Control Action Namespace */
164 static const XMLCh RWEDC_NEG_ACTION_NAMESPACE[];
165 /** Read/Write/Execute/Delete/Control with Negation Action Namespace */
166 static const XMLCh RWEDC_ACTION_NAMESPACE[];
167 /** Get/Head/Put/Post Action Namespace */
168 static const XMLCh GHPP_ACTION_NAMESPACE[];
169 /** UNIX File Permissions Action Namespace */
170 static const XMLCh UNIX_ACTION_NAMESPACE[];
173 BEGIN_XMLOBJECT(SAML_API,Evidence,xmltooling::XMLObject,SAML 1.x Evidence element);
174 DECL_TYPED_CHILDREN(AssertionIDReference);
175 DECL_TYPED_CHILDREN(Assertion);
176 /** EvidenceType local name */
177 static const XMLCh TYPE_NAME[];
180 BEGIN_XMLOBJECT(SAML_API,AuthorizationDecisionStatement,SubjectStatement,SAML 1.x AuthorizationDecisionStatement element);
181 DECL_STRING_ATTRIB(Resource,RESOURCE);
182 DECL_STRING_ATTRIB(Decision,DECISION);
183 DECL_TYPED_CHILDREN(Action);
184 DECL_TYPED_CHILD(Evidence);
185 /** AuthorizationDecisionStatementType local name */
186 static const XMLCh TYPE_NAME[];
187 /** Permit Decision */
188 static const XMLCh DECISION_PERMIT[];
190 static const XMLCh DECISION_DENY[];
191 /** Indeterminate Decision */
192 static const XMLCh DECISION_INDETERMINATE[];
195 BEGIN_XMLOBJECT(SAML_API,AttributeDesignator,xmltooling::XMLObject,SAML 1.x AttributeDesignator element);
196 DECL_STRING_ATTRIB(AttributeName,ATTRIBUTENAME);
197 DECL_STRING_ATTRIB(AttributeNamespace,ATTRIBUTENAMESPACE);
198 /** AttributeDesignatorType local name */
199 static const XMLCh TYPE_NAME[];
202 BEGIN_XMLOBJECT(SAML_API,Attribute,AttributeDesignator,SAML 1.x Attribute element);
203 DECL_XMLOBJECT_CHILDREN(AttributeValue);
204 /** AttributeType local name */
205 static const XMLCh TYPE_NAME[];
208 BEGIN_XMLOBJECT(SAML_API,AttributeValue,xmltooling::ElementProxy,SAML 1.x AttributeValue element);
211 BEGIN_XMLOBJECT(SAML_API,AttributeStatement,SubjectStatement,SAML 1.x AttributeStatement element);
212 DECL_TYPED_CHILDREN(Attribute);
213 /** AttributeStatementType local name */
214 static const XMLCh TYPE_NAME[];
217 BEGIN_XMLOBJECT(SAML_API,Advice,xmltooling::ElementExtensibleXMLObject,SAML 1.x Advice element);
218 DECL_TYPED_CHILDREN(AssertionIDReference);
219 DECL_TYPED_CHILDREN(Assertion);
220 /** AdviceType local name */
221 static const XMLCh TYPE_NAME[];
224 BEGIN_XMLOBJECT(SAML_API,Assertion,opensaml::Assertion,SAML 1.x Assertion element);
225 DECL_INTEGER_ATTRIB(MinorVersion,MINORVERSION);
226 DECL_STRING_ATTRIB(AssertionID,ASSERTIONID);
227 DECL_STRING_ATTRIB(Issuer,ISSUER);
228 DECL_INHERITED_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
229 DECL_TYPED_CHILD(Conditions);
230 DECL_TYPED_CHILD(Advice);
231 DECL_TYPED_CHILDREN(Statement);
232 DECL_TYPED_CHILDREN(SubjectStatement);
233 DECL_TYPED_CHILDREN(AuthenticationStatement);
234 DECL_TYPED_CHILDREN(AttributeStatement);
235 DECL_TYPED_CHILDREN(AuthorizationDecisionStatement);
236 /** AssertionType local name */
237 static const XMLCh TYPE_NAME[];
240 DECL_SAML1OBJECTBUILDER(Action);
241 DECL_SAML1OBJECTBUILDER(Advice);
242 DECL_SAML1OBJECTBUILDER(Assertion);
243 DECL_SAML1OBJECTBUILDER(AssertionIDReference);
244 DECL_SAML1OBJECTBUILDER(Attribute);
245 DECL_SAML1OBJECTBUILDER(AttributeDesignator);
246 DECL_SAML1OBJECTBUILDER(AttributeStatement);
247 DECL_SAML1OBJECTBUILDER(AttributeValue);
248 DECL_SAML1OBJECTBUILDER(Audience);
249 DECL_SAML1OBJECTBUILDER(AudienceRestrictionCondition);
250 DECL_SAML1OBJECTBUILDER(AuthenticationStatement);
251 DECL_SAML1OBJECTBUILDER(AuthorizationDecisionStatement);
252 DECL_SAML1OBJECTBUILDER(AuthorityBinding);
253 DECL_SAML1OBJECTBUILDER(Conditions);
254 DECL_SAML1OBJECTBUILDER(ConfirmationMethod);
255 DECL_SAML1OBJECTBUILDER(DoNotCacheCondition);
256 DECL_SAML1OBJECTBUILDER(Evidence);
257 DECL_SAML1OBJECTBUILDER(NameIdentifier);
258 DECL_SAML1OBJECTBUILDER(Subject);
259 DECL_SAML1OBJECTBUILDER(SubjectConfirmation);
260 DECL_SAML1OBJECTBUILDER(SubjectConfirmationData);
261 DECL_SAML1OBJECTBUILDER(SubjectLocality);
264 * Builder for Condition extension objects.
266 * This is customized to force the schema type to be specified.
268 class SAML_API ConditionBuilder : public xmltooling::XMLObjectBuilder {
270 virtual ~ConditionBuilder() {}
271 /** Builder that allows element/type override. */
272 #ifdef HAVE_COVARIANT_RETURNS
273 virtual Condition* buildObject(
275 virtual xmltooling::XMLObject* buildObject(
277 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const xmltooling::QName* schemaType=NULL
280 /** Singleton builder. */
281 static Condition* buildCondition(const xmltooling::QName& schemaType) {
282 const ConditionBuilder* b = dynamic_cast<const ConditionBuilder*>(
283 XMLObjectBuilder::getBuilder(xmltooling::QName(samlconstants::SAML1_NS,Condition::LOCAL_NAME))
286 #ifdef HAVE_COVARIANT_RETURNS
287 return b->buildObject(samlconstants::SAML1_NS, Condition::LOCAL_NAME, samlconstants::SAML1_PREFIX, &schemaType);
289 return dynamic_cast<Condition*>(b->buildObject(samlconstants::SAML1_NS, Condition::LOCAL_NAME, samlconstants::SAML1_PREFIX, &schemaType));
292 throw xmltooling::XMLObjectException("Unable to obtain typed builder for Condition.");
297 * Builder for Statement extension objects.
299 * This is customized to force the schema type to be specified.
301 class SAML_API StatementBuilder : public xmltooling::XMLObjectBuilder {
303 virtual ~StatementBuilder() {}
304 /** Builder that allows element/type override. */
305 #ifdef HAVE_COVARIANT_RETURNS
306 virtual Statement* buildObject(
308 virtual xmltooling::XMLObject* buildObject(
310 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const xmltooling::QName* schemaType=NULL
313 /** Singleton builder. */
314 static Statement* buildStatement(const xmltooling::QName& schemaType) {
315 const StatementBuilder* b = dynamic_cast<const StatementBuilder*>(
316 XMLObjectBuilder::getBuilder(xmltooling::QName(samlconstants::SAML1_NS,Statement::LOCAL_NAME))
319 #ifdef HAVE_COVARIANT_RETURNS
320 return b->buildObject(samlconstants::SAML1_NS, Statement::LOCAL_NAME, samlconstants::SAML1_PREFIX, &schemaType);
322 return dynamic_cast<Statement*>(b->buildObject(samlconstants::SAML1_NS, Statement::LOCAL_NAME, samlconstants::SAML1_PREFIX, &schemaType));
325 throw xmltooling::XMLObjectException("Unable to obtain typed builder for Statement.");
330 * Registers builders and validators for SAML 1.x Assertion classes into the runtime.
332 void SAML_API registerAssertionClasses();
336 #endif /* __saml1_assertions_h__ */