functions.php 29.7 KB
Newer Older
1
2
3
4
5
6
7
8
<?php // Copyright (c) 2015, SWITCH

/*
******************************************************************************
This file contains common functions of the SWITCHwayf
******************************************************************************
*/

9
10
11
12
13
14
15
16
17
18
19
20
// Initilizes default configuration options if they were not set already
function initConfigOptions(){
	global $defaultLanguage;
	global $commonDomain;
	global $cookieNamePrefix;
	global $redirectCookieName;
	global $redirectStateCookieName;
	global $SAMLDomainCookieName;
	global $SPCookieName;
	global $cookieSecurity;
	global $cookieValidity;
	global $showPermanentSetting;
21
	global $useImprovedDropDownList;
haemmer's avatar
haemmer committed
22
	global $disableRemoteLogos;
23
24
25
26
27
28
29
30
31
32
33
34
35
	global $useSAML2Metadata;
	global $SAML2MetaOverLocalConf;
	global $includeLocalConfEntries;
	global $enableDSReturnParamCheck;
	global $useACURLsForReturnParamCheck;
	global $useKerberos;
	global $useReverseDNSLookup;
	global $useEmbeddedWAYF;
	global $useEmbeddedWAYFPrivacyProtection;
	global $useEmbeddedWAYFRefererForPrivacyProtection;
	global $useLogging;
	global $exportPreselectedIdP;
	global $federationName;
36
	global $supportContactEmail;
37
	global $federationURL;
haemmer's avatar
haemmer committed
38
39
40
41
	global $organizationURL;
	global $faqURL;
	global $helpURL;
	global $privacyURL;
42
43
44
45
46
	global $imageURL;
	global $javascriptURL;
	global $cssURL;
	global $logoURL;
	global $smallLogoURL;
haemmer's avatar
haemmer committed
47
	global $organizationLogoURL;
48
49
50
51
52
53
54
55
	global $IDPConfigFile;
	global $backupIDPConfigFile;
	global $metadataFile;
	global $metadataIDPFile;
	global $metadataSPFile;
	global $metadataLockFile;
	global $WAYFLogFile;
	global $kerberosRedirectURL;
haemmer's avatar
haemmer committed
56
	global $instanceIdentifier;
57
58
	global $developmentMode;
	
haemmer's avatar
haemmer committed
59
	
60
61
	// Set independet default configuration options
	$defaults = array();
62
	$defaults['instanceIdentifier'] = 'SWITCHwayf';
63
	$defaults['defaultLanguage'] = 'en'; 
haemmer's avatar
haemmer committed
64
	$defaults['commonDomain'] = getTopLevelDomain($_SERVER['SERVER_NAME']);
65
66
67
68
	$defaults['cookieNamePrefix'] = '';
	$defaults['cookieSecurity'] = false;
	$defaults['cookieValidity'] = 100;
	$defaults['showPermanentSetting'] = false;
69
	$defaults['useImprovedDropDownList'] = true;
haemmer's avatar
haemmer committed
70
	$defaults['disableRemoteLogos'] = false;
haemmer's avatar
haemmer committed
71
	$defaults['useSAML2Metadata'] = false; 
72
73
74
75
76
77
78
79
80
81
82
	$defaults['SAML2MetaOverLocalConf'] = false;
	$defaults['includeLocalConfEntries'] = true;
	$defaults['enableDSReturnParamCheck'] = true;
	$defaults['useACURLsForReturnParamCheck'] = false;
	$defaults['useKerberos'] = false;
	$defaults['useReverseDNSLookup'] = false;
	$defaults['useEmbeddedWAYF'] = false;
	$defaults['useEmbeddedWAYFPrivacyProtection'] = false;
	$defaults['useEmbeddedWAYFRefererForPrivacyProtection'] = false;
	$defaults['useLogging'] = true; 
	$defaults['exportPreselectedIdP'] = false;
haemmer's avatar
haemmer committed
83
84
85
86
87
88
89
	$defaults['federationName'] = 'Identity Federation';
	$defaults['organizationURL'] = 'http://www.'.$defaults['commonDomain'];
	$defaults['federationURL'] = $defaults['organizationURL'].'/aai';
	$defaults['faqURL'] = $defaults['federationURL'].'/faq';
	$defaults['helpURL'] = $defaults['federationURL'].'/help';
	$defaults['privacyURL'] = $defaults['federationURL'].'/privacy';
	$defaults['supportContactEmail'] = 'support-contact@'.$defaults['commonDomain'];
90
91
92
93
94
95
96
97
	$defaults['imageURL'] = 'https://'.$_SERVER['SERVER_NAME'].dirname($_SERVER['SCRIPT_NAME']).'/images';
	$defaults['javascriptURL'] = 'https://'.$_SERVER['SERVER_NAME'].dirname($_SERVER['SCRIPT_NAME']).'/js';
	$defaults['cssURL'] = 'https://'.$_SERVER['SERVER_NAME'].dirname($_SERVER['SCRIPT_NAME']).'/css';
	$defaults['IDPConfigFile'] = 'IDProvider.conf.php';
	$defaults['backupIDPConfigFile'] = 'IDProvider.conf.php';
	$defaults['metadataFile'] = '/etc/shibboleth/metadata.switchaai.xml';
	$defaults['metadataIDPFile'] = 'IDProvider.metadata.php';
	$defaults['metadataSPFile'] = 'SProvider.metadata.php';
98
99
	$lockFileName = preg_replace('/[^-_\.a-zA-Z]/', '', $defaults['instanceIdentifier']);
	$defaults['metadataLockFile'] = (substr($_SERVER['PATH'],0,1) == '/') ? '/tmp/wayf_metadata-'.$lockFileName.'.lock' : 'C:\windows\TEMP\wayf_metadata-'.$lockFileName.'.lock';
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
	$defaults['WAYFLogFile'] = '/var/log/apache2/wayf.log'; 
	$defaults['kerberosRedirectURL'] = dirname($_SERVER['SCRIPT_NAME']).'kerberosRedirect.php';
	$defaults['developmentMode'] = false;
	
	// Initialize independent defaults
	foreach($defaults as $key => $value){
		if (!isset($$key)){
			$$key = $value;
		}
	}
	
	// Set dependent default configuration options
	$defaults = array();
	$defaults['redirectCookieName'] = $cookieNamePrefix.'_redirect_user_idp';
	$defaults['redirectStateCookieName'] = $cookieNamePrefix.'_redirection_state';
	$defaults['SAMLDomainCookieName'] = $cookieNamePrefix.'_saml_idp';
	$defaults['SPCookieName'] = $cookieNamePrefix.'_saml_sp';
haemmer's avatar
haemmer committed
117
118
119
	$defaults['logoURL'] = $imageURL.'/federation-logo.png'; 
	$defaults['smallLogoURL'] = $imageURL.'/small-federation-logo.png';
	$defaults['organizationLogoURL'] = $imageURL.'/organization-logo.png';
120
121
122
123
124
125
126
127
128
	
	// Initialize dependent defaults
	foreach($defaults as $key => $value){
		if (!isset($$key)){
			$$key = $value;
		}
	}
}

