org.netxms.base

Class EncryptionContext

java.lang.Object

org.netxms.base.EncryptionContext

public final class EncryptionContext
extends Object

Encryption context for NXCP communication session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EncryptionContext(int cipher) Internal constructor

Method Summary

Modifier and Type	Method and Description
static EncryptionContext	createInstance(NXCPMessage request) Create encryption context based on information from session key request message.
byte[]	decryptMessage(NXCPDataInputStream inputStream, int length) Decrypt message from input stream
byte[]	encryptMessage(NXCPMessage msg, boolean allowCompression) Encrypt NXCP message.
int	getCipher() Get cipher
static String	getCipherName(int cipher) Get cipher name
byte[]	getEncryptedIv(NXCPMessage msg) Encrypt initialization vector with public key from encryption setup message.
byte[]	getEncryptedSessionKey(NXCPMessage msg) Encrypt session key with public key from encryption setup message.
int	getIvLength() Get initialization vector length (in bytes)
int	getKeyLength() Get key length (in bytes)
static boolean	testCipher(int cipherId) Test cipher with given ID

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptionContext

protected EncryptionContext(int cipher)
                     throws GeneralSecurityException

Internal constructor

Parameters:

cipher - cipher to use

Throws:

GeneralSecurityException

Method Detail

getCipherName

public static String getCipherName(int cipher)

Get cipher name

Parameters:

cipher - cipher ID

Returns:

cipher name or null if ID is invalid or cipher is not supported

testCipher

public static boolean testCipher(int cipherId)

Test cipher with given ID

Parameters:

cipherId -

Returns:

true if cipher is available and working correctly

createInstance

public static EncryptionContext createInstance(NXCPMessage request)
                                        throws NXCPException

Create encryption context based on information from session key request message.

Parameters:

request - session key request message

Returns:

encryption context

Throws:

NXCPException - if encryption context cannot be created

getEncryptedSessionKey

public byte[] getEncryptedSessionKey(NXCPMessage msg)
                              throws GeneralSecurityException

Encrypt session key with public key from encryption setup message.

Parameters:

msg - encryption setup message

Returns:

encrypted session key

Throws:

GeneralSecurityException

getEncryptedIv

public byte[] getEncryptedIv(NXCPMessage msg)
                      throws GeneralSecurityException

Encrypt initialization vector with public key from encryption setup message.

Parameters:

msg - encryption setup message

Returns:

encrypted initialization vector

Throws:

GeneralSecurityException

encryptMessage

public byte[] encryptMessage(NXCPMessage msg,
                             boolean allowCompression)
                      throws IOException,
                             GeneralSecurityException

Encrypt NXCP message.

Parameters:

msg - message to encrypt

allowCompression - true if payload compression is allowed

Returns:

encrypted message as sequence of bytes, ready to send over the network

Throws:

IOException

GeneralSecurityException

InvalidKeyException

decryptMessage

public byte[] decryptMessage(NXCPDataInputStream inputStream,
                             int length)
                      throws GeneralSecurityException,
                             IOException

Decrypt message from input stream

Parameters:

inputStream - input stream

length - length of encrypted message

Returns:

decrypted message

Throws:

GeneralSecurityException

IOException

getCipher

public int getCipher()

Get cipher

Returns:

cipher

getKeyLength

public int getKeyLength()

Get key length (in bytes)

Returns:

key length (in bytes)

getIvLength

public int getIvLength()

Get initialization vector length (in bytes)

Returns:

initialization vector length (in bytes)