2 * Copyright 2001-2006 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/RootObject.h>
27 #include <saml/util/SAMLConstants.h>
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>
35 #define DECL_SAML1OBJECTBUILDER(cname) \
36 DECL_XMLOBJECTBUILDER(SAML_API,cname,samlconstants::SAML1_NS,samlconstants::SAML1_PREFIX)
41 * @namespace opensaml::saml1
42 * SAML 1.x assertion namespace
47 class SAML_API Assertion;
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);
53 BEGIN_XMLOBJECT(SAML_API,Condition,xmltooling::XMLObject,SAML 1.x Condition element);
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[];
62 BEGIN_XMLOBJECT(SAML_API,DoNotCacheCondition,Condition,SAML 1.x DoNotCacheCondition element);
63 /** DoNotCacheConditionType local name */
64 static const XMLCh TYPE_NAME[];
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[];
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[];
93 BEGIN_XMLOBJECT(SAML_API,SubjectConfirmationData,xmltooling::ElementProxy,SAML 1.x SubjectConfirmationData element);
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[];
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[];
121 BEGIN_XMLOBJECT(SAML_API,Statement,xmltooling::XMLObject,SAML 1.x Statement element);
124 BEGIN_XMLOBJECT(SAML_API,SubjectStatement,Statement,SAML 1.x SubjectStatement element);
125 DECL_TYPED_CHILD(Subject);
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[];
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[];
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[];
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[];
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[];
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[];
184 static const XMLCh DECISION_DENY[];
185 /** Indeterminate Decision */
186 static const XMLCh DECISION_INDETERMINATE[];
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[];
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[];
202 BEGIN_XMLOBJECT(SAML_API,AttributeValue,xmltooling::ElementProxy,SAML 1.x AttributeValue element);
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[];
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[];
218 BEGIN_XMLOBJECT(SAML_API,Assertion,RootObject,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 DECL_INHERITED_TYPED_FOREIGN_CHILD(Signature,xmlsignature);
231 /** AssertionType local name */
232 static const XMLCh TYPE_NAME[];
235 DECL_SAML1OBJECTBUILDER(Action);
236 DECL_SAML1OBJECTBUILDER(Advice);
237 DECL_SAML1OBJECTBUILDER(Assertion);
238 DECL_SAML1OBJECTBUILDER(AssertionIDReference);
239 DECL_SAML1OBJECTBUILDER(Attribute);
240 DECL_SAML1OBJECTBUILDER(AttributeDesignator);
241 DECL_SAML1OBJECTBUILDER(AttributeStatement);
242 DECL_SAML1OBJECTBUILDER(AttributeValue);
243 DECL_SAML1OBJECTBUILDER(Audience);
244 DECL_SAML1OBJECTBUILDER(AudienceRestrictionCondition);
245 DECL_SAML1OBJECTBUILDER(AuthenticationStatement);
246 DECL_SAML1OBJECTBUILDER(AuthorizationDecisionStatement);
247 DECL_SAML1OBJECTBUILDER(AuthorityBinding);
248 DECL_SAML1OBJECTBUILDER(Conditions);
249 DECL_SAML1OBJECTBUILDER(ConfirmationMethod);
250 DECL_SAML1OBJECTBUILDER(DoNotCacheCondition);
251 DECL_SAML1OBJECTBUILDER(Evidence);
252 DECL_SAML1OBJECTBUILDER(NameIdentifier);
253 DECL_SAML1OBJECTBUILDER(Subject);
254 DECL_SAML1OBJECTBUILDER(SubjectConfirmation);
255 DECL_SAML1OBJECTBUILDER(SubjectConfirmationData);
256 DECL_SAML1OBJECTBUILDER(SubjectLocality);
259 * Registers builders and validators for SAML 1.x Assertion classes into the runtime.
261 void SAML_API registerAssertionClasses();
265 #endif /* __saml1_assertions_h__ */