EncryptBase

java.lang.Object
- org.jgroups.stack.Protocol
- - org.jgroups.protocols.EncryptBase

Direct Known Subclasses:

ASYM_ENCRYPT, SYM_ENCRYPT
```
public abstract class EncryptBase
extends Protocol
```
Super class of symmetric (SYM_ENCRYPT) and asymmetric (ASYM_ENCRYPT) encryption protocols.

Author:

Bela Ban

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`EncryptBase.Decrypter` Decrypts all messages in a batch, replacing encrypted messages in-place with their decrypted versions

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`asym_algorithm`
`protected int`	`asym_keylength`
`protected int`	`cipher_pool_size`
`protected java.util.concurrent.BlockingQueue<javax.crypto.Cipher>`	`decoding_ciphers`
`protected static java.lang.String`	`DEFAULT_SYM_ALGO`
`protected java.util.concurrent.BlockingQueue<javax.crypto.Cipher>`	`encoding_ciphers`
`protected boolean`	`encrypt_entire_message`
`protected java.util.Map<AsciiString,javax.crypto.Cipher>`	`key_map`
`protected int`	`key_map_max_size`
`protected Address`	`local_addr`
`protected java.lang.String`	`provider`
`protected java.security.Key`	`secret_key`
`protected boolean`	`sign_msgs`
`protected java.lang.String`	`sym_algorithm`
`protected int`	`sym_keylength`
`protected byte[]`	`sym_version`
`protected boolean`	`use_adler`
`protected View`	`view`

Fields inherited from class org.jgroups.stack.Protocol
after_creation_hook, down_prot, ergonomics, id, log, name, stack, stats, up_prot

Constructor Summary

Constructors
Constructor and Description

EncryptBase()

Constructors
Constructor and Description
`EncryptBase()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Message`	`_decrypt(javax.crypto.Cipher cipher, Message msg, EncryptHeader hdr)`
`boolean`	`adler()`
`<T extends EncryptBase> T`	`adler(boolean flag)`
`java.lang.String`	`asymAlgorithm()`
`<T extends EncryptBase> T`	`asymAlgorithm(java.lang.String alg)`
`int`	`asymKeylength()`
`<T extends EncryptBase> T`	`asymKeylength(int len)`
`protected byte[]`	`code(byte[] buf, int offset, int length, boolean decode)`
`protected long`	`computeChecksum(byte[] input, int offset, int length)`
`protected java.util.zip.Checksum`	`createChecksummer()`
`protected javax.crypto.Cipher`	`createCipher(int mode, java.security.Key secret_key, java.lang.String algorithm)`
`protected long`	`decryptChecksum(javax.crypto.Cipher cipher, byte[] input, int offset, int length)`
`protected Message`	`decryptMessage(javax.crypto.Cipher cipher, Message msg)` Does the actual work for decrypting - if version does not match current cipher then tries the previous cipher
`java.lang.Object`	`down(Event evt)` An event is to be sent down the stack.
`protected void`	`encryptAndSend(Message msg)`
`protected byte[]`	`encryptChecksum(long checksum)`
`boolean`	`encryptEntireMessage()`
`<T extends EncryptBase> T`	`encryptEntireMessage(boolean b)`
`protected static java.lang.String`	`getAlgorithm(java.lang.String s)`
`protected java.lang.Object`	`handleEncryptedMessage(Message msg)`
`protected void`	`handleUnknownVersion(byte[] version)` Called when the version shipped in the header can't be found
`protected java.lang.Object`	`handleUpEvent(Message msg, EncryptHeader hdr)`
`protected java.lang.Object`	`handleUpMessage(Message msg)`
`protected void`	`handleView(View view)`
`void`	`init()` Called after instance has been created (null constructor) and before protocol is started.
`protected void`	`initSymCiphers(java.lang.String algorithm, java.security.Key secret)` Initialises the ciphers for both encryption and decryption using the generated or supplied secret key
`protected boolean`	`inView(Address sender, java.lang.String error_msg)`
`<T extends EncryptBase> T`	`localAddress(Address addr)`
`protected boolean`	`process(Message msg)` Whether or not to process this received message
`java.security.Key`	`secretKey()`
`<T extends EncryptBase> T`	`secretKey(java.security.Key key)`
`boolean`	`signMessages()`
`<T extends EncryptBase> T`	`signMessages(boolean flag)`
`java.lang.String`	`symAlgorithm()`
`<T extends EncryptBase> T`	`symAlgorithm(java.lang.String alg)`
`int`	`symKeylength()`
`<T extends EncryptBase> T`	`symKeylength(int len)`
`byte[]`	`symVersion()`
`<T extends EncryptBase> T`	`symVersion(byte[] v)`
`java.lang.Object`	`up(Event evt)` An event was received from the layer below.
`void`	`up(MessageBatch batch)` Sends up a multiple messages in a `MessageBatch`.
`java.lang.String`	`version()`

