Hi,

In article <[EMAIL PROTECTED]>,
Fri, 20 Feb 2004 11:56:29 +0900 (JST),
Kazuhito SUGURI <[EMAIL PROTECTED]> wrote: 
suguri> I modified FormAuthentication while we (Ankur and I) were solving this. 
suguri> # please refer archive of cactus-users ML for detail.
suguri> 
suguri> I believe the new FormAuthentication will be a solution for a issue:
suguri>         http://issues.apache.org/bugzilla/show_bug.cgi?id=17933
suguri> 
suguri> The code is appending to this message.
suguri> The code is modified from the one of the source release of Cactus-1.5.

I didn't care about difference between 1.5 and 1.6dev,
so I modified little more.

The code modified from the one of cactus-1.6dev20040225 is appending.


Followings are what I did to the original cactus-1.6dev20040225:
1. Bug #17933 is fixed (I hope so)
(1) Get hostname from a HttpURLConnection instance of the first connection,
    which should contains set-cookie header field in its response,
    then pass the hostname to the first argument of Cookie(String, String, String)
    constructor.
(2) Use WebRequest#addCookie(Cookie) instead of WebRequest#addCookie(String, String)
    
2. New accessors are provided
(1) setExpectedPreAuthResponse(int)/getExpectedPreAuthResponse()
        Set/get the expected HTTP response code for a request
        to a restricted resource without authenticated principal.
        The default is HttpURLConnection.HTTP_MOVED_TEMP.

        If the response code of the first connection is not what's expected,
        authentication process will not be proceeded.

(2) setExpectedAuthResponse(int)/getExpectedAuthResponse()
        Set/get the expected HTTP response code for an authntication request
        which should be succeeded.
        The default is HttpURLConnection.HTTP_MOVED_TEMP.

        If the response code of the second connection is not what's expected,
        the authentication is considerd as failed.

(3) setSessionCookieName(String)/getSessionCookieName()
        Set/get the cookie name of the session. The default is "JSESSIONID". 


Best Regards,
----
Kazuhito SUGURI
mailto:[EMAIL PROTECTED]
/* 
 * ========================================================================
 * 
 * Copyright 2001-2003 The Apache Software Foundation.
 *
 * Licensed 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
 * 
 *   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.apache.cactus.client.authentication;

import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;

import org.apache.cactus.Cookie;
import org.apache.cactus.WebRequest;
import org.apache.cactus.client.connector.http.ConnectionHelper;
import org.apache.cactus.client.connector.http.ConnectionHelperFactory;
import org.apache.cactus.configuration.Configuration;
import org.apache.cactus.configuration.WebConfiguration;
import org.apache.cactus.internal.WebRequestImpl;
import org.apache.cactus.util.ChainedRuntimeException;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Form-based authentication implementation. An instance of this class
 * can be reused across several tests as it caches the session cookie.
 * Thus the first time it is used to authenticate the user, it calls
 * the security URL (which is by default the context URL prepended by
 * "j_security_check"), caches the returned session cookie and adds the
 * cookie for the next request. The second time it is called, it simply
 * addes the session cookie for the next request.
 * 
 * @author <a href="mailto:[EMAIL PROTECTED]">Jason Robertson</a>
 * @author <a href="mailto:[EMAIL PROTECTED]">Vincent Massol</a>
 * @author <a href="mailto:[EMAIL PROTECTED]">Kazuhito SUGURI</a>
 *
 * @since 1.5
 *
 * @version $Id: $
 */
public class FormAuthentication extends AbstractAuthentication
{
    /**
     * The logger.
     */
    private static final Log LOGGER = 
        LogFactory.getLog(FormAuthentication.class);

    /**
     * The expected HTTP response code for the request to a restricted
     * resource without authenticated principal.
     */
    private int expectedPreAuthResponse = HttpURLConnection.HTTP_MOVED_TEMP;

    /**
     * The expected HTTP response code when the authentication is succeeded.
     */
    private int expectedAuthResponse = HttpURLConnection.HTTP_MOVED_TEMP;

