Made cookieName optional.
[shibboleth/cpp-sp.git] / schemas / shibboleth-targetconfig-1.0.xsd
1 <?xml version="1.0" encoding="US-ASCII"?>
2 <schema targetNamespace="urn:mace:shibboleth:target:config:1.0"
3         xmlns="http://www.w3.org/2001/XMLSchema"
4         xmlns:conf="urn:mace:shibboleth:target:config:1.0"
5         xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
6         elementFormDefault="qualified"
7         attributeFormDefault="unqualified"
8         blockDefault="substitution"
9         version="1.0">
10
11         <import namespace="http://www.w3.org/2000/09/xmldsig#" schemaLocation="xmldsig-core-schema.xsd"/>
12         <import namespace="urn:oasis:names:tc:SAML:1.0:assertion" schemaLocation="cs-sstc-schema-assertion-1.1.xsd"/>
13
14         <annotation>
15                 <documentation>
16         1.0 schema for XML-based configuration of Shibboleth target libraries and modules.
17         First appearing in Shibboleth 1.2 release.
18         </documentation>
19     </annotation>
20
21         <complexType name="PluggableType">
22                 <complexContent>
23                         <extension base="anyType">
24                                 <attribute name="type" type="string" use="required"/>
25                         </extension>
26                 </complexContent>
27         </complexType>
28
29         <element name="ShibbolethTargetConfig">
30                 <annotation>
31                         <documentation>Outer element of configuration file</documentation>
32                 </annotation>
33                 <complexType>
34                         <sequence>
35                                 <element ref="conf:Extensions" minOccurs="0"/>
36                                 <element ref="conf:SHAR" minOccurs="0"/>
37                                 <element ref="conf:SHIRE" minOccurs="0"/>
38                                 <element ref="conf:Applications"/>
39                                 <element name="CredentialsProvider" type="conf:PluggableType" maxOccurs="unbounded"/>
40                         </sequence>
41                         <attribute name="logger" type="anyURI" use="optional"/>
42                         <attribute name="clockSkew" type="unsignedInt" use="optional"/>
43                         <anyAttribute namespace="##other" processContents="lax"/>
44                 </complexType>
45         </element>
46
47         <element name="Extensions">
48                 <annotation>
49                         <documentation>Container for extension libraries and custom configuration</documentation>
50                 </annotation>
51                 <complexType>
52                         <sequence>
53                                 <element name="Library" minOccurs="0" maxOccurs="unbounded">
54                                         <complexType>
55                                     <complexContent>
56                                         <extension base="anyType">
57                                                 <attribute name="path" type="anyURI" use="required"/>
58                                                                 <attribute name="fatal" type="boolean" use="optional"/>
59                                         </extension>
60                                     </complexContent>
61                                         </complexType>
62                                 </element>
63                                 <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
64                         </sequence>
65                 </complexType>
66         </element>
67
68         <element name="SHAR">
69                 <annotation>
70                         <documentation>Container for SHAR configuration</documentation>
71                 </annotation>
72                 <complexType>
73                         <sequence>
74                                 <element ref="conf:Extensions" minOccurs="0"/>
75                                 <choice>
76                                         <element name="UnixListener">
77                                                 <complexType>
78                                                         <complexContent>
79                                                                 <extension base="anyType">
80                                                                         <attribute name="address" type="string" use="required"/>
81                                                                 </extension>
82                                                         </complexContent>
83                                                 </complexType>
84                                         </element>
85                                         <element name="TCPListener">
86                                                 <complexType>
87                                                         <complexContent>
88                                                                 <extension base="anyType">
89                                                                         <attribute name="address" type="string" use="required"/>
90                                                                         <attribute name="port" type="unsignedInt" use="required"/>
91                                                                         <attribute name="acl" use="optional" default="127.0.0.1">
92                                                                                 <simpleType>
93                                                                                         <list itemType="string"/>
94                                                                                 </simpleType>
95                                                                         </attribute>
96                                                                 </extension>
97                                                         </complexContent>
98                                                 </complexType>
99                                         </element>
100                                         <element name="Listener" type="conf:PluggableType"/>
101                                 </choice>
102                                 <choice>
103                                         <element name="MemorySessionCache">
104                                                 <complexType>
105                                                         <complexContent>
106                                                                 <restriction base="anyType" mixed="false">
107                                                                         <sequence/>
108                                                                         <attributeGroup ref="conf:SessionCacheProperties"/>
109                                                                         <anyAttribute namespace="##other" processContents="lax"/>
110                                                                 </restriction>
111                                                         </complexContent>
112                                                 </complexType>
113                                         </element>
114                                         <element name="MySQLSessionCache">
115                                                 <complexType>
116                                                         <complexContent>
117                                                                 <restriction base="anyType" mixed="false">
118                                                                         <sequence>
119                                                                                 <element name="Argument" type="string" minOccurs="0" maxOccurs="unbounded"/>
120                                                                         </sequence>
121                                                                         <attributeGroup ref="conf:SessionCacheProperties"/>
122                                                                         <attribute name="mysqlTimeout" type="unsignedInt" use="optional" default="14400"/>
123                                                                         <anyAttribute namespace="##other" processContents="lax"/>
124                                                                 </restriction>
125                                                         </complexContent>
126                                                 </complexType>
127                                         </element>
128                                         <element name="SessionCache">
129                                                 <complexType>
130                                             <complexContent>
131                                                 <extension base="conf:PluggableType">
132                                                         <attributeGroup ref="conf:SessionCacheProperties"/>
133                                                 </extension>
134                                             </complexContent>
135                                                 </complexType>
136                                         </element>
137                                 </choice>
138                                 <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
139                         </sequence>
140                         <attribute name="logger" type="anyURI" use="optional"/>
141                         <anyAttribute namespace="##other" processContents="lax"/>
142                 </complexType>
143         </element>
144
145         <attributeGroup name="SessionCacheProperties">
146         <attribute name="cleanupInterval" type="unsignedInt" use="optional" default="300"/>
147         <attribute name="cacheTimeout" type="unsignedInt" use="optional" default="28800"/>
148                 <attribute name="AAConnectTimeout" type="unsignedInt" use="optional" default="15"/>
149                 <attribute name="AATimeout" type="unsignedInt" use="optional" default="30"/>
150                 <attribute name="defaultLifetime" type="unsignedInt" use="optional" default="1800"/>
151                 <attribute name="retryInterval" type="unsignedInt" use="optional" default="300"/>
152                 <attribute name="strictValidity" type="boolean" use="optional" default="true"/>
153                 <attribute name="propagateErrors" type="boolean" use="optional" default="false"/>
154         </attributeGroup>
155
156         <element name="SHIRE">
157                 <annotation>
158                         <documentation>
159                         Container for configuration glue between target library and the surrounding application environment.
160                         </documentation>
161                 </annotation>
162                 <complexType>
163                         <sequence>
164                                 <element ref="conf:Extensions" minOccurs="0"/>
165                                 <choice minOccurs="0">
166                                         <element ref="conf:RequestMap"/>
167                                         <element name="RequestMapProvider" type="conf:PluggableType"/>
168                                 </choice>
169                                 <element name="Implementation" minOccurs="0">
170                                         <complexType>
171                                                 <choice maxOccurs="unbounded">
172                                                         <element ref="conf:ISAPI"/>
173                                                         <element ref="conf:NSAPI"/>
174                                                         <element ref="conf:Java"/>
175                                                         <any namespace="##other" processContents="lax"/>
176                                                 </choice>
177                                         </complexType>
178                                 </element>
179                                 <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
180                         </sequence>
181                         <attribute name="logger" type="anyURI" use="optional"/>
182                         <anyAttribute namespace="##other" processContents="lax"/>
183                 </complexType>
184         </element>
185         
186         <element name="ISAPI">
187                 <complexType>
188                         <sequence>
189                                 <element name="Site" maxOccurs="unbounded">
190                                         <complexType>
191                                                 <complexContent>
192                                                         <extension base="anyType">
193                                                                 <attribute name="id" type="unsignedInt" use="required"/>
194                                                                 <attribute name="host" type="string" use="required"/>
195                                                         </extension>
196                                                 </complexContent>
197                                         </complexType>
198                                 </element>
199                                 <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
200                         </sequence>
201                         <attribute name="normalizeRequest" type="boolean" use="optional"/>
202                         <anyAttribute namespace="##other" processContents="lax"/>
203                 </complexType>
204         </element>
205         <element name="NSAPI" type="anyType"/>
206         <element name="Java" type="anyType"/>
207
208         <element name="htaccess" type="conf:UniOperatorType">
209                 <annotation>
210                         <documentation>
211                         A simple example access policy language extension that supersedes Apache .htaccess
212                         </documentation>
213                 </annotation>
214         </element>
215         <element name="OR" type="conf:MultiOperatorType"/>
216         <element name="AND" type="conf:MultiOperatorType"/>
217         <element name="NOT" type="conf:UniOperatorType"/>
218         <complexType name="UniOperatorType">
219                 <choice>
220                         <element ref="conf:AND"/>
221                         <element ref="conf:OR"/>
222                         <element ref="conf:NOT"/>
223                         <element ref="conf:Rule"/>
224                 </choice>
225         </complexType>
226         <complexType name="MultiOperatorType">
227                 <choice minOccurs="2" maxOccurs="unbounded">
228                         <element ref="conf:AND"/>
229                         <element ref="conf:OR"/>
230                         <element ref="conf:NOT"/>
231                         <element ref="conf:Rule"/>
232                 </choice>
233         </complexType>
234         <element name="Rule">
235                 <complexType>
236                         <simpleContent>
237                                 <extension base="conf:listOfStrings">
238                                         <attribute name="require" type="string" use="required"/>
239                                 </extension>
240                         </simpleContent>
241                 </complexType>
242         </element>
243         <simpleType name="listOfStrings">
244                 <list itemType='string'/>
245         </simpleType>
246         
247         <attributeGroup name="ContentSettings">
248                 <attribute name="requireSession" type="boolean" use="optional"/>
249                 <attribute name="exportAssertion" type="boolean" use="optional"/>
250                 <anyAttribute namespace="##other" processContents="lax"/>
251         </attributeGroup>
252         <element name="AccessControlProvider" type="conf:PluggableType"/>
253
254     <element name="RequestMap">
255                 <annotation>
256                         <documentation>
257                         Built-in request mapping syntax, decomposes URLs into Host/Path/Path/...
258                         </documentation>
259                 </annotation>
260         <complexType>
261             <sequence>
262                 <choice minOccurs="0">
263                         <element ref="conf:htaccess"/>
264                         <element ref="conf:AccessControlProvider"/>
265                     </choice>
266                 <element ref="conf:Host" minOccurs="0" maxOccurs="unbounded"/>
267             </sequence>
268             <attribute name="applicationId" type="string" fixed="default"/>
269                 <attributeGroup ref="conf:ContentSettings"/>
270         </complexType>
271     </element>
272
273     <element name="Host">
274         <complexType>
275                 <sequence>
276                 <choice minOccurs="0">
277                         <element ref="conf:htaccess"/>
278                         <element ref="conf:AccessControlProvider"/>
279                     </choice>
280                         <element ref="conf:Path" minOccurs="0" maxOccurs="unbounded"/>
281                 </sequence>
282                 <attribute name="scheme" use="optional" default="http">
283                             <simpleType>
284                                 <restriction base="string">
285                                     <enumeration value="http"/>
286                                     <enumeration value="https"/>
287                                     <enumeration value="ftp"/>
288                                     <enumeration value="ldap"/>
289                                     <enumeration value="ldaps"/>
290                                 </restriction>
291                             </simpleType>
292                 </attribute>
293                 <attribute name="name" type="string" use="required"/>
294                 <attribute name="port" type="unsignedInt" use="optional"/>
295                 <attribute name="applicationId" type="string" use="optional"/>
296                 <attributeGroup ref="conf:ContentSettings"/>
297         </complexType>
298     </element>
299
300     <element name="Path">
301         <complexType>
302                 <sequence>
303                 <choice minOccurs="0">
304                         <element ref="conf:htaccess"/>
305                         <element ref="conf:AccessControlProvider"/>
306                     </choice>
307                         <element ref="conf:Path" minOccurs="0" maxOccurs="unbounded"/>
308                 </sequence>
309                 <attribute name="name" type="string" use="required"/>
310                 <attribute name="applicationId" type="string" use="optional"/>
311                 <attributeGroup ref="conf:ContentSettings"/>
312         </complexType>
313     </element>
314
315         <element name="Applications">
316                 <annotation>
317                         <documentation>
318                         Container for global target settings and application-specific overrides
319                         </documentation>
320                 </annotation>
321                 <complexType>
322                         <sequence>
323                                 <element ref="conf:Sessions"/>
324                                 <element ref="conf:Errors"/>
325                                 <element ref="conf:Policy" minOccurs="0"/>
326                                 <element ref="conf:CredentialUse" minOccurs="0"/>
327                                 <element ref="conf:Application" minOccurs="0" maxOccurs="unbounded"/>
328                                 <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
329                         </sequence>
330                         <attribute name="id" type="string" fixed="default"/>
331                         <attribute name="providerId" type="anyURI" use="required"/>
332                 <anyAttribute namespace="##other" processContents="lax"/>
333                 </complexType>
334         </element>
335         
336         <element name="Application">
337                 <annotation>
338                         <documentation>
339                         Container for application-specific overrides
340                         </documentation>
341                 </annotation>
342                 <complexType>
343                         <sequence>
344                                 <element ref="conf:Sessions"/>
345                                 <element ref="conf:Errors" minOccurs="0"/>
346                                 <element ref="conf:Policy" minOccurs="0"/>
347                                 <element ref="conf:CredentialUse" minOccurs="0"/>
348                                 <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
349                         </sequence>
350                         <attribute name="id" type="string" use="required"/>
351                         <attribute name="providerId" type="anyURI" use="optional"/>
352                 <anyAttribute namespace="##other" processContents="lax"/>
353                 </complexType>
354         </element>
355
356         <element name="Sessions">
357                 <annotation>
358                         <documentation>Container for specifying app session establishment and policy</documentation>
359                 </annotation>
360                 <complexType>
361             <complexContent>
362                 <extension base="anyType">
363                                         <attribute name="wayfURL" type="anyURI" use="required"/>
364                                         <attribute name="shireURL" type="anyURI" use="required"/>
365                                         <attribute name="shireSSL" type="boolean" use="optional"/>
366                                         <attribute name="cookieName" type="string" use="optional"/>
367                                         <attribute name="cookieProps" type="string" use="optional"/>
368                                         <attribute name="lifetime" type="unsignedInt" use="optional"/>
369                                         <attribute name="timeout" type="unsignedInt" use="optional"/>
370                                         <attribute name="checkAddress" type="boolean" use="optional"/>
371                                         <attribute name="oldAuthnRequest" type="boolean" use="optional"/>
372                 </extension>
373             </complexContent>
374                 </complexType>
375         </element>
376
377         <element name="Errors">
378                 <annotation>
379                         <documentation>Container for error templates and associated details</documentation>
380                 </annotation>
381                 <complexType>
382             <complexContent>
383                 <extension base="anyType">
384                         <attribute name="shire" type="anyURI" use="required"/>
385                         <attribute name="rm" type="anyURI" use="required"/>
386                         <attribute name="access" type="anyURI" use="required"/>
387                         <attribute name="supportContact" type="string" use="optional"/>
388                         <attribute name="logoLocation" type="anyURI" use="optional"/>
389                         <attribute name="styleSheet" type="anyURI" use="optional"/>
390                 </extension>
391             </complexContent>
392                 </complexType>
393         </element>
394
395         <element name="Policy">
396                 <annotation>
397                         <documentation>
398                         Container for specifying various policies for attributes, trust, and federations
399                         </documentation>
400                 </annotation>
401                 <complexType>
402                         <sequence>
403                                 <element ref="saml:AttributeDesignator" minOccurs="0" maxOccurs="unbounded"/>
404                                 <element name="AAPProvider" type="conf:PluggableType" minOccurs="0" maxOccurs="unbounded"/>
405                                 <element name="FederationProvider" type="conf:PluggableType" minOccurs="0" maxOccurs="unbounded"/>
406                                 <element name="TrustProvider" type="conf:PluggableType" minOccurs="0" maxOccurs="unbounded"/>
407                                 <element name="RevocationProvider" type="conf:PluggableType" minOccurs="0" maxOccurs="unbounded"/>
408                                 <element ref="saml:Audience"  minOccurs="0" maxOccurs="unbounded"/>
409                                 <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
410                         </sequence>
411                         <attribute name="signRequest" type="boolean" use="optional" default="false"/>
412                         <attribute name="signedResponse" type="boolean" use="optional" default="false"/>
413                         <attribute name="signedAssertions" type="boolean" use="optional" default="false"/>
414                 <anyAttribute namespace="##other" processContents="lax"/>
415                 </complexType>
416         </element>
417         
418         <element name="CredentialUse">
419                 <annotation>
420                         <documentation>Container for specifying credentials to use</documentation>
421                 </annotation>
422                 <complexType>
423                         <sequence>
424                                 <element name="RelyingParty" minOccurs="0" maxOccurs="unbounded">
425                                         <complexType>
426                                                 <complexContent>
427                                                         <extension base="anyType">
428                                                                 <attribute name="Name" type="string" use="required"/>
429                                                                 <attribute name="TLS" type="string" use="required"/>
430                                                                 <attribute name="Signing" type="string" use="required"/>
431                                                         </extension>
432                                                 </complexContent>
433                                         </complexType>
434                                 </element>
435                                 <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
436                         </sequence>
437                         <attribute name="TLS" type="string" use="required"/>
438                         <attribute name="Signing" type="string" use="required"/>
439                 <anyAttribute namespace="##other" processContents="lax"/>
440                 </complexType>
441         </element>
442 </schema>
443