services.moleculer.serializer

Class BlockCipherSerializer

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.serializer.Serializer

services.moleculer.serializer.ChainedSerializer

services.moleculer.serializer.BlockCipherSerializer

All Implemented Interfaces:

MoleculerLifecycle

public class BlockCipherSerializer
extends ChainedSerializer

Serializer with Symmetric Key Encryption. This enables message-level encryption. Sample of usage:

 BlockCipherSerializer serializer = new BlockCipherSerializer();
 serializer.setAlgorithm("AES/CBC/PKCS5Padding");
 serializer.setPassword("12345678901234567890123456789012");
 serializer.setIv("1234567890123456");
 Transporter trans = new NatsTransporter("localhost");
 trans.setSerializer(serializer);
 ServiceBroker broker = ServiceBroker.builder()
                                     .nodeID("node1")
                                     .transporter(trans)
                                     .build();
 

Chaining Serializers (serialize then compress then encrypt packets):

 Transporter trans = new NatsTransporter("localhost");
 MsgPackSerializer msgPack = new MsgPackSerializer();
 DeflaterSerializer deflater = new DeflaterSerializer(msgPack);
 BlockCipherSerializer cipher = new BlockCipherSerializer(deflater);
 trans.setSerializer(cipher);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	algorithm Type of the block Cipher.
protected java.lang.ThreadLocal<javax.crypto.Cipher>	decriptors
static java.lang.String	DEFAULT_ALGORITHM Same as "aes-256-cbc" in Node.js.
static byte[]	EMPTY_IV Empty IV block.
protected java.lang.ThreadLocal<javax.crypto.Cipher>	encriptors
protected byte[]	iv Algorithm parameters (IV).
protected java.lang.String	password Password for Symmetric Key Encryption.
protected javax.crypto.spec.SecretKeySpec	secretKey SecretKeySpec, can be specified externally.

Fields inherited from class services.moleculer.serializer.ChainedSerializer

parent

Fields inherited from class services.moleculer.serializer.Serializer

debug, format, reader, writer

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Constructor Summary

Constructors

Constructor and Description
BlockCipherSerializer() Creates a JSON Serializer that uses AES encryption algorithm with the default password (using the hard-coded, default password is not very secure).
BlockCipherSerializer(Serializer parent) Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.
BlockCipherSerializer(Serializer parent, java.lang.String password) Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.
BlockCipherSerializer(Serializer parent, java.lang.String password, java.lang.String algorithm) Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.
BlockCipherSerializer(Serializer parent, java.lang.String password, java.lang.String algorithm, byte[] iv) Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.
BlockCipherSerializer(Serializer parent, java.lang.String password, java.lang.String algorithm, java.lang.String iv) Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.
BlockCipherSerializer(java.lang.String password) Creates a JSON Serializer that uses AES encryption algorithm to encrypt/decrypt messages.
BlockCipherSerializer(java.lang.String password, java.lang.String algorithm, byte[] iv) Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.
BlockCipherSerializer(java.lang.String password, java.lang.String algorithm, java.lang.String iv) Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.

Method Summary

Modifier and Type	Method and Description
protected byte[]	decrypt(javax.crypto.Cipher cipher, byte[] bytes)
protected byte[]	encrypt(javax.crypto.Cipher cipher, byte[] bytes)
java.lang.String	getAlgorithm()
protected java.lang.String	getAlgorithmName()
protected javax.crypto.Cipher	getDecryptor()
protected javax.crypto.Cipher	getEncriptor()
byte[]	getIv()
java.lang.String	getPassword()
javax.crypto.spec.SecretKeySpec	getSecretKey()
io.datatree.Tree	read(byte[] source)
void	setAlgorithm(java.lang.String algorithm)
void	setIv(byte[] iv)
void	setIv(java.lang.String iv)
void	setPassword(java.lang.String password)
void	setSecretKey(javax.crypto.spec.SecretKeySpec secretKey)
void	started(ServiceBroker broker)
byte[]	write(io.datatree.Tree value)

Methods inherited from class services.moleculer.serializer.ChainedSerializer

getFormat, setDebug, stopped

Methods inherited from class services.moleculer.serializer.Serializer

isDebug

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ALGORITHM

public static final java.lang.String DEFAULT_ALGORITHM

Same as "aes-256-cbc" in Node.js.

See Also:

Constant Field Values

EMPTY_IV

public static final byte[] EMPTY_IV

Empty IV block.

algorithm

protected java.lang.String algorithm

Type of the block Cipher. Possible values include:

• AES/CTR/NoPadding
• AES/CBC/PKCS5Padding
• AES
• DES
• DESede
• RC2
• Blowfish
• ARCFOUR
• etc.

password

protected java.lang.String password

Password for Symmetric Key Encryption. Using this hard-coded, default password is not secure. Use a custom password instead of this. The required password length is 32, when using "AES/CBC/PKCS5Padding"!