    /**
     * The URL to use when attempting to log in, if for whatever reason 
     * the default URL is incorrect.
     */
    private URL securityCheckURL = null;

    /**
     * The cookie name of the session.
     */
    private String sessionCookieName = "JSESSIONID";

    /**
     * We store the session cookie.
     */
    private Cookie jsessionCookie = null;


    /**
     * [EMAIL PROTECTED] WebRequest} object that will be used to connect to the
     * security URL. 
     */
    private WebRequest securityRequest = new WebRequestImpl();
      
    /**
     * @param theName user name of the Credential
     * @param thePassword user password of the Credential
     */
    public FormAuthentication(String theName, String thePassword)
    {
        super(theName, thePassword);
    }
    
    /**
     * @see AbstractAuthentication#validateName(String)
     */
    protected void validateName(String theName)
    {
        // Nothing to do here...
    }
    
    /**
     * @see AbstractAuthentication#validatePassword(String)
     */
    protected void validatePassword(String thePassword)
    {
        // Nothing to do here...
    }

    /**
     * @see AbstractAuthentication#configure(WebRequest, Configuration)
     */
    public void configure(WebRequest theRequest,
        Configuration theConfiguration)
    {
        // Only authenticate the first time this instance is used.
        if (this.jsessionCookie == null)
        {
           authenticate(theRequest, theConfiguration);
        }

        // Sets the session id cookie for the next request.
        if (this.jsessionCookie != null)
        {
            theRequest.addCookie(this.jsessionCookie);
        }
    }

    /**
     * @return the [EMAIL PROTECTED] WebRequest} that will be used to connect to the
     * security URL. It can be used to add additional HTTP parameters such
     * as proprietary ones required by some containers.
     */
    public WebRequest getSecurityRequest()
    {
        return this.securityRequest;
    }
    
    /**
     * This sets the URL to use when attempting to log in. This method is used
     * if for whatever reason the default URL is incorrect.
     *
     * @param theUrl A URL to use to attempt to login.
     */
    public void setSecurityCheckURL(URL theUrl)
    {
       this.securityCheckURL = theUrl;
    }
    
    /**
     * This returns the URL to use when attempting to log in. By default, it's
     * the context URL defined in the Cactus configuration with  
     * "/j_security_check" appended. 
     *
     * @param theConfiguration the Cactus configuration
     * @return the URL that is being used to attempt to login.
     */
    public URL getSecurityCheckURL(Configuration theConfiguration)
    {
        if (this.securityCheckURL == null)
        {
            // Configure default
            String stringUrl = 
                ((WebConfiguration) theConfiguration).getContextURL()
                + "/j_security_check";

            try
            {
                this.securityCheckURL = new URL(stringUrl);
            }
            catch (MalformedURLException e)
            {
                throw new ChainedRuntimeException(
                    "Unable to create default Security Check URL [" 
                    + stringUrl + "]");
            }
        }

        LOGGER.debug("Using security check URL [" + this.securityCheckURL
            + "]");

        return securityCheckURL;
    }


    /**
     * Get the cookie name of the session.
     */
    public String getSessionCookieName(){
        return this.sessionCookieName;
    }

    /**
     * Set the cookie name of the session to theName.
     * If theName is null, the change request will be ignored.
     * The default is &quot;<code>JSESSIONID</code>&quot;.
     */
    public void setSessionCookieName(String theName){
        if(theName==null){
            return;
        }
        this.sessionCookieName = theName;
    }

    /**
     * Get the expected HTTP response code for a request to a restricted
     * resource without authenticated principal.
     */
    public int getExpectedPreAuthResponse(){
        return this.expectedPreAuthResponse;
    }

    /**
     * Set the expected HTTP response code for a request to a restricted
     * resource without authenticated principal.
     * The default is HttpURLConnection.HTTP_MOVED_TEMP.
     */
    public void setExpectedPreAuthResponse(int expected){
        this.expectedPreAuthResponse = expected;
    }

