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