org.restcomm.media.ice

Interface IceAuthenticator

All Known Implementing Classes:

IceAgent, IceAuthenticatorImpl, IceLiteAgent

public interface IceAuthenticator

Authenticator that verifies the integrity of incoming messages.

Author:

Henrique Rosa

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getLocalKey(String ufrag) Gets the password assigned to a local user.
byte[]	getRemoteKey(String ufrag, String media) Gets the password assigned to a remote user.
boolean	isUserRegistered(String ufrag) Verifies whether a local user is registered.
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.

Method Detail

getLocalKey

byte[] getLocalKey(String ufrag)

Gets the password assigned to a local user.

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

byte[] getRemoteKey(String ufrag,
                  String media)

Gets the password assigned to a remote user.

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

boolean isUserRegistered(String ufrag)

Verifies whether a local user is registered.

Parameters:

ufrag - the fragment of the local user

Returns:

true if the user exists, false otherwise.

validateUsername

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.

Parameters:

username - The username to be validated

Returns:

Whether the username is valid or not.