com.digi.xbee.api.utils.srp

Class SrpUser

java.lang.Object

com.digi.xbee.api.utils.srp.SrpUser

public class SrpUser
extends Object

This class represents the user role in the Secure Remote Password protocol.

Since:

1.3.0

Constructor Summary

Constructors

Constructor and Description
SrpUser(String username, String password) Class constructor.

Method Summary

Modifier and Type	Method and Description
byte[]	getSessionKey() Returns the session key.
boolean	isAuthenticated() Returns whether the user is authenticated or not.
byte[]	processChallenge(byte[] byte_s, byte[] byte_B) Returns M1 if the challenge was successfully processed.
byte[]	startAuthentication() Computes and returns A, which is needed to start authentication.
void	verifySession(byte[] host_H_AMK) Verifies the given server proof of session key M2.

Methods inherited from class java.lang.Object

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

Constructor Detail

SrpUser

public SrpUser(String username,
               String password)

Class constructor. Instantiates a new SrpUser object with the given parameters.

Parameters:

username - The username to authenticate.

password - The password to authenticate.

Method Detail

getSessionKey

public byte[] getSessionKey()

Returns the session key.

Returns:

The session key, or null if it is not known yet.

isAuthenticated

public boolean isAuthenticated()

Returns whether the user is authenticated or not.

Returns:

true if the user is authenticated, false otherwise.

processChallenge

public byte[] processChallenge(byte[] byte_s,
                               byte[] byte_B)
                        throws NoSuchAlgorithmException,
                               IOException

Returns M1 if the challenge was successfully processed.

Parameters:

byte_s - Salt.

byte_B - Public ephemeral value B.

Returns:

Proof of session key M1, or null if the challenge could not be processed.

Throws:

IOException - If there is a problem generating any value.

NoSuchAlgorithmException - If the hash algorithm to use does not exist.

startAuthentication

public byte[] startAuthentication()
                           throws NoSuchAlgorithmException,
                                  IOException

Computes and returns A, which is needed to start authentication.

Returns:

Public ephemeral value A.

Throws:

IOException - If there is a problem generating 'byte k' value.

NoSuchAlgorithmException - If the hash algorithm to use does not exist.

verifySession

public void verifySession(byte[] host_H_AMK)

Verifies the given server proof of session key M2.

Parameters:

host_H_AMK - Proof of session key M2.