-
Notifications
You must be signed in to change notification settings - Fork 704
Expand file tree
/
Copy pathHTTP.php
More file actions
1293 lines (1114 loc) · 46.8 KB
/
Copy pathHTTP.php
File metadata and controls
1293 lines (1114 loc) · 46.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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
declare(strict_types=1);
namespace SimpleSAML\Utils;
use Exception;
use SimpleSAML\Configuration;
use SimpleSAML\Error;
use SimpleSAML\Logger;
use SimpleSAML\Module;
use SimpleSAML\Session;
use SimpleSAML\XHTML\Template;
use SimpleSAML\XMLSecurity\Alg\Encryption\AES;
use SimpleSAML\XMLSecurity\Constants as C;
use SimpleSAML\XMLSecurity\Key\SymmetricKey;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use function array_merge;
use function basename;
use function dirname;
use function is_string;
use function parse_url;
use function realpath;
use function rtrim;
use function str_replace;
use function str_starts_with;
use function strlen;
use function substr;
/**
* HTTP-related utility methods.
*
* @package SimpleSAMLphp
*/
class HTTP
{
protected Configuration $config;
/**
* Instantiate an HTTP Client
*
* https://github.com/symfony/symfony/blob/d1ebc450128b626d4b9822f6baf97f530eb3b4d1/src/Symfony/Contracts/HttpClient/HttpClientInterface.php#L26
*
* @param array $options See Symfony\Contracts\HttpClient\HttpClientInterface::OPTIONS_DEFAULTS for possible values
*/
public function createHttpClient(array $options = []): HttpClientInterface
{
$config = Configuration::getInstance();
$proxy = $config->getOptionalString('proxy', null);
if ($proxy !== null) {
$proxy = preg_replace('/^(tcp:\/\/)+/i', 'http://', $proxy);
$proxyAuth = $config->getOptionalString('proxy.auth', null);
if ($proxyAuth !== null) {
$scheme = parse_url($proxy, PHP_URL_SCHEME);
$proxy = str_replace($scheme . '://', $scheme . '://' . $proxyAuth . '@', $proxy);
}
$proxy = ['proxy' => $proxy];
$options = array_merge($proxy, $options);
}
return HttpClient::create($options);
}
/**
* Determine if the user agent can support cookies being sent with SameSite equal to "None".
* Browsers without support may drop the cookie and or treat it as stricter setting
* Browsers with support may have additional requirements on setting it on non-secure websites.
*
* Based on the Azure teams experience rolling out support and Chromium's advice
* https://devblogs.microsoft.com/aspnet/upcoming-samesite-cookie-changes-in-asp-net-and-asp-net-core/
* https://www.chromium.org/updates/same-site/incompatible-clients
* @return bool true if user agent supports a None value for SameSite.
*/
public function canSetSameSiteNone(): bool
{
$useragent = $_SERVER['HTTP_USER_AGENT'] ?? null;
if (!$useragent) {
return true;
}
// All iOS 12 based browsers have no support
if (strpos($useragent, "CPU iPhone OS 12") !== false || strpos($useragent, "iPad; CPU OS 12") !== false) {
return false;
}
// Safari Mac OS X 10.14 has no support
// - Safari on Mac OS X.
if (strpos($useragent, "Macintosh; Intel Mac OS X 10_14") !== false) {
// regular safari
if (strpos($useragent, "Version/") !== false && strpos($useragent, "Safari") !== false) {
return false;
} elseif (preg_match('|AppleWebKit/[\.\d]+ \(KHTML, like Gecko\)$|', $useragent)) {
return false;
}
}
// Chrome based UCBrowser may have support (>= 12.13.2) even though its chrome version is old
$matches = [];
if (preg_match('|UCBrowser/(\d+\.\d+\.\d+)[\.\d]*|', $useragent, $matches)) {
return version_compare($matches[1], '12.13.2', '>=');
}
// Chrome 50-69 may have broken SameSite=None and don't require it to be set
if (strpos($useragent, "Chrome/5") !== false || strpos($useragent, "Chrome/6") !== false) {
return false;
}
return true;
}
/**
* Obtain a URL where we can redirect to securely post a form with the given data to a specific destination.
*
* @param string $destination The destination URL.
* @param array $data An associative array containing the data to be posted to $destination.
*
* @throws \SimpleSAML\Error\Exception If the current session is transient.
* @return string A URL which allows to securely post a form to $destination.
*
*/
private function getSecurePOSTRedirectURL(string $destination, array $data): string
{
$session = Session::getSessionFromRequest();
$id = $this->savePOSTData($session, $destination, $data);
if ($session->isTransient()) {
// this is a transient session, it is pointless to continue
throw new Error\Exception('Cannot save POST data to a transient session.');
}
/** @var string $session_id */
$session_id = $session->getSessionId();
// encrypt the session ID and the random ID
$symmetricKey = new SymmetricKey((new Config())->getSecretSalt());
$encryptor = new AES($symmetricKey, C::BLOCK_ENC_AES256_GCM);
$info = base64_encode($encryptor->encrypt($session_id . ':' . $id));
$url = Module::getModuleURL('core/postredirect', ['RedirInfo' => $info]);
return preg_replace('#^https:#', 'http:', $url);
}
/**
* Retrieve Host value from $_SERVER environment variables.
*
* @return string The current host name, including the port if needed. It will use localhost when unable to
* determine the current host.
*
*/
private function getServerHost(): string
{
$current = null;
if (array_key_exists('HTTP_HOST', $_SERVER)) {
$current = $_SERVER['HTTP_HOST'];
} elseif (array_key_exists('SERVER_NAME', $_SERVER)) {
$current = $_SERVER['SERVER_NAME'];
}
if (is_null($current)) {
// almost certainly not what you want, but...
$current = 'localhost';
}
if (strstr($current, ":")) {
$decomposed = explode(":", $current);
$port = array_pop($decomposed);
if (!is_numeric($port)) {
array_push($decomposed, $port);
}
$current = implode(":", $decomposed);
}
return $current;
}
/**
* Retrieve HTTPS status from $_SERVER environment variables.
*
* @return boolean True if the request was performed through HTTPS, false otherwise.
*
*/
public function getServerHTTPS(): bool
{
// When $_SERVER['HTTPS'] is set — by a web server that terminates
// TLS itself — it is the authoritative signal. Preserve the
// existing three-case interpretation exactly, so an admin's
// explicit 'off' (IIS convention) still wins.
if (array_key_exists('HTTPS', $_SERVER)) {
if ($_SERVER['HTTPS'] === 'off') {
return false;
}
return !empty($_SERVER['HTTPS']);
}
// $_SERVER['HTTPS'] is COMPLETELY ABSENT. This is the typical
// php-fpm case behind a TLS-terminating reverse proxy: nginx's
// stock fastcgi_params line `fastcgi_param HTTPS $https
// if_not_empty;` only sends the param when $https itself is
// non-empty, which only happens when nginx terminates TLS.
//
// Fall back to the admin-set baseurlpath. We trust it only when:
// (a) it is a full URL starting with https://, AND
// (b) its host exactly matches the current request's host.
//
// (a) restricts to deployments where the admin has explicitly
// declared an HTTPS deployment scheme (the maintainer-prescribed
// form for reverse-proxy setups, e.g. as in
// github.com/simplesamlphp/simplesamlphp/pull/795).
//
// (b) prevents a multi-host SimpleSAMLphp installation from
// over-promoting unrelated requests to HTTPS just because some
// virtual host the library knows about is configured for HTTPS.
//
// No client-controlled header is read at any point.
$cfg = Configuration::getInstance();
$baseURL = $cfg->getOptionalString('baseurlpath', null);
if (
$baseURL !== null
&& preg_match('#^https://([^/:]+)(?::([0-9]+))?#', $baseURL, $matches)
) {
$configuredHost = strtolower($matches[1]);
$currentHost = strtolower($this->getServerHost());
if ($configuredHost === $currentHost) {
Logger::debug(
"getServerHTTPS(): no \$_SERVER['HTTPS']; treating the request as HTTPS "
. "because the 'baseurlpath' host '" . $configuredHost
. "' matches the current host.",
);
return true;
}
Logger::debug(
"getServerHTTPS(): no \$_SERVER['HTTPS']; not treating the request as HTTPS "
. "because the 'baseurlpath' host '" . $configuredHost
. "' does not match the current host '" . $currentHost . "'.",
);
return false;
}
Logger::debug(
"getServerHTTPS(): no \$_SERVER['HTTPS'] and 'baseurlpath' is not a full https:// "
. "URL, so the request is not treated as HTTPS. If TLS is terminated at an upstream "
. "proxy, set 'baseurlpath' (or 'application.baseURL') to your full https:// URL.",
);
return false;
}
/**
* Retrieve the port number from $_SERVER environment variables.
*
* @return string The port number prepended by a colon, if it is different than the default port for the protocol
* (80 for HTTP, 443 for HTTPS), or an empty string otherwise.
*
*/
public function getServerPort(): string
{
$default_port = $this->getServerHTTPS() ? '443' : '80';
$port = isset($_SERVER['SERVER_PORT']) ? $_SERVER['SERVER_PORT'] : $default_port;
// Take care of edge-case where SERVER_PORT is an integer
$port = strval($port);
if ($port !== $default_port) {
return ':' . $port;
}
return '';
}
/**
* Verify that a given URL is valid.
*
* @param string $url The URL we want to verify.
*
* @return boolean True if the given URL is valid, false otherwise.
*/
public function isValidURL(string $url): bool
{
$url = filter_var($url, FILTER_VALIDATE_URL);
if ($url === false) {
return false;
}
$scheme = parse_url($url, PHP_URL_SCHEME);
if (is_string($scheme) && in_array(strtolower($scheme), ['http', 'https'], true)) {
return true;
}
return false;
}
/**
* This function redirects the user to the specified address using the "HTTP 303 See Other" redirection.
*
* The function will also generate a simple web page with a clickable link to the target page.
*
* @param string $url The URL we should redirect to. This URL may include query parameters. If this URL is a
* relative URL (starting with '/'), then it will be turned into an absolute URL by prefixing it with the
* absolute URL to the root of the website.
* @param string[] $parameters An array with extra query string parameters which should be appended to the URL. The
* name of the parameter is the array index. The value of the parameter is the value stored in the index. Both
* the name and the value will be urlencoded. If the value is NULL, then the parameter will be encoded as just
* the name, without a value.
*
* @throws \InvalidArgumentException If $url is not a string or is empty, or $parameters is not an array.
* @throws \SimpleSAML\Error\Exception If $url is not a valid HTTP URL.
*
*/
private function redirect(string $url, array $parameters = []): void
{
if (empty($url)) {
throw new \InvalidArgumentException('Invalid input parameters.');
}
if (!$this->isValidURL($url)) {
throw new Error\Exception('Invalid destination URL: ' . $url);
}
if (!empty($parameters)) {
$url = $this->addURLParameters($url, $parameters);
}
if (strlen($url) > 2048) {
Logger::warning('Redirecting to a URL longer than 2048 bytes.');
}
if (!headers_sent()) {
// set the location header
header('Location: ' . $url, true, 303);
// disable caching of this response
header('Pragma: no-cache');
header('Cache-Control: no-cache, no-store, must-revalidate');
}
// show a minimal web page with a clickable link to the URL
echo '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"';
echo ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n";
echo '<html xmlns="http://www.w3.org/1999/xhtml">' . "\n";
echo " <head>\n";
echo ' <meta http-equiv="content-type" content="text/html; charset=utf-8">' . "\n";
echo ' <meta http-equiv="refresh" content="0;URL=\'' . htmlspecialchars($url) . '\'">' . "\n";
echo " <title>Redirect</title>\n";
echo " </head>\n";
echo " <body>\n";
echo " <h1>Redirect</h1>\n";
echo ' <p>You were redirected to: <a id="redirlink" href="' . htmlspecialchars($url) . '">';
echo htmlspecialchars($url) . "</a>\n";
echo ' <script type="text/javascript">document.getElementById("redirlink").focus();</script>' . "\n";
echo " </p>\n";
echo " </body>\n";
echo '</html>';
// end script execution
if (!defined('SIMPLESAMLPHP_TEST_NOEXIT')) {
exit;
}
}
/**
* Save the given HTTP POST data and the destination where it should be posted to a given session.
*
* @param \SimpleSAML\Session $session The session where to temporarily store the data.
* @param string $destination The destination URL where the form should be posted.
* @param array $data An associative array with the data to be posted to $destination.
*
* @return string A random identifier that can be used to retrieve the data from the current session.
*
*/
private function savePOSTData(Session $session, string $destination, array $data): string
{
// generate a random ID to avoid replay attacks
$randomUtils = new Random();
$id = $randomUtils->generateID();
$postData = [
'post' => $data,
'url' => $destination,
];
// save the post data to the session, tied to the random ID
$session->setData('core_postdatalink', $id, $postData);
return $id;
}
/**
* Add one or more query parameters to the given URL.
*
* @param string $url The URL the query parameters should be added to.
* @param array $parameters The query parameters which should be added to the url. This should be an associative
* array.
*
* @return string The URL with the new query parameters.
* @throws \InvalidArgumentException If $url is not a string or $parameters is not an array.
*
*/
public function addURLParameters(string $url, array $parameters): string
{
$queryStart = strpos($url, '?');
if ($queryStart === false) {
$oldQuery = [];
$url .= '?';
} else {
$oldQuery = substr($url, $queryStart + 1);
if ($oldQuery === false) {
$oldQuery = [];
} else {
$oldQuery = $this->parseQueryString($oldQuery);
}
$url = substr($url, 0, $queryStart + 1);
}
$query = array_merge($oldQuery, $parameters);
$url .= http_build_query($query, '', '&');
return $url;
}
/**
* Check for session cookie, and show missing-cookie page if it is missing.
*
* @param string|null $retryURL The URL the user should access to retry the operation. Defaults to null.
*
* page telling about the missing cookie.
* @throws \InvalidArgumentException If $retryURL is neither a string nor null.
*
*/
public function checkSessionCookie(?string $retryURL = null): void
{
$session = Session::getSessionFromRequest();
if ($session->hasSessionCookie()) {
return;
}
// we didn't have a session cookie. Redirect to the no-cookie page
$url = Module::getModuleURL('core/error/nocookie');
if ($retryURL !== null) {
$url = $this->addURLParameters($url, ['retryURL' => $retryURL]);
}
$this->redirectTrustedURL($url);
}
/**
* Check if a URL is valid and is in our list of allowed URLs.
*
* @param string $url The URL to check.
* @param string[]|null $trustedSites An optional whitelist of domains. If none specified, the 'trusted.url.domains'
* configuration directive will be used.
*
* @return string The normalized URL itself if it is allowed. An empty string if the $url parameter is empty as
* defined by the empty() function.
* @throws \InvalidArgumentException If the URL is malformed.
* @throws \SimpleSAML\Error\Exception If the URL is not allowed by configuration.
*
*/
public function checkURLAllowed(string $url, ?array $trustedSites = null): string
{
if (empty($url)) {
return '';
}
$url = $this->normalizeURL($url);
if (!$this->isValidURL($url)) {
throw new Error\Exception('Invalid URL: ' . $url);
}
// get the white list of domains
if ($trustedSites === null) {
$trustedSites = Configuration::getInstance()->getOptionalArray('trusted.url.domains', null);
}
// validates the URL's host is among those allowed
if (is_array($trustedSites)) {
$components = parse_url($url);
$hostname = $components['host'];
// check for userinfo
if (
(isset($components['user'])
&& strpos($components['user'], '\\') !== false)
|| (isset($components['pass'])
&& strpos($components['pass'], '\\') !== false)
) {
throw new Error\Exception('Invalid URL: ' . $url);
}
// allow URLs with standard ports specified (non-standard ports must then be allowed explicitly)
if (
isset($components['port'])
&& (($components['scheme'] === 'http'
&& $components['port'] !== 80)
|| ($components['scheme'] === 'https'
&& $components['port'] !== 443))
) {
$hostname = $hostname . ':' . $components['port'];
}
$self_host = $this->getSelfHostWithNonStandardPort();
$trustedRegex = Configuration::getInstance()->getOptionalValue('trusted.url.regex', null);
$trusted = false;
if (!in_array($trustedRegex, [null, false])) {
// add self host to the white list
$trustedSites[] = preg_quote($self_host);
foreach ($trustedSites as $regex) {
// Add start and end delimiters.
$regex = "@^{$regex}$@";
if (preg_match($regex, $hostname)) {
$trusted = true;
break;
}
}
} else {
// add self host to the white list
$trustedSites[] = $self_host;
$trusted = in_array($hostname, $trustedSites, true);
}
// throw exception due to redirection to untrusted site
if (!$trusted) {
throw new Error\Exception('URL not allowed: ' . $url);
}
}
return $url;
}
/**
* Helper function to retrieve a file or URL with proxy support, also
* supporting proxy basic authorization..
*
* An exception will be thrown if we are unable to retrieve the data.
*
* @param string $url The path or URL we should fetch.
* @param array $context Extra context options. This parameter is optional.
* @param boolean $getHeaders Whether to also return response headers. Optional.
*
* @return string|array An array if $getHeaders is set, containing the data and the headers respectively; string
* otherwise.
* @throws \InvalidArgumentException If the input parameters are invalid.
* @throws \SimpleSAML\Error\Exception If the file or URL cannot be retrieved.
*/
#[\Deprecated('Use an HTTP client instead (see createHttpClient method)', '16-12-2025')]
public function fetch(string $url, array $context = [], bool $getHeaders = false)
{
$client = $this->createHttpClient($context);
$response = $client->request('GET', $url);
try {
$headers = $response->getHeaders();
/** @var string $data */
$data = $response->getContent();
// data and headers
if ($getHeaders) {
return [$data, $headers];
}
return $data;
} catch (Exception $e) {
throw new Error\Exception('Error fetching ' . var_export($url, true) . ':' . $e->getMessage());
}
}
/**
* This function parses the Accept-Language HTTP header and returns an associative array with each language and the
* score for that language. If a language includes a region, then the result will include both the language with
* the region and the language without the region.
*
* The returned array will be in the same order as the input.
*
* @return array An associative array with each language and the score for that language.
*
*/
public function getAcceptLanguage(): array
{
if (!array_key_exists('HTTP_ACCEPT_LANGUAGE', $_SERVER)) {
// no Accept-Language header, return an empty set
return [];
}
$languages = explode(',', strtolower($_SERVER['HTTP_ACCEPT_LANGUAGE']));
$ret = [];
foreach ($languages as $l) {
$opts = explode(';', $l);
$l = trim(array_shift($opts)); // the language is the first element
$q = 1.0;
// iterate over all options, and check for the quality option
foreach ($opts as $o) {
$o = explode('=', $o);
if (count($o) < 2) {
// skip option with no value
continue;
}
$name = trim($o[0]);
$value = trim($o[1]);
if ($name === 'q') {
$q = (float) $value;
}
}
// remove the old key to ensure that the element is added to the end
unset($ret[$l]);
// set the quality in the result
$ret[$l] = $q;
if (strpos($l, '-')) {
// the language includes a region part
// extract the language without the region
$l = explode('-', $l);
$l = $l[0];
// add this language to the result (unless it is defined already)
if (!array_key_exists($l, $ret)) {
$ret[$l] = $q;
}
}
}
return $ret;
}
/**
* Try to guess the base SimpleSAMLphp path from the current request.
*
* This method offers just a guess, so don't rely on it.
*
* @return string The guessed base path that should correspond to the root installation of SimpleSAMLphp.
*/
public function guessBasePath(): string
{
if (!array_key_exists('REQUEST_URI', $_SERVER) || !array_key_exists('SCRIPT_FILENAME', $_SERVER)) {
return '/';
}
$requestPath = (string) parse_url((string) $_SERVER['REQUEST_URI'], PHP_URL_PATH);
$scriptName = (string) ($_SERVER['SCRIPT_NAME'] ?? '');
if ($scriptName !== '' && basename($scriptName) === 'index.php') {
$basePath = str_replace(DIRECTORY_SEPARATOR, '/', dirname($scriptName));
return rtrim($basePath, '/') . '/';
}
// get the name of the current script
$path = explode(DIRECTORY_SEPARATOR, (string) $_SERVER['SCRIPT_FILENAME']);
$script = array_pop($path);
// get the portion of the URI up to the script, i.e.: /simplesaml/some/directory/script.php
if (!preg_match('#^/(?:[^/]+/)*' . $script . '#', $requestPath, $matches)) {
return '/';
}
$uri_s = explode('/', $matches[0]);
$file_s = explode(DIRECTORY_SEPARATOR, (string) $_SERVER['SCRIPT_FILENAME']);
// compare both arrays from the end, popping elements matching out of them
while ($uri_s[count($uri_s) - 1] === $file_s[count($file_s) - 1]) {
array_pop($uri_s);
array_pop($file_s);
}
// we are now left with the minimum part of the URI that does not match anything in the file system, use it
return join('/', $uri_s) . '/';
}
/**
* Retrieve the base URL of the SimpleSAMLphp installation. The URL will always end with a '/'. For example:
* https://idp.example.org/simplesaml/
*
* @return string The absolute base URL for the SimpleSAMLphp installation.
* @throws \SimpleSAML\Error\CriticalConfigurationError If 'baseurlpath' has an invalid format.
*
*/
public function getBaseURL(): string
{
$globalConfig = Configuration::getInstance();
$baseURL = $globalConfig->getOptionalString('baseurlpath', 'simplesaml/');
if (preg_match('#^https?://.*/?$#D', $baseURL, $matches)) {
// full URL in baseurlpath, override local server values
return rtrim($baseURL, '/') . '/';
} elseif (
(preg_match('#^/?([^/]?.*/)$#D', $baseURL, $matches))
|| (preg_match('#^\*(.*)/$#D', $baseURL, $matches))
|| ($baseURL === '')
) {
// get server values
$protocol = 'http';
$protocol .= ($this->getServerHTTPS()) ? 's' : '';
$protocol .= '://';
$hostname = $this->getServerHost();
$port = $this->getServerPort();
$path = $globalConfig->getBasePath();
return $protocol . $hostname . $port . $path;
} else {
/*
* Invalid 'baseurlpath'. We cannot recover from this, so throw a critical exception and try to be graceful
* with the configuration. Use a guessed base path instead of the one provided.
*/
$c = $globalConfig->toArray();
$c['baseurlpath'] = $this->guessBasePath();
throw new Error\CriticalConfigurationError(
'Invalid value for \'baseurlpath\' in config.php. Valid format is in the form: ' .
'[(http|https)://(hostname|fqdn)[:port]]/[path/to/simplesaml/]. It must end with a \'/\'.',
null,
$c,
);
}
}
/**
* Create a link which will POST data.
*
* @param string $destination The destination URL.
* @param array $data The name-value pairs which will be posted to the destination.
*
* @return string A URL which can be accessed to post the data.
* @throws \InvalidArgumentException If $destination is not a string or $data is not an array.
*
*/
public function getPOSTRedirectURL(string $destination, array $data): string
{
$config = Configuration::getInstance();
$allowed = $config->getOptionalBoolean('enable.http_post', false);
if ($allowed && preg_match("#^http:#", $destination) && $this->isHTTPS()) {
// we need to post the data to HTTP
$url = $this->getSecurePOSTRedirectURL($destination, $data);
} else {
// post the data directly
$session = Session::getSessionFromRequest();
$id = $this->savePOSTData($session, $destination, $data);
$url = Module::getModuleURL('core/postredirect', ['RedirId' => $id]);
}
return $url;
}
/**
* Retrieve our own host.
*
* E.g. www.example.com
*
* @return string The current host.
*/
public function getSelfHost(): string
{
$decomposed = explode(':', $this->getSelfHostWithNonStandardPort());
return array_shift($decomposed);
}
/**
* Retrieve our own host, including the port in case the it is not standard for the protocol in use. That is port
* 80 for HTTP and port 443 for HTTPS.
*
* E.g. www.example.com:8080
*
* @return string The current host, followed by a colon and the port number, in case the port is not standard for
* the protocol.
*/
public function getSelfHostWithNonStandardPort(): string
{
$url = $this->getBaseURL();
/** @var int<0, max>|false $colon getBaseURL() will always return a valid URL */
$colon = strpos($url, '://');
$start = $colon + 3;
$length = strcspn($url, '/', $start);
return substr($url, $start, $length);
}
/**
* Retrieve our own host together with the URL path. Please note this function will return the base URL for the
* current SP, as defined in the global configuration.
*
* @return string The current host (with non-default ports included) plus the URL path.
*/
public function getSelfHostWithPath(): string
{
$baseurl = explode("/", $this->getBaseURL());
$elements = array_slice($baseurl, 3 - count($baseurl), count($baseurl) - 4);
$path = implode("/", $elements);
return $this->getSelfHostWithNonStandardPort() . "/" . $path;
}
/**
* Retrieve the current URL using the base URL in the configuration, if possible.
*
* If the current request is being handled by SimpleSAMLphp's front controller, this method rebuilds the URL from
* the configured base path and the current request URI. If SimpleSAMLphp is being called from another
* application script, it returns that application's current request URL instead.
*
* Note that this method does NOT make use of the HTTP X-Forwarded-* set of headers.
*
* @return string The current URL, including query parameters.
*/
public function getSelfURL(): string
{
$cfg = Configuration::getInstance();
$requestUri = (string)($_SERVER['REQUEST_URI'] ?? '');
$requestPath = (string)parse_url($requestUri, PHP_URL_PATH);
$requestQuery = (string)parse_url($requestUri, PHP_URL_QUERY);
$requestFragment = (string)parse_url($requestUri, PHP_URL_FRAGMENT);
if (!$this->isSimpleSamlFrontControllerRequest($cfg)) {
return $this->buildExternalApplicationURL($cfg, $requestUri);
}
$basePath = $cfg->getBasePath();
$trimmedBasePath = rtrim($basePath, '/');
if ($requestPath === $trimmedBasePath) {
$suffix = '';
} elseif ($basePath === '/' || str_starts_with($requestPath, $basePath)) {
$suffix = ltrim(substr($requestPath, strlen($basePath)), '/');
} else {
return $this->buildExternalApplicationURL($cfg, $requestUri);
}
$url = $this->getBaseURL();
if ($suffix !== '') {
$url .= $suffix;
}
if ($requestQuery !== '') {
$url .= '?' . $requestQuery;
}
if ($requestFragment !== '') {
$url .= '#' . $requestFragment;
}
return $url;
}
/**
* Check if the current request is being handled by SimpleSAMLphp's front controller.
*/
private function isSimpleSamlFrontControllerRequest(Configuration $cfg): bool
{
if (!array_key_exists('SCRIPT_FILENAME', $_SERVER)) {
return false;
}
$currentScript = realpath((string) $_SERVER['SCRIPT_FILENAME']);
$frontController = realpath($cfg->getBaseDir() . 'public' . DIRECTORY_SEPARATOR . 'index.php');
return is_string($currentScript) && is_string($frontController) && $currentScript === $frontController;
}
/**
* Build a URL for requests handled by an embedding application instead of SimpleSAMLphp's front controller.
*/
private function buildExternalApplicationURL(Configuration $cfg, string $requestUri): string
{
$appcfg = $cfg->getOptionalConfigItem('application', null);
$appurl = ($appcfg !== null) ? $appcfg->getOptionalString('baseURL', null) : null;
if (!empty($appurl)) {
$protocol = (string) parse_url($appurl, PHP_URL_SCHEME);
$hostname = (string) parse_url($appurl, PHP_URL_HOST);
$portNum = parse_url($appurl, PHP_URL_PORT);
$port = !empty($portNum) ? ':' . $portNum : '';
} else {
$protocol = $this->getServerHTTPS() ? 'https' : 'http';
$hostname = $this->getServerHost();
$port = $this->getServerPort();
}
return $protocol . '://' . $hostname . $port . $requestUri;
}
/**
* Retrieve the current URL using the base URL in the configuration, containing the protocol, the host and
* optionally, the port number.
*
* @return string The current URL without path or query parameters.
*/
public function getSelfURLHost(): string
{
$url = $this->getSelfURL();
/** @var int<0, max>|false $colon getBaseURL() will always return a valid URL */
$colon = strpos($url, '://');
$start = $colon + 3;
$length = strcspn($url, '/', $start) + $start;
return substr($url, 0, $length);
}
/**
* Retrieve the current URL using the base URL in the configuration, without the query parameters.
*
* @return string The current URL, not including query parameters.
*/
public function getSelfURLNoQuery(): string
{
$url = $this->getSelfURL();
$pos = strpos($url, '?');
if (!$pos) {
return $url;
}
return substr($url, 0, $pos);
}
/**
* This function checks if we are using HTTPS as protocol.
*
* @return boolean True if the HTTPS is used, false otherwise.
*/
public function isHTTPS(): bool
{
return strpos($this->getSelfURL(), 'https://') === 0;
}
/**
* Normalizes a URL to an absolute URL and validate it. In addition to resolving the URL, this function makes sure
* that it is a link to an http or https site.
*
* @param string $url The relative URL.
*
* @return string An absolute URL for the given relative URL.
* @throws \InvalidArgumentException If $url is not a string or a valid URL.
*/
public function normalizeURL(string $url): string
{
$url = $this->resolveURL($url, $this->getSelfURL());
// verify that the URL is to a http or https site
if (!preg_match('@^https?://@i', $url)) {
throw new \InvalidArgumentException('Invalid URL: ' . $url);
}
return $url;
}
/**
* Parse a query string into an array.
*
* This function parses a query string into an array, similar to the way the builtin 'parse_str' works, except it
* doesn't handle arrays, and it doesn't do "magic quotes".
*
* Query parameters without values will be set to an empty string.
*
* @param string $query_string The query string which should be parsed.
*
* @return array The query string as an associative array.
* @throws \InvalidArgumentException If $query_string is not a string.
*/
public function parseQueryString(string $query_string): array
{
$res = [];
if (empty($query_string)) {
return $res;
}
foreach (explode('&', $query_string) as $param) {
$param = explode('=', $param);
$name = urldecode($param[0]);