proton-j/src/test/java/org/apache/qpid/proton/engine/impl/ssl/SslHandshakeSniffingTransportWrapperTest.java

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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
 *
 *   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.qpid.proton.engine.impl.ssl;

import static org.apache.qpid.proton.engine.impl.TransportTestHelper.assertByteBufferContentEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.when;

import java.nio.ByteBuffer;

import org.apache.qpid.proton.engine.TransportException;
import org.apache.qpid.proton.engine.impl.TransportWrapper;
import org.junit.Test;

public class SslHandshakeSniffingTransportWrapperTest
{
    private static final byte[] EXAMPLE_SSL_V3_HANDSHAKE_BYTES = new byte[] {0x16, 0x03, 0x02, 0x00, 0x31};
    private static final byte[] EXAMPLE_SSL_V2_HANDSHAKE_BYTES = new byte[] {0x00, 0x00, 0x01, 0x03, 0x00};

    private SslTransportWrapper _secureTransportWrapper = mock(SslTransportWrapper.class);
    private TransportWrapper _plainTransportWrapper = mock(TransportWrapper.class);
    private SslTransportWrapper _sniffingWrapper = new SslHandshakeSniffingTransportWrapper(_secureTransportWrapper, _plainTransportWrapper);

    @Test
    public void testGetInputBufferGetOutputBufferWithNonSsl()
    {
        testInputAndOutput("INPUT".getBytes(), _plainTransportWrapper);
    }

    @Test
    public void testWithSSLv2()
    {
        testInputAndOutput(EXAMPLE_SSL_V2_HANDSHAKE_BYTES, _secureTransportWrapper);
    }

    @Test
    public void testWithSSLv3TLS()
    {
        testInputAndOutput(EXAMPLE_SSL_V3_HANDSHAKE_BYTES, _secureTransportWrapper);
    }

    private void testInputAndOutput(byte[] input, TransportWrapper transportThatShouldBeUsed)
    {
        byte[] output = "OUTPUT".getBytes();

        ByteBuffer underlyingInputBuffer = ByteBuffer.allocate(1024);
        ByteBuffer underlyingOutputBuffer = ByteBuffer.wrap(output);

        // set up underlying transport
        when(transportThatShouldBeUsed.tail()).thenReturn(underlyingInputBuffer);
        when(transportThatShouldBeUsed.head()).thenReturn(underlyingOutputBuffer);

        // do input and verify underlying calls were made
        ByteBuffer inputBuffer = _sniffingWrapper.tail();
        inputBuffer.put(input);
        _sniffingWrapper.process();

        verify(transportThatShouldBeUsed).tail();
        verify(transportThatShouldBeUsed).process();

        // check the wrapped input actually received the expected bytes
        underlyingInputBuffer.flip();
        assertByteBufferContentEquals(input, underlyingInputBuffer);

        // do output and check we get the correct transport's output
        ByteBuffer outputBuffer = _sniffingWrapper.head();
        verify(transportThatShouldBeUsed).head();

        assertByteBufferContentEquals(output, outputBuffer);
        int consumed = outputBuffer.position();
        _sniffingWrapper.pop(consumed);
        verify(transportThatShouldBeUsed).pop(consumed);

        verifyNoInteractionsWithOtherTransport(transportThatShouldBeUsed);
    }

    @Test
    public void testTooFewBytesToMakeDetermination()
    {
        byte[] sourceBuffer = new byte[] {0x00};

        try
        {
            _sniffingWrapper.tail().put(sourceBuffer);
            _sniffingWrapper.close_tail();

            try {
                _sniffingWrapper.process();
                fail("Expected an exception to be thrown");
            } catch (TransportException te) {
                // Expected
            }
        }
        finally
        {
            verifyNoInteractions(_secureTransportWrapper, _plainTransportWrapper);
        }
    }

    @Test
    public void testGetSslAttributesWhenProtocolIsNotYetDetermined_returnNull()
    {
        assertEquals("Cipher name should be null", null, _sniffingWrapper.getCipherName());
        assertEquals("Protocol name should be null", null, _sniffingWrapper.getProtocolName());
        verifyNoInteractions(_secureTransportWrapper, _plainTransportWrapper);
    }

    @Test
    public void testGetSslAttributesWhenUsingNonSsl_returnNull()
    {
        testGetSslAttributes("INPUT".getBytes(), _plainTransportWrapper, null, null);
    }

    /**
     * Tests {@link SslHandshakeSniffingTransportWrapper#getCipherName()}
     * and {@link SslHandshakeSniffingTransportWrapper#getProtocolName()}.
     */
    @Test
    public void testGetSslAttributesWhenUsingSsl()
    {
        String cipherName = "testCipherName";
        String protocolName = "testProtocolName";
        when(_secureTransportWrapper.getCipherName()).thenReturn(cipherName);
        when(_secureTransportWrapper.getProtocolName()).thenReturn(protocolName);

        testGetSslAttributes(EXAMPLE_SSL_V2_HANDSHAKE_BYTES, _secureTransportWrapper, cipherName, protocolName);
    }

    private void testGetSslAttributes(
            byte[] input, TransportWrapper transportThatShouldBeUsed,
            String expectedCipherName, String expectedProtocolName)
    {
        ByteBuffer underlyingInputBuffer = ByteBuffer.allocate(1024);
        when(transportThatShouldBeUsed.tail()).thenReturn(underlyingInputBuffer);

        _sniffingWrapper.tail().put(input);
        _sniffingWrapper.process();

        assertEquals(expectedCipherName, _sniffingWrapper.getCipherName());
        assertEquals(expectedProtocolName, _sniffingWrapper.getProtocolName());

        verifyNoInteractionsWithOtherTransport(transportThatShouldBeUsed);
    }

    private void verifyNoInteractionsWithOtherTransport(TransportWrapper transportThatShouldBeUsed)
    {
        final TransportWrapper transportThatShouldNotBeUsed;
        if(transportThatShouldBeUsed == _plainTransportWrapper)
        {
            transportThatShouldNotBeUsed = _secureTransportWrapper;
        }
        else
        {
            transportThatShouldNotBeUsed = _plainTransportWrapper;
        }

        verifyNoInteractions(transportThatShouldNotBeUsed);
    }

}