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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grizzly-http-webserver Show documentation
The newest version!
/*
 *
 * 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.io.IOException;
import java.nio.ByteBuffer;
import java.util.LinkedList;
import java.util.concurrent.Future;
import javax.net.ssl.SSLEngine;
import javax.net.ssl.SSLEngineResult;
import javax.net.ssl.SSLEngineResult.Status;
import javax.net.ssl.SSLException;
import com.sun.grizzly.Buffer;
import com.sun.grizzly.CompletionHandler;
import com.sun.grizzly.Connection;
import com.sun.grizzly.Grizzly;
import com.sun.grizzly.attributes.Attribute;
import com.sun.grizzly.streams.StreamReader;
import com.sun.grizzly.streams.StreamReaderDecorator;
import com.sun.grizzly.utils.conditions.Condition;

/**
 * SSL aware {@link StreamReader} implementation, which work like a wrapper over
 * existing {@link StreamReader}.
 *
 * @see SSLStreamWriter
 * 
 * @author Alexey Stashok
 */
public class SSLStreamReader extends StreamReaderDecorator {
    public static Attribute sslAttribute =
            Grizzly.DEFAULT_ATTRIBUTE_BUILDER.createAttribute("SSL_REMAINDER");
    
    public SSLStreamReader() {
        this(null);
    }

    public SSLStreamReader(StreamReader underlyingReader) {
        super(underlyingReader);
    }

    @Override
    public void setUnderlyingReader(StreamReader underlyingReader) {
        super.setUnderlyingReader(underlyingReader);
        
        if (underlyingReader != null) {
            checkBuffers();
            attach();
        }
    }

    @Override
    public boolean appendBuffer(Buffer buffer) {
        if (buffer == null) return false;
        
        checkBuffers();
        boolean wasAdded = true;
        SSLEngine sslEngine = getSSLEngine();
        while(wasAdded && buffer.hasRemaining()) {
            ByteBuffer underlyingByteBuffer = (ByteBuffer) buffer.underlying();

            Buffer newBuffer = newBuffer(bufferSize);
            ByteBuffer appByteBuffer = (ByteBuffer) newBuffer.underlying();
            SSLEngineResult result;
            try {
                result = sslEngine.unwrap(underlyingByteBuffer, appByteBuffer);
            } catch (SSLException e) {
                newBuffer.dispose();
                throw new IllegalStateException(e);
            }

            if (result.getStatus() == Status.OK ||
                    result.getStatus() == Status.CLOSED) {
                if (result.bytesProduced() > 0 || result.bytesConsumed() > 0) {
                    newBuffer.trim();
                    wasAdded = super.appendBuffer(newBuffer);
                } else {
                    wasAdded = false;
                    newBuffer.dispose();
                }
            } else {
                newBuffer.dispose();
                wasAdded = false;
            }
        }

        if (wasAdded) {
            buffer.dispose();
        }

        return wasAdded;
    }


    public SSLEngine getSSLEngine() {
        SSLResourcesAccessor resourceAccessor =
                SSLResourcesAccessor.getInstance();
        return resourceAccessor.getSSLEngine(getConnection());
    }


    /**
     * Attach state, saved in {@link Connection} to this {@link SSLStreamReader}.
     */
    protected void attach() {
        Connection connection = getConnection();
        if (connection == null || connection.getAttributes() == null) {
            return;
        }
        
        LinkedList attachedBuffers = sslAttribute.remove(connection.getAttributes());
        if (attachedBuffers != null) {
            dataRecords = attachedBuffers;
        } else if (dataRecords == null) {
            dataRecords = new LinkedList();
        }
    }

    /**
     * Save state of this {@link SSLStreamReader} into {@link Connection}.
     */
    protected void detach() {
        if (dataRecords != null && !dataRecords.isEmpty()) {
            sslAttribute.set(getConnection().obtainAttributes(), dataRecords);
            dataRecords = null;
        }
    }

    Future handshakeUnwrap(CompletionHandler completionHandler) throws IOException {
        return notifyCondition(new Condition() {

            public boolean check(StreamReader state) {
                return getSSLEngine().getHandshakeStatus() !=
                        SSLEngineResult.HandshakeStatus.NEED_UNWRAP;
            }
        }, completionHandler);
    }

    @Override
    protected Buffer read0() throws IOException {
        return underlyingReader.readBuffer();
    }

    private void checkBuffers() {
        SSLEngine sslEngine = getSSLEngine();

        if (sslEngine != null) {
            int underlyingBufferSize = sslEngine.getSession().getPacketBufferSize();
            if (underlyingReader.getBufferSize() < underlyingBufferSize) {
                underlyingReader.setBufferSize(underlyingBufferSize);
            }

            int appBufferSize = sslEngine.getSession().getApplicationBufferSize();
            if (bufferSize < appBufferSize) {
                bufferSize = appBufferSize;
            }
        }
    }

    @Override
    protected final Object wrap(Buffer buffer) {
        return buffer;
    }

    @Override
    protected Buffer unwrap(Object data) {
        return (Buffer) data;
    }
}