/
wildfly-elytron_9_0.xsd
5779 lines (5528 loc) · 263 KB
/
wildfly-elytron_9_0.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ JBoss, Home of Professional Open Source.
~ Copyright 2014 Red Hat, Inc., and individual contributors
~ as indicated by the @author tags.
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="urn:wildfly:elytron:9.0"
xmlns="urn:wildfly:elytron:9.0"
xmlns:credential-reference="urn:wildfly:credential-reference:1.0"
elementFormDefault="qualified"
attributeFormDefault="unqualified"
version="1.0">
<!-- Need to include the path to the schema location here in order for the xml-validation that's defined in
elytron/pom.xml to succeed. -->
<xs:import namespace="urn:wildfly:credential-reference:1.0" schemaLocation="../controller/src/main/resources/schema/wildfly-credential-reference_1_0.xsd"/>
<!-- The subsystem root element -->
<xs:element name="subsystem" type="subsystemType"/>
<xs:complexType name="subsystemType">
<xs:all>
<xs:element name="security-properties" type="securityPropertiesType" minOccurs="0" />
<xs:element name="authentication-client" type="authenticationClientType" minOccurs="0" />
<xs:element name="providers" type="providersType" minOccurs="0" />
<xs:element name="audit-logging" type="auditLoggingType" minOccurs="0" />
<xs:element name="security-domains" type="securityDomainsType" minOccurs="0" />
<xs:element name="security-realms" type="realmsType" minOccurs="0" />
<xs:element name="credential-security-factories" type="credentialSecurityFactoriesType" minOccurs="0" />
<xs:element name="mappers" type="mappersType" minOccurs="0" />
<xs:element name="permission-sets" type="permissionSetsType" minOccurs="0" />
<xs:element name="http" type="httpType" minOccurs="0" />
<xs:element name="sasl" type="saslType" minOccurs="0" />
<xs:element name="tls" type="tlsType" minOccurs="0" />
<xs:element name="credential-stores" type="credentialStoresType" minOccurs="0" />
<xs:element name="dir-contexts" type="dirContextsType" minOccurs="0" />
<xs:element name="policy" type="policyType" minOccurs="0" />
<xs:element name="jaspi" type="jaspiType" minOccurs="0" />
</xs:all>
<xs:attribute name="default-authentication-context" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to the default authentication context to be associated with all deployments.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="initial-providers" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a capability providing a Provider[] which will be registered globally ahead of all existing Provider registrations.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="final-providers" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a capability providing a Provider[] which will be registered globally after all existing Provider registrations.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="disallowed-providers" type="stringListType">
<xs:annotation>
<xs:documentation>
A list of providers that are disallowed, and will be removed from the providers list.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="register-jaspi-factory" default="true">
<xs:annotation>
<xs:documentation>
Should the WildFly Elytron AuthConfigFactory implementation be automatically registered.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="default-ssl-context" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to an SSLContext which should be globally registered as the default.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<!--
Security Properties
-->
<xs:complexType name="securityPropertiesType">
<xs:annotation>
<xs:documentation>
Type to contain a list of security properties to be set.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="security-property" type="propertyType" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="propertyType">
<xs:annotation>
<xs:documentation>
Representation of a key/value property pair.
</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The key for this property.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The value for this property.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<!--
Authentication Client
-->
<xs:complexType name="authenticationClientType">
<xs:annotation>
<xs:documentation>
Container for the authentication client definitions.
</xs:documentation>
</xs:annotation>
<xs:choice maxOccurs="unbounded">
<xs:element name="authentication-configuration" type="authenticationConfigurationType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="authentication-context" type="authenticationContextType" minOccurs="0" maxOccurs="unbounded" />
</xs:choice>
</xs:complexType>
<xs:complexType name="authenticationConfigurationType">
<xs:annotation>
<xs:documentation>
Authentication configuration definition.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="mechanism-properties" minOccurs="0">
<xs:annotation>
<xs:documentation>
An ordered list of properties to be used to configure all of the providers.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="property" type="propertyType" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="credential-reference" type="credential-reference:credentialReferenceType" minOccurs="0">
<xs:annotation>
<xs:documentation>
Credential to be used by the configuration.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The unique name for the authentication-configuration, note names used for authentication-configurations must be unique across the whole context.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="extends" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a previously defined authentication configuration to extend.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="anonymous" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>
Enables anonymous authentication.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="authentication-name" type="xs:string">
<xs:annotation>
<xs:documentation>
The name to use for authentication.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="authorization-name" type="xs:string">
<xs:annotation>
<xs:documentation>
The name to use for authorization.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="host" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the host to use.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="protocol" type="xs:string">
<xs:annotation>
<xs:documentation>
The protocol to use.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="port" type="xs:int">
<xs:annotation>
<xs:documentation>
The port to use.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="realm" type="xs:string">
<xs:annotation>
<xs:documentation>
The realm to use.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="security-domain" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a security domain to use for a forwarded identity.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="forwarding-mode" default="authentication">
<xs:simpleType>
<xs:annotation>
<xs:documentation>
The type of identity forwarding to use when security-domain is specified. The value "authenticaiton" forwards
the identity of the currently authenticated user, including credentials. The value "authorization" forwards
the underlying authorization identity, which allows for a different identity to be used for authentication.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="authentication" />
<xs:enumeration value="authorization" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name = "sasl-mechanism-selector" type="xs:string">
<xs:annotation>
<xs:documentation>
The SASL mechanism selector string. Allows to specify allowed/forbidden SASL mechanisms.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="kerberos-security-factory" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a kerberos security factory used to obtain a GSS kerberos credential.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="authenticationContextType">
<xs:annotation>
<xs:documentation>
Authentication context definition.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="match-rule" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
An ordered list of match-rules to be defined on this authentication context.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="match-abstract-type" type="xs:string">
<xs:annotation>
<xs:documentation>
Match based on abstract type.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-abstract-type-authority" type="xs:string">
<xs:annotation>
<xs:documentation>
Match based on abstract type authority.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-host" type="xs:string">
<xs:annotation>
<xs:documentation>
Match based on host.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-local-security-domain" type="xs:string">
<xs:annotation>
<xs:documentation>
Match based on local security domain.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-no-user" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>
Match based on no user.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-path" type="xs:string">
<xs:annotation>
<xs:documentation>
Match based on path.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-port" type="xs:int">
<xs:annotation>
<xs:documentation>
Match based on port.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-protocol" type="xs:string">
<xs:annotation>
<xs:documentation>
Match based on protocol.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-urn" type="xs:string">
<xs:annotation>
<xs:documentation>
Match based on urn.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="match-user" type="xs:string">
<xs:annotation>
<xs:documentation>
Match based on user.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="authentication-configuration" type="xs:string">
<xs:annotation>
<xs:documentation>
The AuthenticationConfiguration to use with this match.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ssl-context" type="xs:string">
<xs:annotation>
<xs:documentation>
The SSLContext to use with this match.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The unique name for the authentication-context, note names used for authentication-contexts must be unique across the whole context.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="extends" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a previously defined authentication context to extend.
match-rules defined here are added after the rules of the parent.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<!--
Providers
-->
<xs:complexType name="providersType">
<xs:annotation>
<xs:documentation>
Container of Provider configuration.
</xs:documentation>
</xs:annotation>
<xs:choice maxOccurs="unbounded">
<xs:element name="aggregate-providers" type="aggregateProvidersType" />
<xs:element name="provider-loader" type="providerLoaderType" />
</xs:choice>
</xs:complexType>
<xs:complexType name="aggregateProvidersType">
<xs:annotation>
<xs:documentation>
A PrincipalDecoder definition that is actually an aggregation of other PrincipalDecoders.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="providers" type="providersRefType" minOccurs="2" maxOccurs="unbounded" />
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name to use to represent this provider loader in the management model.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="providersRefType">
<xs:annotation>
<xs:documentation>
A reference to a Provider[] resource.
</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required" />
</xs:complexType>
<xs:complexType name="providerLoaderType">
<xs:annotation>
<xs:documentation>
Definition of a single provider loader.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="configuration" minOccurs="0" >
<xs:complexType>
<xs:sequence>
<xs:element name="property" type="propertyType" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name to use to represent this provider loader in the management model.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="module" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the module to use to load the providers.
If this is not specified the ClassLoader used to load the service will be used instead.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="class-names" type="stringListType">
<xs:annotation>
<xs:documentation>
The fully qualified class names of the providers to load.
If this attribute is not specified then service loader based discovery will be used instead.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="path" type="xs:string">
<xs:annotation>
<xs:documentation>
The path to the configuration to use to initialise the provider.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="relative-to" type="xs:string">
<xs:annotation>
<xs:documentation>
A reference to a previously defined path that the path of the configuration is
relative to.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="argument" type="xs:string">
<xs:annotation>
<xs:documentation>
Argument to pass into the constructor as the Provider is instantiated.
Can only be used where the class names to load are specified.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<!--
Audit Logging
-->
<xs:complexType name="auditLoggingType">
<xs:annotation>
<xs:documentation>
Container for the security domain definitions.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="aggregate-security-event-listener" type="aggregateSecurityEventListenerType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="custom-security-event-listener" type="customSecurityEventListenerType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="file-audit-log" type="fileAuditLogType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="periodic-rotating-file-audit-log" type="periodicRotatingFileAuditLogType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="size-rotating-file-audit-log" type="sizeRotatingFileAuditLogType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="syslog-audit-log" type="syslogAuditLogType" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:simpleType name="formatType">
<xs:annotation>
<xs:documentation>
The format type.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="SIMPLE" />
<xs:enumeration value="JSON" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="transportType">
<xs:annotation>
<xs:documentation>
The syslog transport method type.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="TCP" />
<xs:enumeration value="UDP" />
<xs:enumeration value="SSL_TCP" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="auditLogType" abstract="true">
<xs:annotation>
<xs:documentation>
Base type for all audit log types.
</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The unique name for the audit log.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="aggregateSecurityEventListenerType">
<xs:annotation>
<xs:documentation>
A security event listener definition that is actually an aggregation of other security event listeners.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="auditLogType">
<xs:sequence>
<xs:element name="security-event-listener" type="securityEventListenerRefType" minOccurs="2" maxOccurs="unbounded" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="securityEventListenerRefType">
<xs:annotation>
<xs:documentation>
A reference to a security event listener.
</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required" />
</xs:complexType>
<xs:complexType name="fileAuditLogType">
<xs:annotation>
<xs:documentation>
An audit log definition for persisting an audit log to a local file.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="auditLogType">
<xs:attribute name="path" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The path to write the audit log to.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="relative-to" type="xs:string">
<xs:annotation>
<xs:documentation>
A reference to a previously defined path that the path of the audit log is
relative to.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="synchronized" type="xs:boolean" default="true">
<xs:annotation>
<xs:documentation>
Whether every event should be immediately synchronised to disk.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="autoflush" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Whether every event should be immediately flushed to output stream.
When not specified, "synchronized" value is used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="format" default="SIMPLE" type="formatType">
<xs:annotation>
<xs:documentation>
The format to use to log the event.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="periodicRotatingFileAuditLogType">
<xs:annotation>
<xs:documentation>
An audit log definition for persisting an audit log to a local file rotating the log after a time period
derived from the given suffix string, which should be in a format understood by java.time.format.DateTimeFormatter.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fileAuditLogType">
<xs:attribute name="suffix" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The suffix string in a format which can be understood by java.time.format.DateTimeFormatter.
The period of the rotation is automatically calculated based on the suffix.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="sizeRotatingFileAuditLogType">
<xs:annotation>
<xs:documentation>
An audit log definition for persisting an audit log to a local file rotating the log after the
size of the file grows beyond a certain point and keeping a fixed number of backups.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fileAuditLogType">
<xs:attribute name="max-backup-index" default="1" type="xs:long" use="optional">
<xs:annotation>
<xs:documentation>
The maximum number of files to backup when rotating.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rotate-on-boot" type="xs:boolean" default="false" use="optional">
<xs:annotation>
<xs:documentation>
Whether the file should be rotated before the a new file is set.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rotate-size" default="10m" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
The log file size the file should rotate at.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="suffix" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
Format of date used as suffix of log file names in java.time.format.DateTimeFormatter.
The suffix does not play a role in determining when the file should be rotated.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="syslogAuditLogType">
<xs:annotation>
<xs:documentation>
An audit log definition for persisting an audit log to a local file.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="auditLogType">
<xs:attribute name="server-address" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Address of the server to send syslog messages to.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="port" type="xs:int" use="required">
<xs:annotation>
<xs:documentation>
The port number the remote syslog server is listening on.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="transport" type="transportType" default="TCP">
<xs:annotation>
<xs:documentation>
The transport to use to communicate with the syslog server.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="format" type="formatType" default="SIMPLE">
<xs:annotation>
<xs:documentation>
The format to use to log the event.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="host-name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The host name to send within all events sent to the syslog server.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ssl-context" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of ssl-context used to secure connection to the syslog server.
Applies only when SSL_TCP transport is used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="syslog-format" type="xs:string">
<xs:annotation>
<xs:documentation>
The RFC format to be used for formatting the log entry, default value of RFC5424.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="reconnect-attempts" type="xs:int">
<xs:annotation>
<xs:documentation>
The maximum amount of failed reconnect attempts that should be made for sending messages to a syslog server before the endpoint is closed, default value of 0 (no reconnect attempts).
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="customSecurityEventListenerType">
<xs:annotation>
<xs:documentation>
A security event listener definition for a custom security event listener implementation.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="auditLogType">
<xs:sequence>
<xs:element name="configuration"
type="customComponentConfiguration" minOccurs="0">
<xs:annotation>
<xs:documentation>
The configuration to apply to the security event listener implementation.
Note: If configuration is supplied the listener MUST implement a void initialize(Map<String, String>) method.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attributeGroup ref="customComponentAttributes" />
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!--
Domains and Realms
-->
<xs:complexType name="securityDomainsType">
<xs:annotation>
<xs:documentation>
Container for the security domain definitions.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="security-domain" type="securityDomainType" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="securityDomainType">
<xs:annotation>
<xs:documentation>
Complex type for the definition of a single security domain.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="realm" type="realmRefType" maxOccurs="unbounded" />
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required" />
<xs:attribute name="default-realm" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Which of the listed realms should be the default?
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="pre-realm-principal-transformer" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to the PrincipalTransformer to be applied before the realm is selected.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="post-realm-principal-transformer" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to the PrincipalTransformer to be applied after the realm is selected.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="principal-decoder" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to the PrincipalDecoder to be used by this domain.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="evidence-decoder" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to an EvidenceDecoder to be used by the domain.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="realm-mapper" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a RealmMapper to be used by this security domain.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="role-mapper" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a RoleMapper to be used by the domain.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="permission-mapper" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to the PermissionMapper to be used by the domain.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="trusted-security-domains" type="stringListType" use="optional">
<xs:annotation>
<xs:documentation>
A list of references to security domains that are trusted by this security domain.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="outflow-anonymous" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>
Where automatic outflow to a security domain is configured, if outflowing
the current identity is not authorized should the
anonymous identity of that domain be used instead?
Outflowing an identity replaces any previously
established identity for the outflow domain for the
ongoing call, outflowing anonymous has the effect of
clearing the identity.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="outflow-security-domains" type="stringListType" use="optional">
<xs:annotation>
<xs:documentation>
A list of references to security domains that any identity established for this
domain should automatically outflow to.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="security-event-listener" type="xs:string">
<xs:annotation>
<xs:documentation>
Reference to a security event listener to be notified of security events
emitted from this domain.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="realmRefType">
<xs:annotation>
<xs:documentation>
A reference to a security realm.
</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required" />
<xs:attribute name="principal-transformer" type="xs:string">
<xs:annotation>
<xs:documentation>
The PrincipalTransformer to be associated with this realm.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="role-decoder" type="xs:string">
<xs:annotation>
<xs:documentation>
The RoleDecoder to be associated with this realm.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="role-mapper" type="xs:string">
<xs:annotation>
<xs:documentation>
The RoleMapper to be associated with this realm.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="realmsType">
<xs:annotation>
<xs:documentation>
Container for the security realm definitions.
</xs:documentation>
</xs:annotation>
<xs:choice maxOccurs="unbounded">
<xs:element name="aggregate-realm" type="aggregateRealmType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="custom-realm" type="customRealmType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Custom realm definitions can implement either the SecurityRealm interface or the ModifiableSecurityRealm interface.
Regardless of which interface is implemented management operations will not be exposed to manage the realm. However other
services that depend on the realm will still be able to perform a type check and cast to gain access to the modification API.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="custom-modifiable-realm" type="customRealmType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Custom realm configured as being modifiable will be expected to implement the ModifiableSecurityRealm interface.
By configuring a realm as being modifiable management operations will be made available to manipulate the realm.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="identity-realm" type="identityRealmType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="jdbc-realm" type="jdbcRealmType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="key-store-realm" type="keyStoreRealmType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="properties-realm" type="propertiesRealmType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="ldap-realm" type="ldapRealmType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="filesystem-realm" type="fileSystemRealmType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="token-realm" type="tokenRealmType" minOccurs="0" maxOccurs="unbounded" />
<xs:element name="caching-realm" type="cachingRealmType" minOccurs="0" maxOccurs="unbounded" />
</xs:choice>
</xs:complexType>
<xs:complexType name="realmType" abstract="true">
<xs:annotation>
<xs:documentation>
Base type for all realm definitions.
</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The unique name for the realm, note names used for realms must be unique across the whole context.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>