Package org.tinyradius.core.packet.request

Class AccessRequest

java.lang.Object

org.tinyradius.core.packet.BaseRadiusPacket<RadiusRequest>

org.tinyradius.core.packet.request.GenericRequest

org.tinyradius.core.packet.request.AccessRequest

All Implemented Interfaces:

AttributeHolder<RadiusRequest>, NestedAttributeHolder<RadiusRequest>, RadiusPacket<RadiusRequest>, RadiusRequest, MessageAuthSupport<RadiusRequest>

Direct Known Subclasses:

AccessRequestArap, AccessRequestChap, AccessRequestEap, AccessRequestNoAuth, AccessRequestPap

public abstract class AccessRequest
extends GenericRequest
implements MessageAuthSupport<RadiusRequest>

This class represents an Access-Request Radius packet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessRequest.AccessRequestFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	ARAP_PASSWORD
protected static final int	CHAP_PASSWORD
protected static final int	EAP_MESSAGE
protected static final org.apache.logging.log4j.Logger	logger
protected static final SecureRandom	RANDOM
protected static final int	USER_NAME
protected static final int	USER_PASSWORD

Fields inherited from interface org.tinyradius.core.attribute.AttributeHolder

attrHolderLogger

Fields inherited from interface org.tinyradius.core.packet.util.MessageAuthSupport

MESSAGE_AUTHENTICATOR, msgAuthLogger

Fields inherited from interface org.tinyradius.core.packet.RadiusPacket

HEADER_LENGTH, MAX_PACKET_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AccessRequest(Dictionary dictionary, io.netty.buffer.ByteBuf header, List<RadiusAttribute> attributes)

Method Summary

Modifier and Type	Method	Description
RadiusRequest	decodeRequest(String sharedSecret)	Decodes the request against the supplied shared secret.
RadiusRequest	encodeRequest(String sharedSecret)	AccessRequest overrides this method to generate a randomized authenticator (RFC 2865) and encode required attributes (e.g.
protected byte[]	genAuth(String sharedSecret)
Optional<String>	getUsername()	Retrieves the username
protected static byte[]	random16bytes()
AccessRequest	withAttributes(List<RadiusAttribute> attributes)
AccessRequest	withAuthAttributes(byte[] auth, List<RadiusAttribute> attributes)
AccessRequest	withChapPassword(String password)	Set CHAP-Password attribute with provided password and initializes CHAP-Challenge with random bytes.
AccessRequest	withPapPassword(String password)	Set User-Password attribute with provided password.

Methods inherited from class org.tinyradius.core.packet.request.GenericRequest

with

Methods inherited from class org.tinyradius.core.packet.BaseRadiusPacket

equals, getAttributes, getAuthenticator, getChildVendorId, getDictionary, getHeader, getId, getType, hashCode, toString, verifyPacketAuth

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tinyradius.core.attribute.AttributeHolder

addAttribute, addAttribute, decodeAttributes, encodeAttributes, getAttribute, getAttribute, getAttributeByteBuf, getAttributes, getAttributes, getAttributes, getAttributes, getChildVendorId, getDictionary, removeAttributes, removeLastAttribute

Methods inherited from interface org.tinyradius.core.packet.util.MessageAuthSupport

computeMessageAuth, encodeMessageAuth, verifyMessageAuth

Methods inherited from interface org.tinyradius.core.attribute.NestedAttributeHolder

addAttribute, getAttribute, getAttributes, getAttributes, getFlattenedAttributes, getVendorAttributes, removeAttribute, removeAttributes

Methods inherited from interface org.tinyradius.core.packet.RadiusPacket

genHashedAuth, getAuthenticator, getHeader, getId, getLength, getType, toByteBuf, toByteBuffer, toBytes

Field Details

logger

protected static final org.apache.logging.log4j.Logger logger

RANDOM

protected static final SecureRandom RANDOM

USER_NAME

protected static final int USER_NAME

See Also:

• Constant Field Values

USER_PASSWORD

protected static final int USER_PASSWORD

See Also:

• Constant Field Values

CHAP_PASSWORD

protected static final int CHAP_PASSWORD

See Also:

• Constant Field Values

EAP_MESSAGE

protected static final int EAP_MESSAGE

See Also:

• Constant Field Values

ARAP_PASSWORD

protected static final int ARAP_PASSWORD

See Also:

• Constant Field Values

Constructor Details

AccessRequest

protected AccessRequest(Dictionary dictionary,
 io.netty.buffer.ByteBuf header,
 List<RadiusAttribute> attributes)
                 throws RadiusPacketException

Throws:

RadiusPacketException

Method Details

random16bytes

protected static byte[] random16bytes()

genAuth

protected byte[] genAuth(String sharedSecret)

Overrides:

genAuth in class GenericRequest

Parameters:

sharedSecret - to generate authenticator

Returns:

new authenticator, must be idempotent

getUsername

public Optional<String> getUsername()

Retrieves the username

Returns:

username as String

withChapPassword

public AccessRequest withChapPassword(String password)
                               throws RadiusPacketException

Set CHAP-Password attribute with provided password and initializes CHAP-Challenge with random bytes.

Removes existing auth-related attributes if present (User-Password, CHAP-Password etc).

Parameters:

password - plaintext password to encode into CHAP-Password

Returns:

AccessRequestChap with encoded CHAP-Password and CHAP-Challenge attributes

Throws:

IllegalArgumentException - invalid password

RadiusPacketException - packet validation exceptions

withPapPassword

public AccessRequest withPapPassword(String password)
                              throws RadiusPacketException

Set User-Password attribute with provided password.

Removes existing auth-related attributes if present (User-Password, CHAP-Password etc).

Parameters:

password - plaintext password to encode into User-Password

Returns:

AccessRequestPap with encoded User-Password attribute

Throws:

RadiusPacketException - packet validation exceptions

encodeRequest

public RadiusRequest encodeRequest(String sharedSecret)
                            throws RadiusPacketException

AccessRequest overrides this method to generate a randomized authenticator (RFC 2865) and encode required attributes (e.g. User-Password).

Specified by:

encodeRequest in interface RadiusRequest

Overrides:

encodeRequest in class GenericRequest

Parameters:

sharedSecret - shared secret that secures the communication with the other Radius server/client

Returns:

RadiusPacket with new authenticator and encoded attributes

Throws:

RadiusPacketException - if invalid or missing attributes

decodeRequest

public RadiusRequest decodeRequest(String sharedSecret)
                            throws RadiusPacketException

Description copied from interface: RadiusRequest

Decodes the request against the supplied shared secret.

Must be idempotent.

Specified by:

decodeRequest in interface RadiusRequest

Overrides:

decodeRequest in class GenericRequest

Parameters:

sharedSecret - shared secret

Returns:

verified RadiusRequest with decoded attributes if appropriate

Throws:

RadiusPacketException - if authenticator check fails

withAttributes

public AccessRequest withAttributes(List<RadiusAttribute> attributes)
                             throws RadiusPacketException

Specified by:

withAttributes in interface AttributeHolder<RadiusRequest>

Overrides:

withAttributes in class BaseRadiusPacket<RadiusRequest>

Throws:

RadiusPacketException

withAuthAttributes

public AccessRequest withAuthAttributes(byte[] auth,
 List<RadiusAttribute> attributes)
                                 throws RadiusPacketException

Overrides:

withAuthAttributes in class BaseRadiusPacket<RadiusRequest>

Throws:

RadiusPacketException