Debian Codegraph @

lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Build/Attributes.pm

raw
1 # This file contains the description of all configuration parameters
2 # It may be included only by batch files, never in portal or handler chain
3 # for performances reasons
4
5 # DON'T FORGET TO RUN "make json" AFTER EACH CHANGE
6
7 package Lemonldap::NG::Manager::Build::Attributes;
8
9 our $VERSION = '2.23.0';
10 use strict;
11 use Regexp::Common qw/URI/;
12
13 sub perlExpr {
14 my ( $val, $conf ) = @_;
15 my $cpt = new Safe;
16 $cpt->share_from( 'MIME::Base64', ['&encode_base64'] );
17 $cpt->share_from(
18 'Lemonldap::NG::Handler::Main::Jail',
19 [
20 '&encrypt', '&token',
21 @Lemonldap::NG::Handler::Main::Jail::builtCustomFunctions
22 ]
23 );
24 $cpt->share_from( 'Lemonldap::NG::Common::Safelib',
25 $Lemonldap::NG::Common::Safelib::functions );
26 $cpt->reval("local *_;$val");
27 my $err = join( '',
28 grep { $_ =~ /(?:Undefined subroutine|Devel::StackTrace)/ ? () : $_ }
29 split( /\n/, $@ ) );
30 return ( -1, "__badExpression__: $err" )
31 if ( $err && $conf->{useSafeJail} );
32 return ( $val =~ qr/(?<=[^=<!>\|\?])=(?![>=~])/
33 && $conf->{avoidAssignment} )
34 ? ( 1, "__badExpressionAssignment__" )
35 : 1;
36 }
37
38 my $url_re = $RE{URI}{HTTP}{ -scheme => "https?" };
39 $url_re =~ s/(?<=[^\\])\$/\\\$/g;
40 my $url = qr/$url_re/;
41 my $urlOrEmpty = qr/(?:^$|$url_re)/;
42
43 sub types {
44 return {
45
46 # Simple text types
47 text => {
48 test => sub { 1 },
49 msgFail => '__malformedValue__',
50 },
51 password => {
52 test => sub { 1 },
53 msgFail => '__malformedValue__',
54 },
55 longtext => {
56 test => sub { 1 }
57 },
58 url => {
59 form => 'text',
60 test => $urlOrEmpty,
61 msgFail => '__badUrl__',
62 },
63 PerlModule => {
64 form => 'text',
65 test => qr/^(?:[a-zA-Z][a-zA-Z0-9]*)*(?:::[a-zA-Z][a-zA-Z0-9]*)*$/,
66 msgFail => '__badPerlPackageName__',
67 },
68 hostname => {
69 form => 'text',
70 test => qr/^(?:$Regexp::Common::URI::RFC2396::host)?$/,
71 msgFail => '__badHostname__',
72 },
73 pcre => {
74 form => 'text',
75 test => sub {
76 eval { qr/$_[0]/ };
77 return $@ ? ( 0, "__badRegexp__: $@" ) : (1);
78 },
79 },
80 lmAttrOrMacro => {
81 form => 'text',
82 test => sub {
83 my ( $val, $conf ) = @_;
84 return 1
85 if ( defined $conf->{macros}->{$val}
86 or $val =~ m/^_/ );
87 foreach ( keys %$conf ) {
88 return 1
89 if ( $_ =~ /exportedvars$/i
90 and defined $conf->{$_}->{$val} );
91 }
92 return ( 1, "__unknownAttrOrMacro__: $val" );
93 },
94 },
95
96 # Other types
97 int => {
98 test => qr/^\-?\d+$/,
99 msgFail => '__notAnInteger__',
100 },
101 intOrNull => {
102 test => qr/^\-?\d*$/,
103 msgFail => '__notAnInteger__',
104 },
105 bool => {
106 test => qr/^[01]$/,
107 msgFail => '__notABoolean__',
108 },
109 trool => {
110 test => qr/^(?:-1|0|1)$/,
111 msgFail => '__authorizedValues__: -1, 0, 1',
112 },
113 boolOrExpr => {
114 test => sub { return perlExpr(@_) },
115 msgFail => '__notAValidPerlExpression__',
116 },
117 keyTextContainer => {
118 test => qr/./,
119 msgFail => '__emptyValueNotAllowed__',
120 keyTest => qr/^\w[\w\.\-]*$/,
121 keyMsgFail => '__badKeyName__',
122 },
123 subContainer => {
124 keyTest => qr/\w/,
125 test => sub { 1 },
126 },
127 select => {
128 test => sub {
129 return ( 0, "Value is not a scalar" ) if ref( $_[0] );
130 my $test = grep ( { $_ eq $_[0] }
131 map ( { $_->{k} } @{ $_[2]->{select} } ) );
132 return $test
133 ? 1
134 : ( 1, "Invalid value '$_[0]' for this select" );
135 },
136 },
137
138 # Files type (long text)
139 file => {
140 test => sub { 1 }
141 },
142 RSAPublicKey => {
143 test => sub {
144 return (
145 $_[0] =~
146 /^(?:(?:\-+\s*BEGIN\s+PUBLIC\s+KEY\s*\-+\r?\n)?[a-zA-Z0-9\/\+\r\n]+={0,2}(?:\r?\n\-+\s*END\s+PUBLIC\s+KEY\s*\-+)?[\r\n]*)?$/s
147 ? (1)
148 : ( 1, '__badPemEncoding__' )
149 );
150 },
151 },
152 'RSAPublicKeyOrCertificate' => {
153 'test' => sub {
154 return (
155 $_[0] =~
156 /^(?:(?:\-+\s*BEGIN\s+(?:PUBLIC\s+KEY|CERTIFICATE)\s*\-+\r?\n)?[a-zA-Z0-9\/\+\r\n]+={0,2}(?:\r?\n\-+\s*END\s+(?:PUBLIC\s+KEY|CERTIFICATE)\s*\-+)?[\r\n]*)?$/s
157 ? (1)
158 : ( 1, '__badPemEncoding__' )
159 );
160 },
161 },
162 RSAPrivateKey => {
163 test => sub {
164 return (
165 $_[0] =~
166 /^(?:(?:\-+\s*BEGIN\s+(?:(?:RSA|ENCRYPTED)\s+)?PRIVATE\s+KEY\s*\-+\r?\n)?(?:Proc-Type:.*\r?\nDEK-Info:.*\r?\n[\r\n]*)?[a-zA-Z0-9\/\+\r\n]+={0,2}(?:\r?\n\-+\s*END\s+(?:(?:RSA|ENCRYPTED)\s+)?PRIVATE\s+KEY\s*\-+)?[\r\n]*)?$/s
167 ? (1)
168 : ( 1, '__badPemEncoding__' )
169 );
170 },
171 },
172 'EcOrRSAPublicKeyOrCertificate' => {
173 'test' => sub {
174 return (
175 $_[0] =~
176 /^(?:(?:\-+\s*BEGIN\s+(?:PUBLIC\s+KEY|CERTIFICATE)\s*\-+\r?\n)?[a-zA-Z0-9\/\+\r\n]+={0,2}(?:\r?\n\-+\s*END\s+(?:PUBLIC\s+KEY|CERTIFICATE)\s*\-+)?[\r\n]*)?$/s
177 ? (1)
178 : ( 1, '__badPemEncoding__' )
179 );
180 },
181 },
182 EcOrRSAPrivateKey => {
183 test => sub {
184 return (
185 $_[0] =~
186 /^(?:(?:\-+\s*BEGIN\s+(?:(?:RSA|EC|ENCRYPTED)\s+)?PRIVATE\s+KEY\s*\-+\r?\n)?(?:Proc-Type:.*\r?\nDEK-Info:.*\r?\n[\r\n]*)?[a-zA-Z0-9\/\+\r\n]+={0,2}(?:\r?\n\-+\s*END\s+(?:(?:RSA|EC|ENCRYPTED)\s+)?PRIVATE\s+KEY\s*\-+)?[\r\n]*)?$/s
187 ? (1)
188 : ( 1, '__badPemEncoding__' )
189 );
190 },
191 },
192
193 authParamsText => {
194 test => sub { 1 }
195 },
196 blackWhiteList => {
197 test => sub { 1 }
198 },
199 catAndAppList => {
200 test => sub { 1 }
201 },
202 keyText => {
203 keyTest => qr/^[a-zA-Z0-9_]+$/,
204 test => qr/^.*$/,
205 msgFail => '__badValue__',
206 },
207 menuApp => {
208 test => sub { 1 }
209 },
210 menuCat => {
211 test => sub { 1 }
212 },
213 oidcAttribute => {
214 test => sub { 1 }
215 },
216 oidcOPMetaDataNode => {
217 test => sub { 1 }
218 },
219 oidcRPMetaDataNode => {
220 test => sub { 1 }
221 },
222 oidcmetadatajson => {
223 test => sub { 1 }
224 },
225 oidcmetadatajwks => {
226 test => sub { 1 }
227 },
228 portalskin => {
229 test => sub { 1 }
230 },
231 portalskinbackground => {
232 test => sub { 1 }
233 },
234 post => {
235 test => sub { 1 }
236 },
237 rule => {
238 test => sub { 1 }
239 },
240 samlAssertion => {
241 test => sub { 1 }
242 },
243 samlAttribute => {
244 test => sub { 1 }
245 },
246 samlIDPMetaDataNode => {
247 test => sub { 1 }
248 },
249 samlSPMetaDataNode => {
250 test => sub { 1 }
251 },
252 samlService => {
253 test => sub { 1 }
254 },
255 array => {
256 test => sub { 1 }
257 },
258 };
259 }
260
261 use constant oidcEncAlgorithmEnc => [
262 { k => 'A256CBC-HS512', v => 'A256CBC-HS512' },
263 { k => 'A256GCM', v => 'A256GCM' },
264 { k => 'A192CBC-HS384', v => 'A192CBC-HS384' },
265 { k => 'A192GCM', v => 'A192GCM' },
266 { k => 'A128CBC-HS256', v => 'A128CBC-HS256' },
267 { k => 'A128GCM', v => 'A128GCM' },
268 ];
269
270 use constant oidcEncAlgorithmAlg => [
271
272 # Symetric encryption not supported
273 #{ k => 'A128KW', v => 'A128KW' },
274 #{ k => 'A192KW', v => 'A192KW' },
275 #{ k => 'A256KW', v => 'A256KW' },
276 #{ k => 'A128GCMKW', v => 'A128GCMKW' },
277 #{ k => 'A192GCMKW', v => 'A192GCMKW' },
278 #{ k => 'A256GCMKW', v => 'A256GCMKW' },
279 #{ k => 'PBES2-HS256+A128KW', v => 'PBES2-HS256+A128KW' },
280 #{ k => 'PBES2-HS384+A192KW', v => 'PBES2-HS384+A192KW' },
281 #{ k => 'PBES2-HS512+A256KW', v => 'PBES2-HS512+A256KW' },
282 { k => 'RSA-OAEP', v => 'RSA-OAEP' },
283 { k => 'RSA-OAEP-256', v => 'RSA-OAEP-256' },
284 { k => 'RSA1_5', v => 'RSA1_5' },
285 { k => 'ECDH-ES', v => 'ECDH-ES' },
286 { k => 'ECDH-ES+A128KW', v => 'ECDH-ES+A128KW' },
287 { k => 'ECDH-ES+A192KW', v => 'ECDH-ES+A192KW' },
288 { k => 'ECDH-ES+A256KW', v => 'ECDH-ES+A256KW' },
289 ];
290
291 use constant oidcSigAlgorithmAlg => [
292 { k => 'HS256', v => 'HS256' },
293 { k => 'HS384', v => 'HS384' },
294 { k => 'HS512', v => 'HS512' },
295 { k => 'RS256', v => 'RS256' },
296 { k => 'RS384', v => 'RS384' },
297 { k => 'RS512', v => 'RS512' },
298 { k => 'PS256', v => 'PS256' },
299 { k => 'PS384', v => 'PS384' },
300 { k => 'PS512', v => 'PS512' },
301 { k => 'ES256', v => 'ES256' },
302 { k => 'ES384', v => 'ES384' },
303 { k => 'ES512', v => 'ES512' },
304 { k => 'EdDSA', v => 'EdDSA' },
305 ];
306
307 sub attributes {
308 return {
309
310 # Other
311 checkTime => {
312 type => 'int',
313 documentation =>
314 'Timeout to check new configuration in local cache',
315 default => 600,
316 flags => 'hp',
317 },
318 checkMsg => {
319 type => 'int',
320 documentation => 'Timeout to check new evant',
321 default => 5,
322 flags => 'hp',
323 },
324 defaultAuthnLevel => { type => 'intOrNull' },
325 defaultNewKeySize => {
326 type => 'int',
327 documentation => 'Default size for new RSA key helper',
328 default => 2048,
329 flags => 'm',
330 },
331 mySessionAuthorizedRWKeys => {
332 type => 'array',
333 documentation => 'Alterable session keys by user itself',
334 default => [
335 '_appsListOrder', '_oidcConnectedRP',
336 '_oidcConnectedRPIDs', '_oidcConsents'
337 ],
338 },
339 configStorage => {
340 type => 'text',
341 documentation => 'Configuration storage',
342 flags => 'hmp',
343 },
344 localStorage => {
345 type => 'text',
346 documentation => 'Local cache',
347 flags => 'hmp',
348 },
349 localStorageOptions => {
350 type => 'keyTextContainer',
351 documentation => 'Local cache parameters',
352 flags => 'hmp',
353 },
354 cfgNum => {
355 type => 'int',
356 default => 0,
357 documentation => 'Enable Cross Domain Authentication',
358 },
359 cfgAuthor => {
360 type => 'text',
361 documentation => 'Name of the author of the current configuration',
362 },
363 cfgAuthorIP => {
364 type => 'text',
365 documentation => 'Uploader IP address of the current configuration',
366 },
367 cfgDate => {
368 type => 'int',
369 documentation => 'Timestamp of the current configuration',
370 },
371 cfgLog => {
372 type => 'longtext',
373 documentation => 'Configuration update log',
374 },
375 cfgVersion => {
376 type => 'text',
377 documentation => 'Version of LLNG which build configuration',
378 },
379 eventStatus => {
380 type => 'bool',
381 documentation => 'Push status into message broker',
382 flags => 'h',
383 },
384 statusQueueName => {
385 type => 'text',
386 default => 'llng_status',
387 flags => 'h',
388 documentation => 'Status channel name',
389 },
390 confirmFormMethod => {
391 type => "select",
392 select =>
393 [ { k => 'get', v => 'GET' }, { k => 'post', v => 'POST' }, ],
394 default => 'post',
395 documentation => 'HTTP method for confirm page form',
396 },
397 customFunctions => {
398 type => 'text',
399 test => qr/^(?:\w+(?:::\w+)*(?:\s+\w+(?:::\w+)*)*)?$/,
400 help => 'customfunctions.html',
401 msgFail => "__badCustomFuncName__",
402 documentation => 'List of custom functions',
403 flags => 'hmp',
404 },
405 https => {
406 default => -1,
407 type => 'trool',
408 documentation => 'Use HTTPS for redirection from portal',
409 flags => 'h',
410 },
411 infoFormMethod => {
412 type => "select",
413 select =>
414 [ { k => 'get', v => 'GET' }, { k => 'post', v => 'POST' }, ],
415 default => 'get',
416 documentation => 'HTTP method for info page form',
417 },
418 port => {
419 default => -1,
420 type => 'int',
421 documentation => 'Force port in redirection',
422 flags => 'h',
423 },
424 jsRedirect => {
425 type => 'boolOrExpr',
426 default => 0,
427 documentation => 'Use javascript for redirections',
428 },
429 externalMenu => {
430 type => 'text',
431 default => '',
432 documentation =>
433 'URL to redirect authenticated users to instead of showing menu. Supports session variables like $uid, $mail, etc.',
434 },
435 logoutServices => {
436 type => 'keyTextContainer',
437 help => 'logoutforward.html',
438 default => {},
439 documentation => 'Send logout trough GET request to these services',
440 },
441 maintenance => {
442 default => 0,
443 type => 'bool',
444 documentation => 'Maintenance mode for all virtual hosts',
445 flags => 'h',
446 },
447 nginxCustomHandlers => {
448 type => 'keyTextContainer',
449 keyTest => qr/^\w+$/,
450 test => qr/^[a-zA-Z][a-zA-Z0-9]*(?:::[a-zA-Z][a-zA-Z0-9]*)*$/,
451 help => 'handlerarch.html',
452 msgFail => '__badPerlPackageName__',
453 documentation => 'Custom Nginx handler (deprecated)',
454 },
455 noAjaxHook => {
456 default => 0,
457 type => 'bool',
458 documentation => 'Avoid replacing 302 by 401 for Ajax responses',
459 },
460 portal => {
461 type => 'url',
462 default => 'http://auth.example.com/',
463 documentation => 'Portal URL',
464 flags => 'hmp',
465 test => $url,
466 msgFail => '__badUrl__',
467 },
468 portalFavicon => {
469 type => 'text',
470 default => 'common/favicon.ico',
471 documentation => 'Path to favicon file',
472 },
473 portalCustomCss => {
474 type => 'text',
475 documentation => 'Path to custom CSS file',
476 },
477 portalCustomJs => {
478 type => 'text',
479 documentation => 'Path to custom JS file',
480 },
481 portalCustomTplParams => {
482 type => 'keyTextContainer',
483 documentation => 'Custom templates parameters',
484 },
485 portalStatus => {
486 type => 'bool',
487 default => 0,
488 help => 'status.html',
489 documentation => 'Enable portal status',
490 },
491 portalUserAttr => {
492 type => 'text',
493 default => '_user',
494 documentation =>
495 'Session parameter to display connected user in portal',
496 },
497 redirectFormMethod => {
498 type => "select",
499 select =>
500 [ { k => 'get', v => 'GET' }, { k => 'post', v => 'POST' }, ],
501 default => 'get',
502 documentation => 'HTTP method for redirect page form',
503 },
504 reloadTimeout => {
505 type => 'int',
506 default => 5,
507 documentation => 'Configuration reload timeout',
508 flags => 'm',
509 },
510 reloadUrls => {
511 type => 'keyTextContainer',
512 keyTest => qr/^$Regexp::Common::URI::RFC2396::host(?::\d+)?$/,
513 test => $url,
514 msgFail => '__badUrl__',
515 documentation => 'URL to call on reload',
516 },
517 compactConf => {
518 type => 'bool',
519 default => 0,
520 documentation => 'Compact configuration',
521 },
522 portalMainLogo => {
523 type => 'text',
524 default => 'common/logos/logo_llng_400px.png',
525 documentation => 'Portal main logo path',
526 },
527 showLanguages => {
528 type => 'bool',
529 default => 1,
530 documentation => 'Display langs icons',
531 },
532 scrollTop => {
533 type => 'int',
534 default => 400,
535 documentation => 'Display back to top button',
536 },
537 floatingCategoryName => {
538 type => 'text',
539 documentation => 'Name of the category displayed as floating menu',
540 },
541 staticPrefix => {
542 type => 'text',
543 documentation => 'Prefix of static files for HTML templates',
544 },
545 groupsBeforeMacros => {
546 type => 'bool',
547 default => 0,
548 documentation => 'Compute groups before macros',
549 },
550 multiValuesSeparator => {
551 type => 'authParamsText',
552 default => '; ',
553 documentation => 'Separator for multiple values',
554 flags => 'hmp',
555 },
556 rememberAuthChoiceForgetAtLogout => {
557 type => 'bool',
558 default => 0,
559 documentation => 'Forget Auth Choice at logout',
560 },
561 rememberAuthChoiceRule => {
562 type => 'boolOrExpr',
563 default => 0,
564 documentation => 'remember auth choice activation rule',
565 },
566 rememberCookieName => {
567 type => 'text',
568 test => qr/^[a-zA-Z][a-zA-Z0-9_-]*$/,
569 msgFail => '__badCookieName__',
570 default => 'llngrememberauthchoice',
571 documentation => 'Name of the remember auth choice cookie',
572 flags => 'p',
573 },
574 rememberCookieTimeout => {
575 type => 'int',
576 default => 31536000,
577 documentation => 'lifetime of the remember auth choice cookie',
578 flags => 'm',
579 },
580 rememberDefaultChecked => {
581 type => 'bool',
582 default => 0,
583 documentation =>
584 'Is remember auth choice checkbox enabled by default?',
585 },
586 rememberTimer => {
587 type => 'int',
588 default => 5,
589 documentation =>
590 'timer before automatic authentication with remembered choice',
591 flags => 'm',
592 },
593 stayConnected => {
594 type => 'boolOrExpr',
595 default => 0,
596 documentation => 'Stay connected activation rule',
597 },
598 stayConnectedBypassFG => {
599 type => 'bool',
600 default => 0,
601 documentation => 'Disable fingerprint checkng',
602 },
603 stayConnectedTimeout => {
604 type => 'int',
605 default => 2592000,
606 documentation =>
607 'StayConnected persistent connexion session timeout',
608 flags => 'm',
609 },
610 stayConnectedCookieName => {
611 type => 'text',
612 test => qr/^[a-zA-Z][a-zA-Z0-9_-]*$/,
613 msgFail => '__badCookieName__',
614 default => 'llngconnection',
615 documentation => 'Name of the stayConnected plugin cookie',
616 flags => 'p',
617 },
618 stayConnectedSingleSession => {
619 default => 0,
620 type => 'bool',
621 documentation => 'Allow only one permanent session per user',
622 },
623 checkState => {
624 type => 'bool',
625 default => 0,
626 documentation => 'Enable CheckState plugin',
627 },
628 checkStateSecret => {
629 type => 'text',
630 documentation => 'Secret token for CheckState plugin',
631 },
632 webCronSecret => {
633 type => 'text',
634 documentation => 'Secret token for webcron plugin',
635 },
636 checkDevOps => {
637 default => 0,
638 type => 'bool',
639 documentation => 'Enable check DevOps',
640 flags => 'p',
641 },
642 checkDevOpsDownload => {
643 default => 1,
644 type => 'bool',
645 documentation => 'Enable check DevOps download field',
646 flags => 'p',
647 },
648 checkDevOpsDisplayNormalizedHeaders => {
649 default => 1,
650 type => 'bool',
651 documentation => 'Display normalized headers',
652 flags => 'p',
653 },
654 checkDevOpsCheckSessionAttributes => {
655 default => 1,
656 type => 'bool',
657 documentation => 'Check if session attributes exist',
658 flags => 'p',
659 },
660 checkHIBP => {
661 default => 0,
662 type => 'bool',
663 documentation => 'Enable check HIBP',
664 flags => 'p',
665 },
666 checkHIBPURL => {
667 default => 'https://api.pwnedpasswords.com/range/',
668 type => 'url',
669 documentation => 'URL of Have I Been Pwned API',
670 flags => 'p',
671 },
672 checkHIBPRequired => {
673 default => 1,
674 type => 'bool',
675 documentation => 'Require HIBP check to pass',
676 flags => 'p',
677 },
678 checkEntropy => {
679 default => 0,
680 type => 'bool',
681 documentation => 'Enable entropy check of password',
682 flags => 'p',
683 },
684 checkEntropyRequired => {
685 default => 0,
686 type => 'bool',
687 documentation => 'Require entropy check to pass',
688 flags => 'p',
689 },
690 checkEntropyRequiredLevel => {
691 type => 'int',
692 documentation =>
693 'Minimal entropy required for the password to be accepted',
694 flags => 'p',
695 },
696 initializePasswordReset => {
697 default => 0,
698 type => 'bool',
699 documentation => 'Enable Password Reset API plugin',
700 flags => 'p',
701 },
702 initializePasswordResetSecret => {
703 type => 'password',
704 documentation => 'Secret key for the Initialize Password Reset API',
705 flags => 'p',
706 },
707 checkUser => {
708 default => 0,
709 type => 'bool',
710 documentation => 'Enable check user',
711 flags => 'p',
712 },
713 checkUserIdRule => {
714 type => 'text',
715 test => sub { return perlExpr(@_) },
716 default => 1,
717 documentation => 'checkUser identities rule',
718 },
719 checkUserUnrestrictedUsersRule => {
720 type => 'text',
721 test => sub { return perlExpr(@_) },
722 documentation => 'checkUser unrestricted users rule',
723 flags => 'p',
724 },
725 checkUserHiddenAttributes => {
726 type => 'text',
727 default => '_loginHistory, _session_id, hGroups',
728 documentation => 'Attributes to hide in CheckUser plugin',
729 flags => 'p',
730 },
731 checkUserSearchAttributes => {
732 type => 'text',
733 documentation =>
734 'Attributes used for retrieving sessions in user DataBase',
735 flags => 'p',
736 },
737 checkUserDisplayPersistentInfo => {
738 default => 0,
739 type => 'boolOrExpr',
740 documentation => 'Display persistent session info rule',
741 flags => 'p',
742 },
743 checkUserDisplayEmptyValues => {
744 default => 0,
745 type => 'boolOrExpr',
746 documentation => 'Display session empty values rule',
747 flags => 'p',
748 },
749 checkUserDisplayEmptyHeaders => {
750 default => 0,
751 type => 'boolOrExpr',
752 documentation => 'Display empty headers rule',
753 flags => 'p',
754 },
755 checkUserDisplayNormalizedHeaders => {
756 default => 0,
757 type => 'boolOrExpr',
758 documentation => 'Display normalized headers rule',
759 flags => 'p',
760 },
761 checkUserDisplayComputedSession => {
762 default => 1,
763 type => 'boolOrExpr',
764 documentation => 'Display empty headers rule',
765 flags => 'p',
766 },
767 checkUserDisplayHistory => {
768 default => 0,
769 type => 'boolOrExpr',
770 documentation => 'Display history rule',
771 flags => 'p',
772 },
773 checkUserDisplayHiddenAttributes => {
774 default => 0,
775 type => 'boolOrExpr',
776 documentation => 'Display hidden attributes rule',
777 flags => 'p',
778 },
779 checkUserHiddenHeaders => {
780 type => 'keyTextContainer',
781 keyTest => qr/^\S+$/,
782 keyMsgFail => '__badHostname__',
783 test => {
784 keyTest => qr/^(?=[^\-])[\w\-\s]+(?<=[^-])$/,
785 keyMsgFail => '__badHeaderName__',
786 test => sub { return perlExpr(@_) },
787 },
788 documentation => 'Header values to hide if not empty',
789 },
790 findUser => {
791 default => 0,
792 type => 'bool',
793 documentation => 'Enable find user',
794 flags => 'p',
795 },
796 findUserSearchingAttributes => {
797 type => 'keyTextContainer',
798 keyTest => qr/^\S+$/,
799 documentation => 'Attributes used for searching accounts',
800 },
801 findUserExcludingAttributes => {
802 type => 'keyTextContainer',
803 keyTest => qr/^\S+$/,
804 documentation => 'Attributes used for excluding accounts',
805 },
806 findUserWildcard => {
807 type => 'text',
808 default => '*',
809 documentation => 'Character used as wildcard',
810 },
811 findUserControl => {
812 type => 'pcre',
813 default => '^[*\w]+$',
814 documentation => 'Regular expression to validate parameters',
815 },
816 newLocationWarning => {
817 default => 0,
818 type => 'bool',
819 documentation => 'Enable New Location Warning',
820 },
821 newLocationWarningLocationAttribute => {
822 type => 'text',
823 default => 'ipAddr',
824 documentation => 'New location session attribute',
825 },
826 newLocationWarningLocationDisplayAttribute => {
827 type => 'text',
828 default => '',
829 documentation => 'New location session attribute for user display',
830 },
831 newLocationWarningMaxValues => {
832 type => 'int',
833 default => '0',
834 documentation => 'How many previous locations should be compared',
835 },
836 newLocationWarningMailAttribute => {
837 type => 'text',
838 documentation => 'New location warning mail session attribute',
839 },
840 newLocationWarningMailBody => {
841 type => 'longtext',
842 documentation => 'Mail body for new location warning',
843 },
844 newLocationWarningMailSubject => {
845 type => 'text',
846 documentation => 'Mail subject for new location warning',
847 },
848 globalLogoutRule => {
849 type => 'boolOrExpr',
850 default => 0,
851 documentation => 'Global logout activation rule',
852 flags => 'p',
853 },
854 globalLogoutTimer => {
855 default => 1,
856 type => 'bool',
857 documentation => 'Global logout auto accept time',
858 flags => 'p',
859 },
860 globalLogoutCustomParam => {
861 type => 'text',
862 documentation => 'Custom session parameter to display',
863 flags => 'p',
864 },
865 impersonationMergeSSOgroups => {
866 default => 0,
867 type => 'boolOrExpr',
868 documentation => 'Merge spoofed and real SSO groups',
869 flags => 'p',
870 },
871 impersonationPrefix => {
872 type => 'text',
873 default => 'real_',
874 documentation => 'Prefix to rename real session attributes',
875 flags => 'p',
876 },
877 impersonationRule => {
878 type => 'boolOrExpr',
879 default => 0,
880 documentation => 'Impersonation activation rule',
881 flags => 'p',
882 },
883 impersonationIdRule => {
884 type => 'text',
885 test => sub { return perlExpr(@_) },
886 default => 1,
887 documentation => 'Impersonation identities rule',
888 flags => 'p',
889 },
890 impersonationUnrestrictedUsersRule => {
891 type => 'text',
892 test => sub { return perlExpr(@_) },
893 documentation => 'Impersonation unrestricted users rule',
894 flags => 'p',
895 },
896 impersonationHiddenAttributes => {
897 type => 'text',
898 default => '_2fDevices, _loginHistory',
899 documentation => 'Attributes to skip',
900 flags => 'p',
901 },
902 impersonationSkipEmptyValues => {
903 default => 1,
904 type => 'bool',
905 documentation => 'Skip session empty values',
906 flags => 'p',
907 },
908 contextSwitchingRule => {
909 type => 'boolOrExpr',
910 default => 0,
911 documentation => 'Context switching activation rule',
912 flags => 'p',
913 },
914 contextSwitchingIdRule => {
915 type => 'text',
916 test => sub { return perlExpr(@_) },
917 default => 1,
918 documentation => 'Context switching identities rule',
919 flags => 'p',
920 },
921 contextSwitchingUnrestrictedUsersRule => {
922 type => 'text',
923 test => sub { return perlExpr(@_) },
924 documentation => 'Context switching unrestricted users rule',
925 flags => 'p',
926 },
927 contextSwitchingStopWithLogout => {
928 type => 'bool',
929 default => 1,
930 documentation => 'Stop context switching by logout',
931 flags => 'p',
932 },
933 contextSwitchingAllowed2fModifications => {
934 type => 'bool',
935 default => 0,
936 documentation => 'Allowed SFA modifications',
937 flags => 'p',
938 },
939 contextSwitchingPrefix => {
940 type => 'text',
941 default => 'switching',
942 documentation => 'Prefix to store real session Id',
943 flags => 'p',
944 },
945 decryptValueRule => {
946 type => 'boolOrExpr',
947 default => 0,
948 documentation => 'Decrypt value activation rule',
949 flags => 'p',
950 },
951 decryptValueFunctions => {
952 type => 'text',
953 test => qr/^(?:\w+(?:::\w+)*(?:\s+\w+(?:::\w+)*)*)?$/,
954 msgFail => "__badCustomFuncName__",
955 documentation => 'Custom function used for decrypting values',
956 flags => 'p',
957 },
958 skipRenewConfirmation => {
959 type => 'bool',
960 default => 0,
961 documentation =>
962 'Avoid asking confirmation when an Issuer asks to renew auth',
963 },
964 skipUpgradeConfirmation => {
965 type => 'bool',
966 default => 0,
967 documentation =>
968 'Avoid asking confirmation during a session upgrade',
969 },
970 refreshSessions => {
971 type => 'bool',
972 help => "refreshsessionapi.html",
973 documentation => 'Refresh sessions plugin',
974 },
975 forceGlobalStorageIssuerOTT => {
976 type => 'bool',
977 documentation =>
978 'Force Issuer tokens to be stored into Global Storage',
979 },
980 handlerInternalCache => {
981 type => 'int',
982 default => 15,
983 documentation => 'Handler internal cache timeout',
984 flags => 'hp',
985 },
986 handlerServiceTokenTTL => {
987 type => 'int',
988 default => 30,
989 documentation => 'Handler ServiceToken timeout',
990 flags => 'hp',
991 },
992
993 # Loggers (ini only)
994 logLevel => {
995 type => 'text',
996 documentation => 'Log level, must be set in .ini',
997 flags => 'hmp',
998 },
999 logger => {
1000 type => 'text',
1001 documentation => 'technical logger',
1002 flags => 'hmp',
1003 },
1004 userLogger => {
1005 type => 'text',
1006 documentation => 'User actions logger',
1007 flags => 'hmp',
1008 },
1009 log4perlConfFile => {
1010 type => 'text',
1011 documentation => 'Log4Perl logger configuration file',
1012 flags => 'hmp',
1013 },
1014 lokiUrl => {
1015 type => 'text',
1016 documentation => 'Loki API',
1017 flags => 'hmp',
1018 },
1019 lokiLabel => {
1020 type => 'text',
1021 documentation => 'Loki label, default llng',
1022 flags => 'hmp',
1023 },
1024 lokiInstance => {
1025 type => 'text',
1026 documentation => 'Loki instance, default `hostname` output',
1027 flags => 'hmp',
1028 },
1029 lokiEnv => {
1030 type => 'text',
1031 documentation => 'Loki env, default "prod"',
1032 flags => 'hmp',
1033 },
1034 lokiTenant => {
1035 type => 'text',
1036 documentation => 'Loki Tenant',
1037 flags => 'hmp',
1038 },
1039 lokiTenantHeader => {
1040 type => 'text',
1041 documentation => 'Loki Tenant Header name',
1042 flags => 'hmp',
1043 },
1044 lokiAuthorization => {
1045 type => 'text',
1046 documentation => 'Loki Authorization header value',
1047 flags => 'hmp',
1048 },
1049 lokiService => {
1050 type => 'text',
1051 documentation => 'Loki Service (technical context)',
1052 flags => 'hmp',
1053 },
1054 lokiUserService => {
1055 type => 'text',
1056 documentation => 'Loki (userLogger context)',
1057 flags => 'hmp',
1058 },
1059 sentryDsn => {
1060 type => 'text',
1061 documentation => 'Sentry logger DSN',
1062 flags => 'hmp',
1063 },
1064 syslogFacility => {
1065 type => 'text',
1066 documentation => 'Syslog logger technical facility',
1067 flags => 'hmp',
1068 },
1069 userSyslogFacility => {
1070 type => 'text',
1071 documentation => 'Syslog logger user-actions facility',
1072 flags => 'hmp',
1073 },
1074 syslogSockOptions => {
1075 type => 'keyTextContainer',
1076 documentation => 'Option to send to setlogsock()',
1077 flags => 'hmp',
1078 keyTest => qr/^(?:type|path|timeout|host|port)$/,
1079 },
1080
1081 # Manager or PSGI protected apps
1082 protection => {
1083 type => 'text',
1084 test => qr/^(?:none|authenticate|manager|)$/,
1085 msgFail => '__authorizedValues__: none authenticate manager',
1086 documentation => 'Manager protection method',
1087 flags => 'hm',
1088 },
1089
1090 # Menu
1091 activeTimer => {
1092 type => 'bool',
1093 default => 1,
1094 documentation => 'Enable timers on portal pages',
1095 },
1096 applicationList => {
1097 type => 'catAndAppList',
1098 keyTest => qr/\w/,
1099 help => 'portalmenu.html#categories-and-applications',
1100 default => {
1101 default => { catname => 'Default category', type => "category" }
1102 },
1103 documentation => 'Applications list',
1104 },
1105 portalErrorOnExpiredSession => {
1106 type => 'bool',
1107 default => 1,
1108 documentation => 'Show error if session is expired',
1109 },
1110 portalErrorOnMailNotFound => {
1111 type => 'bool',
1112 default => 0,
1113 documentation =>
1114 'Show error if mail is not found in password reset process',
1115 },
1116 portalOpenLinkInNewWindow => {
1117 type => 'bool',
1118 default => 0,
1119 documentation => 'Open applications in new windows',
1120 },
1121 portalPingInterval => {
1122 type => 'int',
1123 default => 60000,
1124 documentation => 'Interval in ms between portal Ajax pings',
1125 },
1126 portalSkin => {
1127 type => 'portalskin',
1128 default => 'bootstrap',
1129 documentation => 'Name of portal skin',
1130 select => [ { k => 'bootstrap', v => 'Bootstrap' }, ],
1131 },
1132 portalSkinBackground => {
1133 type => 'portalskinbackground',
1134 documentation => 'Background image of portal skin',
1135 select => [
1136 { k => "", v => 'None' },
1137 {
1138 k => "1280px-Anse_Source_d'Argent_2-La_Digue.jpg",
1139 v => 'Anse'
1140 },
1141 {
1142 k =>
1143 "1280px-Autumn-clear-water-waterfall-landscape_-_Virginia_-_ForestWander.jpg",
1144 v => 'Waterfall'
1145 },
1146 { k => "1280px-BrockenSnowedTrees.jpg", v => 'Snowed Trees' },
1147 {
1148 k => "1280px-Cedar_Breaks_National_Monument_partially.jpg",
1149 v => 'National Monument'
1150 },
1151 {
1152 k => "1280px-Parry_Peak_from_Winter_Park.jpg",
1153 v => 'Winter'
1154 },
1155 {
1156 k => "Aletschgletscher_mit_Pinus_cembra1.jpg",
1157 v => 'Pinus'
1158 },
1159 ],
1160 },
1161 portalSkinRules => {
1162 type => 'keyTextContainer',
1163 help => 'portalcustom.html',
1164 keyTest => sub { return perlExpr(@_) },
1165 keyMsgFail => '__badSkinRule__',
1166 test => sub { 1 },
1167 msgFail => '__badValue__',
1168 documentation => 'Rules to choose portal skin',
1169 },
1170 cacheTagSalt => {
1171 type => 'text',
1172 documentation => 'Salt value for cache busting tag',
1173 },
1174
1175 # Security
1176 formTimeout => {
1177 default => 120,
1178 type => 'int',
1179 documentation => 'Token timeout for forms',
1180 },
1181 shortTokenTTL => {
1182 default => 30,
1183 type => 'int',
1184 documentation => 'Short token timeout (for machines)',
1185 },
1186 issuersTimeout => {
1187 default => 120,
1188 type => 'int',
1189 documentation => 'Token timeout for issuers',
1190 },
1191 requireToken => {
1192 default => 1,
1193 type => 'boolOrExpr',
1194 documentation => 'Enable token for forms',
1195 },
1196 tokenUseGlobalStorage => {
1197 default => 0,
1198 type => 'bool',
1199 documentation => 'Enable global token storage',
1200 },
1201 cda => {
1202 default => 0,
1203 type => 'bool',
1204 documentation => 'Enable Cross Domain Authentication',
1205 flags => 'hp',
1206 },
1207 checkXSS => {
1208 default => 1,
1209 type => 'bool',
1210 documentation => 'Check XSS',
1211 },
1212 portalForceAuthn => {
1213 default => 0,
1214 help => 'forcereauthn.html',
1215 type => 'bool',
1216 documentation =>
1217 'Enable force to authenticate when displaying portal',
1218 },
1219 portalForceAuthnInterval => {
1220 default => 30,
1221 type => 'int',
1222 documentation =>
1223 'Maximum interval in seconds since last authentication to force reauthentication',
1224 },
1225 bruteForceProtection => {
1226 default => 0,
1227 help => 'bruteforceprotection.html',
1228 type => 'bool',
1229 documentation => 'Enable brute force attack protection',
1230 },
1231 bruteForceProtectionTempo => {
1232 default => 30,
1233 type => 'int',
1234 documentation => 'Lock time',
1235 },
1236 bruteForceProtectionMaxAge => {
1237 default => 300,
1238 type => 'int',
1239 documentation => 'Max age between current and first failed login',
1240 },
1241 bruteForceProtectionMaxFailed => {
1242 default => 3,
1243 type => 'int',
1244 documentation => 'Max allowed failed login',
1245 },
1246 bruteForceProtectionMaxLockTime => {
1247 default => 900,
1248 type => 'int',
1249 documentation => 'Max lock time',
1250 },
1251 bruteForceProtectionIncrementalTempo => {
1252 default => 0,
1253 help => 'bruteforceprotection.html',
1254 type => 'bool',
1255 documentation =>
1256 'Enable incremental lock time for brute force attack protection',
1257 },
1258 bruteForceProtectionLockTimes => {
1259 type => 'text',
1260 default => '15, 30, 60, 300, 600',
1261 documentation =>
1262 'Incremental lock time values for brute force attack protection',
1263 },
1264 grantSessionRules => {
1265 type => 'grantContainer',
1266 keyTest => sub { return perlExpr(@_) },
1267 test => sub { 1 },
1268 documentation => 'Rules to grant sessions',
1269 default => {},
1270 },
1271 hiddenAttributes => {
1272 type => 'text',
1273 default => '_password _2fDevices',
1274 documentation => 'Name of attributes to hide in logs',
1275 },
1276 displaySessionId => {
1277 type => 'bool',
1278 default => 1,
1279 documentation => 'Display _session_id with sessions explorer',
1280 },
1281 persistentSessionAttributes => {
1282 type => 'text',
1283 default => '_loginHistory _2fDevices _oidcConsents notification_',
1284 documentation => 'Persistent session attributes to hide',
1285 },
1286 key => {
1287 type => 'password',
1288 documentation => 'Secret key',
1289 },
1290 corsEnabled => {
1291 default => 1,
1292 type => 'bool',
1293 documentation => 'Enable Cross-Origin Resource Sharing',
1294 },
1295 corsAllow_Credentials => {
1296 type => 'text',
1297 default => 'true',
1298 documentation =>
1299 'Allow credentials for Cross-Origin Resource Sharing',
1300 },
1301 corsAllow_Headers => {
1302 type => 'text',
1303 default => '*',
1304 documentation =>
1305 'Allowed headers for Cross-Origin Resource Sharing',
1306 },
1307 corsAllow_Methods => {
1308 type => 'text',
1309 default => 'POST,GET',
1310 documentation =>
1311 'Allowed methods for Cross-Origin Resource Sharing',
1312 },
1313 corsAllow_Origin => {
1314 type => 'text',
1315 default => '*',
1316 documentation =>
1317 'Allowed origine for Cross-Origin Resource Sharing',
1318 },
1319 corsExpose_Headers => {
1320 type => 'text',
1321 default => '*',
1322 documentation =>
1323 'Exposed headers for Cross-Origin Resource Sharing',
1324 },
1325 corsMax_Age => {
1326 type => 'text',
1327 default => '86400', # 24 hours
1328 documentation => 'Max-age for Cross-Origin Resource Sharing',
1329 },
1330 strictTransportSecurityMax_Age => {
1331 type => 'text',
1332 documentation => 'Max-age for Strict-Transport-Security',
1333 },
1334 cspDefault => {
1335 type => 'text',
1336 default => "'self'",
1337 documentation => 'Default value for Content-Security-Policy',
1338 },
1339 cspFormAction => {
1340 type => 'text',
1341 default => "*",
1342 documentation =>
1343 'Form action destination for Content-Security-Policy',
1344 },
1345 cspImg => {
1346 type => 'text',
1347 default => "'self' data:",
1348 documentation => 'Image source for Content-Security-Policy',
1349 },
1350 cspScript => {
1351 type => 'text',
1352 default => "'self'",
1353 documentation => 'Javascript source for Content-Security-Policy',
1354 },
1355 cspStyle => {
1356 type => 'text',
1357 default => "'self'",
1358 documentation => 'Style source for Content-Security-Policy',
1359 },
1360 cspConnect => {
1361 type => 'text',
1362 default => "'self'",
1363 documentation =>
1364 'Authorized Ajax destination for Content-Security-Policy',
1365 },
1366 cspFont => {
1367 type => 'text',
1368 default => "'self'",
1369 documentation => 'Font source for Content-Security-Policy',
1370 },
1371 cspFrameAncestors => {
1372 type => 'text',
1373 default => '',
1374 documentation => 'Frame-Ancestors for Content-Security-Policy',
1375 },
1376 portalAntiFrame => {
1377 default => 1,
1378 type => 'bool',
1379 documentation => 'Avoid portal to be displayed inside frames',
1380 },
1381 portalCheckLogins => {
1382 default => 1,
1383 type => 'bool',
1384 documentation => 'Display login history checkbox in portal',
1385 },
1386 randomPasswordRegexp => {
1387 type => 'pcre',
1388 default => '[A-Z]{3}[a-z]{5}.\d{2}',
1389 documentation => 'Regular expression to create a random password',
1390 },
1391 trustedBrowserUseTotp => {
1392 type => 'bool',
1393 default => 1,
1394 documentation => 'Use TOTP for trusted browser registration',
1395 },
1396 trustedBrowserRule => {
1397 type => 'boolOrExpr',
1398 default => 0,
1399 documentation => 'Trusted browser registration rule',
1400 },
1401 trustedDomains =>
1402 { type => 'text', documentation => 'Trusted domains', },
1403 storePassword => {
1404 default => 0,
1405 type => 'bool',
1406 documentation => 'Store password in session',
1407 },
1408 storePasswordEncrypted => {
1409 default => 0,
1410 type => 'bool',
1411 documentation => 'Crypt the password in session',
1412 },
1413 timeout => {
1414 type => 'int',
1415 test => sub { $_[0] > 0 },
1416 default => 72000,
1417 documentation => 'Session timeout on server side',
1418 },
1419 timeoutActivity => {
1420 type => 'int',
1421 test => sub { $_[0] >= 0 },
1422 default => 0,
1423 documentation => 'Session activity timeout on server side',
1424 },
1425 timeoutActivityInterval => {
1426 type => 'int',
1427 test => sub { $_[0] >= 0 },
1428 default => 60,
1429 documentation => 'Update session timeout interval on server side',
1430 },
1431 userControl => {
1432 type => 'pcre',
1433 default => '^[\w\.\-@]+$',
1434 documentation => 'Regular expression to validate login',
1435 },
1436 browsersDontStorePassword => {
1437 default => 0,
1438 type => 'bool',
1439 documentation => 'Avoid browsers to store users password',
1440 },
1441 useRedirectAjaxOnUnauthorized => {
1442 type => 'bool',
1443 default => 1,
1444 documentation =>
1445 'Redirect Ajax requests to portal for unauthorized (401)',
1446 flags => 'h',
1447 },
1448 useRedirectOnError => {
1449 type => 'bool',
1450 default => 1,
1451 documentation => 'Use 302 redirect code for error (500)',
1452 flags => 'h',
1453 },
1454 useRedirectOnForbidden => {
1455 default => 0,
1456 type => 'bool',
1457 documentation => 'Use 302 redirect code for forbidden (403)',
1458 },
1459 useSafeJail => {
1460 default => 1,
1461 type => 'bool',
1462 help => 'safejail.html',
1463 documentation => 'Activate Safe jail',
1464 flags => 'hp',
1465 },
1466 avoidAssignment => {
1467 default => 0,
1468 type => 'bool',
1469 help => 'safejail.html',
1470 documentation => 'Avoid assignment in expressions',
1471 flags => 'hp',
1472 },
1473 whatToTrace => {
1474 type => 'lmAttrOrMacro',
1475 default => 'uid',
1476 documentation => 'Session parameter used to fill REMOTE_USER',
1477 flags => 'hp',
1478 },
1479 customToTrace => {
1480 type => 'lmAttrOrMacro',
1481 documentation => 'Session parameter used to fill REMOTE_CUSTOM',
1482 flags => 'hp',
1483 },
1484 lwpOpts => {
1485 type => 'keyTextContainer',
1486 documentation => 'Options passed to LWP::UserAgent',
1487 default => { timeout => 10 },
1488 },
1489 lwpSslOpts => {
1490 type => 'keyTextContainer',
1491 documentation => 'TLS/SSL options passed to LWP::UserAgent',
1492 },
1493
1494 # CrowdSec plugins
1495 crowdsec => {
1496 default => 0,
1497 type => 'boolOrExpr',
1498 documentation => 'CrowdSec bouncer activation',
1499 },
1500 crowdsecAction => {
1501 type => 'select',
1502 select => [
1503 { k => 'reject', v => 'Reject' },
1504 { k => 'warn', v => 'Warn' },
1505 ],
1506 default => 'reject',
1507 documentation => 'CrowdSec action',
1508 },
1509 crowdsecUrl => {
1510 type => 'url',
1511 documentation => 'Base URL of CrowdSec local API',
1512 },
1513 crowdsecKey => {
1514 type => 'text',
1515 documentation => 'CrowdSec API key',
1516 },
1517 crowdsecIgnoreFailures => {
1518 default => 0,
1519 type => 'bool',
1520 documentation => 'Ignore Crowdsec errors',
1521 },
1522 crowdsecAgent => {
1523 default => 0,
1524 type => 'boolOrExpr',
1525 documentation =>
1526 'Enable plugin to report auth failures to Crowdsec (simple alert)',
1527 },
1528 crowdsecMachineId => {
1529 type => 'text',
1530 documentation => 'Crowdsec machine ID to send alerts',
1531 },
1532 crowdsecPassword => {
1533 type => 'text',
1534 documentation => 'Crowdsec password to send alerts',
1535 },
1536 crowdsecMaxFailures => {
1537 type => 'int',
1538 documentation =>
1539 'Crowdesc-Agent maximum failures allowed during delay',
1540 },
1541 crowdsecBlockDelay => {
1542 type => 'int',
1543 documentation => 'Crowdsec-Agent check delay',
1544 },
1545 crowdsecBanDuration => {
1546 type => 'text',
1547 default => '4h',
1548 documentation => 'Crowdsec-Agent ban duration (e.g. 4h, 1d)',
1549 },
1550 crowdsecFilters => {
1551 type => 'text',
1552 documentation => 'Crowdsec filters directory',
1553 },
1554 crowdSecAgentResponseCode => {
1555 type => 'int',
1556 default => 404,
1557 documentation => 'Crowdsec ban response code',
1558 },
1559 crowdSecAgentResponseValue => {
1560 type => 'text',
1561 documentation => 'Crowdsec ban response text',
1562 },
1563
1564 # OIDC personnal offline token removal
1565 oidcOfflineTokens => {
1566 type => 'bool',
1567 documentation => 'OIDC personnal offline token removal',
1568 },
1569
1570 # History
1571 failedLoginNumber => {
1572 default => 5,
1573 type => 'int',
1574 documentation => 'Number of failures stored in login history',
1575 },
1576 loginHistoryEnabled => {
1577 default => 0,
1578 type => 'bool',
1579 documentation => 'Enable login history',
1580 },
1581 portalDisplayLoginHistory => {
1582 type => 'boolOrExpr',
1583 default => 1,
1584 documentation => 'Display login history tab in portal',
1585 },
1586
1587 successLoginNumber => {
1588 default => 5,
1589 type => 'int',
1590 documentation => 'Number of success stored in login history',
1591 },
1592
1593 # Other displays
1594 portalDisplayAppslist => {
1595 type => 'boolOrExpr',
1596 default => 1,
1597 documentation => 'Display applications tab in portal',
1598 },
1599 portalDisplayChangePassword => {
1600 type => 'boolOrExpr',
1601 default => '$_auth =~ /^(LDAP|DBI|Demo)$/',
1602 documentation => 'Display password tab in portal',
1603 },
1604 portalDisplayLogout => {
1605 type => 'boolOrExpr',
1606 default => 1,
1607 documentation => 'Display logout tab in portal',
1608 },
1609 portalDisplayCertificateResetByMail => {
1610 type => 'bool',
1611 default => 0,
1612 documentation =>
1613 'Display certificate reset by mail button in portal',
1614 },
1615 portalDisplayRegister => {
1616 default => 1,
1617 type => 'bool',
1618 documentation => 'Display register button in portal',
1619 },
1620 portalDisplayResetPassword => {
1621 default => 0,
1622 type => 'bool',
1623 documentation => 'Display reset password button in portal',
1624 },
1625 portalDisplayOfflineTokens => {
1626 'default' => '$_auth eq \'OIDC\'',
1627 'type' => 'boolOrExpr'
1628 },
1629 portalDisplayOidcConsents => {
1630 type => 'boolOrExpr',
1631 default => '$_oidcConsents && $_oidcConsents =~ /\w+/',
1632 documentation => 'Display OIDC consents tab in portal',
1633 },
1634 portalDisplayOrder => {
1635 type => 'text',
1636 default =>
1637 'Appslist ChangePassword LoginHistory OidcConsents Logout',
1638 documentation => 'List for ordering tabs in portal',
1639 },
1640 portalDisplayGeneratePassword => {
1641 default => 1,
1642 type => 'bool',
1643 documentation =>
1644 'Display password generate box in reset password form',
1645 },
1646 portalDisplayRefreshMyRights => {
1647 default => 1,
1648 type => 'bool',
1649 documentation => 'Display link to refresh the user session',
1650 },
1651 portalEnablePasswordDisplay => {
1652 default => 0,
1653 type => 'bool',
1654 documentation => 'Allow to display password in login form',
1655 },
1656 passwordResetAllowedRetries => {
1657 default => 3,
1658 type => 'int',
1659 documentation => 'Maximum number of retries to reset password',
1660 },
1661
1662 # Cookies
1663 cookieExpiration => {
1664 type => 'intOrNull',
1665 documentation => 'SSO cookie expiration',
1666 flags => 'hp',
1667 },
1668 cookieName => {
1669 type => 'text',
1670 test => qr/^[a-zA-Z][a-zA-Z0-9_-]*$/,
1671 msgFail => '__badCookieName__',
1672 default => 'lemonldap',
1673 documentation => 'Name of the SSO cookie',
1674 flags => 'hp',
1675 },
1676 domain => {
1677 type => 'text',
1678 test =>
1679 qr/^(?:(?:$Regexp::Common::URI::RFC2396::hostname|#\w+#))?$/,
1680 msgFail => '__badDomainName__',
1681 default => 'example.com',
1682 documentation => 'DNS domain',
1683 flags => 'hp',
1684 },
1685 pdataDomain => {
1686 type => 'text',
1687 test => qr/^(?:$Regexp::Common::URI::RFC2396::hostname)?$/,
1688 msgFail => '__badDomainName__',
1689 default => '',
1690 documentation => 'pdata cookie DNS domain',
1691 flags => 'hp',
1692 },
1693 httpOnly => {
1694 default => 1,
1695 type => 'bool',
1696 documentation => 'Enable httpOnly flag in cookie',
1697 flags => 'hp',
1698 },
1699 securedCookie => {
1700 type => 'select',
1701 select => [
1702 { k => '0', v => 'unsecuredCookie' },
1703 { k => '1', v => 'securedCookie' },
1704 { k => '2', v => 'doubleCookie' },
1705 { k => '3', v => 'doubleCookieForSingleSession' },
1706 ],
1707 default => 0,
1708 documentation => 'Cookie securisation method',
1709 flags => 'hp',
1710 },
1711 hashedSessionStore => {
1712 type => 'bool',
1713 default => 0,
1714 documentation => 'Securize storage of sensible sessions',
1715 },
1716 sameSite => {
1717 type => 'select',
1718 select => [
1719 { k => '', v => '' },
1720 { k => 'Strict', v => 'Strict' },
1721 { k => 'Lax', v => 'Lax' },
1722 { k => 'None', v => 'None' },
1723 ],
1724 default => '',
1725 documentation => 'Cookie SameSite value',
1726 flags => 'hp',
1727 },
1728
1729 # Viewer
1730 viewerHiddenKeys => {
1731 type => 'text',
1732 default => 'samlIDPMetaDataNodes, samlSPMetaDataNodes',
1733 documentation => 'Hidden Conf keys',
1734 flags => 'm',
1735 },
1736 viewerAllowBrowser => {
1737 type => 'bool',
1738 default => 0,
1739 documentation => 'Allow configuration browser',
1740 },
1741 viewerAllowDiff => {
1742 type => 'bool',
1743 default => 0,
1744 documentation => 'Allow configuration diff',
1745 },
1746
1747 # Notification
1748 oldNotifFormat => {
1749 type => 'bool',
1750 default => 0,
1751 documentation => 'Use old XML format for notifications',
1752 },
1753 notificationWildcard => {
1754 type => 'text',
1755 default => 'allusers',
1756 documentation => 'Notification string to match all users',
1757 },
1758 publicNotifications => {
1759 default => 0,
1760 type => 'bool',
1761 documentation => 'Enable PublicNotification plugin',
1762 },
1763 notificationXSLTfile => {
1764 type => 'text',
1765 documentation => 'Custom XSLT document for notifications',
1766 },
1767 notification => {
1768 default => 0,
1769 type => 'bool',
1770 documentation => 'Notification activation',
1771 },
1772 notificationsExplorer => {
1773 default => 0,
1774 type => 'bool',
1775 documentation => 'Notifications explorer activation',
1776 },
1777 notificationsMaxRetrieve => {
1778 default => 3,
1779 type => 'int',
1780 documentation => 'Max number of displayed notifications',
1781 },
1782 notificationServer => {
1783 default => 0,
1784 type => 'bool',
1785 documentation => 'Notification server activation',
1786 },
1787 notificationDefaultCond => {
1788 type => 'text',
1789 default => '',
1790 documentation => 'Notification default condition',
1791 },
1792 notificationServerGET => {
1793 default => 0,
1794 type => 'bool',
1795 documentation => 'Notification server activation',
1796 },
1797 notificationServerPOST => {
1798 default => 1,
1799 type => 'bool',
1800 documentation => 'Notification server activation',
1801 },
1802 notificationServerDELETE => {
1803 default => 0,
1804 type => 'bool',
1805 documentation => 'Notification server activation',
1806 },
1807 notificationServerSentAttributes => {
1808 type => 'text',
1809 default => 'uid reference date title subtitle text check',
1810 documentation =>
1811 'Prameters to send with notification server GET method',
1812 flags => 'p',
1813 },
1814 notificationStorage => {
1815 type => 'PerlModule',
1816 default => 'File',
1817 documentation => 'Notification backend',
1818 },
1819 notificationStorageOptions => {
1820 type => 'keyTextContainer',
1821 default => { dirName => '/var/lib/lemonldap-ng/notifications', },
1822 documentation => 'Notification backend options',
1823 },
1824
1825 # Captcha
1826 captcha_login_enabled => {
1827 default => 0,
1828 type => 'boolOrExpr',
1829 documentation => 'Captcha on login page',
1830 },
1831 captcha_mail_enabled => {
1832 default => 1,
1833 type => 'boolOrExpr',
1834 documentation => 'Captcha on password reset page',
1835 },
1836 captcha_register_enabled => {
1837 default => 1,
1838 type => 'boolOrExpr',
1839 documentation => 'Captcha on account creation page',
1840 },
1841 captcha_size => {
1842 type => 'int',
1843 default => 6,
1844 documentation => 'Captcha size',
1845 },
1846 captcha => {
1847 type => 'PerlModule',
1848 documentation => 'Captcha backend module',
1849 flags => 'hp',
1850 },
1851 captchaOptions => {
1852 type => 'keyTextContainer',
1853 documentation => 'Captcha module options',
1854 flags => 'hp',
1855 },
1856
1857 # Variables
1858 exportedVars => {
1859 type => 'keyTextContainer',
1860 help => 'exportedvars.html',
1861 keyTest => qr/^!?[_a-zA-Z][a-zA-Z0-9_]*$/,
1862 keyMsgFail => '__badVariableName__',
1863 test => qr/^[_a-zA-Z][a-zA-Z0-9_:\-]*$/,
1864 msgFail => '__badValue__',
1865 default => { 'UA' => 'HTTP_USER_AGENT' },
1866 documentation => 'Main exported variables',
1867 },
1868 groups => {
1869 type => 'keyTextContainer',
1870 help =>
1871 'exportedvars.html#extend-variables-using-macros-and-groups',
1872 test => sub { return perlExpr(@_) },
1873 default => {},
1874 documentation => 'Groups',
1875 },
1876 macros => {
1877 type => 'keyTextContainer',
1878 help =>
1879 'exportedvars.html#extend-variables-using-macros-and-groups',
1880 keyTest => qr/^[_a-zA-Z][a-zA-Z0-9_]*$/,
1881 keyMsgFail => '__badMacroName__',
1882 test => sub { return perlExpr(@_) },
1883 default => {},
1884 documentation => 'Macros',
1885 },
1886
1887 # Storage
1888 globalStorage => {
1889 type => 'PerlModule',
1890 default => 'Apache::Session::File',
1891 documentation => 'Session backend module',
1892 flags => 'hp',
1893 },
1894 globalStorageOptions => {
1895 type => 'keyTextContainer',
1896 default => {
1897 'Directory' => '/var/lib/lemonldap-ng/sessions/',
1898 'LockDirectory' => '/var/lib/lemonldap-ng/sessions/lock/',
1899 'generateModule' =>
1900 'Lemonldap::NG::Common::Apache::Session::Generate::SHA256',
1901 },
1902 documentation => 'Session backend module options',
1903 flags => 'hp',
1904 },
1905 localSessionStorage => {
1906 type => 'PerlModule',
1907 default => 'Cache::FileCache',
1908 documentation => 'Local sessions cache module',
1909 },
1910 localSessionStorageOptions => {
1911 type => 'keyTextContainer',
1912 default => {
1913 'namespace' => 'lemonldap-ng-sessions',
1914 'default_expires_in' => 600,
1915 'directory_umask' => '007',
1916 'cache_root' => '/var/cache/lemonldap-ng',
1917 'cache_depth' => 3,
1918 },
1919 documentation => 'Sessions cache module options',
1920 },
1921
1922 # Persistent storage
1923 persistentStorage => {
1924 type => 'PerlModule',
1925 documentation => 'Storage module for persistent sessions'
1926 },
1927 persistentStorageOptions => {
1928 type => 'keyTextContainer',
1929 documentation => 'Options for persistent sessions storage module'
1930 },
1931 sessionDataToRemember => {
1932 type => 'keyTextContainer',
1933 keyTest => qr/^(\d+_)?[_a-zA-Z][a-zA-Z0-9_]*$/,
1934 keyMsgFail => '__invalidSessionData__',
1935 documentation => 'Data to remember in login history',
1936 },
1937 disablePersistentStorage => {
1938 default => 0,
1939 type => 'bool',
1940 documentation => 'Enabled persistent storage',
1941 },
1942
1943 # SAML issuer
1944 issuerDBSAMLActivation => {
1945 default => 0,
1946 type => 'bool',
1947 documentation => 'SAML IDP activation',
1948 },
1949 issuerDBSAMLPath => {
1950 type => 'pcre',
1951 default => '^/saml/',
1952 documentation => 'SAML IDP request path',
1953 },
1954 issuerDBSAMLRule => {
1955 type => 'boolOrExpr',
1956 default => 1,
1957 documentation => 'SAML IDP rule',
1958 },
1959
1960 # OpenID-Connect issuer
1961 issuerDBOpenIDConnectActivation => {
1962 type => 'bool',
1963 default => 0,
1964 documentation => 'OpenID Connect server activation',
1965 },
1966 issuerDBOpenIDConnectPath => {
1967 type => 'text',
1968 default => '^/oauth2/',
1969 documentation => 'OpenID Connect server request path',
1970 },
1971 issuerDBOpenIDConnectRule => {
1972 type => 'boolOrExpr',
1973 default => 1,
1974 documentation => 'OpenID Connect server rule',
1975 },
1976
1977 # GET issuer
1978 issuerDBGetActivation => {
1979 type => 'bool',
1980 default => 0,
1981 documentation => 'Get issuer activation',
1982 },
1983 issuerDBGetPath => {
1984 type => 'text',
1985 default => '^/get/',
1986 documentation => 'Get issuer request path',
1987 },
1988 issuerDBGetRule => {
1989 type => 'boolOrExpr',
1990 default => 1,
1991 documentation => 'Get issuer rule',
1992 },
1993 issuerDBGetParameters => {
1994 type => 'doubleHash',
1995 default => {},
1996 keyTest => qr/^$Regexp::Common::URI::RFC2396::hostname$/,
1997 keyMsgFail => '__badHostname__',
1998 test => {
1999 keyTest => qr/^(?=[^\-])[\w\-]+(?<=[^-])$/,
2000 keyMsgFail => '__badKeyName__',
2001 test => sub {
2002 my ( $val, $conf ) = @_;
2003 return 1
2004 if ( defined $conf->{macros}->{$val}
2005 or $val eq '_timezone' );
2006 foreach ( keys %$conf ) {
2007 return 1
2008 if ( $_ =~ /exportedvars$/i
2009 and defined $conf->{$_}->{$val} );
2010 }
2011 return ( 1, "__unknownAttrOrMacro__: $val" );
2012 },
2013 },
2014 documentation => 'List of virtualHosts with their get parameters',
2015 },
2016
2017 # Message broker
2018 messageBroker => {
2019 type => 'select',
2020 documentation => 'Messages broker module',
2021 select => [
2022 { k => '', v => '' },
2023 { k => '::Redis', v => 'Redis' },
2024 { k => '::Pg', v => 'PostgreSQL' },
2025 { k => '::MQTT', v => 'MQTT' },
2026 { k => '::Web', v => 'Web' },
2027 ],
2028 flags => 'hp',
2029 },
2030 messageBrokerOptions => {
2031 type => 'keyTextContainer',
2032 default => {},
2033 documentation => 'Options of messages broker module',
2034 flags => 'hp',
2035 },
2036 eventQueueName => {
2037 type => 'text',
2038 default => 'llng_events',
2039 documentation => 'Event channel name',
2040 },
2041
2042 # Jitsi Meet tokens issuer
2043 issuerDBJitsiMeetTokensActivation => {
2044 type => 'bool',
2045 default => 0,
2046 documentation => 'Jitsi issuer activation',
2047 },
2048 issuerDBJitsiMeetTokensPath => {
2049 type => 'text',
2050 default => '^/jitsi/',
2051 documentation => 'Jitsi issuer request path',
2052 },
2053 issuerDBJitsiMeetTokensRule => {
2054 type => 'boolOrExpr',
2055 default => 1,
2056 documentation => 'Jitsi issuer rule',
2057 },
2058
2059 jitsiDefaultServer => {
2060 type => 'url',
2061 documentation => 'Jitsi server URL',
2062 },
2063 jitsiAppId => {
2064 type => 'text',
2065 documentation => 'Jitsi application ID',
2066 },
2067 jitsiAppSecret => {
2068 type => 'text',
2069 documentation => 'Jitsi application secret',
2070 },
2071 jitsiSigningAlg => {
2072 type => 'select',
2073 select => oidcSigAlgorithmAlg,
2074 default => 'RS256',
2075 documentation => 'Jitsi JWT signature method',
2076 },
2077 jitsiSigningKey => {
2078 type => 'text',
2079 default => 'default-oidc-sig, old-oidc-sig, new-oidc-sig',
2080 documentation => 'Jitsi JWT signature key',
2081 },
2082 jitsiExpiration => {
2083 type => 'int',
2084 default => '300',
2085 documentation => 'Jitsi JWT expiration',
2086 },
2087 jitsiIdAttribute => {
2088 type => 'text',
2089 documentation => 'Jitsi attribute for ID',
2090 },
2091 jitsiNameAttribute => {
2092 type => 'text',
2093 documentation => 'Jitsi attribute for name',
2094 },
2095 jitsiMailAttribute => {
2096 type => 'text',
2097 documentation => 'Jitsi attribute for email',
2098 },
2099
2100 # Password
2101 mailOnPasswordChange => {
2102 default => 0,
2103 type => 'bool',
2104 documentation => 'Send a mail when password is changed',
2105 },
2106 portalRequireOldPassword => {
2107 default => 1,
2108 type => 'boolOrExpr',
2109 documentation =>
2110 'Rule to require old password to change the password',
2111 },
2112 hideOldPassword => {
2113 default => 1,
2114 type => 'bool',
2115 documentation => 'Hide old password in portal',
2116 },
2117 passwordPolicyActivation => {
2118 type => 'boolOrExpr',
2119 default => 1,
2120 documentation => 'Enable password policy',
2121 },
2122 passwordPolicyMinSize => {
2123 default => 0,
2124 type => 'int',
2125 documentation => 'Password policy: minimal size',
2126 },
2127 passwordPolicyMaxSize => {
2128 default => 0,
2129 type => 'int',
2130 documentation => 'Password policy: maximal size',
2131 },
2132 passwordPolicyMinLower => {
2133 default => 0,
2134 type => 'int',
2135 documentation => 'Password policy: minimal lower characters',
2136 },
2137 passwordPolicyMinUpper => {
2138 default => 0,
2139 type => 'int',
2140 documentation => 'Password policy: minimal upper characters',
2141 },
2142 passwordPolicyMinDigit => {
2143 default => 0,
2144 type => 'int',
2145 documentation => 'Password policy: minimal digit characters',
2146 },
2147 passwordPolicyMinSpeChar => {
2148 default => 0,
2149 type => 'int',
2150 documentation => 'Password policy: minimal special characters',
2151 },
2152 passwordPolicySpecialChar => {
2153 default => '__ALL__',
2154 type => 'text',
2155 test => qr/^(?:__ALL__|[\S\W]*)$/,
2156 documentation => 'Password policy: allowed special characters',
2157 },
2158 portalDisplayPasswordPolicy => {
2159 default => 0,
2160 type => 'bool',
2161 documentation => 'Display policy in password form',
2162 },
2163
2164 # SMTP server
2165 SMTPServer => {
2166 type => 'text',
2167 default => '',
2168 test => qr/^(?:$Regexp::Common::URI::RFC2396::host(?::\d+)?)?$/,
2169 documentation => 'SMTP Server',
2170 },
2171 SMTPPort => {
2172 type => 'int',
2173 documentation => 'Fix SMTP port',
2174 },
2175 SMTPTLS => {
2176 type => 'select',
2177 default => '',
2178 select => [
2179 { k => '', v => 'none' },
2180 { k => 'starttls', v => 'SMTP + STARTTLS' },
2181 { k => 'ssl', v => 'SMTPS' },
2182 ],
2183 documentation => 'TLS protocol to use with SMTP',
2184 },
2185 SMTPTLSOpts => {
2186 type => 'keyTextContainer',
2187 documentation => 'TLS/SSL options for SMTP',
2188 },
2189 SMTPAuthUser => {
2190 type => 'text',
2191 documentation => 'Login to use to send mails',
2192 },
2193 SMTPAuthPass => {
2194 type => 'password',
2195 documentation => 'Password to use to send mails',
2196 },
2197
2198 # Mails
2199 mailCharset => {
2200 type => 'text',
2201 default => 'utf-8',
2202 documentation => 'Mail charset',
2203 },
2204 mailFrom => {
2205 type => 'text',
2206 default => '[email protected]',
2207 documentation => 'Sender email',
2208 },
2209 mailSessionKey => {
2210 type => 'text',
2211 default => 'mail',
2212 documentation => 'Session parameter where mail is stored',
2213 },
2214 mailReplyTo => { type => 'text', documentation => 'Reply-To address' },
2215 mailTimeout => {
2216 type => 'int',
2217 default => 0,
2218 documentation => 'Mail password reset session timeout',
2219 },
2220
2221 # Password reset
2222 mailBody => {
2223 type => 'longtext',
2224 documentation => 'Custom password reset mail body',
2225 },
2226
2227 mailConfirmBody => {
2228 type => 'longtext',
2229 documentation => 'Custom confirm password reset mail body',
2230 },
2231 mailConfirmSubject => {
2232 type => 'text',
2233 documentation => 'Mail subject for reset confirmation',
2234 },
2235 mailSubject => {
2236 type => 'text',
2237 documentation => 'Mail subject for new password email',
2238 },
2239
2240 mailUrl => {
2241 type => 'url',
2242 documentation => 'URL of password reset page',
2243 },
2244
2245 # Certificate reset by mail
2246 certificateResetByMailCeaAttribute => {
2247 type => 'text',
2248 default => 'description'
2249 },
2250 certificateResetByMailCertificateAttribute => {
2251 type => 'text',
2252 default => 'userCertificate;binary',
2253 },
2254 certificateResetByMailStep1Subject => {
2255 type => 'text',
2256 documentation => 'Mail subject for certificate reset email',
2257 },
2258 certificateResetByMailStep1Body => {
2259 type => 'longtext',
2260 documentation => 'Custom Certificate reset mail body',
2261 },
2262 certificateResetByMailStep2Subject => {
2263 type => 'text',
2264 documentation => 'Mail subject for reset confirmation',
2265 },
2266 certificateResetByMailStep2Body => {
2267 type => 'longtext',
2268 documentation => 'Custom confirm Certificate reset mail body',
2269 },
2270 certificateResetByMailURL => {
2271 type => 'url',
2272 documentation => 'URL of certificate reset page',
2273 },
2274 certificateResetByMailValidityDelay => {
2275 type => 'int',
2276 default => 0
2277 },
2278
2279 # Registration
2280 registerConfirmSubject => {
2281 type => 'text',
2282 documentation => 'Mail subject for register confirmation',
2283 },
2284 registerConfirmBody => {
2285 type => 'longtext',
2286 documentation => 'Mail body for register confirmation',
2287 },
2288 registerDoneSubject => {
2289 type => 'text',
2290 documentation => 'Mail subject when register is done',
2291 },
2292 registerDoneBody => {
2293 type => 'longtext',
2294 documentation => 'Mail body when register is done',
2295 },
2296 registerTimeout => {
2297 default => 0,
2298 type => 'int',
2299 documentation => 'Register session timeout',
2300 },
2301 registerUrl => {
2302 type => 'url',
2303 documentation => 'URL of register page',
2304 },
2305 registerDB => {
2306 type => 'select',
2307 select => [
2308 { k => 'AD', v => 'Active Directory' },
2309 { k => 'Demo', v => 'Demonstration' },
2310 { k => 'LDAP', v => 'LDAP' },
2311 { k => 'Null', v => 'None' },
2312 { k => 'Custom', v => 'customModule' },
2313 ],
2314 default => 'Null',
2315 documentation => 'Register module',
2316 },
2317
2318 # Upgrade session
2319 upgradeSession => {
2320 type => 'bool',
2321 default => 1,
2322 documentation => 'Upgrade session activation',
2323 },
2324 forceGlobalStorageUpgradeOTT => {
2325 type => 'bool',
2326 documentation =>
2327 'Force Upgrade tokens be stored into Global Storage',
2328 },
2329
2330 # 2F
2331 max2FDevices => {
2332 default => 10,
2333 type => 'int',
2334 documentation => 'Maximum registered 2F devices',
2335 },
2336 max2FDevicesNameLength => {
2337 default => 20,
2338 type => 'int',
2339 documentation => 'Maximum 2F devices name length',
2340 },
2341
2342 # Okta 2FA
2343 okta2fActivation => {
2344 type => 'boolOrExpr',
2345 default => 0,
2346 documentation => 'Okta2F activation',
2347 },
2348 okta2fAdminURL => {
2349 type => 'url',
2350 documentation => 'Okta Administration URL'
2351 },
2352 okta2fApiKey => {
2353 type => 'text',
2354 documentation => 'Okta API key'
2355 },
2356 okta2fAuthnLevel => {
2357 type => 'intOrNull',
2358 documentation =>
2359 'Authentication level for users authentified by Okta2F'
2360 },
2361 okta2fLabel => {
2362 type => 'text',
2363 documentation => 'Portal label for Okta2F'
2364 },
2365 okta2fLoginAttribute => {
2366 type => 'text',
2367 documentation => 'Session key containing Okta login'
2368 },
2369 okta2fLogo => {
2370 type => 'text',
2371 documentation => 'Custom logo for Okta 2F',
2372 },
2373
2374 # Password 2FA
2375 password2fActivation => {
2376 type => 'boolOrExpr',
2377 default => 0,
2378 documentation => 'Password2F activation',
2379 },
2380 password2fSelfRegistration => {
2381 type => 'boolOrExpr',
2382 default => 0,
2383 documentation => 'Password2F self registration activation',
2384 },
2385 password2fAuthnLevel => {
2386 type => 'intOrNull',
2387 documentation =>
2388 'Authentication level for users authentified by Password2F'
2389 },
2390 password2fLabel => {
2391 type => 'text',
2392 documentation => 'Portal label for Password2F'
2393 },
2394 password2fLogo => {
2395 type => 'text',
2396 documentation => 'Custom logo for Password 2F',
2397 },
2398 password2fUserCanRemoveKey => {
2399 type => 'bool',
2400 default => 1,
2401 documentation =>
2402 'Authorize users to remove existing Password2F secret',
2403 },
2404 password2fTTL => {
2405 type => 'intOrNull',
2406 documentation => 'Password2F device time to live',
2407 },
2408
2409 # TOTP second factor
2410 totp2fActivation => {
2411 type => 'boolOrExpr',
2412 default => 0,
2413 documentation => 'TOTP activation',
2414 },
2415 totp2fSelfRegistration => {
2416 type => 'boolOrExpr',
2417 default => 0,
2418 documentation => 'TOTP self registration activation',
2419 },
2420 totp2fAuthnLevel => {
2421 type => 'intOrNull',
2422 documentation =>
2423 'Authentication level for users authentified by password+TOTP'
2424 },
2425 totp2fLabel => {
2426 type => 'text',
2427 documentation => 'Portal label for TOTP 2F'
2428 },
2429 totp2fLogo => {
2430 type => 'text',
2431 documentation => 'Custom logo for TOTP 2F',
2432 },
2433 totp2fIssuer => {
2434 type => 'text',
2435 documentation => 'TOTP Issuer',
2436 },
2437 totp2fInterval => {
2438 type => 'int',
2439 default => 30,
2440 documentation => 'TOTP interval',
2441 },
2442 totp2fDigits => {
2443 type => 'int',
2444 default => 6,
2445 documentation => 'Number of digits for TOTP code',
2446 },
2447 totp2fAlgorithm => {
2448 type => 'select',
2449 select => [
2450 { k => 'sha1', v => 'SHA-1' },
2451 { k => 'sha256', v => 'SHA-256' },
2452 { k => 'sha512', v => 'SHA-512' },
2453 ],
2454 default => 'sha1',
2455 documentation => 'Hashing algorithm to use for HMAC',
2456 },
2457 totp2fRange => {
2458 type => 'int',
2459 default => 1,
2460 documentation => 'TOTP range (number of interval to test)',
2461 },
2462 totp2fUserCanRemoveKey => {
2463 type => 'bool',
2464 default => 1,
2465 documentation => 'Authorize users to remove existing TOTP secret',
2466 },
2467 totp2fTTL => {
2468 type => 'intOrNull',
2469 documentation => 'TOTP device time to live',
2470 },
2471 totp2fEncryptSecret => {
2472 type => 'bool',
2473 default => 0,
2474 documentation => 'Encrypt TOTP secrets in database',
2475 },
2476
2477 # Mail second factor
2478 mail2fActivation => {
2479 type => 'boolOrExpr',
2480 default => 0,
2481 documentation => 'Mail second factor activation',
2482 },
2483 mail2fSubject => {
2484 type => 'text',
2485 documentation => 'Mail subject for second factor authentication',
2486 },
2487 mail2fBody => {
2488 type => 'longtext',
2489 documentation => 'Mail body for second factor authentication',
2490 },
2491 mail2fCodeRegex => {
2492 type => 'pcre',
2493 default => '\d{6}',
2494 documentation => 'Regular expression to create a mail OTP code',
2495 },
2496 mail2fTimeout => {
2497 type => 'intOrNull',
2498 documentation => 'Second factor code timeout',
2499 },
2500 mail2fResendInterval => {
2501 type => 'text',
2502 documentation => 'Delay before user is allowed to resend code',
2503 },
2504 mail2fAuthnLevel => {
2505 type => 'intOrNull',
2506 documentation =>
2507 'Authentication level for users authenticated by Mail second factor'
2508 },
2509 mail2fLabel => {
2510 type => 'text',
2511 documentation => 'Portal label for Mail second factor'
2512 },
2513 mail2fLogo => {
2514 type => 'text',
2515 documentation => 'Custom logo for Mail 2F',
2516 },
2517 mail2fSessionKey => {
2518 type => 'text',
2519 documentation => 'Session parameter where mail is stored',
2520 },
2521
2522 # External second factor
2523 ext2fActivation => {
2524 type => 'boolOrExpr',
2525 default => 0,
2526 documentation => 'External second factor activation',
2527 },
2528 ext2fCodeActivation => {
2529 type => 'pcre',
2530 default => '\d{6}',
2531 documentation => 'OTP generated by Portal',
2532 },
2533 ext2FSendCommand => {
2534 type => 'text',
2535 documentation => 'Send command of External second factor',
2536 },
2537 ext2FValidateCommand => {
2538 type => 'text',
2539 documentation => 'Validation command of External second factor',
2540 },
2541 ext2fResendInterval => {
2542 type => 'text',
2543 documentation => 'Delay before user is allowed to resend code',
2544 },
2545 ext2fAuthnLevel => {
2546 type => 'intOrNull',
2547 documentation =>
2548 'Authentication level for users authentified by External second factor'
2549 },
2550 ext2fLabel => {
2551 type => 'text',
2552 documentation => 'Portal label for External second factor'
2553 },
2554 ext2fLogo => {
2555 type => 'text',
2556 documentation => 'Custom logo for External 2F',
2557 },
2558
2559 # Radius second factor
2560 radius2fActivation => {
2561 type => 'boolOrExpr',
2562 default => 0,
2563 documentation => 'Radius second factor activation',
2564 },
2565 radius2fSecret => { type => 'text', },
2566 radius2fServer => { type => 'text', },
2567 radius2fUsernameSessionKey => {
2568 type => 'text',
2569 documentation => 'Session key used as Radius login'
2570 },
2571 radius2fTimeout => {
2572 type => 'int',
2573 default => 20,
2574 documentation => 'Radius 2f verification timeout',
2575 },
2576 radius2fMsgAuth => {
2577 type => 'bool',
2578 documentation => 'Use Message-Authentication for Radius requests',
2579 },
2580 radius2fSendInitialRequest => {
2581 type => 'bool',
2582 default => 0,
2583 documentation => 'Dial in to radius server before displaying form',
2584 },
2585 radius2fAuthnLevel => {
2586 type => 'intOrNull',
2587 documentation =>
2588 'Authentication level for users authenticated by Radius second factor'
2589 },
2590 radius2fLogo => {
2591 type => 'text',
2592 documentation => 'Custom logo for Radius 2F',
2593 },
2594 radius2fLabel => {
2595 type => 'text',
2596 documentation => 'Portal label for Radius 2F'
2597 },
2598
2599 # REST External second factor
2600 rest2fActivation => {
2601 type => 'boolOrExpr',
2602 default => 0,
2603 documentation => 'REST second factor activation',
2604 },
2605 rest2fCodeActivation => {
2606 type => 'pcre',
2607 documentation => 'OTP generated by Portal',
2608 },
2609 rest2fInitUrl => {
2610 type => 'url',
2611 documentation => 'REST 2F init URL',
2612 },
2613 rest2fInitArgs => {
2614 type => 'keyTextContainer',
2615 test => sub { return perlExpr(@_) },
2616 msgFail => '__badValue__',
2617 documentation => 'Args for REST 2F init',
2618 },
2619 rest2fVerifyUrl => {
2620 type => 'url',
2621 documentation => 'REST 2F verify URL',
2622 },
2623 rest2fVerifyArgs => {
2624 type => 'keyTextContainer',
2625 keyTest => qr/^\w+$/,
2626 keyMsgFail => '__badKeyName__',
2627 test => qr/^\w+$/,
2628 msgFail => '__badValue__',
2629 documentation => 'Args for REST 2F verify',
2630 },
2631 rest2fResendInterval => {
2632 type => 'text',
2633 documentation => 'Delay before user is allowed to resend code',
2634 },
2635 rest2fAuthnLevel => {
2636 type => 'intOrNull',
2637 documentation =>
2638 'Authentication level for users authentified by REST second factor'
2639 },
2640 rest2fLabel => {
2641 type => 'text',
2642 documentation => 'Portal label for REST second factor'
2643 },
2644 rest2fLogo => {
2645 type => 'text',
2646 documentation => 'Custom logo for REST 2F',
2647 },
2648 radius2fDictionaryFile => { type => 'text' },
2649 radius2fRequestAttributes => {
2650 type => 'keyTextContainer',
2651
2652 keyTest => qr/^[a-zA-Z0-9_-]*$/,
2653 keyMsgFail => '__badKeyName__',
2654
2655 default => {},
2656 documentation => 'RADIUS second factor authentication attributes',
2657 },
2658
2659 # Yubikey 2FA
2660 yubikey2fActivation => {
2661 type => 'boolOrExpr',
2662 default => 0,
2663 documentation => 'Yubikey second factor activation',
2664 },
2665 yubikey2fSelfRegistration => {
2666 type => 'boolOrExpr',
2667 default => 0,
2668 documentation => 'Yubikey self registration activation',
2669 },
2670 yubikey2fAuthnLevel => {
2671 type => 'intOrNull',
2672 documentation =>
2673 'Authentication level for users authentified by Yubikey second factor'
2674 },
2675 yubikey2fLabel => {
2676 type => 'text',
2677 documentation => 'Portal label for Yubikey second factor'
2678 },
2679 yubikey2fLogo => {
2680 type => 'text',
2681 documentation => 'Custom logo for Yubikey 2F',
2682 },
2683 yubikey2fClientID => {
2684 type => 'text',
2685 documentation => 'Yubico client ID',
2686 },
2687 yubikey2fSecretKey => {
2688 type => 'text',
2689 documentation => 'Yubico secret key',
2690 },
2691 yubikey2fNonce => {
2692 type => 'text',
2693 documentation => 'Yubico nonce',
2694 },
2695 yubikey2fUrl => {
2696 type => 'url',
2697 documentation => 'Yubico server',
2698 },
2699 yubikey2fPublicIDSize => {
2700 type => 'int',
2701 default => 12,
2702 documentation => 'Yubikey public ID size',
2703 },
2704 yubikey2fUserCanRemoveKey => {
2705 type => 'bool',
2706 default => 1,
2707 documentation => 'Authorize users to remove existing Yubikey',
2708 },
2709 yubikey2fFromSessionAttribute => {
2710 type => 'text',
2711 documentation =>
2712 'Provision yubikey from the given session variable',
2713 },
2714 yubikey2fTTL => {
2715 type => 'intOrNull',
2716 documentation => 'Yubikey device time to live',
2717 },
2718
2719 # WebAuthn 2FA
2720 webauthn2fActivation => {
2721 type => 'boolOrExpr',
2722 default => 0,
2723 documentation => 'WebAuthn second factor activation',
2724 },
2725 webauthn2fSelfRegistration => {
2726 type => 'boolOrExpr',
2727 default => 0,
2728 documentation => 'WebAuthn self registration activation',
2729 },
2730 webauthn2fAuthnLevel => {
2731 type => 'intOrNull',
2732 documentation =>
2733 'Authentication level for users authentified by WebAuthn second factor'
2734 },
2735 webauthn2fLabel => {
2736 type => 'text',
2737 documentation => 'Portal label for WebAuthn second factor'
2738 },
2739 webauthn2fLogo => {
2740 type => 'text',
2741 documentation => 'Custom logo for WebAuthn 2F',
2742 },
2743 webauthn2fUserVerification => {
2744 type => 'select',
2745 select => [
2746 { k => 'discouraged', v => 'discouraged' },
2747 { k => 'preferred', v => 'preferred' },
2748 { k => 'required', v => 'required' },
2749 ],
2750 default => 'preferred',
2751 documentation => 'Verify user during registration and login',
2752 },
2753 webauthn2fAttestation => {
2754 type => 'select',
2755 select => [
2756 { k => 'none', v => 'None' },
2757 { k => 'direct', v => 'Direct' },
2758 { k => 'indirect', v => 'Indirect' },
2759 { k => 'enterprise', v => 'Enterprise' },
2760 ],
2761 default => 'none',
2762 documentation => 'Ask the authenticator for an attestation',
2763 },
2764 webauthn2fAttestationTrust => {
2765 type => 'file',
2766 documentation =>
2767 'Certificate bundle for attestation trust validation',
2768 },
2769 webauthn2fResidentKey => {
2770 type => 'select',
2771 select => [
2772 { k => '', v => '' },
2773 { k => 'discouraged', v => 'Discouraged' },
2774 { k => 'preferred', v => 'Preferred' },
2775 { k => 'required', v => 'Required' },
2776 ],
2777 documentation => 'Use discoverable credential',
2778 },
2779 webauthn2fUserCanRemoveKey => {
2780 type => 'bool',
2781 default => 1,
2782 documentation => 'Authorize users to remove existing WebAuthn',
2783 },
2784 webauthnDisplayNameAttr => {
2785 type => 'text',
2786 documentation => 'Session attribute containing user display name',
2787 },
2788 webauthnRpId => {
2789 type => 'text',
2790 documentation => 'WebAuthn Relying Party ID',
2791 },
2792 webauthnAppId => {
2793 type => 'bool',
2794 default => 1,
2795 documentation => 'Send AppID extension',
2796 },
2797 webauthnRpName => {
2798 type => 'text',
2799 documentation => 'WebAuthn Relying Party display name',
2800 },
2801 webauthnDefaultTransports => {
2802 type => 'text',
2803 documentation => 'WebAuthn default transports',
2804 },
2805 webauthnAuthnLevel => {
2806 type => 'int',
2807 default => 3,
2808 documentation => 'WebAuthn authentication level',
2809 },
2810
2811 # Single session
2812 notifyDeleted => {
2813 default => 1,
2814 type => 'bool',
2815 documentation => 'Show deleted sessions in portal',
2816 },
2817 notifyOther => {
2818 default => 0,
2819 type => 'bool',
2820 documentation => 'Show other sessions in portal',
2821 },
2822 singleSession => {
2823 default => 0,
2824 type => 'boolOrExpr',
2825 documentation => 'Allow only one session per user',
2826 },
2827 singleIP => {
2828 default => 0,
2829 type => 'boolOrExpr',
2830 documentation => 'Allow only one session per IP',
2831 },
2832 singleUserByIP => {
2833 default => 0,
2834 type => 'boolOrExpr',
2835 documentation => 'Allow only one user per IP',
2836 },
2837
2838 # REST server
2839 restSessionServer => {
2840 default => 0,
2841 type => 'bool',
2842 documentation => 'Enable REST session server',
2843 },
2844 restAuthServer => {
2845 default => 0,
2846 type => 'bool',
2847 documentation => 'Enable REST authentication server',
2848 },
2849 restPasswordServer => {
2850 default => 0,
2851 type => 'bool',
2852 documentation => 'Enable REST password reset server',
2853 },
2854 restExportSecretKeys => {
2855 default => 0,
2856 type => 'bool',
2857 documentation =>
2858 'Allow to export secret keys in REST session server',
2859 },
2860 restClockTolerance => {
2861 default => 15,
2862 type => 'int',
2863 documentation =>
2864 'How tolerant the REST session server will be to clock dift',
2865 },
2866 restConfigServer => {
2867 default => 0,
2868 type => 'bool',
2869 documentation => 'Enable REST config server',
2870 },
2871 restAuthnLevel => {
2872 type => 'int',
2873 default => 2,
2874 documentation => 'REST authentication level',
2875 },
2876
2877 # OIDC revoke token Plugin
2878 adminLogoutServerSecret => {
2879 type => 'text',
2880 documentation => 'REST OIDC token revocation secret',
2881 },
2882
2883 # SOAP server
2884 soapSessionServer => {
2885 default => 0,
2886 type => 'bool',
2887 help => 'soapservices.html',
2888 documentation => 'Enable SOAP session server',
2889 },
2890 soapConfigServer => {
2891 default => 0,
2892 type => 'bool',
2893 help => 'soapservices.html',
2894 documentation => 'Enable SOAP config server',
2895 },
2896 exportedAttr => {
2897 type => 'text',
2898 documentation =>
2899 'List of attributes to export by SOAP or REST servers',
2900 },
2901 wsdlServer => {
2902 default => 0,
2903 type => 'bool',
2904 documentation => 'Enable /portal.wsdl server',
2905 },
2906
2907 # SOAP Procy client
2908 soapProxyUrn => {
2909 default => 'urn:Lemonldap/NG/Common/PSGI/SOAPService',
2910 type => 'text',
2911 documentation => 'SOAP URN for Proxy',
2912 },
2913
2914 # AutoSignin
2915 autoSigninRules => {
2916 type => 'keyTextContainer',
2917 keyTest => sub { return perlExpr(@_) },
2918 test => sub { 1 },
2919 help => 'autosignin.html',
2920 documentation => 'List of auto signin rules',
2921 },
2922
2923 # Adaptative Authentication Level
2924 adaptativeAuthenticationLevelRules => {
2925 type => 'keyTextContainer',
2926 keyTest => sub { return perlExpr(@_) },
2927 test => sub { 1 },
2928 help => "adaptativeauthenticationlevel.html",
2929 documentation => 'Adaptative authentication level rules',
2930 },
2931
2932 # LocationDetect plugin
2933 locationDetect => {
2934 default => 0,
2935 type => 'bool',
2936 documentation => 'Enable LocationDetect plugin',
2937 },
2938 locationDetectGeoIpDatabase => {
2939 type => 'text',
2940 documentation => 'Path to GeoIP database',
2941 },
2942 locationDetectGeoIpLanguages => {
2943 default => 'en, fr',
2944 type => 'text',
2945 documentation => 'Languages for GeoIP database',
2946 },
2947 locationDetectIpDetail => {
2948 type => 'text',
2949 documentation => 'Information requested for IP',
2950 },
2951 locationDetectUaDetail => {
2952 type => 'text',
2953 documentation => 'Information requested for User Agent',
2954 },
2955
2956 ## Virtualhosts
2957
2958 # Fake attribute: used by manager REST API to agglomerate all other
2959 # nodes
2960 virtualHosts => {
2961 type => 'virtualHostContainer',
2962 help => 'configvhost.html',
2963 template => 'virtualHost',
2964 },
2965
2966 locationRules => {
2967 type => 'ruleContainer',
2968 help => 'writingrulesand_headers.html#rules',
2969 test => {
2970 keyTest => sub {
2971 eval { qr/$_[0]/ };
2972 return $@ ? 0 : 1;
2973 },
2974 keyMsgFail => '__badRegexp__',
2975 test => sub {
2976 my ( $val, $conf ) = @_;
2977 my $s = $val;
2978 if ( $s =~ s/^logout(?:_(?:sso|app(?:_sso)?))?\s*// ) {
2979 return $s =~ m{^(?:https?://.*)?$}
2980 ? (1)
2981 : ( 0, '__badUrl__' );
2982 }
2983 $s =~ s/\b(accept|deny|unprotect|skip)\b/1/g;
2984 return &perlExpr( $s, $conf );
2985 },
2986 msgFail => '__badExpression__',
2987 },
2988 keyTest => qr/^\S+$/,
2989 keyMsgFail => '__badHostname__',
2990 default => { default => 'deny', },
2991 documentation => 'Virtualhost rules',
2992 flags => 'h',
2993 },
2994 exportedHeaders => {
2995 type => 'keyTextContainer',
2996 help => 'writingrulesand_headers.html#headers',
2997 keyTest => qr/^\S+$/,
2998 keyMsgFail => '__badHostname__',
2999 test => {
3000 keyTest => qr/^(?=[^\-])[\w\-]+(?<=[^-])$/,
3001 keyMsgFail => '__badHeaderName__',
3002 test => sub { return perlExpr(@_) },
3003 },
3004 documentation => 'Virtualhost headers',
3005 flags => 'h',
3006 },
3007 post => {
3008 type => 'postContainer',
3009 help => 'formreplay.html',
3010 test => sub { 1 },
3011 keyTest => qr/^\S+$/,
3012 keyMsgFail => '__badHostname__',
3013 documentation => 'Virtualhost urls/Data to post',
3014 },
3015
3016 vhostOptions => { type => 'subContainer', },
3017 vhostPort => {
3018 type => 'int',
3019 default => -1,
3020 },
3021 vhostHttps => {
3022 type => 'trool',
3023 default => -1,
3024 },
3025 vhostMaintenance => {
3026 type => 'bool',
3027 default => 0,
3028 },
3029 vhostServiceTokenTTL => {
3030 type => 'int',
3031 default => -1,
3032 },
3033 vhostComment => {
3034 type => 'longtext',
3035 default => '',
3036 },
3037 vhostAccessToTrace => { type => 'text', default => '' },
3038 vhostAliases => { type => 'text', default => '' },
3039 vhostType => {
3040 type => 'select',
3041 select => [
3042 { k => 'AuthBasic', v => 'AuthBasic' },
3043 { k => 'CDA', v => 'CDA' },
3044 { k => 'DevOps', v => 'DevOps' },
3045 { k => 'DevOpsST', v => 'DevOpsST' },
3046 { k => 'DevOpsCDA', v => 'DevOpsCDA' },
3047 { k => 'Main', v => 'Main' },
3048 { k => 'OAuth2', v => 'OAuth2' },
3049 { k => 'SecureToken', v => 'SecureToken' },
3050 { k => 'ServiceToken', v => 'ServiceToken' },
3051 { k => 'ZimbraPreAuth', v => 'ZimbraPreAuth' },
3052 ],
3053 default => 'Main',
3054 documentation => 'Handler type',
3055 },
3056 vhostAuthnLevel => { type => 'intOrNull' },
3057 vhostDevOpsRulesUrl => { type => 'url' },
3058
3059 # SecureToken parameters
3060 secureTokenAllowOnError => {
3061 type => 'text',
3062 documentation => 'Secure Token allow requests in error',
3063 flags => 'h',
3064 },
3065 secureTokenAttribute => {
3066 type => 'text',
3067 documentation => 'Secure Token attribute',
3068 flags => 'h',
3069 },
3070 secureTokenExpiration => {
3071 type => 'text',
3072 documentation => 'Secure Token expiration',
3073 flags => 'h',
3074 },
3075 secureTokenHeader => {
3076 type => 'text',
3077 documentation => 'Secure Token header',
3078 flags => 'h',
3079 },
3080 secureTokenMemcachedServers => {
3081 type => 'text',
3082 documentation => 'Secure Token Memcached servers',
3083 flags => 'h',
3084 },
3085 secureTokenUrls => {
3086 type => 'text',
3087 documentation => '',
3088 flags => 'h',
3089 },
3090
3091 # Zimbra handler parameters
3092 zimbraAccountKey => {
3093 type => 'text',
3094 flags => 'h',
3095 documentation => 'Zimbra account session key',
3096 },
3097 zimbraBy => {
3098 type => 'text',
3099 flags => 'h',
3100 documentation => 'Zimbra account type',
3101 },
3102 zimbraPreAuthKey => {
3103 type => 'text',
3104 flags => 'h',
3105 documentation => 'Zimbra preauthentication key',
3106 },
3107 zimbraSsoUrl => {
3108 type => 'text',
3109 flags => 'h',
3110 documentation => 'Zimbra local SSO URL pattern',
3111 },
3112 zimbraUrl => {
3113 type => 'text',
3114 flags => 'h',
3115 documentation => 'Zimbra preauthentication URL',
3116 },
3117
3118 # CAS IDP
3119 casAttr =>
3120 { type => 'text', documentation => 'Pivot attribute for CAS', },
3121 casAttributes => {
3122 type => 'keyTextContainer',
3123 documentation => 'CAS exported attributes',
3124 },
3125 casAccessControlPolicy => {
3126 type => 'select',
3127 select => [
3128 { k => 'none', v => 'None' },
3129 { k => 'error', v => 'Display error on portal' },
3130 { k => 'faketicket', v => 'Send a fake service ticket' },
3131 ],
3132 default => 'none',
3133 documentation => 'CAS access control policy',
3134 },
3135 casStorage => {
3136 type => 'PerlModule',
3137 documentation => 'Apache::Session module to store CAS user data',
3138 },
3139 casStorageOptions => {
3140 type => 'keyTextContainer',
3141 documentation => 'Apache::Session module parameters',
3142 },
3143 casStrictMatching => {
3144 default => 0,
3145 type => 'bool',
3146 documentation => 'Disable host-based matching of CAS services',
3147 },
3148 casTicketExpiration => {
3149 default => 0,
3150 type => 'int',
3151 documentation => 'Expiration time of Service and Proxy tickets',
3152 },
3153 casBackChannelSingleLogout => {
3154 default => 0,
3155 type => 'bool',
3156 documentation => 'Enable CAS (Back-Channel) Single Logout',
3157 },
3158 issuerDBCASActivation => {
3159 default => 0,
3160 type => 'bool',
3161 documentation => 'CAS server activation',
3162 },
3163 issuerDBCASPath => {
3164 type => 'pcre',
3165 default => '^/cas/',
3166 documentation => 'CAS server request path',
3167 },
3168 issuerDBCASRule => {
3169 type => 'boolOrExpr',
3170 default => 1,
3171 documentation => 'CAS server rule',
3172 },
3173
3174 # Partners
3175 casAppMetaDataOptions => {
3176 type => 'subContainer',
3177 documentation => 'Root of CAS app options',
3178 },
3179 casAppMetaDataExportedVars => {
3180 type => 'keyTextContainer',
3181 default => { cn => 'cn', mail => 'mail', uid => 'uid', },
3182 documentation => 'CAS exported variables',
3183 },
3184 casAppMetaDataOptionsAuthnLevel => {
3185 type => 'text',
3186 test => sub { return perlExpr(@_) },
3187 documentation =>
3188 'Authentication level requires to access to this CAS application',
3189 },
3190 casAppMetaDataOptionsComment => {
3191 type => 'longtext',
3192 documentation => 'Comment for this CAS application',
3193 },
3194 casAppMetaDataOptionsDisplayName => {
3195 type => 'text',
3196 },
3197 casAppMetaDataOptionsLogout => {
3198 type => 'trool',
3199 default => -1,
3200 },
3201 casAppMetaDataOptionsRule => {
3202 type => 'text',
3203 test => sub { return perlExpr(@_) },
3204 documentation => 'CAS application rule',
3205 },
3206 casAppMetaDataOptionsService => {
3207 type => 'text',
3208 documentation => 'CAS application service',
3209 },
3210 casSrvMetaDataOptionsSamlValidate => {
3211 type => 'bool',
3212 documentation => 'use SAML validateion',
3213 },
3214 casAppMetaDataOptionsUserAttribute => {
3215 type => 'text',
3216 documentation => 'CAS User attribute',
3217 },
3218 casAppMetaDataOptionsAllowProxy => {
3219 type => 'bool',
3220 documentation => 'Allow CAS proxy',
3221 default => 1,
3222 },
3223 casAppMetaDataOptionsActivation => {
3224 type => 'bool',
3225 documentation => 'Activate CAS application',
3226 default => 1,
3227 },
3228 casAppMetaDataMacros => {
3229 type => 'keyTextContainer',
3230 help =>
3231 'exportedvars.html#extend-variables-using-macros-and-groups',
3232 test => {
3233 keyTest => qr/^[_a-zA-Z][a-zA-Z0-9_]*$/,
3234 keyMsgFail => '__badMacroName__',
3235 test => sub { return perlExpr(@_) },
3236 },
3237 default => {},
3238 documentation => 'Macros',
3239 },
3240
3241 # Fake attribute: used by manager REST API to agglomerate all nodes
3242 # related to a CAS SP partner
3243 casAppMetaDataNodes => {
3244 type => 'casAppMetaDataNodeContainer',
3245 template => 'casAppMetaDataNode',
3246 help => 'idpcas.html#configuring-cas-applications',
3247 },
3248
3249 # OpenID Issuer
3250 issuerDBOpenIDActivation => {
3251 default => 0,
3252 type => 'bool',
3253 documentation => 'OpenID server activation',
3254 },
3255 issuerDBOpenIDPath => {
3256 type => 'pcre',
3257 default => '^/openidserver/',
3258 documentation => 'OpenID server request path',
3259 },
3260 issuerDBOpenIDRule => {
3261 type => 'boolOrExpr',
3262 default => 1,
3263 documentation => 'OpenID server rule',
3264 },
3265
3266 openIdIssuerSecret => { type => 'text', },
3267 openIdAttr => { type => 'text', },
3268 openIdSreg_fullname => {
3269 type => 'lmAttrOrMacro',
3270 default => 'cn',
3271 documentation => 'OpenID SREG fullname session parameter',
3272 },
3273 openIdSreg_nickname => {
3274 type => 'lmAttrOrMacro',
3275 default => 'uid',
3276 documentation => 'OpenID SREG nickname session parameter',
3277 },
3278 openIdSreg_language => { type => 'lmAttrOrMacro', },
3279 openIdSreg_postcode => { type => 'lmAttrOrMacro', },
3280 openIdSreg_timezone => {
3281 type => 'lmAttrOrMacro',
3282 default => '_timezone',
3283 documentation => 'OpenID SREG timezone session parameter',
3284 },
3285 openIdSreg_country => { type => 'lmAttrOrMacro', },
3286 openIdSreg_gender => { type => 'lmAttrOrMacro', },
3287 openIdSreg_email => {
3288 type => 'lmAttrOrMacro',
3289 default => 'mail',
3290 documentation => 'OpenID SREG email session parameter',
3291 },
3292 openIdSreg_dob => { type => 'lmAttrOrMacro', },
3293 openIdSPList => { type => 'blackWhiteList', default => '0;' },
3294
3295 #########
3296 ## SAML #
3297 #########
3298 samlEntityID => {
3299 type => 'text',
3300 default => '#PORTAL#/saml/metadata',
3301 documentation => 'SAML service entityID',
3302 },
3303 samlOrganizationDisplayName => {
3304 type => 'text',
3305 default => 'Example',
3306 documentation => 'SAML service organization display name',
3307 },
3308 samlOrganizationName => {
3309 type => 'text',
3310 default => 'Example',
3311 documentation => 'SAML service organization name',
3312 },
3313 samlOrganizationURL => {
3314 type => 'text',
3315 default => 'http://www.example.com',
3316 documentation => 'SAML service organization URL',
3317 },
3318 samlNameIDFormatMapEmail => {
3319 type => 'text',
3320 default => 'mail',
3321 documentation => 'SAML session parameter for NameID email',
3322 },
3323 samlNameIDFormatMapX509 => {
3324 type => 'text',
3325 default => 'mail',
3326 documentation => 'SAML session parameter for NameID x509',
3327 },
3328 samlNameIDFormatMapWindows => {
3329 type => 'text',
3330 default => 'uid',
3331 documentation => 'SAML session parameter for NameID windows',
3332 },
3333 samlNameIDFormatMapKerberos => {
3334 type => 'text',
3335 default => 'uid',
3336 documentation => 'SAML session parameter for NameID kerberos',
3337 },
3338 samlAttributeAuthorityDescriptorAttributeServiceSOAP => {
3339 type => 'samlService',
3340 default => 'urn:oasis:names:tc:SAML:2.0:bindings:SOAP;'
3341 . '#PORTAL#/saml/AA/SOAP;',
3342 documentation => 'SAML Attribute Authority SOAP',
3343 },
3344 samlServicePrivateKeySig => {
3345 type => 'RSAPrivateKey',
3346 default => '',
3347 documentation => 'SAML signature private key',
3348 },
3349 samlServicePrivateKeySigPwd => {
3350 type => 'password',
3351 default => '',
3352 documentation => 'SAML signature private key password',
3353 },
3354 samlServicePublicKeySig => {
3355 type => 'RSAPublicKeyOrCertificate',
3356 default => '',
3357 documentation => 'SAML signature public key',
3358 },
3359 samlServicePrivateKeyEnc => {
3360 type => 'RSAPrivateKey',
3361 default => '',
3362 documentation => 'SAML encryption private key',
3363 },
3364 samlServicePrivateKeyEncPwd => { type => 'password', },
3365 samlServicePublicKeyEnc => {
3366 type => 'RSAPublicKeyOrCertificate',
3367 default => '',
3368 documentation => 'SAML encryption public key',
3369 },
3370 samlServiceSignatureMethod => {
3371 type => 'select',
3372 select => [
3373 { k => 'RSA_SHA1', v => 'RSA SHA1' },
3374 { k => 'RSA_SHA256', v => 'RSA SHA256' },
3375 { k => 'RSA_SHA384', v => 'RSA SHA384' },
3376 { k => 'RSA_SHA512', v => 'RSA SHA512' },
3377 ],
3378 default => 'RSA_SHA256',
3379 },
3380 samlServiceSignatureKey => {
3381 type => 'text',
3382 default => 'default-saml-sig',
3383 documentation => 'Key to use for SAML signature',
3384 },
3385 samlServiceEncryptionKey => {
3386 type => 'text',
3387 default => 'default-saml-enc',
3388 documentation => 'Key to use for SAML encryption',
3389 },
3390 samlServiceUseCertificateInResponse => {
3391 type => 'bool',
3392 default => 0,
3393 documentation =>
3394 'Use certificate instead of public key in SAML responses',
3395 },
3396 samlMetadataForceUTF8 => {
3397 default => 1,
3398 type => 'bool',
3399 documentation => 'SAML force metadata UTF8 conversion',
3400 },
3401 samlStorage => {
3402 type => 'PerlModule',
3403 documentation => 'Apache::Session module to store SAML user data',
3404 },
3405 samlStorageOptions => {
3406 type => 'keyTextContainer',
3407 documentation => 'Apache::Session module parameters',
3408 },
3409 samlAuthnContextMapExtra => {
3410 type => 'keyTextContainer',
3411 keyTest => qr/\w/,
3412 documentation => 'SAML extra authn contexts',
3413 },
3414 samlAuthnContextMapPassword => {
3415 type => 'int',
3416 default => 2,
3417 documentation => 'SAML authn context password level',
3418 },
3419 samlAuthnContextMapPasswordProtectedTransport => {
3420 type => 'int',
3421 default => 3,
3422 documentation =>
3423 'SAML authn context password protected transport level',
3424 },
3425 samlAuthnContextMapTLSClient => {
3426 type => 'int',
3427 default => 5,
3428 documentation => 'SAML authn context TLS client level',
3429 },
3430 samlAuthnContextMapKerberos => {
3431 type => 'int',
3432 default => 4,
3433 documentation => 'SAML authn context kerberos level',
3434 },
3435 samlCommonDomainCookieActivation => {
3436 default => 0,
3437 type => 'bool',
3438 documentation => 'SAML CDC activation',
3439 },
3440 samlCommonDomainCookieDomain => {
3441 type => 'text',
3442 test => qr/^$Regexp::Common::URI::RFC2396::hostname$/,
3443 msgFail => '__badDomainName__',
3444 },
3445 samlCommonDomainCookieReader => {
3446 type => 'text',
3447 test => $url,
3448 msgFail => '__badUrl__',
3449 },
3450 samlCommonDomainCookieWriter => {
3451 type => 'text',
3452 test => $url,
3453 msgFail => '__badUrl__',
3454 },
3455 samlDiscoveryProtocolActivation => {
3456 default => 0,
3457 type => 'bool',
3458 documentation => 'SAML Discovery Protocol activation',
3459 },
3460 samlDiscoveryProtocolURL => {
3461 type => 'text',
3462 test => $url,
3463 msgFail => '__badUrl__',
3464 documentation => 'SAML Discovery Protocol EndPoint URL',
3465 },
3466 samlDiscoveryProtocolPolicy => {
3467 type => 'text',
3468 documentation => 'SAML Discovery Protocol Policy',
3469 },
3470 samlDiscoveryProtocolIsPassive => {
3471 default => 0,
3472 type => 'bool',
3473 documentation => 'SAML Discovery Protocol Is Passive',
3474 },
3475 samlFederationFiles => {
3476 type => 'text',
3477 documentation => 'Path to SAML Federation Metadata',
3478 },
3479 samlRelayStateTimeout => {
3480 type => 'int',
3481 default => 600,
3482 documentation => 'SAML timeout of relay state',
3483 },
3484 samlOverrideIDPEntityID => {
3485 type => 'text',
3486 documentation => 'Override SAML EntityID when acting as an IDP',
3487 default => '',
3488 },
3489 samlUseQueryStringSpecific => {
3490 default => 0,
3491 type => 'bool',
3492 documentation => 'SAML use specific method for query_string',
3493 },
3494 samlIDPSSODescriptorWantAuthnRequestsSigned => {
3495 type => 'bool',
3496 default => 1,
3497 documentation => 'SAML IDP want authn request signed',
3498 },
3499 samlIDPSSODescriptorSingleSignOnServiceHTTPRedirect => {
3500 type => 'samlService',
3501 default => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect;'
3502 . '#PORTAL#/saml/singleSignOn;',
3503 documentation => 'SAML IDP SSO HTTP Redirect',
3504 },
3505 samlIDPSSODescriptorSingleSignOnServiceHTTPPost => {
3506 type => 'samlService',
3507 default => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST;'
3508 . '#PORTAL#/saml/singleSignOn;',
3509 documentation => 'SAML IDP SSO HTTP POST',
3510 },
3511 samlIDPSSODescriptorSingleSignOnServiceHTTPArtifact => {
3512 type => 'samlService',
3513 default => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact;'
3514 . '#PORTAL#/saml/singleSignOnArtifact;',
3515 documentation => 'SAML IDP SSO HTTP Artifact',
3516 },
3517 samlIDPSSODescriptorSingleLogoutServiceHTTPRedirect => {
3518 type => 'samlService',
3519 default => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect;'
3520 . '#PORTAL#/saml/singleLogout;'
3521 . '#PORTAL#/saml/singleLogoutReturn',
3522 documentation => 'SAML IDP SLO HTTP Redirect',
3523 },
3524 samlIDPSSODescriptorSingleLogoutServiceHTTPPost => {
3525 type => 'samlService',
3526 default => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST;'
3527 . '#PORTAL#/saml/singleLogout;'
3528 . '#PORTAL#/saml/singleLogoutReturn',
3529 documentation => 'SAML IDP SLO HTTP POST',
3530 },
3531 samlIDPSSODescriptorSingleLogoutServiceSOAP => {
3532 type => 'samlService',
3533 default => 'urn:oasis:names:tc:SAML:2.0:bindings:SOAP;'
3534 . '#PORTAL#/saml/singleLogoutSOAP;',
3535 documentation => 'SAML IDP SLO SOAP',
3536 },
3537 samlIDPSSODescriptorArtifactResolutionServiceArtifact => {
3538 type => 'samlAssertion',
3539 default => '1;0;urn:oasis:names:tc:SAML:2.0:bindings:SOAP;'
3540 . '#PORTAL#/saml/artifact',
3541 documentation => 'SAML IDP artifact resolution service',
3542 },
3543
3544 # Fake attribute: used by manager REST API to agglomerate all nodes
3545 # related to a SAML IDP partner
3546 samlIDPMetaDataNodes => {
3547 type => 'samlIDPMetaDataNodeContainer',
3548 template => 'samlIDPMetaDataNode',
3549 help => 'authsaml.html',
3550 },
3551
3552 # Fake attribute: used by manager REST API to agglomerate all nodes
3553 # related to a SAML SP partner
3554 samlSPMetaDataNodes => {
3555 type => 'samlSPMetaDataNodeContainer',
3556 template => 'samlSPMetaDataNode',
3557 help => 'idpsaml.html',
3558 },
3559
3560 # TODO: split that
3561 # IDP Keys
3562 samlIDPMetaDataExportedAttributes => {
3563 type => 'samlAttributeContainer',
3564 help => 'authsaml.html#exported-attributes',
3565 keyTest => qr/^[a-zA-Z](?:[a-zA-Z0-9_\-\.]*\w)?$/,
3566 keyMsgFail => '__badMetadataName__',
3567 test => qr/\w/,
3568 msgFail => '__badValue__',
3569 default => {},
3570 },
3571 samlIDPMetaDataXML => {
3572 type => 'file',
3573 },
3574 samlIDPMetaDataOptionsURL => {
3575 type => 'url',
3576 },
3577 samlIDPMetaDataOptions => {
3578 type => 'keyTextContainer',
3579 keyTest => qr/^[a-zA-Z](?:[a-zA-Z0-9_\-\.]*\w)?$/,
3580 keyMsgFail => '__badMetadataName__',
3581 },
3582 samlIDPMetaDataOptionsFederationEntityID => {
3583 type => 'text',
3584 },
3585 samlIDPMetaDataOptionsNameIDFormat => {
3586 type => 'select',
3587 select => [
3588 { k => '', v => '' },
3589 { k => 'unspecified', v => 'Unspecified' },
3590 { k => 'email', v => 'Email' },
3591 { k => 'x509', v => 'X509 certificate' },
3592 { k => 'windows', v => 'Windows' },
3593 { k => 'kerberos', v => 'Kerberos' },
3594 { k => 'entity', v => 'Entity' },
3595 { k => 'persistent', v => 'Persistent' },
3596 { k => 'transient', v => 'Transient' },
3597 { k => 'encrypted', v => 'Encrypted' },
3598 ],
3599 default => '',
3600 },
3601 samlIDPMetaDataOptionsForceAuthn => {
3602 type => 'bool',
3603 default => 0,
3604 },
3605 samlIDPMetaDataOptionsIsPassive => {
3606 type => 'bool',
3607 default => 0,
3608 },
3609 samlIDPMetaDataOptionsAllowLoginFromIDP => {
3610 type => 'bool',
3611 default => 0,
3612 },
3613 samlIDPMetaDataOptionsRequestedAuthnContext => {
3614 type => 'select',
3615 select => [
3616 { k => '', v => '' },
3617 { k => 'kerberos', v => 'Kerberos' },
3618 {
3619 k => 'password-protected-transport',
3620 v => 'Password protected transport'
3621 },
3622 { k => 'password', v => 'Password' },
3623 { k => 'tls-client', v => 'TLS client certificate' },
3624 ],
3625 default => '',
3626 },
3627 samlIDPMetaDataOptionsAdaptSessionUtime => {
3628 type => 'bool',
3629 default => 0,
3630 },
3631 samlIDPMetaDataOptionsCheckSSOMessageSignature => {
3632 type => 'bool',
3633 default => 1,
3634 },
3635 samlIDPMetaDataOptionsComment => {
3636 type => 'longtext'
3637 },
3638 samlIDPMetaDataOptionsForceUTF8 => {
3639 type => 'bool',
3640 default => 0,
3641 },
3642 samlIDPMetaDataOptionsSignSSOMessage => {
3643 type => 'trool',
3644 default => -1,
3645 },
3646 samlIDPMetaDataOptionsSignSLOMessage => {
3647 type => 'trool',
3648 default => -1,
3649 },
3650 samlIDPMetaDataOptionsSignatureMethod => {
3651 type => 'select',
3652 select => [
3653 { k => '', v => 'default' },
3654 { k => 'RSA_SHA1', v => 'RSA SHA1' },
3655 { k => 'RSA_SHA256', v => 'RSA SHA256' },
3656 { k => 'RSA_SHA384', v => 'RSA SHA384' },
3657 { k => 'RSA_SHA512', v => 'RSA SHA512' },
3658 ],
3659 default => '',
3660 },
3661 samlIDPMetaDataOptionsSignatureKey => {
3662 type => 'text',
3663 default => '',
3664 },
3665 samlIDPMetaDataOptionsCheckSLOMessageSignature => {
3666 type => 'bool',
3667 default => 1,
3668 },
3669 samlIDPMetaDataOptionsSSOBinding => {
3670 type => 'select',
3671 select => [
3672 { k => '', v => '' },
3673 { k => 'http-post', v => 'POST' },
3674 { k => 'http-redirect', v => 'Redirect' },
3675 { k => 'artifact-get', v => 'Artifact GET' },
3676 ],
3677 default => '',
3678 },
3679 samlIDPMetaDataOptionsSLOBinding => {
3680 type => 'select',
3681 select => [
3682 { k => '', v => '' },
3683 { k => 'http-post', v => 'POST' },
3684 { k => 'http-redirect', v => 'Redirect' },
3685 { k => 'http-soap', v => 'SOAP' },
3686 ],
3687 default => '',
3688 },
3689 samlIDPMetaDataOptionsEncryptionMode => {
3690 type => 'select',
3691 select => [
3692 { k => 'none', v => 'None' },
3693 { k => 'nameid', v => 'Name ID' },
3694 { k => 'assertion', v => 'Assertion' },
3695 ],
3696 default => 'none',
3697 },
3698 samlIDPMetaDataOptionsCheckTime => {
3699 type => 'bool',
3700 default => 1,
3701 },
3702 samlIDPMetaDataOptionsCheckAudience => {
3703 type => 'bool',
3704 default => 1,
3705 },
3706 samlIDPMetaDataOptionsResolutionRule => {
3707 type => 'longtext',
3708 default => '',
3709 },
3710 samlIDPMetaDataOptionsStoreSAMLToken => {
3711 type => 'bool',
3712 default => 0,
3713 },
3714 samlIDPMetaDataOptionsRelayStateURL => {
3715 type => 'bool',
3716 default => 0,
3717 },
3718 samlIDPMetaDataOptionsUserAttribute => { type => 'text', },
3719 samlIDPMetaDataOptionsDisplayName => { type => 'text', },
3720 samlIDPMetaDataOptionsIcon => { type => 'text', },
3721 samlIDPMetaDataOptionsTooltip => { type => 'text', },
3722 samlIDPMetaDataOptionsSortNumber => { type => 'int', },
3723
3724 # SP keys
3725 samlSPMetaDataExportedAttributes => {
3726 type => 'samlAttributeContainer',
3727 help => 'idpsaml.html#exported-attributes',
3728 keyTest => qr/^[a-zA-Z](?:[a-zA-Z0-9_\-\.]*\w)?$/,
3729 keyMsgFail => '__badMetadataName__',
3730 test => qr/\w/,
3731 msgFail => '__badValue__',
3732 default => {},
3733 },
3734 samlSPMetaDataXML => { type => 'file', },
3735 samlSPMetaDataOptionsActivation => {
3736 type => 'bool',
3737 default => 1,
3738 },
3739 samlSPMetaDataOptionsURL => {
3740 type => 'url',
3741 },
3742 samlSPMetaDataOptions => {
3743 type => 'keyTextContainer',
3744 keyTest => qr/^[a-zA-Z](?:[a-zA-Z0-9_\-\.]*\w)?$/,
3745 keyMsgFail => '__badMetadataName__',
3746 },
3747 samlSPMetaDataOptionsFederationEntityID => {
3748 type => 'text',
3749 },
3750 samlSPMetaDataOptionsFederationOptionalAttributes => {
3751 type => 'select',
3752 select =>
3753 [ { k => '', v => 'keep' }, { k => 'ignore', v => 'ignore' }, ],
3754 default => '',
3755 },
3756 samlSPMetaDataOptionsFederationRequiredAttributes => {
3757 type => 'select',
3758 select => [
3759 { k => '', v => 'keep' },
3760 { k => 'optional', v => 'makeoptional' },
3761 { k => 'ignore', v => 'ignore' },
3762 ],
3763 default => '',
3764 },
3765 samlSPSSODescriptorAuthnRequestsSigned => {
3766 default => 1,
3767 type => 'bool',
3768 documentation => 'SAML SP AuthnRequestsSigned',
3769 },
3770 samlSPSSODescriptorWantAssertionsSigned => {
3771 default => 1,
3772 type => 'bool',
3773 documentation => 'SAML SP WantAssertionsSigned',
3774 },
3775 samlSPSSODescriptorSingleLogoutServiceHTTPRedirect => {
3776 type => 'samlService',
3777 default => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect;'
3778 . '#PORTAL#/saml/proxySingleLogout;'
3779 . '#PORTAL#/saml/proxySingleLogoutReturn',
3780 documentation => 'SAML SP SLO HTTP Redirect',
3781 },
3782 samlSPSSODescriptorSingleLogoutServiceHTTPPost => {
3783 type => 'samlService',
3784 default => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST;'
3785 . '#PORTAL#/saml/proxySingleLogout;'
3786 . '#PORTAL#/saml/proxySingleLogoutReturn',
3787 documentation => 'SAML SP SLO HTTP POST',
3788 },
3789 samlSPSSODescriptorSingleLogoutServiceSOAP => {
3790 type => 'samlService',
3791 default => 'urn:oasis:names:tc:SAML:2.0:bindings:SOAP;'
3792 . '#PORTAL#/saml/proxySingleLogoutSOAP;',
3793 documentation => 'SAML SP SLO SOAP',
3794 },
3795 samlSPSSODescriptorAssertionConsumerServiceHTTPArtifact => {
3796 type => 'samlAssertion',
3797 default =>
3798 '0;1;urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact;'
3799 . '#PORTAL#/saml/proxySingleSignOnArtifact',
3800 documentation => 'SAML SP ACS HTTP artifact',
3801 },
3802 samlSPSSODescriptorAssertionConsumerServiceHTTPPost => {
3803 type => 'samlAssertion',
3804 default => '1;0;urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST;'
3805 . '#PORTAL#/saml/proxySingleSignOnPost',
3806 documentation => 'SAML SP ACS HTTP POST',
3807 },
3808 samlSPSSODescriptorArtifactResolutionServiceArtifact => {
3809 type => 'samlAssertion',
3810 default => '1;0;urn:oasis:names:tc:SAML:2.0:bindings:SOAP;'
3811 . '#PORTAL#/saml/artifact',
3812 documentation => 'SAML SP artifact resolution service',
3813 },
3814 samlSPMetaDataOptionsComment => {
3815 type => 'longtext'
3816 },
3817 samlSPMetaDataOptionsNameIDFormat => {
3818 type => 'select',
3819 select => [
3820 { k => '', v => '' },
3821 { k => 'unspecified', v => 'Unspecified' },
3822 { k => 'email', v => 'Email' },
3823 { k => 'x509', v => 'X509 certificate' },
3824 { k => 'windows', v => 'Windows' },
3825 { k => 'kerberos', v => 'Kerberos' },
3826 { k => 'entity', v => 'Entity' },
3827 { k => 'persistent', v => 'Persistent' },
3828 { k => 'transient', v => 'Transient' },
3829 { k => 'encrypted', v => 'Encrypted' },
3830 ],
3831 default => '',
3832 },
3833 samlSPMetaDataOptionsForceNameIDFormat => { type => 'bool' },
3834 samlSPMetaDataOptionsNameIDSessionKey => { type => 'text' },
3835 samlSPMetaDataOptionsNotOnOrAfterTimeout => {
3836 type => 'int',
3837 default => 72000,
3838 },
3839 samlSPMetaDataOptionsOneTimeUse => {
3840 type => 'bool',
3841 default => 0,
3842 },
3843 samlSPMetaDataOptionsSessionNotOnOrAfterTimeout => {
3844 type => 'int',
3845 default => 72000,
3846 },
3847 samlSPMetaDataOptionsSignSSOMessage => {
3848 type => 'trool',
3849 default => -1,
3850 },
3851 samlSPMetaDataOptionsSignatureMethod => {
3852 type => 'select',
3853 select => [
3854 { k => '', v => 'default' },
3855 { k => 'RSA_SHA1', v => 'RSA SHA1' },
3856 { k => 'RSA_SHA256', v => 'RSA SHA256' },
3857 { k => 'RSA_SHA384', v => 'RSA SHA384' },
3858 { k => 'RSA_SHA512', v => 'RSA SHA512' },
3859 ],
3860 default => '',
3861 },
3862 samlSPMetaDataOptionsSignatureKey => {
3863 type => 'text',
3864 default => '',
3865 },
3866 samlSPMetaDataOptionsCheckSSOMessageSignature => {
3867 type => 'bool',
3868 default => 1,
3869 },
3870 samlSPMetaDataOptionsSignSLOMessage => {
3871 type => 'trool',
3872 default => -1,
3873 },
3874 samlSPMetaDataOptionsCheckSLOMessageSignature => {
3875 type => 'bool',
3876 default => 1,
3877 },
3878 samlSPMetaDataOptionsEncryptionMode => {
3879 type => 'select',
3880 select => [
3881 { k => 'none', v => 'None' },
3882 { k => 'nameid', v => 'Name ID' },
3883 { k => 'assertion', v => 'Assertion' },
3884 ],
3885 default => 'none',
3886 },
3887 samlSPMetaDataOptionsEnableIDPInitiatedURL => {
3888 type => 'bool',
3889 default => 0,
3890 },
3891 samlSPMetaDataOptionsForceUTF8 => {
3892 type => 'bool',
3893 default => 1,
3894 },
3895 samlSPMetaDataOptionsAuthnLevel => {
3896 type => 'text',
3897 test => sub { return perlExpr(@_) },
3898 documentation =>
3899 'Authentication level requires to access to this SP',
3900 },
3901 samlSPMetaDataOptionsRule => {
3902 type => 'text',
3903 test => sub { return perlExpr(@_) },
3904 documentation => 'Rule to grant access to this SP',
3905 },
3906 samlSPMetaDataMacros => {
3907 type => 'keyTextContainer',
3908 help =>
3909 'exportedvars.html#extend-variables-using-macros-and-groups',
3910 test => {
3911 keyTest => qr/^[_a-zA-Z][a-zA-Z0-9_]*$/,
3912 keyMsgFail => '__badMacroName__',
3913 test => sub { return perlExpr(@_) },
3914 },
3915 default => {},
3916 documentation => 'Macros',
3917 },
3918
3919 # AUTH, USERDB and PASSWORD MODULES
3920 authentication => {
3921 type => 'select',
3922 select => [
3923 { k => 'Apache', v => 'Apache' },
3924 { k => 'AD', v => 'Active Directory' },
3925 { k => 'DBI', v => 'Database (DBI)' },
3926 { k => 'Facebook', v => 'Facebook' },
3927 { k => 'GitHub', v => 'GitHub' },
3928 { k => 'GPG', v => 'GPG' },
3929 { k => 'Kerberos', v => 'Kerberos' },
3930 { k => 'LDAP', v => 'LDAP' },
3931 { k => 'LinkedIn', v => 'LinkedIn' },
3932 { k => 'PAM', v => 'PAM' },
3933 { k => 'Radius', v => 'Radius' },
3934 { k => 'REST', v => 'REST' },
3935 { k => 'SSL', v => 'mTLS' },
3936 { k => 'Twitter', v => 'Twitter' },
3937 { k => 'WebID', v => 'WebID (deprecated)' },
3938 { k => 'WebAuthn', v => 'WebAuthn' },
3939 { k => 'Demo', v => 'Demonstration' },
3940 { k => 'Choice', v => 'authChoice' },
3941 { k => 'Combination', v => 'combineMods' },
3942 { k => 'CAS', v => 'Central Authentication Service (CAS)' },
3943 { k => 'OpenID', v => 'OpenID 2.0 (deprecated)' },
3944 { k => 'OpenIDConnect', v => 'OpenID Connect' },
3945 { k => 'SAML', v => 'SAML v2' },
3946 { k => 'Proxy', v => 'Proxy' },
3947 { k => 'Remote', v => 'Remote' },
3948 { k => 'Slave', v => 'Slave' },
3949 { k => 'Null', v => 'None' },
3950 { k => 'Custom', v => 'customModule' },
3951 ],
3952 default => 'Demo',
3953 documentation => 'Authentication module',
3954 },
3955 userDB => {
3956 type => 'select',
3957 select => [
3958 { k => 'Same', v => 'Same' },
3959 { k => 'AD', v => 'Active Directory' },
3960 { k => 'DBI', v => 'Database (DBI)' },
3961 { k => 'LDAP', v => 'LDAP' },
3962 { k => 'REST', v => 'REST' },
3963 { k => 'Null', v => 'None' },
3964 { k => 'Custom', v => 'customModule' },
3965 ],
3966 default => 'Same',
3967 documentation => 'User module',
3968 },
3969 passwordDB => {
3970 type => 'select',
3971 select => [
3972 { k => 'AD', v => 'Active Directory' },
3973 { k => 'Choice', v => 'authChoice' },
3974 { k => 'DBI', v => 'Database (DBI)' },
3975 { k => 'Demo', v => 'Demonstration' },
3976 { k => 'LDAP', v => 'LDAP' },
3977 { k => 'REST', v => 'REST' },
3978 { k => 'Null', v => 'None' },
3979 { k => 'Combination', v => 'combineMods' },
3980 { k => 'Custom', v => 'customModule' },
3981 ],
3982 default => 'Demo',
3983 documentation => 'Password module',
3984 },
3985
3986 # Second Factor Engine
3987 sfEngine => {
3988 type => 'text',
3989 default => '::2F::Engines::Default',
3990 documentation => 'Second factor engine',
3991 },
3992 sfRetries => {
3993 type => 'intOrNull',
3994 documentation => 'Allowed number of retries',
3995 },
3996 sfRequired => {
3997 type => 'boolOrExpr',
3998 default => 0,
3999 help => 'secondfactor.html',
4000 documentation => 'Second factor required',
4001 },
4002 sfOnlyUpgrade => {
4003 type => 'bool',
4004 default => 0,
4005 help => 'secondfactor.html',
4006 documentation => 'Only trigger second factor on session upgrade',
4007 },
4008 sfManagerRule => {
4009 type => 'boolOrExpr',
4010 default => 1,
4011 help => 'secondfactor.html',
4012 documentation => 'Rule to display second factor Manager link',
4013 },
4014 sfRemovedMsgRule => {
4015 type => 'boolOrExpr',
4016 default => 0,
4017 help => 'secondfactor.html',
4018 documentation =>
4019 'Display a message if at leat one expired SF has been removed',
4020 },
4021 sfRemovedUseNotif => {
4022 default => 0,
4023 type => 'bool',
4024 documentation => 'Use Notifications plugin to display message',
4025 },
4026 sfRemovedNotifRef => {
4027 type => 'text',
4028 default => 'RemoveSF',
4029 help => 'secondfactor.html',
4030 documentation => 'Notification reference',
4031 },
4032 sfRemovedNotifTitle => {
4033 type => 'text',
4034 default => 'Second factor notification',
4035 help => 'secondfactor.html',
4036 documentation => 'Notification title',
4037 },
4038 sfRemovedNotifMsg => {
4039 type => 'text',
4040 default =>
4041 '_removedSF_ expired second factor(s) has/have been removed (_nameSF_)!',
4042 help => 'secondfactor.html',
4043 documentation => 'Notification message',
4044 },
4045 sfLoginTimeout => {
4046 type => 'intOrNull',
4047 documentation => 'Timeout for 2F login process',
4048 },
4049 sfRegisterTimeout => {
4050 type => 'intOrNull',
4051 documentation => 'Timeout for 2F registration process',
4052 },
4053 available2F => {
4054 type => 'text',
4055 default => join( ',',
4056 qw/TOTP REST Mail2F Ext2F WebAuthn Yubikey Radius Password Okta/
4057 ),
4058 documentation => 'Available second factor modules',
4059 },
4060 available2FSelfRegistration => {
4061 type => 'text',
4062 default => join( ',', qw/Password TOTP WebAuthn Yubikey/ ),
4063 documentation =>
4064 'Available self-registration modules for second factor',
4065 },
4066
4067 # DEMO
4068 demoExportedVars => {
4069 type => 'keyTextContainer',
4070 keyTest => qr/^!?[a-zA-Z][a-zA-Z0-9_-]*$/,
4071 keyMsgFail => '__badVariableName__',
4072 test => qr/^[a-zA-Z][a-zA-Z0-9_:\-]*$/,
4073 msgFail => '__badValue__',
4074 default => { cn => 'cn', mail => 'mail', uid => 'uid', },
4075 documentation => 'Demo exported variables',
4076 },
4077
4078 # AD
4079 ADPwdExpireWarning => {
4080 type => 'int',
4081 default => 0,
4082 documentation => 'AD password expire warning',
4083 },
4084 ADPwdMaxAge => {
4085 type => 'int',
4086 default => 0,
4087 documentation => 'AD password max age',
4088 },
4089
4090 # LDAP
4091 managerDn => {
4092 type => 'text',
4093 test => qr/^.*$/,
4094 msgFail => '__badValue__',
4095 default => '',
4096 documentation => 'LDAP manager DN',
4097 },
4098 managerPassword => {
4099 type => 'password',
4100 test => qr/^\S*$/,
4101 msgFail => '__badValue__',
4102 default => '',
4103 documentation => 'LDAP manager Password',
4104 },
4105 ldapAuthnLevel => {
4106 type => 'int',
4107 default => 2,
4108 documentation => 'LDAP authentication level',
4109 },
4110 ldapBase => {
4111 type => 'text',
4112 test => qr/^(?:\w+=.*|)$/,
4113 msgFail => '__badValue__',
4114 default => 'dc=example,dc=com',
4115 documentation => 'LDAP search base',
4116 },
4117 ldapExportedVars => {
4118 type => 'keyTextContainer',
4119 keyTest => qr/^!?[a-zA-Z][a-zA-Z0-9_-]*$/,
4120 keyMsgFail => '__badVariableName__',
4121 test => qr/^[a-zA-Z][a-zA-Z0-9_:\-]*$/,
4122 msgFail => '__badValue__',
4123 default => { cn => 'cn', mail => 'mail', uid => 'uid', },
4124 documentation => 'LDAP exported variables',
4125 },
4126 ldapPort => {
4127 type => 'intOrNull',
4128 documentation => 'LDAP port',
4129 },
4130 ldapServer => {
4131 type => 'text',
4132 test => sub {
4133 my $l = shift;
4134 my (@s) = split( /[\s,]+/, $l );
4135 foreach my $s (@s) {
4136 $s =~
4137 m{^(?:ldapi://[^/]*/?|\w[\w\-\.]*(?::\d{1,5})?|ldap(?:s|\+tls)?://\w[\w\-\.]*(?::\d{1,5})?/?.*)$}
4138 or return ( 0, "__badLdapUri__: \"$s\"" );
4139 }
4140 return 1;
4141 },
4142 default => 'ldap://localhost',
4143 documentation => 'LDAP server (host or URI)',
4144 },
4145 ldapPwdEnc => {
4146 type => 'text',
4147 test => qr/^[a-zA-Z0-9_][a-zA-Z0-9_\-]*[a-zA-Z0-9_]$/,
4148 msgFail => '__badEncoding__',
4149 default => 'utf-8',
4150 documentation => 'LDAP password encoding',
4151 },
4152 ldapForcePasswordChangeExpirationWarning => {
4153 type => 'intOrNull',
4154 documentation =>
4155 'Delay to force password change if password is about to expire',
4156 },
4157 ldapUsePasswordResetAttribute => {
4158 type => 'bool',
4159 default => 1,
4160 documentation => 'LDAP store reset flag in an attribute',
4161 },
4162 ldapPasswordResetAttribute => {
4163 type => 'text',
4164 default => 'pwdReset',
4165 documentation => 'LDAP password reset attribute',
4166 },
4167 ldapPasswordResetAttributeValue => {
4168 type => 'text',
4169 default => 'TRUE',
4170 documentation => 'LDAP password reset value',
4171 },
4172 ldapPpolicyControl => {
4173 default => 0,
4174 type => 'bool',
4175 },
4176 ldapSetPassword => {
4177 default => 0,
4178 type => 'bool',
4179 },
4180 ldapChangePasswordAsUser => {
4181 default => 0,
4182 type => 'bool',
4183 },
4184 ldapGetUserBeforePasswordChange => {
4185 default => 0,
4186 type => 'bool',
4187 },
4188 ldapSearchDeref => {
4189 type => 'select',
4190 select => [
4191 { k => 'never', v => 'never' },
4192 { k => 'search', v => 'search' },
4193 { k => 'find', v => 'find' },
4194 { k => 'always', v => 'always' }
4195 ],
4196 default => 'find',
4197 documentation => '"deref" param of Net::LDAP::search()',
4198 },
4199 mailLDAPFilter => {
4200 type => 'text',
4201 documentation => 'LDAP filter for mail search'
4202 },
4203 LDAPFilter =>
4204 { type => 'text', documentation => 'Default LDAP filter' },
4205 AuthLDAPFilter => {
4206 type => 'text',
4207 documentation => 'LDAP filter for auth search'
4208 },
4209 groupLDAPFilter => {
4210 type => 'text',
4211 documentation => 'LDAP filter for group search'
4212 },
4213 ldapGroupDecodeSearchedValue => {
4214 default => 0,
4215 type => 'bool',
4216 documentation => 'Decode value before searching it in LDAP groups',
4217 },
4218 ldapGroupRecursive => {
4219 default => 0,
4220 type => 'bool',
4221 documentation => 'LDAP recursive search in groups',
4222 },
4223 ldapGroupObjectClass => {
4224 type => 'text',
4225 default => 'groupOfNames',
4226 documentation => 'LDAP object class of groups',
4227 },
4228 ldapGroupBase => { type => 'text', },
4229 ldapGroupAttributeName => {
4230 type => 'text',
4231 default => 'member',
4232 documentation => 'LDAP attribute name for member in groups',
4233 },
4234 ldapGroupAttributeNameUser => {
4235 type => 'text',
4236 default => 'dn',
4237 documentation =>
4238 'LDAP attribute name in user entry referenced as member in groups',
4239 },
4240 ldapGroupAttributeNameSearch => {
4241 type => 'text',
4242 default => 'cn',
4243 documentation => 'LDAP attributes to search in groups',
4244 },
4245 ldapGroupAttributeNameGroup => {
4246 type => 'text',
4247 default => 'dn',
4248 documentation =>
4249 'LDAP attribute name in group entry referenced as member in groups',
4250 },
4251 ldapTimeout => {
4252 type => 'int',
4253 default => 10,
4254 documentation => 'LDAP connection timeout',
4255 },
4256 ldapIOTimeout => {
4257 type => 'int',
4258 default => 10,
4259 documentation => 'LDAP operation timeout',
4260 },
4261 ldapVersion => {
4262 type => 'int',
4263 default => 3,
4264 documentation => 'LDAP protocol version',
4265 },
4266 ldapRaw => { type => 'text', },
4267 ldapAllowResetExpiredPassword => {
4268 default => 0,
4269 type => 'bool',
4270 documentation => 'Allow a user to reset his expired password',
4271 },
4272 ldapITDS => {
4273 default => 0,
4274 type => 'bool',
4275 documentation => 'Support for IBM Tivoli Directory Server',
4276 },
4277 ldapVerify => {
4278 type => 'bool',
4279 documentation => 'Whether to validate LDAP certificates',
4280 type => "select",
4281 select => [
4282 { k => 'none', v => 'None' },
4283 { k => 'optional', v => 'Optional' },
4284 { k => 'require', v => 'Require' },
4285 ],
4286 default => 'require',
4287 },
4288 ldapCAFile => {
4289 type => 'text',
4290 documentation =>
4291 'Location of the certificate file for LDAP connections',
4292 },
4293 ldapCAPath => {
4294 type => 'text',
4295 documentation =>
4296 'Location of the CA directory for LDAP connections',
4297 },
4298
4299 # SSL
4300 SSLAuthnLevel => {
4301 type => 'int',
4302 default => 5,
4303 documentation => 'Mutual TLS authentication level',
4304 },
4305 SSLVar => {
4306 type => 'text',
4307 default => 'SSL_CLIENT_S_DN_Email'
4308 },
4309 SSLIssuerVar => {
4310 type => 'text',
4311 default => 'SSL_CLIENT_I_DN'
4312 },
4313 SSLVarIf => {
4314 type => 'keyTextContainer',
4315 keyTest => sub { 1 },
4316 default => {}
4317 },
4318 sslByAjax => {
4319 type => 'bool',
4320 default => 0,
4321 documentation => 'Use Ajax request for Mutual TLS Authentication',
4322 },
4323 sslHost => {
4324 type => 'url',
4325 documentation => 'URL for Mutual TLS Authentication Ajax request',
4326 },
4327
4328 # CAS
4329 casAuthnLevel => {
4330 type => 'int',
4331 default => 1,
4332 documentation => 'CAS authentication level',
4333 },
4334 casSrvMetaDataExportedVars => {
4335 type => 'keyTextContainer',
4336 default => { cn => 'cn', mail => 'mail', uid => 'uid', },
4337 documentation => 'CAS exported variables',
4338 },
4339 casSrvMetaDataOptions => {
4340 type => 'subContainer',
4341 documentation => 'Root of CAS server options',
4342 },
4343 casSrvMetaDataOptionsGateway => { type => 'bool', default => 0 },
4344 casSrvMetaDataOptionsProxiedServices => {
4345 type => 'keyTextContainer',
4346 keyTest => qr/^\w/,
4347 keyMsgFail => '__badCasProxyId__',
4348 },
4349 casSrvMetaDataOptionsRenew => { type => 'bool', default => 0 },
4350 casSrvMetaDataOptionsUrl => {
4351 type => 'text',
4352 test => $url,
4353 msgFail => '__badUrl__',
4354 },
4355 casSrvMetaDataOptionsComment => {
4356 type => 'longtext',
4357 documentation => 'Comment for this CAS server',
4358 },
4359 casSrvMetaDataOptionsDisplayName => {
4360 type => 'text',
4361 documentation => 'Name to display for this CAS server',
4362 },
4363 casSrvMetaDataOptionsIcon => {
4364 type => 'text',
4365 documentation => 'Path of CAS server icon',
4366 },
4367 casSrvMetaDataOptionsSortNumber => {
4368 type => 'int',
4369 documentation => 'Number to sort buttons',
4370 },
4371 casSrvMetaDataOptionsResolutionRule => {
4372 type => 'longtext',
4373 default => '',
4374 },
4375 casSrvMetaDataOptionsTooltip => {
4376 type => 'text',
4377 documentation => 'Tooltip for this CAS Server',
4378 },
4379
4380 # Fake attribute: used by manager REST API to agglomerate all nodes
4381 # related to a CAS IDP partner
4382 casSrvMetaDataNodes => {
4383 type => 'casSrvMetaDataNodeContainer',
4384 template => 'casSrvMetaDataNode',
4385 help => 'authcas.html',
4386 },
4387
4388 # PAM
4389 pamAuthnLevel => {
4390 type => 'int',
4391 default => 2,
4392 documentation => 'PAM authentication level',
4393 },
4394 pamService => {
4395 type => 'text',
4396 default => 'login',
4397 documentation => 'PAM service',
4398 },
4399
4400 # GPG
4401 gpgDb => {
4402 type => 'text',
4403 default => '',
4404 documentation => 'GPG keys database',
4405 },
4406 gpgAuthnLevel => {
4407 type => 'int',
4408 default => 5,
4409 documentation => 'GPG authentication level',
4410 },
4411
4412 # Radius
4413 radiusAuthnLevel => {
4414 type => 'int',
4415 default => 3,
4416 documentation => 'Radius authentication level',
4417 },
4418 radiusSecret => { type => 'text' },
4419 radiusServer => { type => 'text' },
4420 radiusTimeout => {
4421 type => 'intOrNull',
4422 },
4423 radiusMsgAuth => {
4424 type => 'bool',
4425 documentation => 'Use Message-Authentication for Radius requests',
4426 },
4427 radiusExportedVars => {
4428 type => 'keyTextContainer',
4429
4430 # session key name
4431 keyTest => qr/^!?[a-zA-Z][a-zA-Z0-9_-]*$/,
4432 keyMsgFail => '__badVariableName__',
4433
4434 # radius attribue name (from discitonary)
4435 test => qr/^[a-zA-Z][a-zA-Z0-9_:\-]*$/,
4436 msgFail => '__badValue__',
4437 default => {},
4438 documentation => 'RADIUS exported variables',
4439 },
4440 radiusDictionaryFile => { type => 'text' },
4441 radiusRequestAttributes => {
4442 type => 'keyTextContainer',
4443
4444 keyTest => qr/^[a-zA-Z0-9_-]*$/,
4445 keyMsgFail => '__badKeyName__',
4446
4447 default => {},
4448 documentation => 'RADIUS authentication attributes',
4449 },
4450
4451 # REST
4452 restAuthUrl => { type => 'url' },
4453 restAuthArgs => {
4454 type => 'keyTextContainer',
4455 test => sub { return perlExpr(@_) },
4456 msgFail => '__badValue__',
4457 documentation => 'Extra args for REST Auth request',
4458 help => 'authrest.html#rest-args',
4459 },
4460 restUserDBUrl => { type => 'url' },
4461 restUserDBArgs => {
4462 type => 'keyTextContainer',
4463 test => sub { return perlExpr(@_) },
4464 msgFail => '__badValue__',
4465 documentation => 'Extra args for REST UserDB request',
4466 help => 'authrest.html#rest-args',
4467 },
4468 restFindUserDBUrl => { type => 'url' },
4469 restFindUserDBArgs => {
4470 type => 'keyTextContainer',
4471 test => sub { return perlExpr(@_) },
4472 msgFail => '__badValue__',
4473 documentation => 'Extra args for REST FindUser request',
4474 help => 'authrest.html#rest-args',
4475 },
4476
4477 restPwdConfirmUrl => { type => 'url' },
4478 restPwdConfirmArgs => {
4479 type => 'keyTextContainer',
4480 test => sub { return perlExpr(@_) },
4481 msgFail => '__badValue__',
4482 documentation => 'Extra args for REST password confirm request',
4483 help => 'authrest.html#rest-args',
4484 },
4485 restPwdModifyUrl => { type => 'url' },
4486 restPwdModifyArgs => {
4487 type => 'keyTextContainer',
4488 test => sub { return perlExpr(@_) },
4489 msgFail => '__badValue__',
4490 documentation => 'Extra args for REST password modify request',
4491 help => 'authrest.html#rest-args',
4492 },
4493
4494 # Remote
4495 remoteCookieName => {
4496 type => 'text',
4497 test => qr/^[a-zA-Z][a-zA-Z0-9_-]*$/,
4498 msgFail => '__badCookieName__',
4499 documentation => 'Name of the remote portal cookie',
4500 flags => 'p',
4501 },
4502 remotePortal => { type => 'text' },
4503 remoteGlobalStorage => {
4504 type => 'PerlModule',
4505 default => 'Lemonldap::NG::Common::Apache::Session::SOAP',
4506 documentation => 'Remote session backend',
4507 },
4508 remoteGlobalStorageOptions => {
4509 type => 'keyTextContainer',
4510 default => {
4511 proxy => 'http://auth.example.com/sessions',
4512 ns =>
4513 'http://auth.example.com/Lemonldap/NG/Common/PSGI/SOAPService',
4514 },
4515 documentation => 'Apache::Session module parameters',
4516 },
4517
4518 # Proxy
4519 proxyAuthService => { type => 'text' },
4520 proxySessionService => { type => 'text' },
4521 proxyAuthServiceChoiceValue => { type => 'text' },
4522 proxyAuthServiceChoiceParam => {
4523 type => 'text',
4524 default => 'lmAuth'
4525 },
4526 proxyAuthServiceImpersonation => {
4527 type => 'bool',
4528 default => 0,
4529 documentation => 'Enable internal portal Impersonation',
4530 },
4531 proxyCookieName => {
4532 type => 'text',
4533 test => qr/^[a-zA-Z][a-zA-Z0-9_-]*$/,
4534 msgFail => '__badCookieName__',
4535 documentation => 'Name of the internal portal cookie',
4536 flags => 'p',
4537 },
4538 proxyUseSoap => {
4539 type => 'bool',
4540 default => 0,
4541 documentation => 'Use SOAP instead of REST',
4542 },
4543 proxyAuthnLevel => {
4544 type => 'int',
4545 default => 2,
4546 documentation => 'Proxy authentication level',
4547 },
4548
4549 # OpenID
4550 openIdAuthnLevel => {
4551 type => 'int',
4552 default => 1,
4553 documentation => 'OpenID authentication level',
4554 },
4555 openIdSecret => { type => 'text', },
4556 openIdExportedVars => {
4557 type => 'keyTextContainer',
4558 keyTest => qr/^!?[a-zA-Z][a-zA-Z0-9_-]*$/,
4559 keyMsgFail => '__badVariableName__',
4560 test => qr/^[a-zA-Z][a-zA-Z0-9_:\-]*$/,
4561 msgFail => '__badValue__',
4562 default => {},
4563 documentation => 'OpenID exported variables',
4564 },
4565 'openIdIDPList' => { 'type' => 'blackWhiteList', default => '0;' },
4566
4567 # Facebook
4568 facebookAuthnLevel => {
4569 type => 'int',
4570 default => 1,
4571 documentation => 'Facebook authentication level',
4572 },
4573 facebookAppId => { type => 'text', },
4574 facebookAppSecret => { type => 'text', },
4575 facebookExportedVars => {
4576 type => 'keyTextContainer',
4577 keyTest => qr/^!?[a-zA-Z][a-zA-Z0-9_-]*$/,
4578 keyMsgFail => '__badVariableName__',
4579 test => qr/^[a-zA-Z][a-zA-Z0-9_:\-]*$/,
4580 msgFail => '__badValue__',
4581 default => {},
4582 documentation => 'Facebook exported variables',
4583 },
4584 facebookUserField => { type => 'text', default => 'id' },
4585
4586 # Twitter
4587 twitterAuthnLevel => {
4588 type => 'int',
4589 default => 1,
4590 documentation => 'Twitter authentication level',
4591 },
4592 twitterKey => { type => 'text', },
4593 twitterSecret => { type => 'text', },
4594 twitterAppName => { type => 'text', },
4595 twitterUserField => { type => 'text', default => 'screen_name' },
4596
4597 # LinkedIn
4598 linkedInAuthnLevel => {
4599 type => 'int',
4600 default => 1,
4601 documentation => 'LinkedIn authentication level',
4602 },
4603 linkedInClientID => { type => 'text', },
4604 linkedInClientSecret => { type => 'password', },
4605 linkedInFields => {
4606 type => 'text',
4607 default => 'id,first-name,last-name,email-address'
4608 },
4609 linkedInUserField => { type => 'text', default => 'emailAddress' },
4610 linkedInScope =>
4611 { type => 'text', default => 'r_liteprofile r_emailaddress' },
4612
4613 # GitHub
4614 githubAuthnLevel => {
4615 type => 'int',
4616 default => 1,
4617 documentation => 'GitHub authentication level',
4618 },
4619 githubClientID => { type => 'text', },
4620 githubClientSecret => { type => 'password', },
4621 githubScope => { type => 'text', default => 'user:email' },
4622 githubUserField => { type => 'text', default => 'login' },
4623
4624 # WebID
4625 webIDAuthnLevel => {
4626 type => 'int',
4627 default => 1,
4628 documentation => 'WebID authentication level',
4629 },
4630 webIDWhitelist => { type => 'text', },
4631 webIDExportedVars => {
4632 type => 'keyTextContainer',
4633 keyTest => qr/^!?[a-zA-Z][a-zA-Z0-9_-]*$/,
4634 keyMsgFail => '__badVariableName__',
4635 test => qr/^[a-zA-Z][a-zA-Z0-9_:\-]*$/,
4636 msgFail => '__badValue__',
4637 default => {},
4638 documentation => 'WebID exported variables',
4639 },
4640
4641 # DBI
4642 dbiAuthnLevel => {
4643 type => 'int',
4644 default => 2,
4645 documentation => 'DBI authentication level',
4646 },
4647 dbiAuthChain => { type => 'text', },
4648 dbiAuthUser => { type => 'text', },
4649 dbiAuthPassword => { type => 'password', },
4650 dbiAuthTable => { type => 'text', },
4651 dbiUserTable => { type => 'text', },
4652
4653 # TODO: add dbiMailCol
4654 dbiAuthLoginCol => { type => 'text', },
4655 dbiAuthPasswordCol => { type => 'text', },
4656 dbiPasswordMailCol => { type => 'text', },
4657 userPivot => { type => 'text', },
4658 dbiAuthPasswordHash =>
4659 { type => 'text', help => 'authdbi.html#password', },
4660 dbiDynamicHashEnabled =>
4661 { type => 'bool', help => 'authdbi.html#password', },
4662 dbiDynamicHashValidSchemes =>
4663 { type => 'text', help => 'authdbi.html#password', },
4664 dbiDynamicHashValidSaltedSchemes =>
4665 { type => 'text', help => 'authdbi.html#password', },
4666 dbiDynamicHashNewPasswordScheme =>
4667 { type => 'text', help => 'authdbi.html#password', },
4668 dbiExportedVars => {
4669 type => 'keyTextContainer',
4670 keyTest => qr/^!?[a-zA-Z][a-zA-Z0-9_-]*$/,
4671 keyMsgFail => '__badVariableName__',
4672 test => qr/^[a-zA-Z][a-zA-Z0-9_:\-]*$/,
4673 msgFail => '__badValue__',
4674 default => {},
4675 documentation => 'DBI exported variables',
4676 },
4677
4678 # Apache
4679 apacheAuthnLevel => {
4680 type => 'int',
4681 default => 3,
4682 documentation => 'Apache authentication level',
4683 },
4684
4685 # Null
4686 nullAuthnLevel => {
4687 type => 'int',
4688 default => 0,
4689 documentation => 'Null authentication level',
4690 },
4691
4692 # Kerberos
4693 krbKeytab => {
4694 type => 'text',
4695 documentation => 'Kerberos keytab',
4696 },
4697 krbByJs => {
4698 type => 'bool',
4699 default => 0,
4700 documentation => 'Launch Kerberos authentication by Ajax',
4701 },
4702 krbAuthnLevel => {
4703 type => 'int',
4704 default => 3,
4705 documentation => 'Null authentication level',
4706 },
4707 krbRemoveDomain => {
4708 type => 'bool',
4709 default => 1,
4710 documentation => 'Remove domain in Kerberos username',
4711 },
4712 krbAllowedDomains => {
4713 type => 'text',
4714 documentation => 'Allowed domains',
4715 },
4716
4717 # Slave
4718 slaveAuthnLevel => {
4719 type => 'int',
4720 default => 2,
4721 documentation => 'Slave authentication level',
4722 },
4723 slaveUserHeader => { type => 'text', },
4724 slaveCertificateField => { type => 'text', },
4725 slaveCertificateRegexp => {
4726 type => 'pcre',
4727 default => '',
4728 documentation => 'Regular expression to test Slave var',
4729 },
4730 slaveExportedVars => {
4731 type => 'keyTextContainer',
4732 keyTest => qr/^!?[a-zA-Z][a-zA-Z0-9_-]*$/,
4733 keyMsgFail => '__badVariableName__',
4734 test => qr/^[a-zA-Z][a-zA-Z0-9_:\-]*$/,
4735 msgFail => '__badValue__',
4736 default => {},
4737 documentation => 'Slave exported variables',
4738 },
4739 slaveMasterIP => {
4740 type => 'text',
4741 test => qr/^($Regexp::Common::URI::RFC2396::IPv4address\s*)*$/,
4742 msgFail => '__badIPv4Address__',
4743 },
4744 slaveHeaderName => { type => 'text', },
4745 slaveHeaderContent => { type => 'text', },
4746 slaveDisplayLogo => {
4747 type => 'bool',
4748 default => 0,
4749 documentation => 'Display Slave authentication logo',
4750 },
4751
4752 # Choice
4753 authChoiceParam => {
4754 type => 'text',
4755 default => 'lmAuth',
4756 documentation => 'Applications list',
4757 },
4758 authChoiceAuthBasic => {
4759 type => 'text',
4760 documentation => 'Auth module used by AuthBasic handler',
4761 },
4762 authChoiceFindUser => {
4763 type => 'text',
4764 documentation => 'Auth module used by FindUser plugin',
4765 },
4766 authChoiceSelectOnly => {
4767 type => 'bool',
4768 default => 0,
4769 documentation => 'Automatically select only available choice',
4770 },
4771 authChoiceModules => {
4772 type => 'authChoiceContainer',
4773 keyTest => qr/^(\d*)?[a-zA-Z0-9_]+$/,
4774 keyMsgFail => '__badChoiceKey__',
4775 test => sub { 1 },
4776 select => [ [
4777 { k => 'Apache', v => 'Apache' },
4778 { k => 'AD', v => 'Active Directory' },
4779 {
4780 k => 'CAS',
4781 v => 'Central Authentication Service (CAS)'
4782 },
4783 { k => 'DBI', v => 'Database (DBI)' },
4784 { k => 'Demo', v => 'Demo' },
4785 { k => 'Facebook', v => 'Facebook' },
4786 { k => 'GitHub', v => 'GitHub' },
4787 { k => 'GPG', v => 'GPG' },
4788 { k => 'Kerberos', v => 'Kerberos' },
4789 { k => 'LDAP', v => 'LDAP' },
4790 { k => 'LinkedIn', v => 'LinkedIn' },
4791 { k => 'PAM', v => 'PAM' },
4792 { k => 'Null', v => 'None' },
4793 { k => 'OpenID', v => 'OpenID 2.0 (deprecated)' },
4794 { k => 'OpenIDConnect', v => 'OpenID Connect' },
4795 { k => 'Proxy', v => 'Proxy' },
4796 { k => 'Radius', v => 'Radius' },
4797 { k => 'REST', v => 'REST' },
4798 { k => 'Remote', v => 'Remote' },
4799 { k => 'SAML', v => 'SAML v2' },
4800 { k => 'Slave', v => 'Slave' },
4801 { k => 'SSL', v => 'mTLS' },
4802 { k => 'Twitter', v => 'Twitter' },
4803 { k => 'WebID', v => 'WebID (deprecated)' },
4804 { k => 'WebAuthn', v => 'WebAuthn' },
4805 { k => 'Combination', v => 'combineMods' },
4806 { k => 'Custom', v => 'customModule' },
4807 ],
4808 [
4809 { k => 'AD', v => 'Active Directory' },
4810 {
4811 k => 'CAS',
4812 v => 'Central Authentication Service (CAS)'
4813 },
4814 { k => 'DBI', v => 'Database (DBI)' },
4815 { k => 'Demo', v => 'Demo' },
4816 { k => 'Facebook', v => 'Facebook' },
4817 { k => 'LDAP', v => 'LDAP' },
4818 { k => 'Null', v => 'None' },
4819 { k => 'OpenID', v => 'OpenID 2.0 (deprecated)' },
4820 { k => 'OpenIDConnect', v => 'OpenID Connect' },
4821 { k => 'Proxy', v => 'Proxy' },
4822 { k => 'REST', v => 'REST' },
4823 { k => 'Remote', v => 'Remote' },
4824 { k => 'SAML', v => 'SAML v2' },
4825 { k => 'Slave', v => 'Slave' },
4826 { k => 'WebID', v => 'WebID (deprecated)' },
4827 { k => 'Combination', v => 'combineMods' },
4828 { k => 'Custom', v => 'customModule' },
4829 ],
4830 [
4831 { k => 'AD', v => 'Active Directory' },
4832 { k => 'DBI', v => 'Database (DBI)' },
4833 { k => 'Demo', v => 'Demo' },
4834 { k => 'LDAP', v => 'LDAP' },
4835 { k => 'REST', v => 'REST' },
4836 { k => 'Null', v => 'None' },
4837 { k => 'Combination', v => 'combineMods' },
4838 { k => 'Custom', v => 'customModule' },
4839 ]
4840 ],
4841 documentation => 'Hash list of Choice strings',
4842 },
4843
4844 # Combination
4845 combination => {
4846 type => 'text',
4847 documentation => 'Combination rule'
4848 },
4849 combModules => {
4850 type => 'cmbModuleContainer',
4851 keyTest => qr/^\w+$/,
4852 test => sub { 1 },
4853 documentation => 'Combination module description',
4854 select => [
4855 { k => 'Apache', v => 'Apache' },
4856 { k => 'AD', v => 'Active Directory' },
4857 { k => 'DBI', v => 'Database (DBI)' },
4858 { k => 'Facebook', v => 'Facebook' },
4859 { k => 'GitHub', v => 'GitHub' },
4860 { k => 'GPG', v => 'GPG' },
4861 { k => 'Kerberos', v => 'Kerberos' },
4862 { k => 'LDAP', v => 'LDAP' },
4863 { k => 'LinkedIn', v => 'LinkedIn' },
4864 { k => 'PAM', v => 'PAM' },
4865 { k => 'Radius', v => 'Radius' },
4866 { k => 'REST', v => 'REST' },
4867 { k => 'SSL', v => 'mTLS' },
4868 { k => 'Twitter', v => 'Twitter' },
4869 { k => 'WebID', v => 'WebID (deprecated)' },
4870 { k => 'WebAuthn', v => 'WebAuthn' },
4871 { k => 'Demo', v => 'Demonstration' },
4872 { k => 'CAS', v => 'Central Authentication Service (CAS)' },
4873 { k => 'OpenID', v => 'OpenID 2.0 (deprecated)' },
4874 { k => 'OpenIDConnect', v => 'OpenID Connect' },
4875 { k => 'SAML', v => 'SAML v2' },
4876 { k => 'Proxy', v => 'Proxy' },
4877 { k => 'Remote', v => 'Remote' },
4878 { k => 'Slave', v => 'Slave' },
4879 { k => 'Null', v => 'None' },
4880 { k => 'Custom', v => 'customModule' },
4881 ],
4882 },
4883 sfExtra => {
4884 type => 'sfExtraContainer',
4885 help => "sfextra.html",
4886 keyTest => qr/^\w+$/,
4887 test => sub { 1 },
4888 documentation => 'Extra second factors',
4889 select => [
4890 { k => 'Mail2F', v => 'E-Mail' },
4891 { k => 'REST', v => 'REST' },
4892 { k => 'Ext2F', v => 'External' },
4893 { k => 'Radius', v => 'Radius' },
4894 ],
4895 },
4896
4897 # Custom auth modules
4898 customAuth => {
4899 type => 'text',
4900 documentation => 'Custom auth module',
4901 },
4902 customUserDB => {
4903 type => 'text',
4904 documentation => 'Custom user DB module',
4905 },
4906 customPassword => {
4907 type => 'text',
4908 documentation => 'Custom password module',
4909 },
4910 customRegister => {
4911 type => 'text',
4912 documentation => 'Custom register module',
4913 },
4914 customResetCertByMail => {
4915 type => 'text',
4916 documentation => 'Custom certificateResetByMail module',
4917 },
4918 customAddParams => {
4919 type => 'keyTextContainer',
4920 documentation => 'Custom additional parameters',
4921 },
4922
4923 # Custom plugins
4924 customPlugins => {
4925 type => 'text',
4926 documentation => 'Custom plugins',
4927 },
4928 customPluginsParams => {
4929 type => 'keyTextContainer',
4930 documentation => 'Custom plugins parameters',
4931 },
4932 disabledPlugins => {
4933 type => 'text',
4934 documentation => 'Disabled plugins',
4935 },
4936
4937 # OpenID Connect auth params
4938 oidcAuthnLevel => {
4939 type => 'int',
4940 default => 1,
4941 documentation => 'OpenID Connect authentication level',
4942 },
4943 oidcRPCallbackGetParam => {
4944 type => 'text',
4945 default => 'openidconnectcallback',
4946 documentation => 'OpenID Connect Callback GET URLparameter',
4947 },
4948 oidcRPStateTimeout => {
4949 type => 'int',
4950 default => 600,
4951 documentation => 'OpenID Connect Timeout of state sessions',
4952 },
4953
4954 # OpenID Connect service
4955 oidcServiceMetaDataIssuer => {
4956 type => 'text',
4957 documentation => 'OpenID Connect issuer',
4958 },
4959 oidcServiceMetaDataAuthorizeURI => {
4960 type => 'text',
4961 default => 'authorize',
4962 documentation => 'OpenID Connect authorizaton endpoint',
4963 },
4964 oidcServiceMetaDataTokenURI => {
4965 type => 'text',
4966 default => 'token',
4967 documentation => 'OpenID Connect token endpoint',
4968 },
4969 oidcServiceMetaDataUserInfoURI => {
4970 type => 'text',
4971 default => 'userinfo',
4972 documentation => 'OpenID Connect user info endpoint',
4973 },
4974 oidcServiceMetaDataJWKSURI => {
4975 type => 'text',
4976 default => 'jwks',
4977 documentation => 'OpenID Connect JWKS endpoint',
4978 },
4979 oidcServiceMetaDataRegistrationURI => {
4980 type => 'text',
4981 default => 'register',
4982 documentation => 'OpenID Connect registration endpoint',
4983 },
4984
4985 # Oauth2 endpoints
4986 oidcServiceMetaDataIntrospectionURI => {
4987 type => 'text',
4988 default => 'introspect',
4989 documentation => 'OpenID Connect introspection endpoint',
4990 },
4991 oidcServiceMetaDataRevokeURI => {
4992 type => 'text',
4993 default => 'revoke',
4994 documentation => 'OpenID Connect token revocation endpoint',
4995 },
4996
4997 # Logout endpoints
4998 oidcServiceMetaDataEndSessionURI => {
4999 type => 'text',
5000 default => 'logout',
5001 documentation => 'OpenID Connect end session endpoint',
5002 },
5003 oidcServiceMetaDataCheckSessionURI => {
5004 type => 'text',
5005 default => 'checksession.html',
5006 documentation => 'OpenID Connect check session iframe',
5007 },
5008 oidcServiceMetaDataBackChannelURI => {
5009 type => 'text',
5010 default => 'blogout',
5011 documentation => 'OpenID Connect Back-Channel logout endpoint',
5012 },
5013 oidcServiceMetaDataFrontChannelURI => {
5014 type => 'text',
5015 default => 'flogout',
5016 documentation => 'OpenID Connect Front-Channel logout endpoint',
5017 },
5018 oidcServiceMetaDataRpLogoutReturnURI => {
5019 type => 'text',
5020 default => 'rlogoutreturn',
5021 documentation =>
5022 'OpenID Connect RP-Initiated logout return endpoint',
5023 },
5024 oidcServiceMetaDataAuthnContext => {
5025 type => 'keyTextContainer',
5026 keyTest => qr/\w/,
5027 default => {
5028 'loa-1' => 1,
5029 'loa-2' => 2,
5030 'loa-3' => 3,
5031 'loa-4' => 4,
5032 'loa-5' => 5,
5033 },
5034 documentation => 'OpenID Connect Authentication Context Class Ref',
5035 },
5036 oidcServiceMetaDataAmrRules => {
5037 type => 'keyTextContainer',
5038 keyTest => qr/\w/,
5039 test => sub { return perlExpr(@_) },
5040 default => {
5041 'pwd' => '$authenticationLevel == 2',
5042 'mfa' => '$_2f',
5043 'pop' => '$_auth eq "WebAuthn" or $_auth eq "SSL"',
5044 'otp' => '$_2f eq "TOTP"',
5045 },
5046 documentation => 'OpenID Connect AMR rules',
5047 help => 'openidconnectservice.html#amrrules',
5048 },
5049 oidcServiceHideMetadata => {
5050 type => 'bool',
5051 Documentation => "Don't display OIDC metadata",
5052 },
5053
5054 # OIDC Keys
5055 oidcServiceOldPrivateKeySig => { type => 'EcOrRSAPrivateKey', },
5056 oidcServiceOldPublicKeySig =>
5057 { type => 'EcOrRSAPublicKeyOrCertificate', },
5058 oidcServiceOldKeyIdSig => {
5059 type => 'text',
5060 documentation => 'Previous OpenID Connect Signature Key ID',
5061 },
5062 oidcServiceOldKeyTypeSig => {
5063 type => 'select',
5064 select => [ { k => 'RSA', v => 'RSA' }, { k => 'EC', v => 'EC' } ],
5065 default => 'RSA',
5066 },
5067
5068 oidcServicePrivateKeySig => { type => 'EcOrRSAPrivateKey', },
5069 oidcServicePublicKeySig => { type => 'EcOrRSAPublicKeyOrCertificate', },
5070 oidcServiceKeyIdSig => {
5071 type => 'text',
5072 documentation => 'OpenID Connect Signature Key ID',
5073 },
5074 oidcServiceKeyTypeSig => {
5075 type => 'select',
5076 select => [ { k => 'RSA', v => 'RSA' }, { k => 'EC', v => 'EC' } ],
5077 default => 'RSA',
5078 },
5079
5080 oidcServiceNewPrivateKeySig => { type => 'EcOrRSAPrivateKey', },
5081 oidcServiceNewPublicKeySig =>
5082 { type => 'EcOrRSAPublicKeyOrCertificate', },
5083 oidcServiceNewKeyIdSig => {
5084 type => 'text',
5085 documentation => 'Future OpenID Connect Signature Key ID',
5086 },
5087 oidcServiceNewKeyTypeSig => {
5088 type => 'select',
5089 select => [ { k => 'RSA', v => 'RSA' }, { k => 'EC', v => 'EC' } ],
5090 default => 'RSA',
5091 },
5092
5093 oidcServiceEncAlgorithmAlg => {
5094 type => 'select',
5095 select => oidcEncAlgorithmAlg,
5096 default => 'RSA-OAEP',
5097 documentation => 'JWT encryption algorithme',
5098 },
5099 oidcServiceEncAlgorithmEnc => {
5100 type => 'select',
5101 select => oidcEncAlgorithmEnc,
5102 default => 'A256GCM',
5103 documentation => 'JWT encryption algorithme',
5104 },
5105
5106 oidcServiceOldPrivateKeyEnc => { type => 'RSAPrivateKey', },
5107 oidcServiceOldPublicKeyEnc => { type => 'RSAPublicKeyOrCertificate', },
5108 oidcServiceOldKeyIdEnc => {
5109 type => 'text',
5110 documentation => 'Previous OpenID Connect Encryption Key ID',
5111 },
5112 oidcServiceOldKeyTypeEnc => {
5113 type => 'select',
5114 select => [ { k => 'RSA', v => 'RSA' }, { k => 'EC', v => 'EC' } ],
5115 default => 'RSA',
5116 },
5117
5118 oidcServicePrivateKeyEnc => { type => 'RSAPrivateKey', },
5119 oidcServicePublicKeyEnc => { type => 'RSAPublicKeyOrCertificate', },
5120 oidcServiceKeyIdEnc => {
5121 type => 'text',
5122 documentation => 'OpenID Connect Encryption Key ID',
5123 },
5124 oidcServiceKeyTypeEnc => {
5125 type => 'select',
5126 select => [ { k => 'RSA', v => 'RSA' }, { k => 'EC', v => 'EC' } ],
5127 default => 'RSA',
5128 },
5129
5130 oidcServiceSignatureKey => {
5131 type => 'text',
5132 default => 'default-oidc-sig, old-oidc-sig, new-oidc-sig',
5133 documentation => 'Key to use for OIDC signature',
5134 },
5135 oidcServiceEncryptionKey => {
5136 type => 'text',
5137 default => 'default-oidc-enc',
5138 documentation => 'Key to use for OIDC encryption',
5139 },
5140
5141 oidcServiceAllowDynamicRegistration => {
5142 type => 'select',
5143 select => [
5144 { k => '0', v => 'disabled' },
5145 { k => '1', v => 'confidentialOnly' },
5146 { k => '2', v => 'allClients' },
5147 ],
5148 default => 0,
5149 documentation => 'OpenID Connect allow dynamic client registration',
5150 },
5151 oidcServiceAllowOnlyDeclaredScopes => {
5152 type => 'bool',
5153 default => 0,
5154 documentation => 'OpenID Connect allow only declared scopes',
5155 },
5156 oidcServiceIgnoreScopeForClaims => {
5157 type => 'bool',
5158 default => 0,
5159 documentation =>
5160 'OpenID Connect release all attributes even when not allowed by scope',
5161 },
5162 oidcServiceAllowAuthorizationCodeFlow => {
5163 type => 'bool',
5164 default => 1,
5165 documentation => 'OpenID Connect allow authorization code flow',
5166 },
5167 oidcServiceAllowImplicitFlow => {
5168 type => 'bool',
5169 default => 0,
5170 documentation => 'OpenID Connect allow implicit flow',
5171 },
5172 oidcServiceAllowHybridFlow => {
5173 type => 'bool',
5174 default => 0,
5175 documentation => 'OpenID Connect allow hybrid flow',
5176 },
5177 oidcServiceAuthorizationCodeExpiration => {
5178 type => 'int',
5179 default => 60,
5180 documentation => 'OpenID Connect global code TTL',
5181 },
5182 oidcServiceAccessTokenExpiration => {
5183 type => 'int',
5184 default => 3600,
5185 documentation => 'OpenID Connect global access token TTL',
5186 },
5187 oidcServiceDynamicRegistrationExportedVars => {
5188 type => 'keyTextContainer',
5189 documentation =>
5190 'OpenID Connect exported variables for dynamic registration',
5191 },
5192 oidcServiceDynamicRegistrationExtraClaims => {
5193 type => 'keyTextContainer',
5194 keyTest => qr/^[\x21\x23-\x5B\x5D-\x7E]+$/,
5195 documentation =>
5196 'OpenID Connect extra claims for dynamic registration',
5197 },
5198 oidcServiceIDTokenExpiration => {
5199 type => 'int',
5200 default => 3600,
5201 documentation => 'OpenID Connect global ID token TTL',
5202 },
5203 oidcServiceOfflineSessionExpiration => {
5204 type => 'int',
5205 default => 2592000,
5206 documentation => 'OpenID Connect global offline session TTL',
5207 },
5208 oidcStorage => {
5209 type => 'PerlModule',
5210 documentation => 'Apache::Session module to store OIDC user data',
5211 },
5212 oidcStorageOptions => {
5213 type => 'keyTextContainer',
5214 documentation => 'Apache::Session module parameters',
5215 },
5216 oidcDropCspHeaders => {
5217 type => 'bool',
5218 documentation => 'Drop CORS headers from OIDC issuer responses',
5219 },
5220 oidcServiceMetadataTtl => {
5221 type => 'int',
5222 documentation => 'OIDC Metadata TTL',
5223 },
5224 oidcServiceMetaDataDisallowNoneAlg => {
5225 type => 'bool',
5226 description => 'Disallow "none" algorithm for signature',
5227 },
5228
5229 # OpenID Connect metadata nodes
5230 oidcOPMetaDataNodes => {
5231 type => 'oidcOPMetaDataNodeContainer',
5232 help =>
5233 'authopenidconnect.html#declare-the-openid-connect-provider-in-ll-ng',
5234 },
5235 oidcRPMetaDataNodes => {
5236 type => 'oidcRPMetaDataNodeContainer',
5237 help =>
5238 'idpopenidconnect.html#configuration-of-relying-party-in-ll-ng',
5239 },
5240 oidcOPMetaDataOptions => { type => 'subContainer', },
5241 oidcRPMetaDataOptions => { type => 'subContainer', },
5242
5243 # OpenID Connect providers
5244 oidcOPMetaDataJSON => {
5245 type => 'file',
5246 keyTest => sub { 1 }
5247 },
5248 oidcOPMetaDataJWKS => {
5249 type => 'file',
5250 keyTest => sub { 1 }
5251 },
5252 oidcOPMetaDataExportedVars => {
5253 type => 'keyTextContainer',
5254 default => {
5255 'cn' => 'name',
5256 'sn' => 'family_name',
5257 'mail' => 'email',
5258 'uid' => 'sub'
5259 }
5260 },
5261 oidcOPMetaDataOptionsConfigurationURI => { type => 'url', },
5262 oidcOPMetaDataOptionsJWKSTimeout => { type => 'int', default => 0 },
5263 oidcOPMetaDataOptionsUserAttribute => { type => 'text' },
5264 oidcOPMetaDataOptionsClientID => { type => 'text', },
5265 oidcOPMetaDataOptionsClientSecret => { type => 'password', },
5266 oidcOPMetaDataOptionsScope =>
5267 { type => 'text', default => 'openid profile' },
5268 oidcOPMetaDataOptionsDisplay => {
5269 type => 'select',
5270 select => [
5271 { k => '', v => '' },
5272 { k => 'page', v => 'page' },
5273 { k => 'popup', v => 'popup' },
5274 { k => 'touch', v => 'touch' },
5275 { k => 'wap', v => 'wap' },
5276 ],
5277 default => "",
5278 },
5279 oidcOPMetaDataOptionsPrompt => { type => 'text' },
5280 oidcOPMetaDataOptionsMaxAge => { type => 'int', default => 0 },
5281 oidcOPMetaDataOptionsUiLocales => { type => 'text', },
5282 oidcOPMetaDataOptionsAcrValues => { type => 'text', },
5283 oidcOPMetaDataOptionsAuthEndpointExtraParams => {
5284 type => 'keyTextContainer',
5285 documentation =>
5286 'Additional parameters for OpenID Connect Authorization endpoint',
5287 },
5288 oidcOPMetaDataOptionsTokenEndpointAuthMethod => {
5289 type => 'select',
5290 select => [
5291 { k => 'client_secret_post', v => 'client_secret_post' },
5292 { k => 'client_secret_basic', v => 'client_secret_basic' },
5293 { k => 'client_secret_jwt', v => 'client_secret_jwt' },
5294 { k => 'private_key_jwt', v => 'private_key_jwt' },
5295 ],
5296 default => 'client_secret_post',
5297 },
5298 oidcOPMetaDataOptionsTokenEndpointAuthSigAlg => {
5299 type => 'select',
5300 select => oidcSigAlgorithmAlg,
5301 default => 'RS256',
5302 },
5303 oidcOPMetaDataOptionsAuthnEndpointAuthMethod => {
5304 type => 'select',
5305 select =>
5306 [ { k => '', v => 'None' }, { k => 'jws', v => 'Signed JWT' }, ],
5307 },
5308 oidcOPMetaDataOptionsAuthnEndpointAuthSigAlg => {
5309 type => 'select',
5310 select => oidcSigAlgorithmAlg,
5311 default => 'RS256',
5312 },
5313 oidcOPMetaDataOptionsSigningKey => {
5314 type => 'text',
5315 help => 'Signature key used with this OP',
5316 default => '',
5317 },
5318 oidcOPMetaDataOptionsCheckJWTSignature =>
5319 { type => 'bool', default => 1 },
5320 oidcOPMetaDataOptionsIDTokenMaxAge => { type => 'int', default => 30 },
5321 oidcOPMetaDataOptionsUseNonce => { type => 'bool', default => 1 },
5322 oidcOPMetaDataOptionsDisplayName => { type => 'text', },
5323 oidcOPMetaDataOptionsIcon => { type => 'text', },
5324 oidcOPMetaDataOptionsStoreIDToken => { type => 'bool', default => 0 },
5325 oidcOPMetaDataOptionsSortNumber => { type => 'int', },
5326 oidcOPMetaDataOptionsTooltip => { type => 'text', },
5327 oidcOPMetaDataOptionsComment => { type => 'longtext', },
5328 oidcOPMetaDataOptionsResolutionRule => {
5329 type => 'longtext',
5330 default => '',
5331 },
5332 oidcOPMetaDataOptionsRequirePkce => {
5333 type => 'bool',
5334 default => 0,
5335 documentation => 'Use PKCE with this OP',
5336 },
5337 oidcOPMetaDataOptionsRequireIss => {
5338 type => 'bool',
5339 default => 0,
5340 documentation =>
5341 'Require iss parameter in authorization response (RFC 9207)',
5342 },
5343 oidcOPMetaDataOptionsUserinfoSource => {
5344 type => 'select',
5345 default => 'userinfo',
5346 select => [
5347 { k => 'userinfo', v => 'Userinfo endpoint' },
5348 { k => 'id_token', v => 'ID Token' },
5349 { k => 'access_token', v => 'Access Token' },
5350 ],
5351 documentation => "Source of userinfo",
5352 },
5353 oidcOPMetaDataOptionsNoJwtHeader => {
5354 type => 'bool',
5355 default => 0,
5356 documentation => "Don't insert typ header",
5357 },
5358
5359 # OpenID Connect relying parties
5360 oidcRPMetaDataExportedVars => {
5361 help => 'idpopenidconnect.html#exported-attributes',
5362 type => 'oidcAttributeContainer',
5363 keyTest => qr/\w/,
5364 test => qr/\w/,
5365 default => {
5366 'name' => 'cn',
5367 'preferred_username' => 'uid',
5368 'email' => 'mail',
5369 }
5370 },
5371 oidcRPMetaDataOptionsActivation => {
5372 type => 'bool',
5373 default => 1,
5374 },
5375 oidcRPMetaDataOptionsClientID => { type => 'text', },
5376 oidcRPMetaDataOptionsClientSecret => { type => 'password', },
5377 oidcRPMetaDataOptionsAuthMethod => {
5378 type => 'select',
5379 select => [
5380 { k => '', v => 'Any' },
5381 { k => 'client_secret_post', v => 'client_secret_post' },
5382 { k => 'client_secret_basic', v => 'client_secret_basic' },
5383 { k => 'client_secret_jwt', v => 'client_secret_jwt' },
5384 { k => 'private_key_jwt', v => 'private_key_jwt' },
5385 ],
5386 },
5387 oidcRPMetaDataOptionsAuthRequiredForAuthorize => {
5388 type => 'bool',
5389 default => 0,
5390 },
5391 oidcRPMetaDataOptionsDisplayName => { type => 'text', },
5392 oidcRPMetaDataOptionsIcon => { type => 'text', },
5393 oidcRPMetaDataOptionsUserIDAttr => { type => 'text', },
5394 oidcRPMetaDataOptionsSigningKey => {
5395 type => 'text',
5396 help => 'Signature key used with this OP',
5397 default => '',
5398 },
5399 oidcRPMetaDataOptionsIDTokenSignAlg => {
5400 type => 'select',
5401 select => [ { k => 'none', v => 'None' }, @{&oidcSigAlgorithmAlg} ],
5402 default => 'RS256',
5403 },
5404 oidcRPMetaDataOptionsIDTokenExpiration => { type => 'intOrNull' },
5405 oidcRPMetaDataOptionsIDTokenForceClaims =>
5406 { type => 'bool', default => 0 },
5407 oidcRPMetaDataOptionsAccessTokenSignAlg => {
5408 type => 'select',
5409 select => oidcSigAlgorithmAlg,
5410 default => 'RS256',
5411 },
5412 oidcRPMetaDataOptionsUserInfoSignAlg => {
5413 type => 'select',
5414 select => [
5415 { k => '', v => 'JSON' },
5416 { k => 'none', v => 'None' },
5417 @{&oidcSigAlgorithmAlg},
5418 ],
5419 default => '',
5420 },
5421 oidcRPMetaDataOptionsIntrospectionSignAlg => {
5422 type => 'select',
5423 select => [ { k => '', v => 'JSON' }, @{&oidcSigAlgorithmAlg}, ],
5424 default => '',
5425 documentation =>
5426 'Introspection response signature algorithm (RFC 9701)',
5427 },
5428 oidcRPMetaDataOptionsIntrospectionEncKeyMgtAlg => {
5429 type => 'select',
5430 select => [ { k => '', v => 'None' }, @{&oidcEncAlgorithmAlg} ],
5431 documentation =>
5432 '"alg" for introspection response encryption (RFC 9701)',
5433 },
5434 oidcRPMetaDataOptionsIntrospectionEncContentEncAlg => {
5435 type => 'select',
5436 select => oidcEncAlgorithmEnc,
5437 default => 'A256GCM',
5438 documentation =>
5439 '"enc" for introspection response encryption (RFC 9701)',
5440 },
5441 oidcRPMetaDataOptionsAccessTokenJWT => { type => 'bool', default => 0 },
5442 oidcRPMetaDataOptionsAccessTokenClaims =>
5443 { type => 'bool', default => 0 },
5444 oidcRPMetaDataOptionsAdditionalAudiences => { type => 'text' },
5445 oidcRPMetaDataOptionsAccessTokenExpiration => { type => 'intOrNull' },
5446 oidcRPMetaDataOptionsAuthorizationCodeExpiration =>
5447 { type => 'intOrNull' },
5448 oidcRPMetaDataOptionsComment => { type => 'longtext' },
5449 oidcRPMetaDataOptionsOfflineSessionExpiration =>
5450 { type => 'intOrNull' },
5451 oidcRPMetaDataOptionsRedirectUris => { type => 'text', },
5452 oidcRPMetaDataOptionsRequestUris => { type => 'text', },
5453 oidcRPMetaDataOptionsExtraClaims => {
5454 type => 'keyTextContainer',
5455 keyTest => qr/^[\x21\x23-\x5B\x5D-\x7E]+$/,
5456 default => {},
5457 help => 'idpopenidconnect.html#oidcextraclaims'
5458 },
5459 oidcRPMetaDataOptionsBypassConsent => {
5460 type => 'bool',
5461 default => 0
5462 },
5463 oidcRPMetaDataOptionsPostLogoutRedirectUris => { type => 'text', },
5464 oidcRPMetaDataOptionsLogoutBypassConfirm => {
5465 type => 'bool',
5466 default => 0,
5467 documentation => 'Bypass logout confirmation'
5468 },
5469 oidcRPMetaDataOptionsLogoutUrl => {
5470 type => 'text',
5471 documentation => 'Logout URL',
5472 },
5473 oidcRPMetaDataOptionsLogoutType => {
5474 type => 'select',
5475 select => [
5476 { k => 'front', v => 'Front Channel' },
5477 { k => 'back', v => 'Back Channel' },
5478 ],
5479 default => 'front',
5480 documentation => 'Logout type',
5481 },
5482 oidcRPMetaDataOptionsLogoutSessionRequired => {
5483 type => 'bool',
5484 default => 0,
5485 documentation => 'Session required for back/front channel logout',
5486 },
5487 oidcRPMetaDataOptionsPublic => {
5488 type => 'bool',
5489 default => 0,
5490 documentation => 'Declare this RP as public client',
5491 },
5492 oidcRPMetaDataOptionsRequirePKCE => {
5493 type => 'select',
5494 select => [
5495 { k => '0', v => 'disabled' },
5496 { k => '1', v => 'required' },
5497 { k => '2', v => 'pkceOrSecret' },
5498 ],
5499 default => 0,
5500 documentation => 'Require PKCE',
5501 },
5502 oidcRPMetaDataOptionsAllowOffline => {
5503 type => 'bool',
5504 default => 0,
5505 documentation => 'Allow offline access',
5506 },
5507 oidcRPMetaDataOptionsAllowPasswordGrant => {
5508 type => 'bool',
5509 default => 0,
5510 documentation =>
5511 'Allow OAuth2 Resource Owner Password Credentials Grant',
5512 },
5513 oidcRPMetaDataOptionsAllowClientCredentialsGrant => {
5514 type => 'bool',
5515 default => 0,
5516 documentation => 'Allow OAuth2 Client Credentials Grant',
5517 },
5518 oidcRPMetaDataOptionsRefreshToken => {
5519 type => 'bool',
5520 default => 0,
5521 documentation => 'Issue refresh tokens',
5522 },
5523 oidcRPMetaDataOptionsRefreshTokenRotation => {
5524 type => 'bool',
5525 default => 0,
5526 documentation => 'Invalidate refresh token after use',
5527 },
5528 oidcRPMetaDataOptionsRtActivity => {
5529 type => 'int',
5530 test => sub { $_[0] >= 0 },
5531 default => 0,
5532 documentation => 'refresh_token activity timeout',
5533 },
5534 oidcRPMetaDataOptionsAuthnLevel => {
5535 type => 'text',
5536 test => sub { return perlExpr(@_) },
5537 documentation =>
5538 'Authentication level requires to access to this RP',
5539 },
5540 oidcRPMetaDataOptionsRule => {
5541 type => 'text',
5542 test => sub { return perlExpr(@_) },
5543 documentation => 'Rule to grant access to this RP',
5544 },
5545 oidcRPMetaDataOptionsAllowNativeSso => {
5546 type => 'bool',
5547 default => 0,
5548 documentation => 'Allow Native SSO for Mobile Apps',
5549 },
5550 oidcRPMetaDataMacros => {
5551 type => 'keyTextContainer',
5552 help =>
5553 'exportedvars.html#extend-variables-using-macros-and-groups',
5554 test => {
5555 keyTest => qr/^[_a-zA-Z][a-zA-Z0-9_]*$/,
5556 keyMsgFail => '__badMacroName__',
5557 test => sub { return perlExpr(@_) },
5558 },
5559 default => {},
5560 documentation => 'Macros',
5561 },
5562 oidcRPMetaDataScopeRules => {
5563 type => 'keyTextContainer',
5564 help => 'idpopenidconnect.html#scope-rules',
5565 test => {
5566
5567 # RFC6749
5568 keyTest => qr/^[\x21\x23-\x5B\x5D-\x7E]+$/,
5569 keyMsgFail => '__badMacroName__',
5570 test => sub { return perlExpr(@_) },
5571 },
5572 default => {},
5573 documentation => 'Scope rules',
5574 },
5575 oidcRPMetaDataOptionsJwks => {
5576 type => 'file',
5577 keyTest => sub { 1 },
5578 documentation => 'Relying party JWKS document',
5579 },
5580 oidcRPMetaDataOptionsJwksUri => {
5581 type => 'url',
5582 help => 'idpopenidconnect.html',
5583 documentation =>
5584 'Relying party JWKS endpoint (to get encryption keys)',
5585 },
5586 oidcRPMetaDataOptionsAccessTokenEncKeyMgtAlg => {
5587 type => 'select',
5588 select =>
5589 [ { k => '', 'v' => 'None' }, @{ &oidcEncAlgorithmAlg, } ],
5590 documentation => '"alg" algorithm for access_token encryption',
5591 },
5592 oidcRPMetaDataOptionsAccessTokenEncContentEncAlg => {
5593 type => 'select',
5594 select => oidcEncAlgorithmEnc,
5595 default => 'A256GCM',
5596 documentation => '"enc" algorithm for access_token encryption',
5597 },
5598 oidcRPMetaDataOptionsIdTokenEncKeyMgtAlg => {
5599 type => 'select',
5600 select =>
5601 [ { k => '', 'v' => 'None' }, @{ &oidcEncAlgorithmAlg, } ],
5602 documentation => '"alg" algorithm for id_token encryption',
5603 },
5604 oidcRPMetaDataOptionsIdTokenEncContentEncAlg => {
5605 type => 'select',
5606 select => oidcEncAlgorithmEnc,
5607 default => 'A256GCM',
5608 documentation => '"enc" algorithm for id_token encryption',
5609 },
5610 oidcRPMetaDataOptionsUserInfoEncKeyMgtAlg => {
5611 type => 'select',
5612 select => [ { k => '', v => 'None' }, @{&oidcEncAlgorithmAlg} ],
5613 documentation => '"alg" algorithm for user_info encryption',
5614 },
5615 oidcRPMetaDataOptionsUserInfoEncContentEncAlg => {
5616 type => 'select',
5617 select => oidcEncAlgorithmEnc,
5618 default => 'A256GCM',
5619 documentation => '"enc" algorithm for user_info encryption',
5620 },
5621 oidcRPMetaDataOptionsLogoutEncKeyMgtAlg => {
5622 type => 'select',
5623 select => [ { k => '', v => 'None' }, @{&oidcEncAlgorithmAlg} ],
5624 documentation => '"alg" algorithm for logout token encryption',
5625 },
5626 oidcRPMetaDataOptionsLogoutEncContentEncAlg => {
5627 type => 'select',
5628 select => oidcEncAlgorithmEnc,
5629 default => 'A256GCM',
5630 documentation => '"enc" algorithm for logout encryption',
5631 },
5632 oidcRPMetaDataOptionsAuthnRequireState => {
5633 type => 'bool',
5634 default => 0,
5635 },
5636 oidcRPMetaDataOptionsAuthnRequireNonce => {
5637 type => 'bool',
5638 default => 0,
5639 },
5640 oidcRPMetaDataOptionsUserinfoRequireHeaderToken => {
5641 type => 'bool',
5642 default => 0,
5643 documentation =>
5644 '/userinfo endpoint requires authn using Bearer token',
5645 },
5646 oidcRPMetaDataOptionsTokenXAuthorizedRP => {
5647 type => 'text',
5648 documentation =>
5649 'List of RP authorized to query for an access_token of this RP',
5650 },
5651 oidcRPMetaDataOptionsNoJwtHeader => {
5652 type => 'bool',
5653 default => 0,
5654 documentation => "Don't insert typ header",
5655 },
5656 appAccessHistoryEnabled => {
5657 type => 'bool',
5658 default => 0,
5659 documentation =>
5660 'Shall OIDC/SAML/CAS protected apps access be recorded to session?'
5661 },
5662
5663 # Fake attribute: used by manager REST API to agglomerate all other
5664 # nodes
5665 keyNodes => {
5666 type => 'keyNodeContainer',
5667 help => 'keys.html',
5668 template => 'keyNode',
5669 },
5670 keys => {
5671 type => 'subContainer',
5672 documentation => 'Root of keys',
5673 },
5674 keyPrivate => { type => 'EcOrRSAPrivateKey', default => "" },
5675 keyPrivatePwd => { type => 'password', default => "" },
5676 keyPublic => { type => 'EcOrRSAPublicKeyOrCertificate', default => "" },
5677 'keyId' => { type => "text", default => "" },
5678 'keyComment' => { type => 'text', default => "" },
5679 };
5680 }
5681
5682 1;