haemmer's avatar
haemmer committed
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
/******************************************************************************/
// Generates an array of IDPs using the cookie value
function getIdPArrayFromValue($value){

	// Decodes and splits cookie value
	$CookieArray = preg_split('/ /', $value);
	$CookieArray = array_map('base64_decode', $CookieArray);
	
	return $CookieArray;
}

/******************************************************************************/
// Generate the value that is stored in the cookie using the list of IDPs
function getValueFromIdPArray($CookieArray){

	// Merges cookie content and encodes it
	$CookieArray = array_map('base64_encode', $CookieArray);
	$value = implode(' ', $CookieArray);
	return $value;
}

/******************************************************************************/
// Append a value to the array of IDPs
function appendValueToIdPArray($value, $CookieArray){
	
	// Remove value if it already existed in array
	foreach (array_keys($CookieArray) as $i){
		if ($CookieArray[$i] == $value){
			unset($CookieArray[$i]);
		}
	}
	
	// Add value to end of array
	$CookieArray[] = $value;
	
	return $CookieArray;
}

/******************************************************************************/
// Checks if the configuration file has changed. If it has, check the file
// and change its timestamp.
function checkConfig($IDPConfigFile, $backupIDPConfigFile){
	
	// Do files have the same modification time
	if (filemtime($IDPConfigFile) == filemtime($backupIDPConfigFile))
		return true;
	
	// Availability check
	if (!file_exists($IDPConfigFile))
		return false;
	
	// Readability check
	if (!is_readable($IDPConfigFile))
		return false;
	
	// Size check
	if (filesize($IDPConfigFile) < 200)
		return false;
	
	// Make modification time the same
	// If that doesnt work we won't notice it
	touch ($IDPConfigFile, filemtime($backupIDPConfigFile));
	
	return true;
}

/******************************************************************************/
196
197
// Checks if an IDP exists and returns true if it does, false otherwise
function checkIDP($IDP){
haemmer's avatar
haemmer committed
198
	
199
	global $IDProviders;
haemmer's avatar
haemmer committed
200
201
202
203
	
	if (isset($IDProviders[$IDP])){
		return true;
	} else {
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
		return false;
	} 
}

