ChallengeResponseToken

java.lang.Object
- org.jgroups.auth.AuthToken
- - org.jgroups.auth.ChallengeResponseToken

All Implemented Interfaces:

AUTH.UpHandler, Streamable
```
public class ChallengeResponseToken
extends AuthToken
implements AUTH.UpHandler
```
AuthToken implementation which shows how to do challenge-response based authentication. This could for example be used by a coordinator A to authenticate joiner D.
When D wants to join, it sends a join request to A. A sends a challenge to D, which transforms the challenge into a response and sends the hash of the response back to A.
A uses the same algorithm to transform the challenge, hashes the result and compares it to the hash received by D. If they're equal, D is authenticated successfully.
The algorithm to transform the challenge into a response is encrypt(byte[]).
Note that challenge-response authentication does not prevent MIM attacks, see Wikipedia.

Since:

3.3

Author:

Bela Ban

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class ChallengeResponseToken.Entry

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`ChallengeResponseToken.Entry`

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`block_time`
`protected static java.util.function.BiPredicate<Message,java.lang.Boolean>`	`BYPASSER_FUNCTION`
`protected int`	`challenge_size`
`protected static short`	`ID`
`protected java.util.Map<Address,ChallengeResponseToken.Entry>`	`pending_requests`

Fields inherited from class org.jgroups.auth.AuthToken
auth, log

Constructor Summary

Constructors
Constructor and Description

ChallengeResponseToken()

Constructors
Constructor and Description
`ChallengeResponseToken()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`authenticate(AuthToken token, Message msg)` This method should be implemented to perform the actual authentication of joining members.
`void`	`destroy()`
`protected static byte[]`	`encrypt(byte[] buf)` Simplistic example of a transformation by incrementing each byte in the array.
`protected static byte[]`	`generateRandomBytes(int size)`
`java.lang.String`	`getName()` Used to return the full package and class name of the implementation.
`boolean`	`handleUpMessage(Message msg)` Called when a message has been received
`protected static long`	`hash(byte[] buf)`
`void`	`init()`
`void`	`readFrom(java.io.DataInput in)` Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
`protected static void`	`registerBypasser(AUTH auth)`
`int`	`size()` The size of the marshalled AuthToken
`protected static void`	`unregisterBypasser(AUTH auth)`
`void`	`writeTo(java.io.DataOutput out)` Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class org.jgroups.auth.AuthToken
setAuth, start, stop

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

- Field Detail
  - ID
```
protected static final short ID
```
    See Also:
    
    Constant Field Values
  - block_time
```
protected long block_time
```
  - challenge_size
```
protected int challenge_size
```
  - pending_requests
```
protected final java.util.Map<Address,ChallengeResponseToken.Entry> pending_requests
```
  - BYPASSER_FUNCTION
```
protected static final java.util.function.BiPredicate<Message,java.lang.Boolean> BYPASSER_FUNCTION
```
- Constructor Detail
  - ChallengeResponseToken
```
public ChallengeResponseToken()
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Description copied from class: AuthToken
    
    Used to return the full package and class name of the implementation. This is used by the AUTH protocol to create an instance of the implementation.
    
    Specified by:
    
    getName in class AuthToken
    
    Returns:
    
    a java.lang.String object of the package and class name
  - init
```
public void init()
```
    Overrides:
    
    init in class AuthToken
  - destroy
```
public void destroy()
```
    Overrides:
    
    destroy in class AuthToken
  - authenticate
```
public boolean authenticate(AuthToken token,
                            Message msg)
```
    Description copied from class: AuthToken
    
    This method should be implemented to perform the actual authentication of joining members.
    
    Specified by:
    
    authenticate in class AuthToken
    
    Parameters:
    
    token - the token sent by the joiner
    
    msg - the Message object containing the actual JOIN_REQ
    
    Returns:
    
    true if authenticaion passed or false if it failed.
  - writeTo
```
public void writeTo(java.io.DataOutput out)
             throws java.lang.Exception
```
    Description copied from interface: Streamable
    
    Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed
    
    Specified by:
    
    writeTo in interface Streamable
    
    Throws:
    
    java.lang.Exception
  - readFrom
```
public void readFrom(java.io.DataInput in)
              throws java.lang.Exception
```
    Description copied from interface: Streamable
    
    Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
    
    Specified by:
    
    readFrom in interface Streamable
    
    Throws:
    
    java.lang.Exception
  - size
```
public int size()
```
    Description copied from class: AuthToken
    
    The size of the marshalled AuthToken
    
    Specified by:
    
    size in class AuthToken
  - handleUpMessage
```
public boolean handleUpMessage(Message msg)
```
    Description copied from interface: AUTH.UpHandler
    
    Called when a message has been received
    
    Specified by:
    
    handleUpMessage in interface AUTH.UpHandler
    
    Parameters:
    
    msg - the message
    
    Returns:
    
    true if the message should be passed up, else false
  - registerBypasser
```
protected static void registerBypasser(AUTH auth)
```
  - unregisterBypasser
```
protected static void unregisterBypasser(AUTH auth)
```
  - generateRandomBytes
```
protected static byte[] generateRandomBytes(int size)
```
  - encrypt
```
protected static byte[] encrypt(byte[] buf)
```
    Simplistic example of a transformation by incrementing each byte in the array.
  - hash
```
protected static long hash(byte[] buf)
```

Class ChallengeResponseToken

Nested Class Summary

Field Summary

Fields inherited from class org.jgroups.auth.AuthToken

Constructor Summary

Method Summary

Methods inherited from class org.jgroups.auth.AuthToken

Methods inherited from class java.lang.Object

Field Detail

ID

block_time

challenge_size

pending_requests

BYPASSER_FUNCTION

Constructor Detail

ChallengeResponseToken

Method Detail

getName

init

destroy

authenticate

writeTo

readFrom

size

handleUpMessage

registerBypasser

unregisterBypasser

generateRandomBytes

encrypt

hash