    /**
     * Get the expected HTTP response code for an authentication request
     * which should be succeeded.
     */
    public int getExpectedAuthResponse(){
        return this.expectedAuthResponse;
    }

    /**
     * Set the expected HTTP response code for an authentication request
     * which should be succeeded.
     * The default is HttpURLConnection.HTTP_MOVED_TEMP.
     */
    public void setExpectedAuthResponse(int expected){
        this.expectedAuthResponse = expected;
    }


    private void checkResponseCodeEquals(int expected, int actual)
        throws Exception
    {
        if(actual!=expected){
            throw new Exception("Received a [" + actual + "] response code"
                                + " and was expecting a [" + expected + "]");
        }
    }


    private Cookie getCookie(HttpURLConnection connection, String target){
        // Check (possible multiple) cookies for a target.
        int i = 1;
        String key = connection.getHeaderFieldKey(i);
        while (key != null){
            if (key.equalsIgnoreCase("set-cookie")){
                // Cookie is in the form:
                // "NAME=VALUE; expires=DATE; path=PATH;
                //  domain=DOMAIN_NAME; secure"
                // The only thing we care about is finding a cookie with
                // the name "JSESSIONID" and caching the value.
                String cookiestr = connection.getHeaderField(i);
                String nameValue = cookiestr.substring(0, cookiestr.indexOf(";"));
                int equalsChar = nameValue.indexOf("=");
                String name = nameValue.substring(0, equalsChar);
                String value = nameValue.substring(equalsChar + 1);
                if (name.equalsIgnoreCase(target)){
                    return new Cookie(connection.getURL().getHost(),
                                      name, value);
                }
            }
            key = connection.getHeaderFieldKey(++i);
        }
        return null;
    }


    private Cookie getSecureSessionIdCookie(WebRequest theRequest,
                                           Configuration theConfiguration)
    {
        HttpURLConnection connection;
        String resource = null;

        try{
            // Create a helper that will connect to a restricted resource.
            resource = ((WebConfiguration) 
theConfiguration).getRedirectorURL(theRequest);
            ConnectionHelper helper =
                ConnectionHelperFactory.getConnectionHelper(resource,
                                                            theConfiguration);
            WebRequest request =
                new WebRequestImpl((WebConfiguration) theConfiguration);
            // Make the connection using a default web request.
            connection = helper.connect(request, theConfiguration);
            checkResponseCodeEquals(getExpectedPreAuthResponse(),
                                    connection.getResponseCode());
        }catch(Throwable e){
            throw new ChainedRuntimeException("Failed to connect to the secured 
redirector: "
                                              + resource, e);
        }

        return getCookie(connection, getSessionCookieName());
    }


    /**
     * Authenticate the principal by calling the security URL.
     * 
     * @param theRequest the web request used to connect to the Redirector
     * @param theConfiguration the Cactus configuration
     */
    public void authenticate(WebRequest theRequest,
                             Configuration theConfiguration)
    {
        jsessionCookie = getSecureSessionIdCookie(theRequest,
                                                  theConfiguration);
        
        try {
            // Create a helper that will connect to the security check URL.
            ConnectionHelper helper =
                
ConnectionHelperFactory.getConnectionHelper(getSecurityCheckURL(theConfiguration).toString(),
                                                            (WebConfiguration) 
theConfiguration);

            // Configure a web request with the JSESSIONID cookie,
            // the username and the password.
            WebRequest request = getSecurityRequest();
            ((WebRequestImpl)request).setConfiguration(theConfiguration);
            request.addCookie(jsessionCookie);
            request.addParameter("j_username", getName(), WebRequest.POST_METHOD);
            request.addParameter("j_password", getPassword(), WebRequest.POST_METHOD);

            // Make the connection using the configured web request.
            HttpURLConnection connection = helper.connect(request, theConfiguration);
            checkResponseCodeEquals(getExpectedAuthResponse(),
                                    connection.getResponseCode());
        }catch(Throwable e){
            // this may causes infinite loop...
            jsessionCookie = null;
            throw new ChainedRuntimeException("Failed to authenticate the principal",
                                              e);
        }
    }
}

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to