com.sun.grizzly.ssl.SSLHandshakeEncoder Maven / Gradle / Ivy

Go to download
/*
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 *
 * Contributor(s):
 *
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 *
 */

package com.sun.grizzly.ssl;

import java.nio.ByteBuffer;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.net.ssl.SSLEngine;
import javax.net.ssl.SSLEngineResult;
import javax.net.ssl.SSLEngineResult.HandshakeStatus;
import javax.net.ssl.SSLException;
import com.sun.grizzly.Buffer;
import com.sun.grizzly.Connection;
import com.sun.grizzly.Grizzly;
import com.sun.grizzly.IOEvent;
import com.sun.grizzly.TransformationException;
import com.sun.grizzly.TransformationResult;
import com.sun.grizzly.TransformationResult.Status;
import com.sun.grizzly.Transformer;
import com.sun.grizzly.attributes.AttributeHolder;
import com.sun.grizzly.threadpool.WorkerThread;
import com.sun.grizzly.attributes.AttributeStorage;

/**
 * {@link Transformer}, which works as the encoder on the SSL handshaking phase.
 *
 * @author Alexey Stashok
 */
public class SSLHandshakeEncoder implements Transformer {
    private Logger logger = Grizzly.logger;
    private TransformationResult lastResult;

    public TransformationResult transform(AttributeStorage state)
            throws TransformationException {
        return transform(state, getInput(state), getOutput(state));
    }

    public TransformationResult transform(AttributeStorage state,
            Buffer input, Buffer output) throws TransformationException {

        SSLResourcesAccessor accessor = SSLResourcesAccessor.getInstance();
        SSLEngine sslEngine = accessor.getSSLEngine(state);
        assert sslEngine.getHandshakeStatus() == HandshakeStatus.NEED_WRAP;

        if (input == null) {
            input = getInput(state);
        }

        if (output == null) {
            output = getOutput(state);
        }
        
        SSLEngineResult result = null;

        try {
            if (logger.isLoggable(Level.FINE)) {
                    logger.fine("SSLHandshakeEncoder engine: " + sslEngine +
                            " input: " + input + " output: " + output);
            }

            result = sslEngine.wrap((ByteBuffer) input.underlying(),
                    (ByteBuffer) output.underlying());

            if (logger.isLoggable(Level.FINE)) {
                    logger.fine("SSLHandshakeEncoder engine: " + sslEngine +
                            " result: " + result + " input: " + input +
                            " output: " + output);
            }
        } catch (SSLException e) {
            throw new TransformationException(e);
        }
        
        if (!input.hasRemaining()) {
            accessor.setSecuredOutBuffer(state, null);
        }
        
        lastResult = new TransformationResult(Status.COMPLETED,
                output.duplicate().flip());

        if (result.getHandshakeStatus() == HandshakeStatus.NEED_UNWRAP) {
            // Lock the read even processing to not miss the peer reply
//            ((Connection) state).obtainProcessorLock(IOEvent.READ).lock();
        }

        return lastResult;
    }

    public Buffer getInput(AttributeStorage state) {
        SSLResourcesAccessor accessor = SSLResourcesAccessor.getInstance();
        Buffer buffer = accessor.obtainAppBuffer(state);
        buffer.position(buffer.limit());
        return buffer;
    }

    public void setInput(AttributeStorage state, Buffer input) {
        SSLResourcesAccessor accessor = SSLResourcesAccessor.getInstance();
        accessor.setAppBuffer(state, input);
    }

    public Buffer getOutput(AttributeStorage state) {
        SSLResourcesAccessor accessor = SSLResourcesAccessor.getInstance();
        return accessor.obtainSecuredOutBuffer(state);
    }

    public void setOutput(AttributeStorage state, Buffer output) {
        SSLResourcesAccessor accessor = SSLResourcesAccessor.getInstance();
        accessor.setSecuredOutBuffer(state, output);
    }

    public TransformationResult getLastResult(AttributeStorage state) {
        return lastResult;
    }

    public AttributeHolder getProperties(AttributeStorage state) {
        return state.getAttributes();
    }

    /**
     * If hibernate is called - it means result data were not written on network
     * completely and next write attempt may be executed in different thread,
     * so we need to detach all thread associated resources.
     * 
     * @param state
     */
    public void hibernate(AttributeStorage state) {
        // Check if last result message is associated with the WorkerThread
        if (lastResult != null) {
            Buffer lastResultMessage = lastResult.getMessage();
            if (lastResultMessage != null && lastResultMessage.hasRemaining()) {
                Buffer outputBuffer = getOutput(state);
                if (isWorkerThreadOutBuffer(outputBuffer)) {
                    // If associated - create new one
                    Connection connection = (Connection) state;
                    Buffer newBuffer =
                            connection.getTransport().getMemoryManager().
                            allocate(lastResultMessage.remaining());
                    newBuffer.put(lastResultMessage);
                    newBuffer.flip();
                    lastResult.setMessage(newBuffer);
                }
                outputBuffer.clear();
            }
        }
    }

    public void release(AttributeStorage state) {
        Buffer output = getOutput(state);
        output.clear();
        lastResult = null;
    }

    private boolean isWorkerThreadOutBuffer(Buffer output) {
        Thread thread = Thread.currentThread();
        if (thread instanceof WorkerThread) {
            WorkerThread workerThread = (WorkerThread) thread;
            SSLResourcesAccessor accessor = SSLResourcesAccessor.getInstance();
            return accessor.getSecuredOutBuffer(workerThread) == output;
        }

        return false;
    }
}