You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by cr...@locus.apache.org on 2000/11/01 00:53:31 UTC
cvs commit: jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves CertificatesValve.java LocalStrings.properties
craigmcc 00/10/31 15:53:31
Modified: catalina/src/share/org/apache/catalina/valves
CertificatesValve.java LocalStrings.properties
Log:
Enable per-web-app negotiation of the need for client certificates.
Previously, the SSL socket factory had to be configured globally to
require (or not require) client certificates for *all* apps. Now, you can
leave the factory configured to not require certificates. Individual
applications that use CLIENT-CERT authentication will automatically
renegotiate the SSL session (with client certificates required).
If all of your applications require client certificates, it is still
faster to configure the factory to require them -- this avoids the need to
renegotiate on every single session to every app.
Revision Changes Path
1.5 +296 -18 jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/CertificatesValve.java
Index: CertificatesValve.java
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/CertificatesValve.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CertificatesValve.java 2000/10/13 20:16:25 1.4
+++ CertificatesValve.java 2000/10/31 23:53:29 1.5
@@ -1,7 +1,7 @@
/*
- * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/CertificatesValve.java,v 1.4 2000/10/13 20:16:25 craigmcc Exp $
- * $Revision: 1.4 $
- * $Date: 2000/10/13 20:16:25 $
+ * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/CertificatesValve.java,v 1.5 2000/10/31 23:53:29 craigmcc Exp $
+ * $Revision: 1.5 $
+ * $Date: 2000/10/31 23:53:29 $
*
* ====================================================================
*
@@ -73,42 +73,66 @@
import java.security.cert.CertificateFactory;
import javax.security.cert.X509Certificate;
import javax.servlet.ServletException;
+import org.apache.catalina.Context;
import org.apache.catalina.Globals;
+import org.apache.catalina.Lifecycle;
+import org.apache.catalina.LifecycleEvent;
+import org.apache.catalina.LifecycleException;
+import org.apache.catalina.LifecycleListener;
+import org.apache.catalina.Logger;
import org.apache.catalina.Request;
import org.apache.catalina.Response;
import org.apache.catalina.Valve;
import org.apache.catalina.connector.RequestWrapper;
+import org.apache.catalina.deploy.LoginConfig;
+import org.apache.catalina.util.LifecycleSupport;
import org.apache.catalina.util.StringManager;
/**
- * Implementation of a Valve that checks if the socket underlying this
- * request is an SSLSocket or not. If it is, and if the client has presented
- * a certificate chain to authenticate itself, the array of certificates is
- * exposed as a request attribute.
- * <p>
- * In addition, this Valve exposes the cipher suite and key size being used
- * on this SSL connection as request attributes. Although this function is
- * unrelated to certificates, the two tasks have been combined here to minimize
- * the amount of code that has to check for the existence of JSSE classes.
+ * Implementation of a Valve that deals with SSL client certificates, as
+ * follows:
+ * <ul>
+ * <li>If this request was not received on an SSL socket, simply pass it
+ * on unmodified.</li>
+ * <li>If this request was received on an SSL socket:
+ * <ul>
+ * <li>If this web application is using client certificate authentication,
+ * and no certificate chain is present (because the underlying socket
+ * did not default to requiring it), force an SSL handshake to acquire
+ * the client certificate chain.</li>
+ * <li>If there is a client certificate chain present, expose it as a
+ * request attribute.</li>
+ * <li>Expose the cipher suite and key size used on this SSL socket
+ * as request attributes.</li>
+ * </ul>
*
+ * The above tasks have been combined into a single Valve to minimize the
+ * amount of code that has to check for the existence of JSSE classes.
+ *
* @author Craig R. McClanahan
- * @version $Revision: 1.4 $ $Date: 2000/10/13 20:16:25 $
+ * @version $Revision: 1.5 $ $Date: 2000/10/31 23:53:29 $
*/
public final class CertificatesValve
- extends ValveBase {
+ extends ValveBase implements Lifecycle {
// ----------------------------------------------------- Instance Variables
/**
+ * Are certificates required for authentication by this web application?
+ */
+ protected boolean certificates = false;
+
+
+ /**
* A mapping table to determine the number of effective bits in the key
* when using a cipher suite containing the specified cipher name. The
* underlying data came from the TLS Specification (RFC 2246), Appendix C.
*/
- private static final CipherData ciphers[] = {
+ protected static final CipherData ciphers[] = {
new CipherData("_WITH_NULL_", 0),
new CipherData("_WITH_IDEA_CBC_", 128),
new CipherData("_WITH_RC2_CBC_40_", 40),
@@ -121,23 +145,61 @@
/**
+ * The debugging detail level for this component.
+ */
+ protected int debug = 0;
+
+
+ /**
* The descriptive information related to this implementation.
*/
- private static final String info =
+ protected static final String info =
"org.apache.catalina.valves.CertificatesValve/1.0";
/**
+ * The lifecycle event support for this component.
+ */
+ protected LifecycleSupport lifecycle = new LifecycleSupport(this);
+
+
+ /**
* The StringManager for this package.
*/
protected static StringManager sm =
StringManager.getManager(Constants.Package);
+ /**
+ * Has this component been started yet?
+ */
+ protected boolean started = false;
+
+
// ------------------------------------------------------------- Properties
/**
+ * Return the debugging detail level for this component.
+ */
+ public int getDebug() {
+
+ return (this.debug);
+
+ }
+
+
+ /**
+ * Set the debugging detail level for this component.
+ */
+ public void setDebug(int debug) {
+
+ this.debug = debug;
+
+ }
+
+
+ /**
* Return descriptive information about this Valve implementation.
*/
public String getInfo() {
@@ -166,7 +228,13 @@
Request actual = request;
while (actual instanceof RequestWrapper)
actual = ((RequestWrapper) actual).getWrappedRequest();
+ // if (debug >= 2)
+ // log("Processing request");
+ // Verify the existence of a certificate chain if appropriate
+ if (certificates)
+ verify(request, actual);
+
// Expose the certificate chain if appropriate
expose(request, actual);
@@ -175,17 +243,109 @@
}
+
+ // ------------------------------------------------------ Lifecycle Methods
+
+
+ /**
+ * Add a LifecycleEvent listener to this component.
+ *
+ * @param listener The listener to add
+ */
+ public void addLifecycleListener(LifecycleListener listener) {
+
+ lifecycle.addLifecycleListener(listener);
+
+ }
+
+
+ /**
+ * Remove a LifecycleEvent listener from this component.
+ *
+ * @param listener The listener to remove
+ */
+ public void removeLifecycleListener(LifecycleListener listener) {
+
+ lifecycle.removeLifecycleListener(listener);
+
+ }
+
+
+ /**
+ * Prepare for the beginning of active use of the public methods of this
+ * component. This method should be called before any of the public
+ * methods of this component are utilized. It should also send a
+ * LifecycleEvent of type START_EVENT to any registered listeners.
+ *
+ * @exception IllegalStateException if this component has already been
+ * started
+ * @exception LifecycleException if this component detects a fatal error
+ * that prevents this component from being used
+ */
+ public void start() throws LifecycleException {
+
+ // Validate and update our current component state
+ if (started)
+ throw new LifecycleException
+ (sm.getString("certificatesValve.alreadyStarted"));
+ started = true;
+ if (debug >= 1)
+ log("Starting");
+
+ // Check what type of authentication (if any) we are doing
+ certificates = false;
+ if (container instanceof Context) {
+ Context context = (Context) container;
+ LoginConfig loginConfig = context.getLoginConfig();
+ if (loginConfig != null) {
+ String authMethod = loginConfig.getAuthMethod();
+ if ("CLIENT-CERT".equalsIgnoreCase(authMethod))
+ certificates = true;
+ }
+ }
+
+ // Notify our interested LifecycleListeners
+ lifecycle.fireLifecycleEvent(Lifecycle.START_EVENT, null);
+
+ }
+
- // -------------------------------------------------------- Private Methods
+ /**
+ * Gracefully terminate the active use of the public methods of this
+ * component. This method should be the last one called on a given
+ * instance of this component. It should also send a LifecycleEvent
+ * of type STOP_EVENT to any registered listeners.
+ *
+ * @exception IllegalStateException if this component has not been started
+ * @exception LifecycleException if this component detects a fatal error
+ * that needs to be reported
+ */
+ public void stop() throws LifecycleException {
+
+ // Validate and update our current component state
+ if (!started)
+ throw new LifecycleException
+ (sm.getString("certificatesValve.notStarted"));
+ lifecycle.fireLifecycleEvent(Lifecycle.STOP_EVENT, null);
+ started = false;
+ if (debug >= 1)
+ log("Stopping");
+
+ certificates = false;
+
+ }
+
+ // ------------------------------------------------------ Protected Methods
+
/**
* Expose the certificate chain for this request, if there is one.
*
* @param request The possibly wrapped Request being processed
* @param actual The actual underlying Request object
*/
- private void expose(Request request, Request actual) {
+ protected void expose(Request request, Request actual) {
// Ensure that this request came in on an SSLSocket
if (actual.getSocket() == null)
@@ -198,6 +358,8 @@
SSLSession session = socket.getSession();
if (session == null)
return;
+ // if (debug >= 2)
+ // log(" expose: Has current SSLSession");
// Expose the cipher suite and key size
String cipherSuite = session.getCipherSuite();
@@ -218,10 +380,15 @@
}
request.getRequest().setAttribute(Globals.KEY_SIZE_ATTR,
keySize);
+ // if (debug >= 2)
+ // log(" expose: Has cipher suite " + cipherSuite +
+ // " and key size " + keySize);
// If we have cached certificates, return them
Object cached = session.getValue(Globals.CERTIFICATES_ATTR);
if (cached != null) {
+ // if (debug >= 2)
+ // log(" expose: Has cached certificates");
request.getRequest().setAttribute(Globals.CERTIFICATES_ATTR,
cached);
return;
@@ -253,8 +420,119 @@
if ((x509Certs == null) || (x509Certs.length < 1))
return;
session.putValue(Globals.CERTIFICATES_ATTR, x509Certs);
+ log(" expose: Exposing converted certificates");
request.getRequest().setAttribute(Globals.CERTIFICATES_ATTR,
x509Certs);
+
+ }
+
+
+ /**
+ * Log a message on the Logger associated with our Container (if any).
+ *
+ * @param message Message to be logged
+ */
+ protected void log(String message) {
+
+ Logger logger = container.getLogger();
+ if (logger != null)
+ logger.log("CertificatesValve[" + container.getName() + "]: " +
+ message);
+ else
+ System.out.println("CertificatesValve[" + container.getName() +
+ "]: " + message);
+
+ }
+
+
+ /**
+ * Log a message on the Logger associated with our Container (if any).
+ *
+ * @param message Message to be logged
+ * @param throwable Associated exception
+ */
+ protected void log(String message, Throwable throwable) {
+
+ Logger logger = container.getLogger();
+ if (logger != null)
+ logger.log("CertificatesValve[" + container.getName() + "]: " +
+ message, throwable);
+ else {
+ System.out.println("CertificatesValve[" + container.getName() +
+ "]: " + message);
+ throwable.printStackTrace(System.out);
+ }
+
+ }
+
+
+ /**
+ * Verify that a client certificate chain exists if our web application
+ * is doing client certificate authentication.
+ *
+ * @param request The possibly wrapped Request being processed
+ * @param actual The actual underlying Request object
+ */
+ protected void verify(Request request, Request actual) {
+
+ // Ensure that this request came in on an SSLSocket
+ if (actual.getSocket() == null)
+ return;
+ if (!(actual.getSocket() instanceof SSLSocket))
+ return;
+ SSLSocket socket = (SSLSocket) actual.getSocket();
+
+ // Look up the current SSLSession
+ SSLSession session = socket.getSession();
+ if (session == null)
+ return;
+ // if (debug >= 2)
+ // log(" verify: Has current SSLSession");
+
+ // Verify that there is a client certificate chain present
+ X509Certificate jsseCerts[] = null;
+ try {
+ jsseCerts = session.getPeerCertificateChain();
+ if (jsseCerts == null)
+ jsseCerts = new X509Certificate[0];
+ } catch (SSLPeerUnverifiedException e) {
+ log(" verify: SSLPeerUnverifiedException");
+ jsseCerts = new X509Certificate[0];
+ }
+ // if (debug >= 2)
+ // log(" verify: Certificate chain has " +
+ // jsseCerts.length + " certificates");
+ if (jsseCerts.length > 0)
+ return;
+
+ // Force a new handshake to request the client certificates
+ // if (debug >= 2)
+ // log(" verify: Invalidating current session");
+ session.invalidate();
+ // if (debug >= 2)
+ // log(" verify: Forcing new SSL handshake");
+ socket.setNeedClientAuth(true);
+ try {
+ socket.startHandshake();
+ } catch (IOException e) {
+ log(" verify: ", e);
+ }
+
+ // Revalidate the existence of the required certificates
+ session = socket.getSession();
+ if (session == null)
+ return;
+ try {
+ jsseCerts = session.getPeerCertificateChain();
+ if (jsseCerts == null)
+ jsseCerts = new X509Certificate[0];
+ } catch (SSLPeerUnverifiedException e) {
+ log(" verify: SSLPeerUnverifiedException");
+ jsseCerts = new X509Certificate[0];
+ }
+ // if (debug >= 2)
+ // log(" verify: Certificate chain has " +
+ // jsseCerts.length + " certificates");
}
1.2 +2 -0 jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/LocalStrings.properties
Index: LocalStrings.properties
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/LocalStrings.properties,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LocalStrings.properties 2000/08/11 17:03:15 1.1
+++ LocalStrings.properties 2000/10/31 23:53:29 1.2
@@ -1,5 +1,7 @@
accessLogValve.alreadyStarted=Access Logger has already been started
accessLogValve.notStarted=Access Logger has not yet been started
+certificatesValve.alreadyStarted=Certificates Valve has already been started
+certificatesValve.notStarted=Certificates Valve has not yet been started
interceptorValve.alreadyStarted=Interceptor Valve has already been started
interceptorValve.notStarted=Interceptor Valve has not yet been started
requestFilterValve.next=No 'next' valve has been configured