Methods inherited from class org.jgroups.stack.Protocol
accept, afterCreationHook, destroy, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, start, statsEnabled, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SYM_ALGO

protected static final java.lang.String DEFAULT_SYM_ALGO

See Also:: Constant Field Values

provider
```
protected java.lang.String provider
```

asym_algorithm

protected java.lang.String asym_algorithm

sym_algorithm

protected java.lang.String sym_algorithm

asym_keylength
```
protected int asym_keylength
```

sym_keylength
```
protected int sym_keylength
```

cipher_pool_size
```
protected int cipher_pool_size
```

encrypt_entire_message

protected boolean encrypt_entire_message

sign_msgs
```
protected boolean sign_msgs
```

use_adler
```
protected boolean use_adler
```

key_map_max_size
```
protected int key_map_max_size
```

local_addr
```
protected volatile Address local_addr
```

view
```
protected volatile View view
```

encoding_ciphers

protected java.util.concurrent.BlockingQueue<javax.crypto.Cipher> encoding_ciphers

decoding_ciphers

protected java.util.concurrent.BlockingQueue<javax.crypto.Cipher> decoding_ciphers

sym_version
```
protected volatile byte[] sym_version
```

secret_key

protected volatile java.security.Key secret_key

key_map

protected java.util.Map<AsciiString,javax.crypto.Cipher> key_map

Constructor Detail
- EncryptBase
```
public EncryptBase()
```

Method Detail
- asymKeylength
```
public int asymKeylength()
```
- asymKeylength
```
public <T extends EncryptBase> T asymKeylength(int len)
```
- symKeylength
```
public int symKeylength()
```
- symKeylength
```
public <T extends EncryptBase> T symKeylength(int len)
```
- secretKey
```
public java.security.Key secretKey()
```
- secretKey
```
public <T extends EncryptBase> T secretKey(java.security.Key key)
```
- symAlgorithm
```
public java.lang.String symAlgorithm()
```
- symAlgorithm
```
public <T extends EncryptBase> T symAlgorithm(java.lang.String alg)
```
- asymAlgorithm
```
public java.lang.String asymAlgorithm()
```
- asymAlgorithm
```
public <T extends EncryptBase> T asymAlgorithm(java.lang.String alg)
```
- symVersion
```
public byte[] symVersion()
```
- symVersion
```
public <T extends EncryptBase> T symVersion(byte[] v)
```
- localAddress
```
public <T extends EncryptBase> T localAddress(Address addr)
```
- encryptEntireMessage
```
public boolean encryptEntireMessage()
```
- encryptEntireMessage
```
public <T extends EncryptBase> T encryptEntireMessage(boolean b)
```
- signMessages
```
public boolean signMessages()
```
- signMessages
```
public <T extends EncryptBase> T signMessages(boolean flag)
```
- adler
```
public boolean adler()
```
- adler
```
public <T extends EncryptBase> T adler(boolean flag)
```
- version
```
public java.lang.String version()
```
- init
```
public void init()
          throws java.lang.Exception
```
  Description copied from class: Protocol
  
  Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.
  
  Overrides:
  
  init in class Protocol
  
  Throws:
  
  java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception
- down
```
public java.lang.Object down(Event evt)
```
  Description copied from class: Protocol
  
  An event is to be sent down the stack. The layer may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the layer may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using up_prot.up().
  
  Overrides:
  
  down in class Protocol