/******************************************************************************/
// Checks if an IDP exists and returns true if it exists and prints an error 
// if it doesnt
function checkIDPAndShowErrors($IDP){
	
	global $IDProviders;
	
	if (checkIDP($IDP)){
		return true;
	}
	
	// Otherwise show an error
haemmer's avatar
haemmer committed
220
	$message = sprintf(getLocalString('invalid_user_idp'), htmlentities($IDP))."</p><p>\n<code>";
221
222
223
	foreach ($IDProviders as $key => $value){
		if (isset($value['SSO'])){
			$message .= $key."<br>\n";
224
		}
haemmer's avatar
haemmer committed
225
	}
haemmer's avatar
haemmer committed
226
	$message .= "</code>\n";
227
228
229
	
	printError($message);
	exit;
haemmer's avatar
haemmer committed
230
231
}

232
233

/******************************************************************************/
haemmer's avatar
haemmer committed
234
235
// Validates the URL and returns it if it is valid or false otherwise 
function getSanitizedURL($url){
236
237
238
	
	$components = parse_url($url);
	
haemmer's avatar
haemmer committed
239
	if ($components){
haemmer's avatar
haemmer committed
240
		return $url;
haemmer's avatar
haemmer committed
241
242
	} else {
		return false;
243
244
245
	}
}

haemmer's avatar
haemmer committed
246
247
248
249
250
251
252
/******************************************************************************/
// Parses the hostname out of a string and returns it
function getHostNameFromURI($string){
	
	// Check if string is URN
	if (preg_match('/^urn:mace:/i', $string)){
		// Return last component of URN
haemmer's avatar
haemmer committed
253
254
		$components = explode(':', $string);
		return end($components);
haemmer's avatar
haemmer committed
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
	}
	
	// Apparently we are dealing with something like a URL
	if (preg_match('/([a-zA-Z0-9\-\.]+\.[a-zA-Z0-9\-\.]{2,6})/', $string, $matches)){
		return $matches[0];
	} else {
		return '';
	}
}

/******************************************************************************/
// Parses the domain out of a string and returns it
function getDomainNameFromURI($string){
	
	// Check if string is URN
	if (preg_match('/^urn:mace:/i', $string)){
		// Return last component of URN
haemmer's avatar
haemmer committed
272
273
		$components = explode(':', $string);
		return getTopLevelDomain(end($components));
haemmer's avatar
haemmer committed
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
	}
	
	// Apparently we are dealing with something like a URL
	if (preg_match('/[a-zA-Z0-9\-\.]+\.([a-zA-Z0-9\-\.]{2,6})/', $string, $matches)){
		return getTopLevelDomain($matches[0]);
	} else {
		return '';
	}
}

/******************************************************************************/
// Returns top level domain name from a DNS name
function getTopLevelDomain($string){
	$hostnameComponents = explode('.', $string);
	if (count($hostnameComponents) >= 2){
		return $hostnameComponents[count($hostnameComponents)-2].'.'.$hostnameComponents[count($hostnameComponents)-1];
	} else {
		return $string;
	}
}

/******************************************************************************/
// Parses the reverse dns lookup hostname out of a string and returns domain
function getDomainNameFromURIHint(){
	
	global $IDProviders;
	
haemmer's avatar
haemmer committed
301
302
	$clientHostname = gethostbyaddr($_SERVER['REMOTE_ADDR']);
	if ($clientHostname == $_SERVER['REMOTE_ADDR']){
haemmer's avatar
haemmer committed
303
304
305
		return '-';
	}
	
haemmer's avatar
haemmer committed
306
307
308
	// Get domain name from client host name
	$clientDomainName = getDomainNameFromURI($clientHostname);
	if ($clientDomainName == ''){
haemmer's avatar
haemmer committed
309
310
311
		return '-';
	}
	
haemmer's avatar
haemmer committed
312
313
	// Return first matching IdP entityID that contains the client domain name
	foreach ($IDProviders as $key => $value){
314
315
316
		if (
			   preg_match('/^http.+'.$clientDomainName.'/', $key)
			|| preg_match('/^urn:.+'.$clientDomainName.'$/', $key)){ 
haemmer's avatar
haemmer committed
317
318
319
320
321
322
			return $key;
		}
	}
	
	// No matching entityID was found
	return '-';
haemmer's avatar
haemmer committed
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
}

