3b5e68a89e2de6ea2b2733d658fbdcfb3f9d2ee2
[shibboleth/opensaml2.git] / saml / saml2 / core / Protocols.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/saml2/core/Protocols.h
19  * 
20  * XMLObjects representing the SAML 2.0 Protocols schema
21  */
22
23 #ifndef __saml2_protocols_h__
24 #define __saml2_protocols_h__
25
26 #include <saml/saml2/core/Assertions.h>
27
28 #define DECL_SAML2POBJECTBUILDER(cname) \
29     DECL_XMLOBJECTBUILDER(SAML_API,cname,samlconstants::SAML20P_NS,samlconstants::SAML20P_PREFIX)
30
31 namespace opensaml {
32
33     /**
34      * @namespace opensaml::saml2p
35      * SAML 2.0 protocol namespace
36      */
37     namespace saml2p {
38
39         DECL_XMLOBJECT_SIMPLE(SAML_API,Artifact,Artifact,SAML 2.0 Artifact element);
40         DECL_XMLOBJECT_SIMPLE(SAML_API,GetComplete,GetComplete,SAML 2.0 GetComplete element);
41         DECL_XMLOBJECT_SIMPLE(SAML_API,NewID,NewID,SAML 2.0 NewID element);
42         DECL_XMLOBJECT_SIMPLE(SAML_API,RequesterID,RequesterID,SAML 2.0 RequesterID element);
43         DECL_XMLOBJECT_SIMPLE(SAML_API,SessionIndex,SessionIndex,SAML 2.0 SessionIndex element);
44         DECL_XMLOBJECT_SIMPLE(SAML_API,StatusMessage,Message,SAML 2.0 StatusMessage element);
45
46         DECL_XMLOBJECT_SIMPLE(SAML_API,RespondTo,Name,SAML 2.0 third-party request RespondTo extension element);
47
48         BEGIN_XMLOBJECT(SAML_API,Extensions,xmltooling::ElementExtensibleXMLObject,SAML 2.0 protocol Extensions element);
49             /** ExtensionsType local name */
50             static const XMLCh TYPE_NAME[];
51         END_XMLOBJECT;
52
53         BEGIN_XMLOBJECT(SAML_API,RequestAbstractType,saml2::RootObject,SAML 2.0 RequestAbstractType base type);
54             DECL_INHERITED_STRING_ATTRIB(ID,ID);
55             DECL_INHERITED_STRING_ATTRIB(Version,VER);
56             DECL_INHERITED_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
57             DECL_STRING_ATTRIB(Destination,DESTINATION);
58             DECL_STRING_ATTRIB(Consent,CONSENT);
59             DECL_INHERITED_TYPED_FOREIGN_CHILD(Issuer,saml2);
60             DECL_TYPED_CHILD(Extensions);
61             /** RequestAbstractType local name */
62             static const XMLCh TYPE_NAME[];
63         END_XMLOBJECT;
64
65         BEGIN_XMLOBJECT(SAML_API,StatusCode,xmltooling::XMLObject,SAML 2.0 StatusCode element);
66             DECL_STRING_ATTRIB(Value,VALUE);
67             DECL_TYPED_CHILD(StatusCode);
68             /** StatusCodeType local name */
69             static const XMLCh TYPE_NAME[];
70
71             /**
72               * @name StatusCode Value Attribute URI Reference Constants
73               *
74               * SAML 2.0 Core, section 3.2.2.2, predefines several URI
75               * references for use in the Value attribue of the StatusCode
76               * element.  Other values may be defined elsewhere.
77               */
78             /*@{*/
79             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:Success' */
80             static const XMLCh SUCCESS[];
81             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:Requester' */
82             static const XMLCh REQUESTER[];
83             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:Responder' */
84             static const XMLCh RESPONDER[];
85             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:VersionMismatch' */
86             static const XMLCh VERSION_MISMATCH[];
87             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:AuthnFailed' */
88             static const XMLCh AUTHN_FAILED[];
89             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:InvalidAttrNameOrValue' */
90             static const XMLCh INVALID_ATTR_NAME_OR_VALUE[];
91             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:InvalidNameIDPolicy' */
92             static const XMLCh INVALID_NAMEID_POLICY[];
93             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:NoAuthnContext' */
94             static const XMLCh NO_AUTHN_CONTEXT[];
95             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:NoAvailableIDP' */
96             static const XMLCh NO_AVAILABLE_IDP[];
97             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:NoPassive' */
98             static const XMLCh NO_PASSIVE[];
99             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:NoSupportedIDP' */
100             static const XMLCh NO_SUPPORTED_IDP[];
101             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:PartialLogout' */
102             static const XMLCh PARTIAL_LOGOUT[];
103             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded' */
104             static const XMLCh PROXY_COUNT_EXCEEDED[];
105             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:RequestDenied' */
106             static const XMLCh REQUEST_DENIED[];
107             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:RequestUnsupported' */
108             static const XMLCh REQUEST_UNSUPPORTED[];
109             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:RequestVersionDeprecated' */
110             static const XMLCh REQUEST_VERSION_DEPRECATED[];
111             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooHigh' */
112             static const XMLCh REQUEST_VERSION_TOO_HIGH[];
113             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooLow' */
114             static const XMLCh REQUEST_VERSION_TOO_LOW[];
115             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:ResourceNotRecognized' */
116             static const XMLCh RESOURCE_NOT_RECOGNIZED[];
117             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:TooManyResponses' */
118             static const XMLCh TOO_MANY_RESPONSES[];
119             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile' */
120             static const XMLCh UNKNOWN_ATTR_PROFILE[];
121             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal' */
122             static const XMLCh UNKNOWN_PRINCIPAL[];
123             /** StatusCode Value 'urn:oasis:names:tc:SAML:2.0:status:UnsupportedBinding' */
124             static const XMLCh UNSUPPORTED_BINDING[];
125             /*@{*/
126         END_XMLOBJECT;
127
128         BEGIN_XMLOBJECT(SAML_API,StatusDetail,xmltooling::ElementExtensibleXMLObject,SAML 2.0 StatusDetail element);
129             /** StatusDetailType local name */
130             static const XMLCh TYPE_NAME[];
131         END_XMLOBJECT;
132
133         BEGIN_XMLOBJECT(SAML_API,Status,xmltooling::XMLObject,SAML 2.0 Status element);
134             DECL_TYPED_CHILD(StatusCode);
135             DECL_TYPED_CHILD(StatusMessage);
136             DECL_TYPED_CHILD(StatusDetail);
137             /** StatusType local name */
138             static const XMLCh TYPE_NAME[];
139         END_XMLOBJECT;
140
141         BEGIN_XMLOBJECT(SAML_API,StatusResponseType,saml2::RootObject,SAML 2.0 StatusResponseType base type);
142             DECL_INHERITED_STRING_ATTRIB(ID,ID);
143             DECL_STRING_ATTRIB(InResponseTo,INRESPONSETO);
144             DECL_INHERITED_STRING_ATTRIB(Version,VER);
145             DECL_INHERITED_DATETIME_ATTRIB(IssueInstant,ISSUEINSTANT);
146             DECL_STRING_ATTRIB(Destination,DESTINATION);
147             DECL_STRING_ATTRIB(Consent,CONSENT);
148             DECL_INHERITED_TYPED_FOREIGN_CHILD(Issuer,saml2);
149             DECL_TYPED_CHILD(Extensions);
150             DECL_TYPED_CHILD(Status);
151             /** StatusResponseType local name */
152             static const XMLCh TYPE_NAME[];
153         END_XMLOBJECT;
154
155         BEGIN_XMLOBJECT(SAML_API,AssertionIDRequest,RequestAbstractType,SAML 2.0 AssertionIDRequest element);
156             DECL_TYPED_FOREIGN_CHILDREN(AssertionIDRef,saml2);
157             /** AssertionIDRequest local name */
158             static const XMLCh TYPE_NAME[];
159         END_XMLOBJECT;
160
161         BEGIN_XMLOBJECT(SAML_API,SubjectQuery,RequestAbstractType,SAML 2.0 SubjectQuery abstract element);
162             DECL_TYPED_FOREIGN_CHILD(Subject,saml2);
163             /** SubjectQueryAbstractType local name */
164             static const XMLCh TYPE_NAME[];
165         END_XMLOBJECT;
166
167         BEGIN_XMLOBJECT(SAML_API,RequestedAuthnContext,xmltooling::XMLObject,SAML 2.0 RequestedAuthnContext element);
168             //TODO whether, and how, to enforce the controlled vocabulary (schema enumeration) for the Comparison attrib, as in the Java ? 
169             DECL_STRING_ATTRIB(Comparison,COMPARISON);
170             DECL_TYPED_FOREIGN_CHILDREN(AuthnContextClassRef,saml2);
171             DECL_TYPED_FOREIGN_CHILDREN(AuthnContextDeclRef,saml2);
172             /** RequestedAuthnContextType local name */
173             static const XMLCh TYPE_NAME[];
174
175             /**
176              * @name RequestedAuthnContext Comparison Attribute Constants
177              *
178              * These are the allowed values for the Comparison attribute of
179              * the RequestedAuthnContext element, as defined by SAML 2.0 Core.
180              */
181             /*@{*/
182             /** 'exact' Comparison */
183             static const XMLCh COMPARISON_EXACT[];
184             /** 'minimum' Comparison */
185             static const XMLCh COMPARISON_MINIMUM[];
186             /** 'maximum' Comparison */
187             static const XMLCh COMPARISON_MAXIMUM[];
188             /** 'better' Comparison */
189             static const XMLCh COMPARISON_BETTER[];
190             /*@}*/
191         END_XMLOBJECT;
192
193         BEGIN_XMLOBJECT(SAML_API,AuthnQuery,SubjectQuery,SAML 2.0 AuthnQuery element);
194             DECL_STRING_ATTRIB(SessionIndex,SESSIONINDEX);
195             DECL_TYPED_CHILD(RequestedAuthnContext);
196             /** AuthnQueryType local name */
197             static const XMLCh TYPE_NAME[];
198         END_XMLOBJECT;
199
200         BEGIN_XMLOBJECT(SAML_API,AttributeQuery,SubjectQuery,SAML 2.0 AttributeQuery element);
201             DECL_TYPED_FOREIGN_CHILDREN(Attribute,saml2);
202             /** AttributeQueryType local name */
203             static const XMLCh TYPE_NAME[];
204         END_XMLOBJECT;
205         
206         BEGIN_XMLOBJECT(SAML_API,AuthzDecisionQuery,SubjectQuery,SAML 2.0 AuthzDecisionQuery element);
207             DECL_STRING_ATTRIB(Resource,RESOURCE);
208             DECL_TYPED_FOREIGN_CHILDREN(Action,saml2);
209             DECL_TYPED_FOREIGN_CHILD(Evidence,saml2);
210             /** AuthzDecisionQueryType local name */
211             static const XMLCh TYPE_NAME[];
212         END_XMLOBJECT;
213
214         BEGIN_XMLOBJECT(SAML_API,NameIDPolicy,xmltooling::XMLObject,SAML 2.0 NameIDPolicy element);
215             DECL_STRING_ATTRIB(Format,FORMAT);
216             DECL_STRING_ATTRIB(SPNameQualifier,SPNAMEQUALIFIER);
217             DECL_BOOLEAN_ATTRIB(AllowCreate,ALLOWCREATE,false);
218             /** NameIDPolicyType local name */
219             static const XMLCh TYPE_NAME[];
220         END_XMLOBJECT;
221
222         BEGIN_XMLOBJECT(SAML_API,IDPEntry,xmltooling::XMLObject,SAML2.0 IDPEntry element);
223             DECL_STRING_ATTRIB(ProviderID,PROVIDERID);
224             DECL_STRING_ATTRIB(Name,NAME);
225             DECL_STRING_ATTRIB(Loc,LOC);
226             /** IDPEntryType local name */
227             static const XMLCh TYPE_NAME[];
228         END_XMLOBJECT;
229
230         BEGIN_XMLOBJECT(SAML_API,IDPList,xmltooling::XMLObject,SAML 2.0 IDPList element);
231             DECL_TYPED_CHILDREN(IDPEntry);
232             DECL_TYPED_CHILD(GetComplete);
233             /** IDPListType local name */
234             static const XMLCh TYPE_NAME[];
235         END_XMLOBJECT;
236
237         BEGIN_XMLOBJECT(SAML_API,Scoping,xmltooling::XMLObject,SAML 2.0 Scoping element);
238             DECL_INTEGER_ATTRIB(ProxyCount,PROXYCOUNT);
239             DECL_TYPED_CHILD(IDPList);
240             DECL_TYPED_CHILDREN(RequesterID);
241             /** ScopingType local name */
242             static const XMLCh TYPE_NAME[];
243         END_XMLOBJECT;
244
245         BEGIN_XMLOBJECT(SAML_API,AuthnRequest,RequestAbstractType,SAML 2.0 AuthnRequest element);
246             DECL_BOOLEAN_ATTRIB(ForceAuthn,FORCEAUTHN,false);
247             DECL_BOOLEAN_ATTRIB(IsPassive,ISPASSIVE,false);
248             DECL_STRING_ATTRIB(ProtocolBinding,PROTOCOLBINDING);
249             DECL_INTEGER_ATTRIB(AssertionConsumerServiceIndex,ASSERTIONCONSUMERSERVICEINDEX);
250             DECL_STRING_ATTRIB(AssertionConsumerServiceURL,ASSERTIONCONSUMERSERVICEURL);
251             DECL_INTEGER_ATTRIB(AttributeConsumingServiceIndex,ATTRIBUTECONSUMINGSERVICEINDEX);
252             DECL_STRING_ATTRIB(ProviderName,PROVIDERNAME);
253
254             DECL_TYPED_FOREIGN_CHILD(Subject,saml2);
255             DECL_TYPED_CHILD(NameIDPolicy);
256             DECL_TYPED_FOREIGN_CHILD(Conditions,saml2);
257             DECL_TYPED_CHILD(RequestedAuthnContext);
258             DECL_TYPED_CHILD(Scoping);
259             /** AuthnRequestType local name */
260             static const XMLCh TYPE_NAME[];
261         END_XMLOBJECT;
262
263         BEGIN_XMLOBJECT(SAML_API,Response,StatusResponseType,SAML 2.0 Response element);
264             DECL_TYPED_FOREIGN_CHILDREN(Assertion,saml2);
265             DECL_TYPED_FOREIGN_CHILDREN(EncryptedAssertion,saml2);
266             /** ResponseType local name */
267             static const XMLCh TYPE_NAME[];
268         END_XMLOBJECT;
269
270         BEGIN_XMLOBJECT(SAML_API,ArtifactResolve,RequestAbstractType,SAML 2.0 ArtifactResolve element);
271             DECL_TYPED_CHILD(Artifact);
272             /** ArtifiactResolveType local name */
273             static const XMLCh TYPE_NAME[];
274         END_XMLOBJECT;
275
276         BEGIN_XMLOBJECT(SAML_API,ArtifactResponse,StatusResponseType,SAML 2.0 ArtifactResponse element);
277             DECL_XMLOBJECT_CHILD(Payload);
278             /** ArtifiactResponseType local name */
279             static const XMLCh TYPE_NAME[];
280         END_XMLOBJECT;
281
282         BEGIN_XMLOBJECT(SAML_API,Terminate,xmltooling::XMLObject,SAML 2.0 Terminate element);
283             /** TerminateType local name */
284             static const XMLCh TYPE_NAME[];
285         END_XMLOBJECT;
286
287         BEGIN_XMLOBJECT(SAML_API,NewEncryptedID,saml2::EncryptedElementType,SAML 2.0 NewEncryptedID element);
288         END_XMLOBJECT;
289
290         BEGIN_XMLOBJECT(SAML_API,ManageNameIDRequest,RequestAbstractType,SAML 2.0 ManageNameIDRequest element);
291             DECL_TYPED_FOREIGN_CHILD(NameID,saml2);
292             DECL_TYPED_FOREIGN_CHILD(EncryptedID,saml2);
293             DECL_TYPED_CHILD(NewID);
294             DECL_TYPED_CHILD(NewEncryptedID);
295             DECL_TYPED_CHILD(Terminate);
296             /** ManageNameIDRequestType local name */
297             static const XMLCh TYPE_NAME[];
298         END_XMLOBJECT;
299
300         BEGIN_XMLOBJECT(SAML_API,ManageNameIDResponse,StatusResponseType,SAML 2.0 ManageNameIDResponse element);
301         END_XMLOBJECT;
302         
303         BEGIN_XMLOBJECT(SAML_API,LogoutRequest,RequestAbstractType,SAML 2.0 LogoutRequest element);
304             DECL_STRING_ATTRIB(Reason,REASON);
305             DECL_DATETIME_ATTRIB(NotOnOrAfter,NOTONORAFTER);
306             DECL_TYPED_FOREIGN_CHILD(BaseID,saml2);
307             DECL_TYPED_FOREIGN_CHILD(NameID,saml2);
308             DECL_TYPED_FOREIGN_CHILD(EncryptedID,saml2);
309             DECL_TYPED_CHILDREN(SessionIndex);
310
311             /** LogoutRequestType local name */
312             static const XMLCh TYPE_NAME[];
313
314             /**
315               * @name LogoutRequest Reason URI Constants
316               * 
317               * URI Constants for the Reason attribute of the LogoutRequest
318               * element as defined by SAML 2.0 Core, section 3.7.3.
319               */
320             /*@{*/
321             /** Reason value 'urn:oasis:names:tc:SAML:2.0:logout:user' */
322             static const XMLCh REASON_USER[];
323             /** Reason value 'urn:oasis:names:tc:SAML:2.0:logout:admin' */
324             static const XMLCh REASON_ADMIN[];
325             /** Reason value 'urn:oasis:names:tc:SAML:2.0:logout:global-timeout' */
326             static const XMLCh REASON_GLOBAL_TIMEOUT[];
327             /** Reason value 'urn:oasis:names:tc:SAML:2.0:logout:sp-timeout' */
328             static const XMLCh REASON_SP_TIMEOUT[];
329             /*@}*/
330         END_XMLOBJECT;
331
332         BEGIN_XMLOBJECT(SAML_API,LogoutResponse,StatusResponseType,SAML 2.0 LogoutResponse element);
333         END_XMLOBJECT;
334
335         BEGIN_XMLOBJECT(SAML_API,NameIDMappingRequest,RequestAbstractType,SAML 2.0 NameIDMappingRequest element);
336             DECL_TYPED_FOREIGN_CHILD(BaseID,saml2);
337             DECL_TYPED_FOREIGN_CHILD(NameID,saml2);
338             DECL_TYPED_FOREIGN_CHILD(EncryptedID,saml2);
339             DECL_TYPED_CHILD(NameIDPolicy);
340             /** NameIDMappingRequestType local name */
341             static const XMLCh TYPE_NAME[];
342         END_XMLOBJECT;
343
344         BEGIN_XMLOBJECT(SAML_API,NameIDMappingResponse,StatusResponseType,SAML 2.0 NameIDMappingResponse element);
345             DECL_TYPED_FOREIGN_CHILD(NameID,saml2);
346             DECL_TYPED_FOREIGN_CHILD(EncryptedID,saml2);
347             /** NameIDMappingResponseType local name */
348             static const XMLCh TYPE_NAME[];
349         END_XMLOBJECT;
350
351
352         // Builders
353         DECL_SAML2POBJECTBUILDER(Artifact);
354         DECL_SAML2POBJECTBUILDER(ArtifactResolve);
355         DECL_SAML2POBJECTBUILDER(ArtifactResponse);
356         DECL_SAML2POBJECTBUILDER(AssertionIDRequest);
357         DECL_SAML2POBJECTBUILDER(AttributeQuery);
358         DECL_SAML2POBJECTBUILDER(AuthnQuery);
359         DECL_SAML2POBJECTBUILDER(AuthnRequest);
360         DECL_SAML2POBJECTBUILDER(AuthzDecisionQuery);
361         DECL_SAML2POBJECTBUILDER(Extensions);
362         DECL_SAML2POBJECTBUILDER(GetComplete);
363         DECL_SAML2POBJECTBUILDER(IDPEntry);
364         DECL_SAML2POBJECTBUILDER(IDPList);
365         DECL_SAML2POBJECTBUILDER(LogoutRequest);
366         DECL_SAML2POBJECTBUILDER(LogoutResponse);
367         DECL_SAML2POBJECTBUILDER(ManageNameIDRequest);
368         DECL_SAML2POBJECTBUILDER(ManageNameIDResponse);
369         DECL_SAML2POBJECTBUILDER(NameIDMappingRequest);
370         DECL_SAML2POBJECTBUILDER(NameIDMappingResponse);
371         DECL_SAML2POBJECTBUILDER(NameIDPolicy);
372         DECL_SAML2POBJECTBUILDER(NewEncryptedID);
373         DECL_SAML2POBJECTBUILDER(NewID);
374         DECL_SAML2POBJECTBUILDER(RequestedAuthnContext);
375         DECL_SAML2POBJECTBUILDER(RequesterID);
376         DECL_SAML2POBJECTBUILDER(Response);
377         DECL_SAML2POBJECTBUILDER(Scoping);
378         DECL_SAML2POBJECTBUILDER(SessionIndex);
379         DECL_SAML2POBJECTBUILDER(Status);
380         DECL_SAML2POBJECTBUILDER(StatusCode);
381         DECL_SAML2POBJECTBUILDER(StatusDetail);
382         DECL_SAML2POBJECTBUILDER(StatusMessage);
383         DECL_SAML2POBJECTBUILDER(Terminate);
384         
385         DECL_XMLOBJECTBUILDER(SAML_API,RespondTo,samlconstants::SAML20P_THIRDPARTY_EXT_NS,samlconstants::SAML20P_THIRDPARTY_EXT_PREFIX);
386
387         /**
388          * Registers builders and validators for SAML 2.0 Protocol classes into the runtime.
389          */
390         void SAML_API registerProtocolClasses();
391     };
392 };
393
394 #endif /* __saml2_protocols_h__ */