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