/******************************************************************************/
// Get the user's language using the accepted language http header
function determineLanguage(){
	
	global $langStrings, $defaultLanguage;
	
	// Check if language is enforced by PATH-INFO argument
	if (isset($_SERVER['PATH_INFO']) && !empty($_SERVER['PATH_INFO'])){
		foreach ($langStrings as $lang => $values){
			if (preg_match('#/'.$lang.'($|/)#',$_SERVER['PATH_INFO'])){
				return $lang;
			}
		}
	}
	
	// Check if there is a language GET argument
	if (isset($_GET['lang'])){
		$localeComponents = decomposeLocale($_GET['lang']);
		if (
		    $localeComponents !== false 
		    && isset($langStrings[$localeComponents[0]])
		    ){
			
			// Return language
			return $localeComponents[0];
		}
	}
	
	// Return default language if no headers are present otherwise
	if (!isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])){
		return $defaultLanguage;
	}
	
	// Inspect Accept-Language header which looks like:
	// Accept-Language: en,de-ch;q=0.8,fr;q=0.7,fr-ch;q=0.5,en-us;q=0.3,de;q=0.2
	$languages = explode( ',', trim($_SERVER['HTTP_ACCEPT_LANGUAGE']));
	foreach ($languages as $language){
		$languageParts = explode(';', $language);
		
		// Only treat art before the prioritization
		$localeComponents = decomposeLocale($languageParts[0]);
		if (
		    $localeComponents !== false 
		    && isset($langStrings[$localeComponents[0]])
		    ){
			
			// Return language
			return $localeComponents[0];
		}
	}
	
	return $defaultLanguage;
}

/******************************************************************************/

// Splits up a  string (relazed) according to
// http://www.debian.org/doc/manuals/intro-i18n/ch-locale.en.html#s-localename
// and returns an array with the four components
function decomposeLocale($locale){
	
	// Locale name syntax:  language[_territory][.codeset][@modifier]
	if (!preg_match('/^([a-zA-Z]{2})([-_][a-zA-Z]{2})?(\.[^@]+)?(@.+)?$/', $locale, $matches)){
		return false;
	} else {
		// Remove matched string in first position
		array_shift($matches);
		
		return $matches;
	}
}

/******************************************************************************/
haemmer's avatar
haemmer committed
398
399
// Gets a string in a specific language. Fallback to default language and 
// to English.
haemmer's avatar
haemmer committed
400
401
402
403
404
405
406
function getLocalString($string, $encoding = ''){
	
	global $defaultLanguage, $langStrings, $language;
	
	$textString = '';
	if (isset($langStrings[$language][$string])){
		$textString = $langStrings[$language][$string];
haemmer's avatar
haemmer committed
407
	} elseif (isset($langStrings[$defaultLanguage][$string])){
haemmer's avatar
haemmer committed
408
		$textString = $langStrings[$defaultLanguage][$string];
haemmer's avatar
haemmer committed
409
410
	} else {
		$textString = $langStrings['en'][$string];
haemmer's avatar
haemmer committed
411
412
413
414
415
416
417
418
419
420
421
422
423
	}
	
	// Change encoding if necessary
	if ($encoding == 'js'){
		$textString = convertToJSString($textString);
	}
	
	return $textString;
}

/******************************************************************************/
// Converts string to a JavaScript format that can be used in JS alert
function convertToJSString($string){
haemmer's avatar
haemmer committed
424
	return addslashes(html_entity_decode($string, ENT_COMPAT, 'UTF-8'));
haemmer's avatar
haemmer committed
425
426
}

haemmer's avatar
haemmer committed
427
428
429
430
431
432
/******************************************************************************/
// Replaces all newlines with spaces and then trims the string to get one line
function trimToSingleLine($string){
	return trim(preg_replace("|\n|",' ',$string));
}

haemmer's avatar
haemmer committed
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/******************************************************************************/
// Checks if entityID hostname of a valid IdP exists in path info
function getIdPPathInfoHint(){
	
	global $IDProviders;
	
	// Check if path info is available at all
	if (!isset($_SERVER['PATH_INFO']) || empty($_SERVER['PATH_INFO'])){
		return '-';
	}
	
	// Check for entityID hostnames of all available IdPs
	foreach ($IDProviders as $key => $value){
		// Only check actual IdPs
		if (
				isset($value['SSO']) 
				&& !empty($value['SSO'])
				&& $value['Type'] != 'wayf'
451
				&& isPartOfPathInfo(getHostNameFromURI($key))
haemmer's avatar
haemmer committed
452
453
454
455
456
457
458
459
460
461
462
463
				){
			return $key;
		}
	}
	
	// Check for entityID domain names of all available IdPs
	foreach ($IDProviders as $key => $value){
		// Only check actual IdPs
		if (
				isset($value['SSO']) 
				&& !empty($value['SSO'])
				&& $value['Type'] != 'wayf'
464
				&& isPartOfPathInfo(getDomainNameFromURI($key))
haemmer's avatar
haemmer committed
465
466
467
468
469
470
471
472
				){
			return $key;
		}
	}
	
	return '-';
}

473
/******************************************************************************/
474
// Joins localized names and keywords of an IdP to a single string
haemmer's avatar
haemmer committed
475
476
function composeOptionData($IdPValues){
	$data = '';
477
478
	foreach($IdPValues as $key => $value){
		if (is_array($value) && isset($value['Name'])){
haemmer's avatar
haemmer committed
479
			$data .= ' '.$value['Name'];
480
481
482
		} 
		
		if (is_array($value) && isset($value['Keywords'])) {
haemmer's avatar
haemmer committed
483
			$data .= ' '.$value['Keywords'];
484
485
486
		}
	}
	
haemmer's avatar
haemmer committed
487
	return $data;
488
489
}

