| /* * Licensed to Jasig under one or more contributor license * agreements. See the NOTICE file distributed with this work * for additional information regarding copyright ownership. * Jasig licenses this file to you under the Apache License, * Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a * copy of the License at the following location: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */package org.jasig.cas.client.validation;import java.io.StringReader;import java.util.*;import javax.xml.parsers.SAXParser;import javax.xml.parsers.SAXParserFactory;import org.jasig.cas.client.authentication.AttributePrincipal;import org.jasig.cas.client.authentication.AttributePrincipalImpl;import org.jasig.cas.client.proxy.Cas20ProxyRetriever;import org.jasig.cas.client.proxy.ProxyGrantingTicketStorage;import org.jasig.cas.client.proxy.ProxyRetriever;import org.jasig.cas.client.util.CommonUtils;import org.jasig.cas.client.util.XmlUtils;import org.xml.sax.Attributes;import org.xml.sax.InputSource;import org.xml.sax.SAXException;import org.xml.sax.XMLReader;import org.xml.sax.helpers.DefaultHandler;/** * Implementation of the TicketValidator that will validate Service Tickets in compliance with the CAS 2. * * @author Scott Battaglia * @since 3.1 */public class Cas20ServiceTicketValidator extends AbstractCasProtocolUrlBasedTicketValidator { /** The CAS 2.0 protocol proxy callback url. */ private String proxyCallbackUrl; /** The storage location of the proxy granting tickets. */ private ProxyGrantingTicketStorage proxyGrantingTicketStorage; /** Implementation of the proxy retriever. */ private ProxyRetriever proxyRetriever; /** * Constructs an instance of the CAS 2.0 Service Ticket Validator with the supplied * CAS server url prefix. * * @param casServerUrlPrefix the CAS Server URL prefix. * @param urlFactory URL connection factory to use when communicating with the server */ public Cas20ServiceTicketValidator(final String casServerUrlPrefix) { super(casServerUrlPrefix); this.proxyRetriever = new Cas20ProxyRetriever(casServerUrlPrefix, getEncoding(), getURLConnectionFactory()); } /** * Adds the pgtUrl to the list of parameters to pass to the CAS server. * * @param urlParameters the Map containing the existing parameters to send to the server. */ protected final void populateUrlAttributeMap(final Map<String, String> urlParameters) { // BUG: CWE-74 Improper Neutralization of Special Elements in Output Used by a Downstream Component ('Injection') // urlParameters.put("pgtUrl", encodeUrl(this.proxyCallbackUrl)); // FIXED: urlParameters.put("pgtUrl", this.proxyCallbackUrl); } protected String getUrlSuffix() { return "serviceValidate"; } protected final Assertion parseResponseFromServer(final String response) throws TicketValidationException { final String error = XmlUtils.getTextForElement(response, "authenticationFailure"); if (CommonUtils.isNotBlank(error)) { throw new TicketValidationException(error); } final String principal = XmlUtils.getTextForElement(response, "user"); final String proxyGrantingTicketIou = XmlUtils.getTextForElement(response, "proxyGrantingTicket"); final String proxyGrantingTicket; if (CommonUtils.isBlank(proxyGrantingTicketIou) || this.proxyGrantingTicketStorage == null) { proxyGrantingTicket = null; } else { proxyGrantingTicket = this.proxyGrantingTicketStorage.retrieve(proxyGrantingTicketIou); } if (CommonUtils.isEmpty(principal)) { throw new TicketValidationException("No principal was found in the response from the CAS server."); } final Assertion assertion; final Map<String, Object> attributes = extractCustomAttributes(response); if (CommonUtils.isNotBlank(proxyGrantingTicket)) { final AttributePrincipal attributePrincipal = new AttributePrincipalImpl(principal, attributes, proxyGrantingTicket, this.proxyRetriever); assertion = new AssertionImpl(attributePrincipal); } else { assertion = new AssertionImpl(new AttributePrincipalImpl(principal, attributes)); } customParseResponse(response, assertion); return assertion; } /** * Default attribute parsing of attributes that look like the following: * <cas:attributes> * <cas:attribute1>value</cas:attribute1> * <cas:attribute2>value</cas:attribute2> * </cas:attributes> * <p> * * Attributes look like following also parsed correctly: * <cas:attributes><cas:attribute1>value</cas:attribute1><cas:attribute2>value</cas:attribute2></cas:attributes> * <p> * * This code is here merely for sample/demonstration purposes for those wishing to modify the CAS2 protocol. You'll * probably want a more robust implementation or to use SAML 1.1 * * @param xml the XML to parse. * @return the map of attributes. */ protected Map<String, Object> extractCustomAttributes(final String xml) { final SAXParserFactory spf = SAXParserFactory.newInstance(); spf.setNamespaceAware(true); spf.setValidating(false); try { final SAXParser saxParser = spf.newSAXParser(); final XMLReader xmlReader = saxParser.getXMLReader(); final CustomAttributeHandler handler = new CustomAttributeHandler(); xmlReader.setContentHandler(handler); xmlReader.parse(new InputSource(new StringReader(xml))); return handler.getAttributes(); } catch (final Exception e) { logger.error(e.getMessage(), e); return Collections.emptyMap(); } } /** * Template method if additional custom parsing (such as Proxying) needs to be done. * * @param response the original response from the CAS server. * @param assertion the partially constructed assertion. * @throws TicketValidationException if there is a problem constructing the Assertion. */ protected void customParseResponse(final String response, final Assertion assertion) throws TicketValidationException { // nothing to do } public final void setProxyCallbackUrl(final String proxyCallbackUrl) { this.proxyCallbackUrl = proxyCallbackUrl; } public final void setProxyGrantingTicketStorage(final ProxyGrantingTicketStorage proxyGrantingTicketStorage) { this.proxyGrantingTicketStorage = proxyGrantingTicketStorage; } public final void setProxyRetriever(final ProxyRetriever proxyRetriever) { this.proxyRetriever = proxyRetriever; } protected final String getProxyCallbackUrl() { return this.proxyCallbackUrl; } protected final ProxyGrantingTicketStorage getProxyGrantingTicketStorage() { return this.proxyGrantingTicketStorage; } protected final ProxyRetriever getProxyRetriever() { return this.proxyRetriever; } private class CustomAttributeHandler extends DefaultHandler { private Map<String, Object> attributes; private boolean foundAttributes; private String currentAttribute; private StringBuilder value; @Override public void startDocument() throws SAXException { this.attributes = new HashMap<String, Object>(); } @Override public void startElement(final String namespaceURI, final String localName, final String qName, final Attributes attributes) throws SAXException { if ("attributes".equals(localName)) { this.foundAttributes = true; } else if (this.foundAttributes) { this.value = new StringBuilder(); this.currentAttribute = localName; } } @Override public void characters(final char[] chars, final int start, final int length) throws SAXException { if (this.currentAttribute != null) { value.append(chars, start, length); } } @Override public void endElement(final String namespaceURI, final String localName, final String qName) throws SAXException { if ("attributes".equals(localName)) { this.foundAttributes = false; this.currentAttribute = null; } else if (this.foundAttributes) { final Object o = this.attributes.get(this.currentAttribute); if (o == null) { this.attributes.put(this.currentAttribute, this.value.toString()); } else { final List<Object> items; if (o instanceof List) { items = (List<Object>) o; } else { items = new LinkedList<Object>(); items.add(o); this.attributes.put(this.currentAttribute, items); } items.add(this.value.toString()); } } } public Map<String, Object> getAttributes() { return this.attributes; } }} |