org.restcomm.media.ice

Class IceAuthenticatorImpl

java.lang.Object

org.restcomm.media.ice.IceAuthenticatorImpl

All Implemented Interfaces:

IceAuthenticator

public class IceAuthenticatorImpl
extends Object
implements IceAuthenticator

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	password
protected String	remotePassword
protected String	remoteUfrag
protected String	ufrag

Constructor Summary

Constructors

Constructor and Description
IceAuthenticatorImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	generateIceCredentials() The ice-ufrag and ice-pwd attributes MUST be chosen randomly at the beginning of a session.
byte[]	getLocalKey(String ufrag) Gets the password assigned to a local user.
String	getPassword()
byte[]	getRemoteKey(String ufrag, String media) Gets the password assigned to a remote user.
String	getRemotePassword()
String	getRemoteUfrag()
String	getUfrag()
boolean	isUserRegistered(String ufrag) Verifies whether a local user is registered.
void	reset()
void	setRemotePassword(String remotePassword)
void	setRemoteUfrag(String remoteUfrag)
boolean	validateUsername(String username) Validates the autenticity of a STUN USERNAME attribute. The agent MUST consider the username to be valid if it consists of two values separated by a colon, where the first value is equal to the username fragment generated by the agent in an offer or answer for a session in-progress.

Methods inherited from class java.lang.Object

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

Field Detail

ufrag

protected String ufrag

password

protected String password

remoteUfrag

protected String remoteUfrag

remotePassword

protected String remotePassword

Constructor Detail

IceAuthenticatorImpl

public IceAuthenticatorImpl()

Method Detail

getUfrag

public String getUfrag()

getPassword

public String getPassword()

getRemoteUfrag

public String getRemoteUfrag()

setRemoteUfrag

public void setRemoteUfrag(String remoteUfrag)

getRemotePassword

public String getRemotePassword()

setRemotePassword

public void setRemotePassword(String remotePassword)

generateIceCredentials

public void generateIceCredentials()

The ice-ufrag and ice-pwd attributes MUST be chosen randomly at the beginning of a session.

The ice-ufrag attribute MUST contain at least 24 bits of randomness, and the ice-pwd attribute MUST contain at least 128 bits of randomness.
This means that the ice-ufrag attribute will be at least 4 characters long, and the ice-pwd at least 22 characters long, since the grammar for these attributes allows for 6 bits of randomness per character.
The attributes MAY be longer than 4 and 22 characters, respectively, of course, up to 256 characters. The upper limit allows for buffer sizing in implementations. Its large upper limit allows for increased amounts of randomness to be added over time.

See Also:

RFC 5245

getLocalKey

public byte[] getLocalKey(String ufrag)

Description copied from interface: IceAuthenticator

Gets the password assigned to a local user.

Specified by:

getLocalKey in interface IceAuthenticator

Parameters:

ufrag - the fragment of the local user

Returns:

The password of the specified user.
If the user has no password associated, returns an empty key.
If the user does not exist, returns null.

getRemoteKey

public byte[] getRemoteKey(String ufrag,
                  String media)

Description copied from interface: IceAuthenticator

Gets the password assigned to a remote user.

Specified by:

getRemoteKey in interface IceAuthenticator

Parameters:

ufrag - the fragment of the remote user

media - the name of the target media stream

Returns:

The password of the specified user.
If the user has no password associated, returns an empty key.
If the user or media stream do not exist, returns null.

isUserRegistered

public boolean isUserRegistered(String ufrag)

Description copied from interface: IceAuthenticator

Verifies whether a local user is registered.

Specified by:

isUserRegistered in interface IceAuthenticator

Parameters:

ufrag - the fragment of the local user

Returns:

true if the user exists, false otherwise.

validateUsername

public boolean validateUsername(String username)

Description copied from interface: IceAuthenticator

Validates the autenticity of a STUN USERNAME attribute.
The agent MUST consider the username to be valid if it consists of two values separated by a colon, where the first value is equal to the username fragment generated by the agent in an offer or answer for a session in-progress.

Specified by:

validateUsername in interface IceAuthenticator

Parameters:

username - The username to be validated

Returns:

Whether the username is valid or not.

reset

public void reset()