- up
```
public java.lang.Object up(Event evt)
```
  Description copied from class: Protocol
  
  An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().
  
  Overrides:
  
  up in class Protocol
- up
```
public void up(MessageBatch batch)
```
  Description copied from class: Protocol
  
  Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.
  The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(org.jgroups.Message)), and - if true - calls Protocol.up(org.jgroups.Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.
  Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.getMatchingMessages(short,boolean)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.
  
  Overrides:
  
  up in class Protocol
  
  Parameters:
  
  batch - The message batch
- initSymCiphers
```
protected void initSymCiphers(java.lang.String algorithm,
                              java.security.Key secret)
                       throws java.lang.Exception
```
  Initialises the ciphers for both encryption and decryption using the generated or supplied secret key
  
  Throws:
  
  java.lang.Exception
- createCipher
```
protected javax.crypto.Cipher createCipher(int mode,
                                           java.security.Key secret_key,
                                           java.lang.String algorithm)
                                    throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- handleUpMessage
```
protected java.lang.Object handleUpMessage(Message msg)
                                    throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- handleEncryptedMessage
```
protected java.lang.Object handleEncryptedMessage(Message msg)
                                           throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- handleUpEvent
```
protected java.lang.Object handleUpEvent(Message msg,
                                         EncryptHeader hdr)
```
- process
```
protected boolean process(Message msg)
```
  Whether or not to process this received message
- handleView
```
protected void handleView(View view)
```
- inView
```
protected boolean inView(Address sender,
                         java.lang.String error_msg)
```
- createChecksummer
```
protected java.util.zip.Checksum createChecksummer()
```
- decryptMessage
```
protected Message decryptMessage(javax.crypto.Cipher cipher,
                                 Message msg)
                          throws java.lang.Exception
```
  Does the actual work for decrypting - if version does not match current cipher then tries the previous cipher
  
  Throws:
  
  java.lang.Exception
- _decrypt
```
protected Message _decrypt(javax.crypto.Cipher cipher,
                           Message msg,
                           EncryptHeader hdr)
                    throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- encryptAndSend
```
protected void encryptAndSend(Message msg)
                       throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- code
```
protected byte[] code(byte[] buf,
                      int offset,
                      int length,
                      boolean decode)
               throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- computeChecksum
```
protected long computeChecksum(byte[] input,
                               int offset,
                               int length)
```
- encryptChecksum
```
protected byte[] encryptChecksum(long checksum)
                          throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- decryptChecksum
```
protected long decryptChecksum(javax.crypto.Cipher cipher,
                               byte[] input,
                               int offset,
                               int length)
                        throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- getAlgorithm
```
protected static java.lang.String getAlgorithm(java.lang.String s)
```
- handleUnknownVersion
```
protected void handleUnknownVersion(byte[] version)
```
  Called when the version shipped in the header can't be found

Class EncryptBase

Nested Class Summary

Field Summary

Fields inherited from class org.jgroups.stack.Protocol

Constructor Summary

Method Summary

Methods inherited from class org.jgroups.stack.Protocol

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SYM_ALGO

provider

asym_algorithm

sym_algorithm

asym_keylength

sym_keylength

cipher_pool_size

encrypt_entire_message

sign_msgs

use_adler

key_map_max_size

local_addr

view

encoding_ciphers

decoding_ciphers

sym_version

secret_key

key_map

Constructor Detail

EncryptBase

Method Detail

asymKeylength

asymKeylength

symKeylength

symKeylength

secretKey

secretKey

symAlgorithm

symAlgorithm

asymAlgorithm

asymAlgorithm

symVersion

symVersion

localAddress

encryptEntireMessage

encryptEntireMessage

signMessages

signMessages

adler

adler

version

init

down

up

up

initSymCiphers

createCipher

handleUpMessage

handleEncryptedMessage

handleUpEvent

process

handleView

inView

createChecksummer

decryptMessage

_decrypt

encryptAndSend

code

computeChecksum

encryptChecksum

decryptChecksum

getAlgorithm

handleUnknownVersion