org.apache.nifi.remote.io.socket.ssl

Class SSLSocketChannel

java.lang.Object

org.apache.nifi.remote.io.socket.ssl.SSLSocketChannel

All Implemented Interfaces:

Closeable, AutoCloseable

public class SSLSocketChannel
extends Object
implements Closeable

SSLSocketChannel supports reading and writing bytes using TLS and NIO SocketChannels with configurable timeouts

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SSLSocketChannel.ChannelStatus

Field Summary

Fields

Modifier and Type	Field and Description
private BufferStateManager	appDataManager
private static long	BUFFER_FULL_EMPTY_WAIT_NANOS
private SocketChannel	channel
private SSLSocketChannel.ChannelStatus	channelStatus
private static boolean	CLIENT_AUTHENTICATION_REQUIRED
private static int	DISCARD_BUFFER_LENGTH
private static byte[]	EMPTY_MESSAGE
private static int	END_OF_STREAM
private SSLEngine	engine
private static long	FINISH_CONNECT_SLEEP
private static long	INITIAL_INCREMENTAL_SLEEP
private boolean	interrupted
private static org.slf4j.Logger	LOGGER
private static int	MINIMUM_READ_BUFFER_SIZE
private int	port
private String	remoteAddress
private SocketAddress	socketAddress
private BufferStateManager	streamInManager
private BufferStateManager	streamOutManager
private int	timeoutMillis

Constructor Summary

Constructors

Constructor and Description
SSLSocketChannel(SSLContext sslContext, SocketChannel socketChannel, boolean useClientMode) SSLSocketChannel constructor with SSLContext and connected SocketChannel
SSLSocketChannel(SSLContext sslContext, String remoteAddress, int port, InetAddress bindAddress, boolean useClientMode) SSLSocketChannel constructor with SSLContext and remote address parameters
SSLSocketChannel(SSLEngine sslEngine, SocketChannel socketChannel) SSLSocketChannel constructor with configured SSLEngine and connected SocketChannel

Method Summary