haemmer's avatar
haemmer committed
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
/******************************************************************************/
// Parses the Kerbores realm out of the string and returns it
function getKerberosRealm($string){
	
	global $IDProviders;
	
	if ($string !='' ) {
		// Find a matching Kerberos realm
		foreach ($IDProviders as $key => $value){
			if ($value['Realm'] == $string) return $key;
		}
	}
	
	return '-';
}


/******************************************************************************/
// Determines the IdP according to the IP address if possible
function getIPAdressHint() {
	global $IDProviders;
	
	foreach($IDProviders as $name => $idp) {
513
		if (is_array($idp) && array_key_exists("IP", $idp)) {
haemmer's avatar
haemmer committed
514
515
516
			$clientIP = $_SERVER["REMOTE_ADDR"];
			
			foreach( $idp["IP"] as $network ) {
517
				if (isIPinCIDRBlock($network, $clientIP)) {
haemmer's avatar
haemmer committed
518
519
520
521
522
523
524
					return $name;
				}
			}
		}
	}
	return '-';
}
525

526
527
528
529
530
531
/******************************************************************************/
// Returns true if IP is in IPv4/IPv6 CIDR range
// and returns false otherwise
function isIPinCIDRBlock($cidr, $ip) {
	
	// Split CIDR notation
532
	list ($net, $mask) = preg_split ("|/|", $cidr);
533
534
	
	// Convert to binary string value of 1s and 0s
haemmer's avatar
haemmer committed
535
536
	$netAsBinary = convertIPtoBinaryForm($net);
	$ipAsBinary =  convertIPtoBinaryForm($ip);
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
	
	// Return false if netmask and ip are using different protocols
	if (strlen($netAsBinary) != strlen($ipAsBinary)){
		return false;
	}
	
	// Compare the first $mask bits
	for($i = 0; $i < $mask; $i++){
	
		// Return false if bits don't match
		if ($netAsBinary[$i] != $ipAsBinary[$i]){
			return false;
		}
	}
	
	// If we got here, ip matches net
	return true;
	
}

/******************************************************************************/
// Converts IP in human readable format to binary string
haemmer's avatar
haemmer committed
559
function convertIPtoBinaryForm($ip){
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
	
	//  Handle IPv4 IP
	if(filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false){
		return base_convert(ip2long($ip),10,2);
	}
	
	// Return false if IP is neither IPv4 nor a IPv6 IP
	if(filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) === false){
		return false;
	}
	
	// Convert IP to binary structure and return false if this fails
	if(($ipAsBinStructure = inet_pton($ip)) === false) {
		return false;
	}
	
	
	$numOfBytes = 16; 
	$ipAsBinaryString = '';
	
	// Convert IP to binary string
	while ($numOfBytes > 0){
		// Convert current byte to decimal number
		$currentByte = ord($ipAsBinStructure[$numOfBytes - 1]);
		
		// Convert currenty byte to string of 1 and 0
		$currentByteAsBinary = sprintf("%08b", $currentByte);
		
		// Prepend to rest of IP in binary string
		$ipAsBinaryString = $currentByteAsBinary.$ipAsBinaryString;
		
		// Decrease byte counter
		$numOfBytes--;
	}
	
	return $ipAsBinaryString;
}

haemmer's avatar
haemmer committed
598
599
600
601
602
603
/******************************************************************************/
// Returns URL without GET arguments
function getURLWithoutArguments($url){
	return preg_replace('/\?.*/', '', $url);
}

604
/******************************************************************************/
605
606
// Returns true if URL could be verified or if no check is necessary, false otherwise
function verifyReturnURL($entityID, $returnURL) {
607
	global $SProviders, $useACURLsForReturnParamCheck;
608
	
609
610
	// If SP has a <idpdisc:DiscoveryResponse>, check return param
	if (isset($SProviders[$entityID]['DSURL'])){
haemmer's avatar
haemmer committed
611
612
613
614
		$returnURLWithoutArguments = getURLWithoutArguments($returnURL);
		foreach($SProviders[$entityID]['DSURL'] as $DSURL){
			$DSURLWithoutArguments = getURLWithoutArguments($DSURL);
			if ($DSURLWithoutArguments == $returnURLWithoutArguments){
615
616
617
				return true;
			}
		}
haemmer's avatar
haemmer committed
618
619
		
		// DS URLs did not match the return URL
620
		return false;
621
622
	}
	
haemmer's avatar
haemmer committed
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
	// Return true if SP has no <idpdisc:DiscoveryResponse> 
	// and $useACURLsForReturnParamCheck is disabled (we don't check anything)
	if (!$useACURLsForReturnParamCheck){
		return true;
	}
	
	// $useACURLsForReturnParamCheck is enabled, so
	// check return param against host name of assertion consumer URLs
	
	// Check hostnames
	$returnURLHostName = getHostNameFromURI($returnURL);
	foreach($SProviders[$entityID]['ACURL'] as $ACURL){
		if (getHostNameFromURI($ACURL) == $returnURLHostName){
			return true;
		}
	}
	
	// We haven't found a matching assertion consumer URL, therefore we return false
	return false;
	
643
644
}

