File: Artifact.php

package info (click to toggle)
simplesamlphp 1.14.11-1%2Bdeb9u2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 15,024 kB
  • sloc: php: 72,337; xml: 1,078; python: 376; sh: 220; perl: 185; makefile: 57
file content (178 lines) | stat: -rw-r--r-- 5,467 bytes parent folder | download
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
<?php

/**
 * Implementation of the Shibboleth 1.3 Artifact binding.
 *
 * @package SimpleSAMLphp
 */
class SimpleSAML_Bindings_Shib13_Artifact {

	/**
	 * Parse the query string, and extract the SAMLart parameters.
	 *
	 * This function is required because each query contains multiple
	 * artifact with the same parameter name.
	 *
	 * @return array  The artifacts.
	 */
	private static function getArtifacts() {
		assert('array_key_exists("QUERY_STRING", $_SERVER)');

		// We need to process the query string manually, to capture all SAMLart parameters

		$artifacts = array();

		$elements = explode('&', $_SERVER['QUERY_STRING']);
		foreach ($elements as $element) {
			list($name, $value) = explode('=', $element, 2);
			$name = urldecode($name);
			$value = urldecode($value);

			if ($name === 'SAMLart') {
				$artifacts[] = $value;
			}
		}

		return $artifacts;
	}


	/**
	 * Build the request we will send to the IdP.
	 *
	 * @param array $artifacts  The artifacts we will request.
	 * @return string  The request, as an XML string.
	 */
	private static function buildRequest(array $artifacts) {

		$msg = '<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">' .
			'<SOAP-ENV:Body>' .
			'<samlp:Request xmlns:samlp="urn:oasis:names:tc:SAML:1.0:protocol"' .
			' RequestID="' . SimpleSAML\Utils\Random::generateID() . '"' .
			' MajorVersion="1" MinorVersion="1"' .
			' IssueInstant="' . SimpleSAML\Utils\Time::generateTimestamp() . '"' .
			'>';

		foreach ($artifacts as $a) {
			$msg .= '<samlp:AssertionArtifact>' . htmlspecialchars($a) . '</samlp:AssertionArtifact>';
		}

		$msg .= '</samlp:Request>' .
			'</SOAP-ENV:Body>' .
			'</SOAP-ENV:Envelope>';

		return $msg;
	}


	/**
	 * Extract the response element from the SOAP response.
	 *
	 * @param string $soapResponse  The SOAP response.
	 * @return string  The <saml1p:Response> element, as a string.
	 */
	private static function extractResponse($soapResponse) {
		assert('is_string($soapResponse)');

		try {
			$doc = SAML2_DOMDocumentFactory::fromString($soapResponse);
		} catch(\Exception $e) {
			throw new SimpleSAML_Error_Exception('Error parsing SAML 1 artifact response.');
		}

		$soapEnvelope = $doc->firstChild;
		if (!SimpleSAML\Utils\XML::isDOMElementOfType($soapEnvelope, 'Envelope', 'http://schemas.xmlsoap.org/soap/envelope/')) {
			throw new SimpleSAML_Error_Exception('Expected artifact response to contain a <soap:Envelope> element.');
		}

		$soapBody = SimpleSAML\Utils\XML::getDOMChildren($soapEnvelope, 'Body', 'http://schemas.xmlsoap.org/soap/envelope/');
		if (count($soapBody) === 0) {
			throw new SimpleSAML_Error_Exception('Couldn\'t find <soap:Body> in <soap:Envelope>.');
		}
		$soapBody = $soapBody[0];


		$responseElement = SimpleSAML\Utils\XML::getDOMChildren($soapBody, 'Response', 'urn:oasis:names:tc:SAML:1.0:protocol');
		if (count($responseElement) === 0) {
			throw new SimpleSAML_Error_Exception('Couldn\'t find <saml1p:Response> in <soap:Body>.');
		}
		$responseElement = $responseElement[0];

		/*
		 * Save the <saml1p:Response> element. Note that we need to import it
		 * into a new document, in order to preserve namespace declarations.
		 */
		$newDoc = SAML2_DOMDocumentFactory::create();
		$newDoc->appendChild($newDoc->importNode($responseElement, TRUE));
		$responseXML = $newDoc->saveXML();

		return $responseXML;
	}


	/**
	 * This function receives a SAML 1.1 artifact.
	 *
	 * @param SimpleSAML_Configuration $spMetadata  The metadata of the SP.
	 * @param SimpleSAML_Configuration $idpMetadata  The metadata of the IdP.
	 * @return string  The <saml1p:Response> element, as an XML string.
	 */
	public static function receive(SimpleSAML_Configuration $spMetadata, SimpleSAML_Configuration $idpMetadata) {

		$artifacts = self::getArtifacts();
		$request = self::buildRequest($artifacts);

		\SimpleSAML\Utils\XML::debugSAMLMessage($request, 'out');

		$url = $idpMetadata->getDefaultEndpoint('ArtifactResolutionService', array('urn:oasis:names:tc:SAML:1.0:bindings:SOAP-binding'));
		$url = $url['Location'];

		$peerPublicKeys = $idpMetadata->getPublicKeys('signing', TRUE);
		$certData = '';
		foreach ($peerPublicKeys as $key) {
			if ($key['type'] !== 'X509Certificate') {
				continue;
			}
			$certData .= "-----BEGIN CERTIFICATE-----\n" .
				chunk_split($key['X509Certificate'], 64) .
				"-----END CERTIFICATE-----\n";
		}

		$file = SimpleSAML\Utils\System::getTempDir() . DIRECTORY_SEPARATOR . sha1($certData) . '.crt';
		if (!file_exists($file)) {
            SimpleSAML\Utils\System::writeFile($file, $certData);
		}

		$spKeyCertFile = \SimpleSAML\Utils\Config::getCertPath($spMetadata->getString('privatekey'));

		$opts = array(
			'ssl' => array(
				'verify_peer' => TRUE,
				'cafile' => $file,
				'local_cert' => $spKeyCertFile,
				'capture_peer_cert' => TRUE,
				'capture_peer_chain' => TRUE,
			),
			'http' => array(
				'method' => 'POST',
				'content' => $request,
				'header' => 'SOAPAction: http://www.oasis-open.org/committees/security' . "\r\n" .
					'Content-Type: text/xml',
			),
		);

		// Fetch the artifact
		$response = \SimpleSAML\Utils\HTTP::fetch($url, $opts);
		if ($response === FALSE) {
			throw new SimpleSAML_Error_Exception('Failed to retrieve assertion from IdP.');
		}

		\SimpleSAML\Utils\XML::debugSAMLMessage($response, 'in');

		// Find the response in the SOAP message
		$response = self::extractResponse($response);

		return $response;
	}

}