-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathsettings.php
257 lines (219 loc) · 11.3 KB
/
settings.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Plugin settings.
*
* @package auth_oidc
* @author James McQuillan <[email protected]>
* @author Lai Wei <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @copyright (C) 2014 onwards Microsoft, Inc. (http://microsoft.com/)
*/
defined('MOODLE_INTERNAL') || die();
use auth_oidc\adminsetting\auth_oidc_admin_setting_iconselect;
use auth_oidc\adminsetting\auth_oidc_admin_setting_loginflow;
use auth_oidc\adminsetting\auth_oidc_admin_setting_redirecturi;
use auth_oidc\utils;
require_once($CFG->dirroot . '/auth/oidc/lib.php');
if ($hassiteconfig) {
// Add folder for OIDC settings.
$oidcfolder = new admin_category('oidcfolder', get_string('pluginname', 'auth_oidc'));
$ADMIN->add('authsettings', $oidcfolder);
// Application configuration page.
$ADMIN->add('oidcfolder', new admin_externalpage('auth_oidc_application', get_string('settings_page_application', 'auth_oidc'),
new moodle_url('/auth/oidc/manageapplication.php')));
$idptype = get_config('auth_oidc', 'idptype');
if ($idptype) {
// Binding username claim page.
$ADMIN->add('oidcfolder', new admin_externalpage('auth_oidc_binding_username_claim',
get_string('settings_page_binding_username_claim', 'auth_oidc'),
new moodle_url('/auth/oidc/binding_username_claim.php')));
// Change binding username claim tool page.
$ADMIN->add('oidcfolder', new admin_externalpage('auth_oidc_change_binding_username_claim_tool',
get_string('settings_page_change_binding_username_claim_tool', 'auth_oidc'),
new moodle_url('/auth/oidc/change_binding_username_claim_tool.php')));
}
// Other settings page and its settings.
$settings = new admin_settingpage($section, get_string('settings_page_other_settings', 'auth_oidc'));
// Basic heading.
$settings->add(new admin_setting_heading('auth_oidc/basic_heading', get_string('heading_basic', 'auth_oidc'),
get_string('heading_basic_desc', 'auth_oidc')));
// Redirect URI.
$settings->add(new auth_oidc_admin_setting_redirecturi('auth_oidc/redirecturi',
get_string('cfg_redirecturi_key', 'auth_oidc'), get_string('cfg_redirecturi_desc', 'auth_oidc'), utils::get_redirecturl()));
// Link to authentication options.
$authenticationconfigurationurl = new moodle_url('/auth/oidc/manageapplication.php');
$settings->add(new admin_setting_description('auth_oidc/authenticationlink',
get_string('settings_page_application', 'auth_oidc'),
get_string('cfg_authenticationlink_desc', 'auth_oidc', $authenticationconfigurationurl->out())));
// Additional options heading.
$settings->add(new admin_setting_heading('auth_oidc/additional_options_heading',
get_string('heading_additional_options', 'auth_oidc'), get_string('heading_additional_options_desc', 'auth_oidc')));
// Force redirect.
$settings->add(new admin_setting_configcheckbox('auth_oidc/forceredirect',
get_string('cfg_forceredirect_key', 'auth_oidc'), get_string('cfg_forceredirect_desc', 'auth_oidc'), 0));
// Silent login mode.
$forceloginconfigurl = new moodle_url('/admin/settings.php', ['section' => 'sitepolicies']);
$settings->add(new admin_setting_configcheckbox('auth_oidc/silentloginmode',
get_string('cfg_silentloginmode_key', 'auth_oidc'),
get_string('cfg_silentloginmode_desc', 'auth_oidc', $forceloginconfigurl->out(false)), 0));
// Auto-append.
$settings->add(new admin_setting_configtext('auth_oidc/autoappend',
get_string('cfg_autoappend_key', 'auth_oidc'), get_string('cfg_autoappend_desc', 'auth_oidc'), '', PARAM_TEXT));
// Domain hint.
$settings->add(new admin_setting_configtext('auth_oidc/domainhint',
get_string('cfg_domainhint_key', 'auth_oidc'), get_string('cfg_domainhint_desc', 'auth_oidc'), '' , PARAM_TEXT));
// Login flow.
$settings->add(new auth_oidc_admin_setting_loginflow('auth_oidc/loginflow',
get_string('cfg_loginflow_key', 'auth_oidc'), '', 'authcode'));
// User restrictions heading.
$settings->add(new admin_setting_heading('auth_oidc/user_restrictions_heading',
get_string('heading_user_restrictions', 'auth_oidc'), get_string('heading_user_restrictions_desc', 'auth_oidc')));
// User restrictions.
$settings->add(new admin_setting_configtextarea('auth_oidc/userrestrictions',
get_string('cfg_userrestrictions_key', 'auth_oidc'), get_string('cfg_userrestrictions_desc', 'auth_oidc'), '', PARAM_TEXT));
// User restrictions case sensitivity.
$settings->add(new admin_setting_configcheckbox('auth_oidc/userrestrictionscasesensitive',
get_string('cfg_userrestrictionscasesensitive_key', 'auth_oidc'),
get_string('cfg_userrestrictionscasesensitive_desc', 'auth_oidc'), '1'));
// Sign out integration heading.
$settings->add(new admin_setting_heading('auth_oidc/sign_out_heading',
get_string('heading_sign_out', 'auth_oidc'), get_string('heading_sign_out_desc', 'auth_oidc')));
// Single sign out from Moodle to IdP.
$settings->add(new admin_setting_configcheckbox('auth_oidc/single_sign_off',
get_string('cfg_signoffintegration_key', 'auth_oidc'),
get_string('cfg_signoffintegration_desc', 'auth_oidc', $CFG->wwwroot), '0'));
// IdP logout endpoint.
$settings->add(new admin_setting_configtext('auth_oidc/logouturi',
get_string('cfg_logoutendpoint_key', 'auth_oidc'), get_string('cfg_logoutendpoint_desc', 'auth_oidc'),
'https://login.microsoftonline.com/common/oauth2/logout', PARAM_URL));
// Front channel logout URL.
$settings->add(new auth_oidc_admin_setting_redirecturi('auth_oidc/logoutendpoint',
get_string('cfg_frontchannellogouturl_key', 'auth_oidc'), get_string('cfg_frontchannellogouturl_desc', 'auth_oidc'),
utils::get_frontchannellogouturl()));
// Display heading.
$settings->add(new admin_setting_heading('auth_oidc/display_heading',
get_string('heading_display', 'auth_oidc'), get_string('heading_display_desc', 'auth_oidc')));
// Provider Name (opname).
$settings->add(new admin_setting_configtext('auth_oidc/opname',
get_string('cfg_opname_key', 'auth_oidc'), get_string('cfg_opname_desc', 'auth_oidc'),
get_string('pluginname', 'auth_oidc'), PARAM_TEXT));
// Icon.
$icons = [
[
'pix' => 'o365',
'alt' => new lang_string('cfg_iconalt_o365', 'auth_oidc'),
'component' => 'auth_oidc',
],
[
'pix' => 't/locked',
'alt' => new lang_string('cfg_iconalt_locked', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 't/lock',
'alt' => new lang_string('cfg_iconalt_lock', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 't/go',
'alt' => new lang_string('cfg_iconalt_go', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 't/stop',
'alt' => new lang_string('cfg_iconalt_stop', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 't/user',
'alt' => new lang_string('cfg_iconalt_user', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 'u/user35',
'alt' => new lang_string('cfg_iconalt_user2', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 'i/permissions',
'alt' => new lang_string('cfg_iconalt_key', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 'i/cohort',
'alt' => new lang_string('cfg_iconalt_group', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 'i/groups',
'alt' => new lang_string('cfg_iconalt_group2', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 'i/mnethost',
'alt' => new lang_string('cfg_iconalt_mnet', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 'i/permissionlock',
'alt' => new lang_string('cfg_iconalt_userlock', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 't/more',
'alt' => new lang_string('cfg_iconalt_plus', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 't/approve',
'alt' => new lang_string('cfg_iconalt_check', 'auth_oidc'),
'component' => 'moodle',
],
[
'pix' => 't/right',
'alt' => new lang_string('cfg_iconalt_rightarrow', 'auth_oidc'),
'component' => 'moodle',
],
];
$settings->add(new auth_oidc_admin_setting_iconselect('auth_oidc/icon',
get_string('cfg_icon_key', 'auth_oidc'), get_string('cfg_icon_desc', 'auth_oidc'), 'auth_oidc:o365', $icons));
// Custom icon.
$configkey = new lang_string('cfg_customicon_key', 'auth_oidc');
$configdesc = new lang_string('cfg_customicon_desc', 'auth_oidc');
$customiconsetting = new admin_setting_configstoredfile('auth_oidc/customicon',
get_string('cfg_customicon_key', 'auth_oidc'), get_string('cfg_customicon_desc', 'auth_oidc'), 'customicon');
$customiconsetting->set_updatedcallback('auth_oidc_initialize_customicon');
$settings->add($customiconsetting);
// Debugging heading.
$settings->add(new admin_setting_heading('auth_oidc/debugging_heading',
get_string('heading_debugging', 'auth_oidc'), get_string('heading_debugging_desc', 'auth_oidc')));
// Record debugging messages.
$settings->add(new admin_setting_configcheckbox('auth_oidc/debugmode',
get_string('cfg_debugmode_key', 'auth_oidc'), get_string('cfg_debugmode_desc', 'auth_oidc'), '0'));
$ADMIN->add('oidcfolder', $settings);
// Cleanup OIDC tokens page.
$ADMIN->add('oidcfolder', new admin_externalpage('auth_oidc_cleanup_oidc_tokens',
get_string('settings_page_cleanup_oidc_tokens', 'auth_oidc'), new moodle_url('/auth/oidc/cleanupoidctokens.php')));
// Other settings page and its settings.
$fieldmappingspage = new admin_settingpage('auth_oidc_field_mapping', get_string('settings_page_field_mapping', 'auth_oidc'));
$ADMIN->add('oidcfolder', $fieldmappingspage);
// Display locking / mapping of profile fields.
$authplugin = get_auth_plugin('oidc');
auth_oidc_display_auth_lock_options($fieldmappingspage, $authplugin->authtype, $authplugin->userfields,
get_string('cfg_field_mapping_desc', 'auth_oidc'), true, false, $authplugin->get_custom_user_profile_fields());
}
$settings = null;