haemmer's avatar
haemmer committed
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
/******************************************************************************/
// Returns a reasonable value for returnIDParam
function getReturnIDParam() {
	
	if (isset($_GET['returnIDParam']) && !empty($_GET['returnIDParam'])){
		return $_GET['returnIDParam'];
	} else {
		return 'entityID';
	}
}

/******************************************************************************/
// Returns true if valid Shibboleth 1.x request or Directory Service request
function isValidShibRequest(){
	return (isValidShib1Request() || isValidDSRequest());
}

/******************************************************************************/
// Returns true if valid Shibboleth request
function isValidShib1Request(){
	if (isset($_GET['shire']) && isset($_GET['target'])){
		return true;
	} else {
		return false;
	}
}

/******************************************************************************/
673
// Returns true if request is a valid Directory Service request
haemmer's avatar
haemmer committed
674
function isValidDSRequest(){
675
676
677
678
679
680
681
682
683
	global $SProviders;
	
	// If entityID is not present, request is invalid
	if (!isset($_GET['entityID'])){
		return false;
	}
	
	// If entityID and return parameters are present, request is valid
	if (isset($_GET['return'])){
haemmer's avatar
haemmer committed
684
		return true;
685
686
687
688
689
690
691
692
693
	}
	
	// If no return parameter and no Discovery Service endpoint is available 
	// for SP, request is invalid
	if (!isset($SProviders[$_GET['entityID']]['DSURL'])){
		return false;
	}
	
	if (count($SProviders[$_GET['entityID']]['DSURL']) < 1){
haemmer's avatar
haemmer committed
694
695
		return false;
	}
696
697
698
699
	
	// EntityID is available and there is at least one DiscoveryService 
	// endpoint defined. Therefore, the request is valid
	return true;
haemmer's avatar
haemmer committed
700
701
}

702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
/******************************************************************************/
// Sets the Location header to redirect the user's web browser
function redirectTo($url){
	header('Location: '.$url);
}

/******************************************************************************/
// Sets the Location that is used for redirect the web browser back to the SP
function redirectToSP($url, $IdP){
	if (preg_match('/\?/', $url) > 0){
		redirectTo($url.'&'.getReturnIDParam().'='.urlencode($IdP));
	} else {
		redirectTo($url.'?'.getReturnIDParam().'='.urlencode($IdP));
	}
}
haemmer's avatar
haemmer committed
717
/******************************************************************************/
haemmer's avatar
haemmer committed
718
719
720
721
// Logs all events where users were redirected to their IdP or back to an SP
// The log then can be used to approximately detect how many users were served
// by the SWITCHwayf
function logAccessEntry($protocol, $type, $sp, $idp, $return){
haemmer's avatar
haemmer committed
722
723
	global $WAYFLogFile, $useLogging;
	
haemmer's avatar
haemmer committed
724
	// Return if logging deactivated
haemmer's avatar
haemmer committed
725
726
727
728
	if (!$useLogging){
		return;
	}
	
haemmer's avatar
haemmer committed
729
730
731
732
733
734
735
736
737
738
739
740
	// Create log file if it does not exist yet
	if (!file_exists($WAYFLogFile) && !touch($WAYFLogFile)){
		// File does not exist and cannot be written to
		logFatalErrorAndExit('WAYF log file '.$WAYFLogFile.' does not exist and could not be created.');
	}
	
	// Ensure that the file exists and is writable
	if (!is_writable($WAYFLogFile)) {
		logFatalErrorAndExit('Current file permission do not allow WAYF to write to its log file '.$WAYFLogFile.'.');
	}
	
	// Compose log entry
haemmer's avatar
haemmer committed
741
	$entry = date('Y-m-d H:i:s').' '.$_SERVER['REMOTE_ADDR'].' '.$protocol.' '.$type.' '.$idp.' '.$return.' '.$sp."\n";
haemmer's avatar
haemmer committed
742
743
744
745
746
747
748
749
750
	
	// Open file in append mode
	if (!$handle = fopen($WAYFLogFile, 'a')) {
		logFatalErrorAndExit('Could not open file '.$WAYFLogFile.' for appending log entries.');
	}
	
	// Try getting the lock
	while (!flock($handle, LOCK_EX)){
		usleep(rand(10, 100));
haemmer's avatar
haemmer committed
751
	}
haemmer's avatar
haemmer committed
752
753
754
755
756
757
758
759
760
761
762
763
	
	// Write entry
	fwrite($handle, $entry);
	
	// Release the lock
	flock($handle, LOCK_UN);
	
	// Close file handle
	fclose($handle);
	
}

