1
|
|
|
<?php |
2
|
|
|
namespace garethp\ews\API; |
3
|
|
|
|
4
|
|
|
use garethp\ews\API; |
5
|
|
|
use garethp\ews\API\Exception\AutodiscoverFailed; |
6
|
|
|
use garethp\HttpPlayback\Client; |
7
|
|
|
use garethp\HttpPlayback\Factory; |
8
|
|
|
|
9
|
|
|
class ExchangeAutodiscover |
10
|
|
|
{ |
11
|
|
|
protected $autodiscoverPath = '/autodiscover/autodiscover.xml'; |
12
|
|
|
|
13
|
|
|
/** |
14
|
|
|
* @var Client |
15
|
|
|
*/ |
16
|
|
|
protected $httpPlayback; |
17
|
|
|
|
18
|
2 |
|
protected function __construct() |
19
|
|
|
{ |
20
|
2 |
|
} |
21
|
|
|
|
22
|
|
|
/** |
23
|
|
|
* Parse the hex ServerVersion value and return a valid |
24
|
|
|
* ExchangeWebServices::VERSION_* constant. |
25
|
|
|
* |
26
|
|
|
* @param $versionHex |
27
|
|
|
* @return string|boolean A known version constant, or FALSE if it could not |
28
|
|
|
* be determined. |
29
|
|
|
* |
30
|
|
|
* @link http://msdn.microsoft.com/en-us/library/bb204122(v=exchg.140).aspx |
31
|
|
|
* @link http://blogs.msdn.com/b/pcreehan/archive/2009/09/21/parsing-serverversion-when-an-int-is-really-5-ints.aspx |
32
|
|
|
*/ |
33
|
3 |
|
protected function parseServerVersion($versionHex) |
34
|
|
|
{ |
35
|
|
|
//Convert from hex to binary |
36
|
3 |
|
$versionBinary = base_convert($versionHex, 16, 2); |
37
|
3 |
|
$versionBinary = str_pad($versionBinary, 32, "0", STR_PAD_LEFT); |
38
|
|
|
|
39
|
|
|
//Get the relevant parts of the binary and convert them to base 10 |
40
|
3 |
|
$majorVersion = base_convert(substr($versionBinary, 4, 6), 2, 10); |
41
|
3 |
|
$minorVersion = base_convert(substr($versionBinary, 10, 6), 2, 10); |
42
|
3 |
|
$buildVersion = base_convert(substr($versionBinary, 17, 15), 2, 10); |
43
|
|
|
|
44
|
3 |
|
if ($majorVersion >= 15) { |
45
|
2 |
|
return $this->parseVersionAfter2013($majorVersion, $minorVersion, $buildVersion); |
46
|
|
|
} |
47
|
|
|
|
48
|
1 |
|
return $this->parseVersionBefore2013($majorVersion, $minorVersion); |
49
|
|
|
} |
50
|
|
|
|
51
|
|
|
/** |
52
|
|
|
* @param string $email |
53
|
|
|
* @param string $password |
54
|
|
|
* @param string $username |
55
|
|
|
* @param array $options |
56
|
|
|
* |
57
|
|
|
* @return API |
58
|
|
|
* @throws AutodiscoverFailed |
59
|
|
|
*/ |
60
|
2 |
|
protected function newAPI($email, $password, $username = null, $options = []) |
61
|
|
|
{ |
62
|
2 |
|
$username = $username ?: $email; |
63
|
2 |
|
$options = array_replace_recursive([ |
64
|
|
|
'httpPlayback' => [ |
65
|
|
|
'mode' => null |
66
|
2 |
|
] |
67
|
2 |
|
], $options); |
68
|
|
|
|
69
|
2 |
|
$this->httpPlayback = Factory::getInstance($options['httpPlayback']); |
70
|
|
|
|
71
|
2 |
|
$settings = $this->discover($email, $password, $username); |
72
|
1 |
|
$server = $this->getServerFromResponse($settings); |
73
|
1 |
|
$version = $this->getServerVersionFromResponse($settings); |
74
|
|
|
|
75
|
1 |
|
$options = []; |
76
|
1 |
|
if ($version) { |
77
|
1 |
|
$options['version'] = $version; |
78
|
1 |
|
} |
79
|
|
|
|
80
|
1 |
|
return API::withUsernameAndPassword($server, $email, $password, $options); |
81
|
|
|
} |
82
|
|
|
|
83
|
1 |
|
protected function getServerVersionFromResponse($response) |
84
|
|
|
{ |
85
|
|
|
// Pick out the host from the EXPR (Exchange RPC over HTTP). |
86
|
1 |
|
foreach ($response['Account']['Protocol'] as $protocol) { |
87
|
1 |
|
if (($protocol['Type'] == 'EXCH' || $protocol['Type'] == 'EXPR') |
88
|
1 |
|
&& isset($protocol['ServerVersion']) |
89
|
1 |
|
) { |
90
|
1 |
|
return $this->parseServerVersion($protocol['ServerVersion']); |
91
|
|
|
} |
92
|
|
|
} |
93
|
|
|
|
94
|
|
|
return false; |
95
|
|
|
} |
96
|
|
|
|
97
|
1 |
|
protected function getServerFromResponse($response) |
98
|
|
|
{ |
99
|
1 |
|
foreach ($response['Account']['Protocol'] as $protocol) { |
100
|
1 |
|
if ($protocol['Type'] == 'EXPR' && isset($protocol['Server'])) { |
101
|
1 |
|
return $protocol['Server']; |
102
|
|
|
} |
103
|
1 |
|
} |
104
|
|
|
|
105
|
|
|
throw new AutodiscoverFailed(); |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
/** |
109
|
|
|
* Static method may fail if there are issues surrounding SSL certificates. |
110
|
|
|
* In such cases, set up the object as needed, and then call newEWS(). |
111
|
|
|
* |
112
|
|
|
* @param string $email |
113
|
|
|
* @param string $password |
114
|
|
|
* @param string $username If left blank, the email provided will be used. |
115
|
|
|
* @throws AutodiscoverFailed |
116
|
|
|
* @return API |
117
|
|
|
*/ |
118
|
2 |
|
public static function getAPI($email, $password, $username = null, $options = []) |
119
|
|
|
{ |
120
|
2 |
|
$auto = new static(); |
121
|
|
|
|
122
|
2 |
|
return $auto->newAPI($email, $password, $username, $options); |
123
|
|
|
} |
124
|
|
|
|
125
|
|
|
/** |
126
|
|
|
* Execute the full discovery chain of events in the correct sequence |
127
|
|
|
* until a valid response is received, or all methods have failed. |
128
|
|
|
* |
129
|
|
|
* @param string $email |
130
|
|
|
* @param string $password |
131
|
|
|
* @param string $username |
132
|
|
|
* @return string The discovered settings |
133
|
|
|
* @throws AutodiscoverFailed |
134
|
|
|
*/ |
135
|
2 |
|
protected function discover($email, $password, $username) |
136
|
|
|
{ |
137
|
2 |
|
$result = $this->tryTopLevelDomain($email, $password, $username); |
138
|
|
|
|
139
|
2 |
|
if ($result === false) { |
140
|
2 |
|
$result = $this->tryAutoDiscoverSubDomain($email, $password, $username); |
141
|
2 |
|
} |
142
|
|
|
|
143
|
2 |
|
if ($result === false) { |
144
|
2 |
|
$result = $this->trySubdomainUnauthenticatedGet($email, $password, $username); |
145
|
2 |
|
} |
146
|
|
|
|
147
|
2 |
|
if ($result === false) { |
148
|
1 |
|
$result = $this->trySRVRecord($email, $password, $username); |
149
|
1 |
|
} |
150
|
|
|
|
151
|
2 |
|
if ($result === false) { |
152
|
1 |
|
throw new AutodiscoverFailed(); |
153
|
|
|
} |
154
|
|
|
|
155
|
1 |
|
return $result; |
156
|
|
|
} |
157
|
|
|
|
158
|
|
|
/** |
159
|
|
|
* Perform an NTLM authenticated HTTPS POST to the top-level |
160
|
|
|
* domain of the email address. |
161
|
|
|
* |
162
|
|
|
* @param string $email |
163
|
|
|
* @param string $password |
164
|
|
|
* @param string $username |
165
|
|
|
* |
166
|
|
|
* @return string The discovered settings |
167
|
|
|
*/ |
168
|
2 |
View Code Duplication |
protected function tryTopLevelDomain($email, $password, $username) |
169
|
|
|
{ |
170
|
2 |
|
$topLevelDomain = $this->getTopLevelDomainFromEmail($email); |
171
|
2 |
|
$url = 'https://www.'.$topLevelDomain.$this->autodiscoverPath; |
172
|
|
|
|
173
|
2 |
|
return $this->doNTLMPost($url, $email, $password, $username); |
174
|
|
|
} |
175
|
|
|
|
176
|
|
|
/** |
177
|
|
|
* Perform an NTLM authenticated HTTPS POST to the 'autodiscover' |
178
|
|
|
* subdomain of the email address' TLD. |
179
|
|
|
* |
180
|
|
|
* @param string $email |
181
|
|
|
* @param string $password |
182
|
|
|
* @param string $username |
183
|
|
|
* |
184
|
|
|
* @return string The discovered settings |
185
|
|
|
*/ |
186
|
2 |
View Code Duplication |
protected function tryAutoDiscoverSubDomain($email, $password, $username) |
187
|
|
|
{ |
188
|
2 |
|
$topLevelDomain = $this->getTopLevelDomainFromEmail($email); |
189
|
2 |
|
$url = 'https://autodiscover.'.$topLevelDomain.$this->autodiscoverPath; |
190
|
|
|
|
191
|
2 |
|
return $this->doNTLMPost($url, $email, $password, $username); |
192
|
|
|
} |
193
|
|
|
|
194
|
|
|
/** |
195
|
|
|
* Perform an unauthenticated HTTP GET in an attempt to get redirected |
196
|
|
|
* via 302 to the correct location to perform the HTTPS POST. |
197
|
|
|
* |
198
|
|
|
* @param string $email |
199
|
|
|
* @param string $password |
200
|
|
|
* @param string $username |
201
|
|
|
* |
202
|
|
|
* @return string The discovered settings |
203
|
|
|
*/ |
204
|
2 |
|
protected function trySubdomainUnauthenticatedGet($email, $password, $username) |
205
|
|
|
{ |
206
|
2 |
|
$topLevelDomain = $this->getTopLevelDomainFromEmail($email); |
207
|
|
|
|
208
|
2 |
|
$url = 'http://autodiscover.'.$topLevelDomain.$this->autodiscoverPath; |
209
|
|
|
|
210
|
|
|
$postOptions = [ |
211
|
2 |
|
'timeout' => 2, |
212
|
2 |
|
'allow_redirects' => false, |
213
|
|
|
'headers' => [ |
214
|
|
|
'Content-Type' => 'text/xml; charset=utf-8' |
215
|
2 |
|
], |
216
|
2 |
|
'curl' => [] |
217
|
2 |
|
]; |
218
|
|
|
|
219
|
|
|
try { |
220
|
2 |
|
$response = $this->httpPlayback->get($url, $postOptions); |
221
|
|
|
|
222
|
1 |
|
if ($response->getStatusCode() == 301 || $response->getStatusCode() == 302) { |
223
|
1 |
|
return $this->doNTLMPost($response->getHeaderLine('Location'), $email, $password, $username); |
224
|
|
|
} |
225
|
1 |
|
} catch (\Exception $e) { |
226
|
|
|
} |
227
|
|
|
|
228
|
1 |
|
return false; |
229
|
|
|
} |
230
|
|
|
|
231
|
|
|
/** |
232
|
|
|
* Attempt to retrieve the autodiscover host from an SRV DNS record. |
233
|
|
|
* |
234
|
|
|
* @link http://support.microsoft.com/kb/940881 |
235
|
|
|
* |
236
|
|
|
* @param string $email |
237
|
|
|
* @param string $password |
238
|
|
|
* @param string $username |
239
|
|
|
* |
240
|
|
|
* @return string The discovered settings |
241
|
|
|
*/ |
242
|
1 |
|
protected function trySRVRecord($email, $password, $username) |
243
|
|
|
{ |
244
|
1 |
|
$topLevelDomain = $this->getTopLevelDomainFromEmail($email); |
245
|
1 |
|
$srvHost = '_autodiscover._tcp.'.$topLevelDomain; |
246
|
1 |
|
$lookup = dns_get_record($srvHost, DNS_SRV); |
247
|
1 |
|
if (sizeof($lookup) > 0) { |
248
|
|
|
$host = $lookup[0]['target']; |
249
|
|
|
$url = 'https://'.$host.$this->autodiscoverPath; |
250
|
|
|
|
251
|
|
|
return $this->doNTLMPost($url, $email, $password, $username); |
252
|
|
|
} |
253
|
|
|
|
254
|
1 |
|
return false; |
255
|
|
|
} |
256
|
|
|
|
257
|
|
|
/** |
258
|
|
|
* Perform the NTLM authenticated post against one of the chosen |
259
|
|
|
* endpoints. |
260
|
|
|
* |
261
|
|
|
* @param string $url URL to try posting to |
262
|
|
|
* @param string $email |
263
|
|
|
* @param string $password |
264
|
|
|
* @param string $username |
265
|
|
|
* |
266
|
|
|
* @return string The discovered settings |
267
|
|
|
*/ |
268
|
2 |
|
protected function doNTLMPost($url, $email, $password, $username) |
269
|
|
|
{ |
270
|
|
|
$autodiscoverXml = <<<XML |
271
|
|
|
<?xml version="1.0" encoding="UTF-8"?> |
272
|
|
|
<Autodiscover xmlns="http://schemas.microsoft.com/exchange/autodiscover/outlook/requestschema/2006"> |
273
|
|
|
<Request> |
274
|
|
|
<EMailAddress>$email</EMailAddress> |
275
|
|
|
<AcceptableResponseSchema>http://schemas.microsoft.com/exchange/autodiscover/outlook/responseschema/2006a</AcceptableResponseSchema> |
276
|
|
|
</Request> |
277
|
2 |
|
</Autodiscover> |
278
|
2 |
|
XML; |
279
|
|
|
$postOptions = [ |
280
|
2 |
|
'body' => $autodiscoverXml, |
281
|
2 |
|
'timeout' => 2, |
282
|
2 |
|
'allow_redirects' => true, |
283
|
|
|
'headers' => [ |
284
|
|
|
'Content-Type' => 'text/xml; charset=utf-8' |
285
|
2 |
|
], |
286
|
2 |
|
'curl' => [], |
287
|
|
|
'verify' => false |
288
|
2 |
|
]; |
289
|
2 |
|
$auth = ExchangeWebServicesAuth::fromUsernameAndPassword($username, $password); |
290
|
2 |
|
$postOptions = array_replace_recursive($postOptions, $auth); |
291
|
|
|
|
292
|
|
|
try { |
293
|
2 |
|
$response = $this->httpPlayback->post($url, $postOptions); |
294
|
2 |
|
} catch (\Exception $e) { |
295
|
2 |
|
return false; |
296
|
|
|
} |
297
|
|
|
|
298
|
1 |
|
return $this->parseAutodiscoverResponse($response->getBody()->__toString()); |
299
|
|
|
} |
300
|
|
|
|
301
|
|
|
/** |
302
|
|
|
* Parse the Autoresponse Payload, particularly to determine if an |
303
|
|
|
* additional request is necessary. |
304
|
|
|
* |
305
|
|
|
* @param $response |
306
|
|
|
* @return array|bool |
307
|
|
|
* @throws AutodiscoverFailed |
308
|
|
|
*/ |
309
|
1 |
|
protected function parseAutodiscoverResponse($response) |
310
|
|
|
{ |
311
|
|
|
// Content-type isn't trustworthy, unfortunately. Shame on Microsoft. |
312
|
1 |
|
if (substr($response, 0, 5) !== '<?xml') { |
313
|
|
|
throw new AutodiscoverFailed(); |
314
|
|
|
} |
315
|
|
|
|
316
|
1 |
|
$response = $this->responseToArray($response); |
317
|
|
|
|
318
|
1 |
|
if (isset($response['Error'])) { |
319
|
|
|
return false; |
320
|
|
|
} |
321
|
|
|
|
322
|
1 |
|
$action = $response['Account']['Action']; |
323
|
1 |
|
if ($action == 'redirectUrl' || $action == 'redirectAddr') { |
324
|
|
|
return false; |
325
|
|
|
} |
326
|
|
|
|
327
|
1 |
|
return $response; |
328
|
|
|
} |
329
|
|
|
|
330
|
|
|
/** |
331
|
|
|
* Get a top level domain based on an email address |
332
|
|
|
* |
333
|
|
|
* @param string $email |
334
|
|
|
* @return string|false |
335
|
|
|
*/ |
336
|
2 |
|
protected function getTopLevelDomainFromEmail($email) |
337
|
|
|
{ |
338
|
2 |
|
$pos = strpos($email, '@'); |
339
|
2 |
|
if ($pos !== false) { |
340
|
1 |
|
return trim(substr($email, $pos + 1)); |
341
|
|
|
} |
342
|
|
|
|
343
|
1 |
|
return false; |
344
|
|
|
} |
345
|
|
|
|
346
|
|
|
/** |
347
|
|
|
* Utility function to parse XML payloads from the response into easier |
348
|
|
|
* to manage associative arrays. |
349
|
|
|
* |
350
|
|
|
* @param string $xml XML to parse |
351
|
|
|
* @return array |
352
|
|
|
*/ |
353
|
1 |
|
protected function responseToArray($xml) |
354
|
|
|
{ |
355
|
1 |
|
$xml = simplexml_load_string($xml, "SimpleXMLElement", LIBXML_NOCDATA); |
356
|
|
|
|
357
|
1 |
|
return json_decode(json_encode($xml), true)['Response']; |
358
|
|
|
} |
359
|
|
|
|
360
|
|
|
/** |
361
|
|
|
* @param $majorVersion |
362
|
|
|
* @param $minorVersion |
363
|
|
|
* @return bool|mixed |
364
|
|
|
*/ |
365
|
1 |
|
protected function parseVersionBefore2013($majorVersion, $minorVersion) |
366
|
|
|
{ |
367
|
|
|
$versions = [ |
368
|
|
|
8 => [ |
369
|
1 |
|
'name' => 'VERSION_2007', |
370
|
|
|
'spCount' => 3 |
371
|
1 |
|
], |
372
|
|
|
14 => [ |
373
|
1 |
|
'name' => 'VERSION_2010', |
374
|
|
|
'spCount' => 3 |
375
|
1 |
|
] |
376
|
1 |
|
]; |
377
|
|
|
|
378
|
1 |
|
if (!isset($versions[$majorVersion])) { |
379
|
|
|
return false; |
380
|
|
|
} |
381
|
|
|
|
382
|
1 |
|
$constant = $versions[$majorVersion]['name']; |
383
|
1 |
|
if ($minorVersion > 0 && $minorVersion <= $versions[$majorVersion]['spCount']) { |
384
|
|
|
$constant .= "_SP$minorVersion"; |
385
|
|
|
} |
386
|
|
|
|
387
|
1 |
|
return constant(ExchangeWebServices::class . "::$constant"); |
388
|
|
|
} |
389
|
|
|
|
390
|
2 |
|
protected function parseVersionAfter2013($majorVersion, $minorVersion, $buildVersion) |
|
|
|
|
391
|
|
|
{ |
392
|
2 |
|
if ($minorVersion >= 1) { |
393
|
1 |
|
return ExchangeWebServices::VERSION_2016; |
394
|
|
|
} |
395
|
|
|
|
396
|
1 |
|
return $buildVersion == 847 ? ExchangeWebServices::VERSION_2013_SP1 : ExchangeWebServices::VERSION_2013; |
397
|
|
|
} |
398
|
|
|
} |
399
|
|
|
|
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.