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