764
765
766
/******************************************************************************/
// Init connection to system logger
function initLogger(){
767
768
	global $instanceIdentifier;
	
haemmer's avatar
haemmer committed
769
	openlog($instanceIdentifier, LOG_NDELAY, LOG_USER);
770
771
}

haemmer's avatar
haemmer committed
772
773
/******************************************************************************/
// Logs an info message
haemmer's avatar
haemmer committed
774
function logInfo($infoMsg){
haemmer's avatar
haemmer committed
775
	global $developmentMode;
776
777
778
	
	initLogger();
	
haemmer's avatar
haemmer committed
779
	syslog(LOG_INFO, $infoMsg);
haemmer's avatar
haemmer committed
780
	
781
	if ($developmentMode && isRun){
haemmer's avatar
haemmer committed
782
		echo $infoMsg;
haemmer's avatar
haemmer committed
783
784
785
786
787
	}
}

/******************************************************************************/
// Logs an warnimg message
haemmer's avatar
haemmer committed
788
function logWarning($warnMsg){
haemmer's avatar
haemmer committed
789
	global $developmentMode;
790
	
791
792
	initLogger();
	
haemmer's avatar
haemmer committed
793
	syslog(LOG_WARNING, $warnMsg);
haemmer's avatar
haemmer committed
794
	
795
	if ($developmentMode && isRunViaCLI()){
haemmer's avatar
haemmer committed
796
		echo $warnMsg;
haemmer's avatar
haemmer committed
797
798
799
800
801
802
	}
}

/******************************************************************************/
// Logs an error message
function logError($errorMsg){
haemmer's avatar
haemmer committed
803
	global $developmentMode;
804
	
805
806
	initLogger();
	
haemmer's avatar
haemmer committed
807
808
809
810
811
812
813
	syslog(LOG_ERR, $errorMsg);
	
	if ($developmentMode){
		echo $errorMsg;
	}
}

haemmer's avatar
haemmer committed
814
815
816
/******************************************************************************/
// Logs an fatal error message
function logFatalErrorAndExit($errorMsg){
haemmer's avatar
haemmer committed
817
	logError($errorMsg);
haemmer's avatar
haemmer committed
818
	exit;
haemmer's avatar
haemmer committed
819
}
haemmer's avatar
haemmer committed
820

haemmer's avatar
haemmer committed
821
822
823
824
/******************************************************************************/
// Returns true if PATH info indicates a request of type $type
function isRequestType($type){
	// Make sure the type is checked at end of path info
825
	return isPartOfPathInfo($type.'$');
haemmer's avatar
haemmer committed
826
827
828
829
}

/******************************************************************************/
// Checks for substrings in Path Info and returns true if match was found
830
function isPartOfPathInfo($needle){
haemmer's avatar
haemmer committed
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
	if (
		isset($_SERVER['PATH_INFO']) 
		&& !empty($_SERVER['PATH_INFO'])
		&& preg_match('|/'.$needle.'|', $_SERVER['PATH_INFO'])){
		
		return true;
	} else {
		return false;
	}
}

/******************************************************************************/
// Converts to the unified datastructure that the Shibboleth DS will be using
function convertToShibDSStructure($IDProviders){
	
846
	$ShibDSIDProviders = array();
haemmer's avatar
haemmer committed
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
	
	foreach ($IDProviders as $key => $value){
		
		// Skip unknown and category entries
		if(
			!isset($value['Type']) 
			|| $value['Type'] == 'category'
			|| $value['Type'] == 'wayf'
			){
			continue;
		}
		
		// Init and fill IdP data
		$identityProvider = array();
		$identityProvider['entityID'] = $key;
862
		$identityProvider['DisplayNames'][] = array('lang' => 'en', 'value' => $value['Name']);
haemmer's avatar
haemmer committed
863
		
864
		// Add DisplayNames in other languages
haemmer's avatar
haemmer committed
865
866
867
868
869
870
871
872
873
874
875
876
877
		foreach($value as $lang => $name){
			if(
				   $lang == 'Name'
				|| $lang == 'SSO'
				|| $lang == 'Realm'
				|| $lang == 'Type'
				|| $lang == 'IP'
				
			){
				continue;
			}
			
			if (isset($name['Name'])){
878
				$identityProvider['DisplayNames'][] = array('lang' => $lang, 'value' => $name['Name']);
haemmer's avatar
haemmer committed
879
880
881
882
			}
		}
		
		// Add data to ShibDSIDProviders
883
		$ShibDSIDProviders[] = $identityProvider;
haemmer's avatar
haemmer committed
884
885
886
887
888
889
	}
	
	return $ShibDSIDProviders;
	
}

