SamlReader.java
20.2 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
/*
* Decompiled with CFR 0_118.
*
* Could not load the following classes:
* org.apache.xml.security.Init
* org.apache.xml.security.encryption.XMLCipher
* org.apache.xml.security.encryption.XMLEncryptionException
* org.apache.xml.security.keys.keyresolver.KeyResolverSpi
* org.joda.time.DateTime
* org.joda.time.DateTimeZone
* org.joda.time.format.DateTimeFormatter
* org.joda.time.format.ISODateTimeFormat
* org.slf4j.Logger
* org.slf4j.LoggerFactory
*/
package com.adobe.granite.auth.saml.util;
import com.adobe.granite.auth.saml.model.Assertion;
import com.adobe.granite.auth.saml.model.Attribute;
import com.adobe.granite.auth.saml.model.AuthnStatement;
import com.adobe.granite.auth.saml.model.Issuer;
import com.adobe.granite.auth.saml.model.LogoutRequest;
import com.adobe.granite.auth.saml.model.Message;
import com.adobe.granite.auth.saml.model.NameId;
import com.adobe.granite.auth.saml.model.Response;
import com.adobe.granite.auth.saml.model.Status;
import com.adobe.granite.auth.saml.model.Subject;
import com.adobe.granite.auth.saml.util.RetrievalMethodEncryptedKeyResolver;
import com.adobe.granite.auth.saml.util.SamlReaderException;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringWriter;
import java.io.Writer;
import java.security.Key;
import java.security.Provider;
import java.util.Calendar;
import java.util.LinkedList;
import java.util.Locale;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.dsig.XMLSignature;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.crypto.dsig.XMLSignatureFactory;
import javax.xml.crypto.dsig.XMLValidateContext;
import javax.xml.crypto.dsig.dom.DOMValidateContext;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.apache.xml.security.Init;
import org.apache.xml.security.encryption.XMLCipher;
import org.apache.xml.security.encryption.XMLEncryptionException;
import org.apache.xml.security.keys.keyresolver.KeyResolverSpi;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.format.DateTimeFormatter;
import org.joda.time.format.ISODateTimeFormat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
public class SamlReader {
private final Logger log;
public SamlReader() {
this.log = LoggerFactory.getLogger(this.getClass());
}
public Message read(InputStream inputStream, Key decryptionKey, Key verificationKey, boolean isSamlRequest) throws SamlReaderException, IOException {
try {
DocumentBuilderFactory builderFactory = this.createBuilderFactory();
DocumentBuilder builder = builderFactory.newDocumentBuilder();
Document doc = builder.parse(inputStream);
Message msg = null;
if (!isSamlRequest) {
if (decryptionKey != null) {
doc = this.decryptResponse(doc, decryptionKey);
}
if ((msg = this.parse(doc, verificationKey)) == null) {
throw new SamlReaderException("Unable to parse document from stream.", new Exception());
}
Transformer transformer = TransformerFactory.newInstance().newTransformer();
StringWriter sw = new StringWriter();
transformer.transform(new DOMSource(doc), new StreamResult(sw));
msg.setRawMessage(sw.toString());
} else {
msg = this.parseRequest(doc, verificationKey);
if (msg == null) {
throw new SamlReaderException("Unable to parse document from stream.", new Exception());
}
}
return msg;
}
catch (ParserConfigurationException e) {
throw new SamlReaderException("Unable to create document builder factory", e);
}
catch (SAXException e) {
throw new SamlReaderException("Unable to parse document from stream", e);
}
catch (TransformerConfigurationException e) {
throw new SamlReaderException("Unable to parse document from stream", e);
}
catch (TransformerException e) {
throw new SamlReaderException("Unable to parse document from stream", e);
}
}
public Message read(InputStream inputStream, Key decryptionKey, Key verificationKey) throws SamlReaderException, IOException {
return this.read(inputStream, decryptionKey, verificationKey, false);
}
private DocumentBuilderFactory createBuilderFactory() throws ParserConfigurationException {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setNamespaceAware(true);
dbf.setValidating(true);
dbf.setExpandEntityReferences(false);
dbf.setFeature("http://xml.org/sax/features/validation", true);
dbf.setFeature("http://xml.org/sax/features/external-general-entities", false);
dbf.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
dbf.setFeature("http://apache.org/xml/features/nonvalidating/load-dtd-grammar", false);
dbf.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
return dbf;
}
protected Response parse(Document document, Key verificationKey) {
Element issuerElement;
Element responseElement = this.getChildElement(document, "Response");
if (responseElement == null) {
this.log.error("Unable to read Response element from document.");
return null;
}
responseElement.setIdAttribute("ID", true);
Response response = new Response();
response.setId(responseElement.getAttribute("ID"));
response.setVersion(responseElement.getAttribute("Version"));
response.setIssueInstant(this.getDateAttr(responseElement, "IssueInstant"));
Element statusElement = this.getChildElement(responseElement, "Status");
if (null != statusElement) {
response.setStatus(this.parseStatus(statusElement));
}
if (null != (issuerElement = this.getChildElement(responseElement, "Issuer"))) {
response.setIssuer(this.parseIssuer(issuerElement));
}
response.setInResponseTo(responseElement.getAttribute("InResponseTo"));
response.setDestination(responseElement.getAttribute("Destination"));
NodeList nodeList = responseElement.getElementsByTagNameNS("urn:oasis:names:tc:SAML:2.0:assertion", "Assertion");
for (int i = 0; i < nodeList.getLength(); ++i) {
Element nameIdElement;
Element assertionElement = (Element)nodeList.item(i);
Assertion assertion = this.parseAssertion(assertionElement);
Element subjectElement = this.getChildElement(assertionElement, "Subject");
if (null != subjectElement && null != (nameIdElement = this.getChildElement(subjectElement, "NameID"))) {
response.setNameId(nameIdElement.getTextContent());
if (nameIdElement.hasAttribute("Format")) {
response.setNameIdFormat(nameIdElement.getAttribute("Format"));
}
if (nameIdElement.hasAttribute("NameQualifier")) {
response.setNameQualifier(nameIdElement.getAttribute("NameQualifier"));
}
if (nameIdElement.hasAttribute("SPNameQualifier")) {
response.setSpNameQualifier(nameIdElement.getAttribute("SPNameQualifier"));
}
}
assertion.setSignatureValid(this.verifySignatures(responseElement, (Element)nodeList.item(i), verificationKey));
response.addAssertion(assertion);
}
return response;
}
private LogoutRequest parseRequest(Document document, Key verificationKey) {
Element issuerElement;
Element nameIdElement;
Element requestElement = this.getChildElement(document, "LogoutRequest");
if (requestElement == null) {
this.log.error("Could not find LogoutRequest element in document");
return null;
}
LogoutRequest logoutRequest = new LogoutRequest();
if (requestElement.hasAttribute("ID")) {
logoutRequest.setId(requestElement.getAttribute("ID"));
}
if (requestElement.hasAttribute("IssueInstant")) {
logoutRequest.setIssueInstant(this.getDateAttr(requestElement, "IssueInstant"));
}
if (requestElement.hasAttribute("Destination")) {
logoutRequest.setDestination(requestElement.getAttribute("Destination"));
}
if ((issuerElement = this.getChildElement(requestElement, "Issuer")) != null) {
logoutRequest.setIssuer(this.parseIssuer(issuerElement));
}
if ((nameIdElement = this.getChildElement(requestElement, "NameID")) != null) {
if (nameIdElement.hasAttribute("NameFormat")) {
logoutRequest.setNameIdFormat(nameIdElement.getAttribute("NameFormat"));
}
logoutRequest.setNameId(nameIdElement.getTextContent());
}
LinkedList<Element> sessionIndexElements = this.getChildElements(requestElement, "SessionIndex");
for (Element sessionIndexElement : sessionIndexElements) {
logoutRequest.addSessionIndex(sessionIndexElement.getTextContent());
}
logoutRequest.setSignatureValid(this.verifySignatures(requestElement, requestElement, verificationKey));
return logoutRequest;
}
private boolean verifySignatures(Element parentElement, Element signedElement, Key publicKey) {
if (publicKey != null) {
NodeList signatureNodes = signedElement.getElementsByTagNameNS("http://www.w3.org/2000/09/xmldsig#", "Signature");
if (signatureNodes.getLength() == 0) {
this.log.warn("Received SAML message without signature element.");
return false;
}
for (int j = 0; j < signatureNodes.getLength(); ++j) {
try {
DOMValidateContext valContext = new DOMValidateContext(publicKey, signatureNodes.item(j));
valContext.setIdAttributeNS(signedElement, null, "ID");
valContext.setIdAttributeNS(parentElement, null, "ID");
String providerName = System.getProperty("jsr105Provider", "org.apache.jcp.xml.dsig.internal.dom.XMLDSigRI");
XMLSignatureFactory sigFactory = XMLSignatureFactory.getInstance("DOM", (Provider)Class.forName(providerName).newInstance());
XMLSignature signature = sigFactory.unmarshalXMLSignature(valContext);
if (signature.validate(valContext)) continue;
return false;
}
catch (MarshalException e) {
this.log.error("Could not unmarshal XML signature.", (Throwable)e);
return false;
}
catch (XMLSignatureException e) {
this.log.error("Failed validating signature.", (Throwable)e);
return false;
}
catch (ClassNotFoundException e) {
this.log.error("Failed obtaining the signature provider: ", (Throwable)e);
return false;
}
catch (InstantiationException e) {
this.log.error("Failed obtaining the signature provider: ", (Throwable)e);
return false;
}
catch (IllegalAccessException e) {
this.log.error("Failed obtaining the signature provider: ", (Throwable)e);
return false;
}
}
} else {
this.log.warn("Could not verify signatures. Public key of IdP not provided.");
return false;
}
return true;
}
protected Document decryptResponse(Document document, Key decryptionKey) {
NodeList encryptedAssertions = document.getElementsByTagNameNS("urn:oasis:names:tc:SAML:2.0:assertion", "EncryptedAssertion");
if (0 >= encryptedAssertions.getLength()) {
throw new RuntimeException("No EncryptedAssertion element was found");
}
for (int i = 0; i < encryptedAssertions.getLength(); ++i) {
this.decryptAssertion((Element)encryptedAssertions.item(i), decryptionKey);
}
return document;
}
protected void decryptAssertion(Element encryptedAssertion, Key decryptionKey) {
DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
builderFactory.setNamespaceAware(true);
try {
Element encryptedDataNode = (Element)encryptedAssertion.getElementsByTagNameNS("http://www.w3.org/2001/04/xmlenc#", "EncryptedData").item(0);
Element algorithmNode = (Element)encryptedDataNode.getElementsByTagNameNS("http://www.w3.org/2001/04/xmlenc#", "EncryptionMethod").item(0);
String algorithm = algorithmNode.getAttributeNS(null, "Algorithm");
DocumentBuilder builder = builderFactory.newDocumentBuilder();
XMLCipher xmlCipher = XMLCipher.getInstance();
xmlCipher.init(2, null);
xmlCipher.setKEK(decryptionKey);
xmlCipher.registerInternalKeyResolver((KeyResolverSpi)new RetrievalMethodEncryptedKeyResolver(algorithm, decryptionKey));
byte[] decryptedAssertion = xmlCipher.decryptToByteArray(encryptedDataNode);
Document doc = builder.parse(new ByteArrayInputStream(decryptedAssertion));
Node decryptedNode = encryptedAssertion.getOwnerDocument().importNode(doc.getDocumentElement(), true);
Element parentElement = (Element)encryptedAssertion.getParentNode();
parentElement.removeChild(encryptedAssertion);
parentElement.appendChild(decryptedNode);
}
catch (XMLEncryptionException e) {
throw new RuntimeException("Error decrypting response", (Throwable)e);
}
catch (ParserConfigurationException e) {
throw new RuntimeException("Error decrypting response", e);
}
catch (SAXException e) {
throw new RuntimeException("Error decrypting response", e);
}
catch (IOException e) {
throw new RuntimeException("Error decrypting response", e);
}
}
protected Issuer parseIssuer(Element issuerElement) {
String value = issuerElement.getTextContent();
if (null == value) {
return null;
}
return new Issuer(value.trim());
}
protected Assertion parseAssertion(Element assertionElement) {
Element audienceRestrictionElement;
Element conditionsElement;
Element attributeStatement;
Assertion assertion = new Assertion();
Element subjectElement = this.getChildElement(assertionElement, "Subject");
if (null != subjectElement) {
Subject subject = new Subject();
Element nameIdElement = this.getChildElement(subjectElement, "NameID");
if (nameIdElement != null) {
NameId nameId = new NameId();
nameId.setValue(nameIdElement.getTextContent());
nameId.setFormat(nameIdElement.getAttribute("Format"));
subject.setNameId(nameId);
}
assertion.setSubject(subject);
}
if (null != (attributeStatement = this.getChildElement(assertionElement, "AttributeStatement"))) {
NodeList nodeList = attributeStatement.getElementsByTagNameNS("urn:oasis:names:tc:SAML:2.0:assertion", "Attribute");
for (int i = 0; i < nodeList.getLength(); ++i) {
assertion.addAttribute(this.parseAttribute((Element)nodeList.item(i)));
}
}
if ((conditionsElement = this.getChildElement(assertionElement, "Conditions")).hasAttribute("NotBefore")) {
assertion.setNotBefore(this.getDateAttr(conditionsElement, "NotBefore"));
}
if (conditionsElement.hasAttribute("NotOnOrAfter")) {
assertion.setNotOnOrAfter(this.getDateAttr(conditionsElement, "NotOnOrAfter"));
}
if (null != (audienceRestrictionElement = this.getChildElement(conditionsElement, "AudienceRestriction"))) {
NodeList nodeList = audienceRestrictionElement.getElementsByTagNameNS("urn:oasis:names:tc:SAML:2.0:assertion", "Audience");
for (int i = 0; i < nodeList.getLength(); ++i) {
assertion.addAudienceRestriction(nodeList.item(i).getTextContent());
}
}
LinkedList<Element> authnStatementElements = this.getChildElements(assertionElement, "AuthnStatement");
for (Element authnStatementElement : authnStatementElements) {
AuthnStatement authnStatement = new AuthnStatement();
if (authnStatementElement.hasAttribute("AuthnInstant")) {
authnStatement.setAuthnInstant(this.getDateAttr(authnStatementElement, "AuthnInstant"));
}
if (authnStatementElement.hasAttribute("SessionNotOnOrAfter")) {
authnStatement.setSessionNotOnOrAfter(this.getDateAttr(authnStatementElement, "SessionNotOnOrAfter"));
}
if (authnStatementElement.hasAttribute("SessionIndex")) {
authnStatement.setSessionIndex(authnStatementElement.getAttribute("SessionIndex"));
}
assertion.addAuthnStatement(authnStatement);
}
return assertion;
}
protected Attribute parseAttribute(Element attributeElement) {
Attribute attribute = new Attribute();
attribute.setName(attributeElement.getAttribute("Name"));
attribute.setNameFormat(attributeElement.getAttribute("NameFormat"));
NodeList valueElements = attributeElement.getElementsByTagNameNS("urn:oasis:names:tc:SAML:2.0:assertion", "AttributeValue");
for (int i = 0; i < valueElements.getLength(); ++i) {
Element valueElement = (Element)valueElements.item(i);
attribute.addAttributeValue(valueElement.getTextContent().trim());
}
return attribute;
}
protected Status parseStatus(Element statusElement) {
Status status = new Status();
Element statusCodeElement = this.getChildElement(statusElement, "StatusCode");
if (null != statusCodeElement) {
status.setStatusCode(statusCodeElement.getAttribute("Value"));
return status;
}
return null;
}
protected Calendar getDateAttr(Element element, String attrName) {
String value = element.getAttribute(attrName);
if (null != value && !"".equals(value)) {
Calendar calendar = ISODateTimeFormat.dateTimeParser().withZone(DateTimeZone.forOffsetHours((int)0)).parseDateTime(value).toCalendar(Locale.getDefault());
return calendar;
}
return null;
}
protected Element getChildElement(Node node, String name) {
NodeList nodeList = node.getChildNodes();
for (int i = 0; i < nodeList.getLength(); ++i) {
Node child = nodeList.item(i);
if (1 != child.getNodeType() || !child.getLocalName().equals(name)) continue;
return (Element)child;
}
return null;
}
protected LinkedList<Element> getChildElements(Node node, String name) {
NodeList nodeList = node.getChildNodes();
LinkedList<Element> childElements = new LinkedList<Element>();
for (int i = 0; i < nodeList.getLength(); ++i) {
Node child = nodeList.item(i);
if (1 != child.getNodeType() || !child.getLocalName().equals(name)) continue;
childElements.add((Element)child);
}
return childElements;
}
static {
Init.init();
}
}