Test_B2c.php
13.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<?php
namespace Wpo\Tests;
use Wpo\Core\Extensions_Helpers;
use \Wpo\Core\WordPress_Helpers;
use \Wpo\Services\Id_Token_Service;
use \Wpo\Services\Options_Service;
use \Wpo\Services\Request_Service;
use \Wpo\Services\User_Service;
// Prevent public access to this script
defined('ABSPATH') or die();
if (!class_exists('\Wpo\Tests\Test_B2c')) {
class Test_B2c
{
private $id_token = null;
private $extensions = [];
public function __construct()
{
$extensions = Extensions_Helpers::get_extensions();
foreach ($extensions as $slug => $extension) {
if ($extension['activated']) {
$this->extensions[$slug] = $extension;
}
}
}
public function test_application_id()
{
$test_result = new Test_Result('Application ID has been configured', Test_Result::CAPABILITY_B2C_SSO, Test_Result::SEVERITY_BLOCKING);
$test_result->passed = true;
$application_id = Options_Service::get_aad_option('application_id');
if (empty($application_id)) {
$test_result->passed = false;
$test_result->message = "Application ID is not configured but needed for Azure AD B2C based Single Sign-On. Please copy the 'Application (Client) ID' from your Azure AD B2C App registration's 'Overview' page and paste it into the corresponding field on the <a href=\"#singleSignOn\">'Single Sign-on' tab</a>.";
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
} elseif (!preg_match('/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/', $application_id)) {
$test_result->passed = false;
$test_result->message = "Application ID is not a valid GUID but needed for Azure AD B2C based Single Sign-On. Please copy the 'Application (Client) ID' from your Azure AD App registration's 'Overview' page and paste it into the corresponding field on the <a href=\"#singleSignOn\">'Single Sign-on' tab</a>.";
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
}
return $test_result;
}
public function test_oidc_flow()
{
$oidc_flow = Options_Service::get_global_string_var('oidc_flow');
$test_result = new Test_Result('The OpenID Connect <strong>Authorization Code User Flow</strong> has been configured', Test_Result::CAPABILITY_B2C_SSO, Test_Result::SEVERITY_CRITICAL);
$test_result->passed = true;
if ($oidc_flow != 'code') {
$test_result->passed = false;
$test_result->message = "Starting with v18.0 it is recommended to configure the OpenID Connect <strong>Authorization Code User Flow</strong> in favor of the <strong>Hybrid User Flow</strong>. Please click the <em>Read more</em> link and consult the online documentation.";
$test_result->more_info = 'https://docs.wpo365.com/article/156-why-the-authorization-code-user-flow-is-now-recommended';
$test_result->fix = array(
array(
'op' => 'replace',
'value' => array(
'oidcFlow' => 'code',
),
),
);
return $test_result;
}
return $test_result;
}
public function test_application_secret()
{
// Only test for the application secret if the authorization code user flow has been configured
$oidc_flow = Options_Service::get_global_string_var('oidc_flow');
if ($oidc_flow != 'code') {
return;
}
$test_result = new Test_Result('Application (Client) Secret has been configured', Test_Result::CAPABILITY_B2C_SSO, Test_Result::SEVERITY_BLOCKING);
$test_result->passed = true;
$application_secret = Options_Service::get_aad_option('application_secret');
if (empty($application_secret)) {
$test_result->passed = false;
$test_result->message = "An <em>Application (Client) Secret</em> is needed for the selected <em>OpenID Connect Flow (Auth.-Code)</em> but the required Application (Client) Secret has not been configured (on the <a href=\"#singleSignOn\">Single Sign-on</a> tab). Please consult the online documentation using the link below.";
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
$this->delegated_access_token_test_result = $test_result;
return $test_result;
}
if (preg_match('/^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/', $application_secret)) {
$test_result->passed = false;
$test_result->message = 'Application (Client) Secret appears to be invalid. Possibly the secret\'s ID instead of its value has been copied from the corresonding page in Azure Portal.';
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
$this->application_access_token_test_result = $test_result;
return $test_result;
}
return $test_result;
}
public function test_redirect_url()
{
$test_result = new Test_Result('Redirect URL has been configured', Test_Result::CAPABILITY_B2C_SSO, Test_Result::SEVERITY_BLOCKING);
$test_result->passed = true;
$redirect_url = Options_Service::get_aad_option('redirect_url');
if (empty($redirect_url)) {
$test_result->passed = false;
$test_result->message = "The Redirect URL is not configured but needed for Azure AD B2C based Single Sign-On. Please copy the 'Redirect URI' from your Azure AD App registration's 'Authentication' page and paste it into the corresponding field on the plugin's <a href=\"#singleSignOn\">Single Sign-on</a> page.";
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
}
return $test_result;
}
public function test_decode_id_token()
{
delete_site_option('wpo365_msft_key');
delete_site_option('wpo365_msft_keys');
$test_result = new Test_Result('Can decode the ID token', Test_Result::CAPABILITY_B2C_SSO, Test_Result::SEVERITY_BLOCKING);
$test_result->passed = true;
Id_Token_Service::process_openidconnect_token(false);
$request_service = Request_Service::get_instance();
$request = $request_service->get_request($GLOBALS['WPO_CONFIG']['request_id']);
$this->id_token = $request->get_item('id_token');
if (empty($this->id_token)) {
$error_message = isset($_POST['error_description']) ? \sanitize_text_field($_POST['error_description']) : 'Could not process the ID token. Please check the <a href="#debug">debug log</a> for errors.';
if (false !== WordPress_Helpers::stripos($error_message, 'AADB2C90057')) {
$application_id = Options_Service::get_aad_option('application_id');
$error_message = 'It appears you have configured the (OpenID Connect) <strong>Hybrid flow</strong> on the <a href="#singleSignOn">Single Sign-on</a> page but did not allow for <em>Implicit grant and hybrid flows</em> by checking the corresponding options in Azure AD for the App registration with ID ' . $application_id . ' on the <em>Authentication</em> page.';
}
$test_result->passed = false;
$test_result->message = $error_message;
$test_result->more_info = '';
return $test_result;
}
$test_result->data = $this->id_token;
return $test_result;
}
public function test_id_token_contains_email()
{
$test_result = new Test_Result('ID token contains email address', Test_Result::CAPABILITY_B2C_SSO, Test_Result::SEVERITY_CRITICAL);
$test_result->passed = true;
if (empty($this->id_token)) {
$test_result->passed = false;
$test_result->message = 'ID token missing -> test skipped';
$test_result->more_info = '';
} elseif (empty($this->id_token->emails)) {
$test_result->passed = false;
$test_result->message = "ID token does not contain email address. Please update the user attributes and claims that you want to collect from the user during sign-up. See <a target=\"_blank\" href=\"https://docs.microsoft.com/en-us/azure/active-directory-b2c/tutorial-create-user-flows?pivots=b2c-user-flow\">this example</a> for guidance.";
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
}
return $test_result;
}
public function test_id_token_contains_given_name()
{
$test_result = new Test_Result('ID token contains first name', Test_Result::CAPABILITY_B2C_SSO, Test_Result::SEVERITY_LOW);
$test_result->passed = true;
if (empty($this->id_token)) {
$test_result->passed = false;
$test_result->message = 'ID token missing -> test skipped';
$test_result->more_info = '';
} elseif (empty($this->id_token->given_name)) {
$test_result->passed = false;
$test_result->message = "ID token does not contain first name (given_name). Please update the user attributes and claims that you want to collect from the user during sign-up. See <a target=\"_blank\" href=\"https://docs.microsoft.com/en-us/azure/active-directory-b2c/tutorial-create-user-flows?pivots=b2c-user-flow\">this example</a> for guidance.";
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
}
return $test_result;
}
public function test_id_token_contains_family_name()
{
$test_result = new Test_Result('ID token contains last name', Test_Result::CAPABILITY_B2C_SSO, Test_Result::SEVERITY_LOW);
$test_result->passed = true;
if (empty($this->id_token)) {
$test_result->passed = false;
$test_result->message = 'ID token missing -> test skipped';
$test_result->more_info = '';
} elseif (empty($this->id_token->family_name)) {
$test_result->passed = false;
$test_result->message = "ID token does not contain last name (family_name). Please update the user attributes and claims that you want to collect from the user during sign-up. See <a target=\"_blank\" href=\"https://docs.microsoft.com/en-us/azure/active-directory-b2c/tutorial-create-user-flows?pivots=b2c-user-flow\">this example</a> for guidance.";
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
}
return $test_result;
}
public function test_source_for_extra_fields()
{
// Check if suitable extensions can be found
$suitable_extensions = \array_flip(
array(
'wpo365-login-premium/wpo365-login.php',
'wpo365-login-intranet/wpo365-login.php',
'wpo365-login-professional/wpo365-login.php',
'wpo365-custom-fields/wpo365-custom-fields.php',
)
);
if (sizeof($this->extensions) === 0 || sizeof(\array_intersect_key($suitable_extensions, $this->extensions)) === 0) {
return;
}
$test_result = new Test_Result('Use ID token as source for custom user fields (instead of Microsoft Graph)', Test_Result::CAPABILITY_PROFILE_PLUS, Test_Result::SEVERITY_LOW);
$test_result->passed = true;
$extra_user_fields_source = Options_Service::get_global_string_var('extra_user_fields_source');
if (0 !== strcasecmp($extra_user_fields_source, 'idToken')) {
$test_result->passed = false;
$test_result->message = 'Starting with v18.0 it is recommended - when using Azure AD B2C - to select the ID token (and its custom claims) as source for extra user fields. This will prevent the plugin from trying to retrieve a user-resource from Microsoft Graph.';
$test_result->more_info = 'https://docs.wpo365.com/article/130-azure-ad-b2c-based-single-sign-on-for-wordpress';
$test_result->fix = array(
array(
'op' => 'replace',
'value' => array(
'extraUserFieldsSource' => 'idToken',
),
),
);
}
return $test_result;
}
public function test_end()
{
if (empty($this->id_token)) {
return;
}
$request_service = Request_Service::get_instance();
$this->request = $request_service->get_request($GLOBALS['WPO_CONFIG']['request_id']);
$this->request->set_item('wpo_usr', User_Service::user_from_b2c_id_token($this->id_token));
}
}
}