890
891
892
/******************************************************************************/
// Sorts the IDProviders array
function sortIdentityProviders(&$IDProviders){
haemmer's avatar
haemmer committed
893
	$orderedCategories = Array();
894
	
haemmer's avatar
haemmer committed
895
896
	// Create array with categories and IdPs in categories
	$unknownCategory = array();
897
	foreach ($IDProviders as $entityId => $IDProvider){
haemmer's avatar
haemmer committed
898
899
900
		// Add categories
		if ($IDProvider['Type'] == 'category'){
			$orderedCategories[$entityId]['data'] = $IDProvider;
haemmer's avatar
haemmer committed
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
		}
	}
	
	// Add category 'unknown' if not present
	if (!isset($orderedCategories['unknown'])){
		$orderedCategories['unknown']['data'] = array (
			'Name' => 'Unknown',
			'Type' => 'category',
		);
	}
	
	foreach ($IDProviders as $entityId => $IDProvider){
	
		// Skip categories
		if ($IDProvider['Type'] == 'category'){
haemmer's avatar
haemmer committed
916
			continue;
haemmer's avatar
haemmer committed
917
918
919
920
921
922
		}
		
		// Skip incomplete descriptions
		if (!is_array($IDProvider) || !isset($IDProvider['Name'])){
			continue;
		}
haemmer's avatar
haemmer committed
923
924
925
926
927
928
		
		// Sanitize category
		if (!isset($IDProvider['Type'])){
			$IDProvider['Type'] = 'unknown';
		}
		
haemmer's avatar
haemmer committed
929
930
		// Add IdP
		$orderedCategories[$IDProvider['Type']]['IdPs'][$entityId] = $IDProvider;
931
932
	}
	
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
	// Relocate all IdPs for which no category with a name was defined
	$toremoveCategories = array();
	foreach ($orderedCategories as $category => $object){
		if (!isset($object['data'])){
			foreach ($object['IdPs'] as $entityId => $IDProvider){
				$unknownCategory[$entityId] = $IDProvider;
			}
			$toremoveCategories[] = $category;
		}
	}
	
	// Remove categories without descriptions
	foreach ($toremoveCategories as $category){
		unset($orderedCategories[$category]);
	}
	
haemmer's avatar
haemmer committed
949
950
951
	// Recompose $IDProviders
	$IDProviders = Array();
	foreach ($orderedCategories as $category => $object){
952
		
haemmer's avatar
haemmer committed
953
		// Skip category if it contains no IdPs
haemmer's avatar
haemmer committed
954
		if (!isset($object['IdPs']) || count($object['IdPs']) < 1 ){
haemmer's avatar
haemmer committed
955
			continue;
956
		}
haemmer's avatar
haemmer committed
957
958
959
960
961
962
963
964
965
966
967
		
		// Add category
		$IDProviders[$category] = $object['data'];
		
		// Sort IdPs in category
		uasort($object['IdPs'], 'sortUsingTypeIndexAndName');
		
		// Add IdPs
		foreach ($object['IdPs'] as $entityId => $IDProvider){
			$IDProviders[$entityId] = $IDProvider;
		}
968
969
970
971
972
973
974
975
976
	}
}

/******************************************************************************/
// Sorts two entries according to their Type, Index and (local) Name
function sortUsingTypeIndexAndName($a, $b){
	global $language;
	
	if ($a['Type'] != $b['Type']){
haemmer's avatar
haemmer committed
977
		return strcasecmp($a['Type'], $b['Type']);
978
	} elseif (isset($a['Index']) && isset($b['Index']) && $a['Index'] != $b['Index']){
haemmer's avatar
haemmer committed
979
		return strcasecmp($a['Index'], $b['Index']);
980
981
982
983
	} else {
		// Sort using locale names
		$localNameB = (isset($a[$language]['Name'])) ? $a[$language]['Name'] : $a['Name'];
		$localNameA = (isset($b[$language]['Name'])) ? $b[$language]['Name'] : $b['Name'];
haemmer's avatar
haemmer committed
984
		return strcasecmp($localNameB, $localNameA);
985
986
987
	}
}

988
989
990
991
992
993
994
995
996
997
998
999
1000

/******************************************************************************/
// Returns true if the referer of the current request is matching an assertion
// consumer or discovery service URL of a Service Provider
function isRequestRefererMatchingSPHost(){
	
	global $SProviders;
	
	// If referer is not available return false
	if (!isset($_SERVER["HTTP_REFERER"]) || $_SERVER["HTTP_REFERER"] == ''){
		return false;
	}