Modifier and Type	Method and Description
int	available() Get application bytes available for reading
private void	checkChannelStatus()
private void	checkInterrupted()
private void	checkTimeoutExceeded(long started)
void	close() Close Channel and process notifications
private void	closeQuietly(Closeable closeable)
void	connect() Connect Channel when not connected and perform handshake process
void	consume() Shutdown Socket Channel input and read available bytes
private static SSLEngine	createEngine(SSLContext sslContext, boolean useClientMode)
private static SocketChannel	createSocketChannel(InetAddress bindAddress)
private SSLHandshakeException	getHandshakeException(SSLEngineResult.HandshakeStatus handshakeStatus, String message)
int	getTimeout()
private long	incrementalSleep(long nanoseconds)
void	interrupt() Interrupt processing and disable transmission
boolean	isClosed() Is Channel Closed
private void	logEngineResult(SSLEngineResult result, String method)
private void	logHandshakeStatus(SSLEngineResult.HandshakeStatus handshakeStatus)
private void	logOperation(String operation)
private void	logOperationBytes(String operation, int bytes)
private void	performHandshake()
int	read() Read and return one byte
int	read(byte[] buffer) Read available bytes into buffer
int	read(byte[] buffer, int offset, int len) Read available bytes into buffer based on offset and length requested
private int	readApplicationBuffer(byte[] buffer, int offset, int len)
private int	readChannel()
private void	readChannelDiscard()
private void	runDelegatedTasks()
void	setTimeout(int timeoutMillis)
private SSLEngineResult	unwrap()
private SSLEngineResult	unwrapBufferReadChannel()
private SSLEngineResult	wrap(ByteBuffer inputBuffer, ByteBuffer outputBuffer)
private SSLEngineResult.Status	wrapWriteChannel(BufferStateManager inputManager)
void	write(byte[] data) Write bytes to channel
void	write(byte[] data, int offset, int len) Write data to channel performs multiple iterations based on data length
void	write(int data) Write one byte to channel
private void	writeChannel(ByteBuffer inputBuffer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

MINIMUM_READ_BUFFER_SIZE

private static final int MINIMUM_READ_BUFFER_SIZE

See Also:

Constant Field Values

DISCARD_BUFFER_LENGTH

private static final int DISCARD_BUFFER_LENGTH

See Also:

Constant Field Values

END_OF_STREAM

private static final int END_OF_STREAM

See Also:

Constant Field Values

EMPTY_MESSAGE

private static final byte[] EMPTY_MESSAGE

BUFFER_FULL_EMPTY_WAIT_NANOS

private static final long BUFFER_FULL_EMPTY_WAIT_NANOS

FINISH_CONNECT_SLEEP

private static final long FINISH_CONNECT_SLEEP

See Also:

Constant Field Values

INITIAL_INCREMENTAL_SLEEP

private static final long INITIAL_INCREMENTAL_SLEEP

See Also:

Constant Field Values

CLIENT_AUTHENTICATION_REQUIRED

private static final boolean CLIENT_AUTHENTICATION_REQUIRED

See Also:

Constant Field Values

remoteAddress

private final String remoteAddress

port

private final int port

engine

private final SSLEngine engine

socketAddress

private final SocketAddress socketAddress

streamInManager

private final BufferStateManager streamInManager

streamOutManager

private final BufferStateManager streamOutManager

appDataManager

private final BufferStateManager appDataManager

channel

private final SocketChannel channel

timeoutMillis

private int timeoutMillis

interrupted

private volatile boolean interrupted

channelStatus

private volatile SSLSocketChannel.ChannelStatus channelStatus

Constructor Detail

SSLSocketChannel

public SSLSocketChannel(SSLContext sslContext,
                        String remoteAddress,
                        int port,
                        InetAddress bindAddress,
                        boolean useClientMode)
                 throws IOException

SSLSocketChannel constructor with SSLContext and remote address parameters

Parameters:

sslContext - SSLContext used to create SSLEngine with specified client mode

remoteAddress - Remote Address used for connection

port - Remote Port used for connection

bindAddress - Local address used for binding server channel when provided

useClientMode - Use Client Mode

Throws:

IOException - Thrown on failures creating Socket Channel

SSLSocketChannel

public SSLSocketChannel(SSLContext sslContext,
                        SocketChannel socketChannel,
                        boolean useClientMode)
                 throws IOException

SSLSocketChannel constructor with SSLContext and connected SocketChannel

Parameters:

sslContext - SSLContext used to create SSLEngine with specified client mode

socketChannel - Connected SocketChannel

useClientMode - Use Client Mode

Throws:

IOException - Thrown on SocketChannel.getRemoteAddress()

SSLSocketChannel

public SSLSocketChannel(SSLEngine sslEngine,
                        SocketChannel socketChannel)
                 throws IOException

SSLSocketChannel constructor with configured SSLEngine and connected SocketChannel

Parameters:

sslEngine - SSLEngine configured with mode and client authentication

socketChannel - Connected SocketChannel

Throws:

IOException - Thrown on SocketChannel.getRemoteAddress()

Method Detail

setTimeout

public void setTimeout(int timeoutMillis)

getTimeout

public int getTimeout()

connect

public void connect()
             throws IOException

Connect Channel when not connected and perform handshake process

Throws:

IOException - Thrown on connection failures

consume

public void consume()
             throws IOException

Shutdown Socket Channel input and read available bytes

Throws:

IOException - Thrown on Socket Channel failures

isClosed

public boolean isClosed()

Is Channel Closed

Returns:

Channel Closed Status

close

public void close()
           throws IOException

Close Channel and process notifications

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - Thrown on SSLEngine.wrap() failures

available

public int available()
              throws IOException

Get application bytes available for reading

Returns:

Number of application bytes available for reading

Throws:

IOException - Thrown on failures checking for available bytes

read

public int read()
         throws IOException

Read and return one byte

Returns:

Byte read or -1 when end of stream reached

Throws:

IOException - Thrown on read failures

read

public int read(byte[] buffer)
         throws IOException

Read available bytes into buffer

Parameters:

buffer - Byte array buffer

Returns:

Number of bytes read

Throws:

IOException - Thrown on read failures

read

public int read(byte[] buffer,
                int offset,
                int len)
         throws IOException

Read available bytes into buffer based on offset and length requested

Parameters:

buffer - Byte array buffer

offset - Buffer offset

len - Length of bytes to read

Returns:

Number of bytes read

Throws:

IOException - Thrown on read failures

write

public void write(int data)
           throws IOException

Write one byte to channel

Parameters:

data - Byte to be written

Throws:

IOException - Thrown on write failures

write

public void write(byte[] data)
           throws IOException

Write bytes to channel

Parameters:

data - Byte array to be written

Throws:

IOException - Thrown on write failures

write

public void write(byte[] data,
                  int offset,
                  int len)
           throws IOException

Write data to channel performs multiple iterations based on data length

Parameters:

data - Byte array to be written

offset - Byte array offset

len - Length of bytes for writing

Throws:

IOException - Thrown on write failures

interrupt

public void interrupt()

Interrupt processing and disable transmission

performHandshake

private void performHandshake()
                       throws IOException

Throws:

IOException

unwrapBufferReadChannel

private SSLEngineResult unwrapBufferReadChannel()
                                         throws IOException

Throws:

IOException

readChannel

private int readChannel()
                 throws IOException

Throws:

IOException

readChannelDiscard

private void readChannelDiscard()

writeChannel

private void writeChannel(ByteBuffer inputBuffer)
                   throws IOException

Throws:

IOException

incrementalSleep

private long incrementalSleep(long nanoseconds)
                       throws IOException

Throws:

IOException

readApplicationBuffer

private int readApplicationBuffer(byte[] buffer,
                                  int offset,
                                  int len)

wrapWriteChannel

private SSLEngineResult.Status wrapWriteChannel(BufferStateManager inputManager)
                                         throws IOException

Throws:

IOException

wrap

private SSLEngineResult wrap(ByteBuffer inputBuffer,
                             ByteBuffer outputBuffer)
                      throws SSLException

Throws:

SSLException

unwrap

private SSLEngineResult unwrap()
                        throws IOException

Throws:

IOException

runDelegatedTasks

private void runDelegatedTasks()

closeQuietly

private void closeQuietly(Closeable closeable)

getHandshakeException

private SSLHandshakeException getHandshakeException(SSLEngineResult.HandshakeStatus handshakeStatus,
                                                    String message)

checkChannelStatus

private void checkChannelStatus()
                         throws IOException

Throws:

IOException

checkInterrupted

private void checkInterrupted()

checkTimeoutExceeded

private void checkTimeoutExceeded(long started)
                           throws SocketTimeoutException

Throws:

SocketTimeoutException

logOperation

private void logOperation(String operation)

logOperationBytes

private void logOperationBytes(String operation,
                               int bytes)

logHandshakeStatus

private void logHandshakeStatus(SSLEngineResult.HandshakeStatus handshakeStatus)

logEngineResult

private void logEngineResult(SSLEngineResult result,
                             String method)

createSocketChannel

private static SocketChannel createSocketChannel(InetAddress bindAddress)
                                          throws IOException

Throws:

IOException

createEngine

private static SSLEngine createEngine(SSLContext sslContext,
                                      boolean useClientMode)