iv

protected byte[] iv

Algorithm parameters (IV). Can be "null".

secretKey

protected javax.crypto.spec.SecretKeySpec secretKey

SecretKeySpec, can be specified externally. If not specified, it is calculated from the "password".

encriptors

protected java.lang.ThreadLocal<javax.crypto.Cipher> encriptors

decriptors

protected java.lang.ThreadLocal<javax.crypto.Cipher> decriptors

Constructor Detail

BlockCipherSerializer

public BlockCipherSerializer()

Creates a JSON Serializer that uses AES encryption algorithm with the default password (using the hard-coded, default password is not very secure).

BlockCipherSerializer

public BlockCipherSerializer(java.lang.String password)

Creates a JSON Serializer that uses AES encryption algorithm to encrypt/decrypt messages.

Parameters:

password - password for Symmetric Key Encryption

BlockCipherSerializer

public BlockCipherSerializer(Serializer parent)

Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.

Parameters:

parent - parent Serializer (eg. a JsonSerializer)

BlockCipherSerializer

public BlockCipherSerializer(Serializer parent,
                             java.lang.String password)

Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.

Parameters:

parent - parent Serializer (eg. a JsonSerializer)

password - password for Symmetric Key Encryption

BlockCipherSerializer

public BlockCipherSerializer(Serializer parent,
                             java.lang.String password,
                             java.lang.String algorithm)

Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.

Parameters:

parent - parent Serializer (eg. a JsonSerializer)

password - password for Symmetric Key Encryption

algorithm - block Cipher type (eg. "AES", "DES", "DESede", "Blowfish")

BlockCipherSerializer

public BlockCipherSerializer(java.lang.String password,
                             java.lang.String algorithm,
                             byte[] iv)

Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.

Parameters:

password - password for Symmetric Key Encryption

algorithm - block Cipher type (eg. "AES", "DES", "DESede", "Blowfish")

iv - IV parameter (can be null)

BlockCipherSerializer

public BlockCipherSerializer(java.lang.String password,
                             java.lang.String algorithm,
                             java.lang.String iv)

Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.

Parameters:

password - password for Symmetric Key Encryption

algorithm - block Cipher type (eg. "AES", "DES", "DESede", "Blowfish")

iv - IV parameter (can be null)

BlockCipherSerializer

public BlockCipherSerializer(Serializer parent,
                             java.lang.String password,
                             java.lang.String algorithm,
                             java.lang.String iv)

Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.

Parameters:

parent - parent Serializer (eg. a JsonSerializer)

password - password for Symmetric Key Encryption

algorithm - block Cipher type (eg. "AES", "DES", "DESede", "Blowfish")

iv - IV parameter (can be null)

BlockCipherSerializer

public BlockCipherSerializer(Serializer parent,
                             java.lang.String password,
                             java.lang.String algorithm,
                             byte[] iv)

Creates a Serializer that uses a symmetric encryption algorithm to encrypt/decrypt messages.

Parameters:

parent - parent Serializer (eg. a JsonSerializer)

password - password for Symmetric Key Encryption

algorithm - block Cipher type (eg. "AES", "DES", "DESede", "Blowfish")

iv - IV parameter (can be null)

Method Detail

started

public void started(ServiceBroker broker)
             throws java.lang.Exception

Specified by:

started in interface MoleculerLifecycle

Overrides:

started in class ChainedSerializer

Throws:

java.lang.Exception

getAlgorithmName

protected java.lang.String getAlgorithmName()

write

public byte[] write(io.datatree.Tree value)
             throws java.lang.Exception

Overrides:

write in class Serializer

Throws:

java.lang.Exception

encrypt

protected byte[] encrypt(javax.crypto.Cipher cipher,
                         byte[] bytes)
                  throws java.lang.Exception

Throws:

java.lang.Exception

read

public io.datatree.Tree read(byte[] source)
                      throws java.lang.Exception

Overrides:

read in class Serializer

Throws:

java.lang.Exception

decrypt

protected byte[] decrypt(javax.crypto.Cipher cipher,
                         byte[] bytes)
                  throws java.lang.Exception

Throws:

java.lang.Exception

getEncriptor

protected javax.crypto.Cipher getEncriptor()
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDecryptor

protected javax.crypto.Cipher getDecryptor()
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getAlgorithm

public java.lang.String getAlgorithm()

setAlgorithm

public void setAlgorithm(java.lang.String algorithm)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getIv

public byte[] getIv()

setIv

public void setIv(java.lang.String iv)

setIv

public void setIv(byte[] iv)

getSecretKey

public javax.crypto.spec.SecretKeySpec getSecretKey()

setSecretKey

public void setSecretKey(javax.crypto.spec.SecretKeySpec secretKey)