oracle.okv.kmip

Class OKVSSLConnection

java.lang.Object

oracle.okv.kmip.OKVSSLConnection

All Implemented Interfaces:

OKVPrimitiveConnection

public final class OKVSSLConnection
extends java.lang.Object
implements OKVPrimitiveConnection

Establishes an SSL connection with an Oracle Key Vault server, and then handles the sending and receiving of byte arrays to and from the server.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	AIX_ENV
private static java.lang.String	ALG_PKIX PKIX algorithm for key manager factory and trust manager factory
private static java.lang.String	ALG_SUNX509 SunX509 algorithm for key manager factory and trust manager factory
private java.io.BufferedInputStream	bis
private java.io.BufferedOutputStream	bos
(package private) static java.lang.String	CLASS_NAME
(package private) static java.util.logging.Logger	logger
private static int	OKV_DEFAULT_PORT Default port to which connection needs to be established if no port is provided in the configuration file
private static java.lang.String	OKV_PKCS12 Wallet type of PKCS12 wallets
private static java.lang.String	OKV_PKCS12_WALLET PKCS12 wallet ewallet.p12 will be used as SSL Connection wallet if a psd is given
private static java.lang.String	OKV_SSO Wallet type of SSO wallets
private static java.lang.String	OKV_SSO_WALLET SSO wallet cwallet.sso will be used as SSL connection wallet if psd is not provided
private static java.lang.String	PLATFORM
private oracle.okv.utils.OKVSecureString	psd
private java.lang.String	serverIP
private int	serverPort
private javax.net.ssl.SSLSocket	ssl_connection
(package private) static java.lang.String	TLS_1_2
private java.lang.String	walletLoc

Constructor Summary

Constructors

Constructor and Description
OKVSSLConnection(java.lang.String serverIP, int serverPort, java.lang.String walletLoc, oracle.okv.utils.OKVSecureString psd)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection to the Oracle Key Vault server if it is not yet already closed.
byte[]	getCACertFromSSLConnection(java.lang.String userCertIssuerDN) Get CA Certificate from SSL connection.
private java.lang.String	getWalletLocation() Get the complete SSL connection wallet file location.
private java.lang.String	getWalletType() Get the SSL connection wallet type.
boolean	isClosed() Checks if the connection is closed.
void	open() Opens the connection to the Oracle Key Vault server if it is not yet already open.
int	recv(byte[] bytes, int offset, int len) Receives a byte array from the Oracle Key Vault server.
void	send(byte[] bytes) Sends a byte array to the Oracle Key Vault server.
private void	setupSSLConnection() Sets up the connection with the Oracle Key Vault Server.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

static final java.lang.String CLASS_NAME

logger

static final java.util.logging.Logger logger

TLS_1_2

static final java.lang.String TLS_1_2

See Also:

Constant Field Values

OKV_PKCS12_WALLET

private static final java.lang.String OKV_PKCS12_WALLET

PKCS12 wallet ewallet.p12 will be used as SSL Connection wallet if a psd is given

See Also:

Constant Field Values

OKV_SSO_WALLET

private static final java.lang.String OKV_SSO_WALLET

SSO wallet cwallet.sso will be used as SSL connection wallet if psd is not provided

See Also:

Constant Field Values

OKV_PKCS12

private static final java.lang.String OKV_PKCS12

Wallet type of PKCS12 wallets

See Also:

Constant Field Values

OKV_SSO

private static final java.lang.String OKV_SSO

Wallet type of SSO wallets

See Also:

Constant Field Values

ALG_SUNX509

private static final java.lang.String ALG_SUNX509

SunX509 algorithm for key manager factory and trust manager factory

See Also:

Constant Field Values

ALG_PKIX

private static final java.lang.String ALG_PKIX

PKIX algorithm for key manager factory and trust manager factory

See Also:

Constant Field Values

OKV_DEFAULT_PORT

private static final int OKV_DEFAULT_PORT

Default port to which connection needs to be established if no port is provided in the configuration file

See Also:

Constant Field Values

PLATFORM

private static final java.lang.String PLATFORM

See Also:

Constant Field Values

AIX_ENV

private static final java.lang.String AIX_ENV

See Also:

Constant Field Values

serverIP

private java.lang.String serverIP

serverPort

private int serverPort

walletLoc

private java.lang.String walletLoc

ssl_connection

private javax.net.ssl.SSLSocket ssl_connection

bos

private java.io.BufferedOutputStream bos

bis

private java.io.BufferedInputStream bis

psd

private oracle.okv.utils.OKVSecureString psd

Constructor Detail

OKVSSLConnection

public OKVSSLConnection(java.lang.String serverIP,
                        int serverPort,
                        java.lang.String walletLoc,
                        oracle.okv.utils.OKVSecureString psd)
                 throws OKVConnectionException

Throws:

OKVConnectionException

Method Detail

setupSSLConnection

private void setupSSLConnection()
                         throws OKVConnectionException

Sets up the connection with the Oracle Key Vault Server. Typically called from by the open operation.

Throws:

OKVConnectionException

send

public void send(byte[] bytes)
          throws java.io.IOException

Sends a byte array to the Oracle Key Vault server.

Specified by:

send in interface OKVPrimitiveConnection

Parameters:

bytes - the bytes to be sent to the server

Throws:

java.io.IOException

open

public void open()
          throws java.io.IOException,
                 OKVConnectionException

Opens the connection to the Oracle Key Vault server if it is not yet already open.

Specified by:

open in interface OKVPrimitiveConnection

Throws:

java.io.IOException

OKVConnectionException

isClosed

public boolean isClosed()

Checks if the connection is closed.

Specified by:

isClosed in interface OKVPrimitiveConnection

Returns:

true if connection is closed false otherwise

close

public void close()
           throws java.io.IOException

Closes the connection to the Oracle Key Vault server if it is not yet already closed.

Specified by:

close in interface OKVPrimitiveConnection

Throws:

java.io.IOException

recv

public int recv(byte[] bytes,
                int offset,
                int len)

Receives a byte array from the Oracle Key Vault server.

Specified by:

recv in interface OKVPrimitiveConnection

Parameters:

bytes - the byte array to which content from OKV server is to be read

offset - offset at which to start storing the bytes

len - maximum number of bytes to read

Returns:

-1 to indicate end-of-file otherwise, number of bytes read

getWalletLocation

private java.lang.String getWalletLocation()
                                    throws OKVConfigurationException

Get the complete SSL connection wallet file location.

Returns:

complete wallet file location

Throws:

OKVConfigurationException

getWalletType

private java.lang.String getWalletType()

Get the SSL connection wallet type.

Returns:

wallet type

getCACertFromSSLConnection

public byte[] getCACertFromSSLConnection(java.lang.String userCertIssuerDN)

Get CA Certificate from SSL connection.

Parameters:

userCertIssuerDN - DN of CA Certificate to be returned

Returns:

byte array of the CA Certificate