Skip to content

Host

Host

Generic RADIUS capable host.

Source code in pyrad2/host.py 
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
class Host:
    """Generic RADIUS capable host."""

    def __init__(
        self,
        authport: int = 1812,
        acctport: int = 1813,
        coaport: int = 3799,
        dict: Optional[Dictionary] = None,
    ):
        """Initializes a host.

        Args:
            authport (int): port to listen on for authentication packets
            acctport (int): port to listen on for accounting packets
            coaport (int): port to listen on for CoA packets
            dict (Dictionary): RADIUS dictionary
        """
        self.dict = dict
        self.authport = authport
        self.acctport = acctport
        self.coaport = coaport

    def create_packet(self, **args) -> packet.Packet:
        """Create a new RADIUS packet.
        This utility function creates a new RADIUS authentication
        packet which can be used to communicate with the RADIUS server
        this client talks to. This is initializing the new packet with
        the dictionary and secret used for the client.

        Returns:
            pyrad2.packet.Packet: A new empty packet instance.
        """
        return packet.Packet(dict=self.dict, **args)

    def create_auth_packet(self, **args) -> packet.Packet:
        """Create a new authentication RADIUS packet.
        This utility function creates a new RADIUS authentication
        packet which can be used to communicate with the RADIUS server
        this client talks to. This is initializing the new packet with
        the dictionary and secret used for the client.

        Returns:
            pyrad2.packet.Packet: A new empty packet instance.
        """
        return packet.AuthPacket(dict=self.dict, **args)

    def create_acct_packet(self, **args) -> packet.Packet:
        """Create a new accounting RADIUS packet.
        This utility function creates a new accounting RADIUS packet
        which can be used to communicate with the RADIUS server this
        client talks to. This is initializing the new packet with the
        dictionary and secret used for the client.

        Returns:
            packet.Packet: A new empty packet instance.
        """
        return packet.AcctPacket(dict=self.dict, **args)

    def create_coa_packet(self, **args) -> packet.Packet:
        """Create a new CoA RADIUS packet.
        This utility function creates a new CoA RADIUS packet
        which can be used to communicate with the RADIUS server this
        client talks to. This is initializing the new packet with the
        dictionary and secret used for the client.

        Returns:
            packet.Packet: A new empty packet instance.
        """
        return packet.CoAPacket(dict=self.dict, **args)

    def create_status_packet(self, **args) -> packet.Packet:
        """Create a new Status-Server RADIUS packet.

        Status-Server packets are used for RFC 5997 health checks and always
        include Message-Authenticator when encoded for transmission.
        """
        return packet.StatusPacket(dict=self.dict, **args)

    def send_packet(self, fd: socket.socket, pkt) -> None:
        """Send a packet.

        Args:
            fd (socket.socket): Socket to send packet with
            pkt (packet.Packet): The packet instance
        """
        fd.sendto(pkt.Packet(), pkt.source)

    def send_reply_packet(self, fd: socket.socket, pkt: packet.Packet) -> None:
        """Send a packet.

        Args:
            fd (socket.socket): Socket to send packet with
            pkt (packet.Packet): The packet instance
        """
        fd.sendto(pkt.reply_packet(), pkt.source)  # type: ignore

__init__(authport=1812, acctport=1813, coaport=3799, dict=None)

Initializes a host.

Parameters:

Name Type Description Default
authport int

port to listen on for authentication packets

 1812
acctport int

port to listen on for accounting packets

 1813
coaport int

port to listen on for CoA packets

 3799
dict Dictionary

RADIUS dictionary

 None
Source code in pyrad2/host.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def __init__(
    self,
    authport: int = 1812,
    acctport: int = 1813,
    coaport: int = 3799,
    dict: Optional[Dictionary] = None,
):
    """Initializes a host.

    Args:
        authport (int): port to listen on for authentication packets
        acctport (int): port to listen on for accounting packets
        coaport (int): port to listen on for CoA packets
        dict (Dictionary): RADIUS dictionary
    """
    self.dict = dict
    self.authport = authport
    self.acctport = acctport
    self.coaport = coaport

create_packet(**args)

Create a new RADIUS packet. This utility function creates a new RADIUS authentication packet which can be used to communicate with the RADIUS server this client talks to. This is initializing the new packet with the dictionary and secret used for the client.

Returns:

Type Description
Packet

pyrad2.packet.Packet: A new empty packet instance.
Source code in pyrad2/host.py 
31
32
33
34
35
36
37
38
39
40
41
def create_packet(self, **args) -> packet.Packet:
    """Create a new RADIUS packet.
    This utility function creates a new RADIUS authentication
    packet which can be used to communicate with the RADIUS server
    this client talks to. This is initializing the new packet with
    the dictionary and secret used for the client.

    Returns:
        pyrad2.packet.Packet: A new empty packet instance.
    """
    return packet.Packet(dict=self.dict, **args)

create_auth_packet(**args)

Create a new authentication RADIUS packet. This utility function creates a new RADIUS authentication packet which can be used to communicate with the RADIUS server this client talks to. This is initializing the new packet with the dictionary and secret used for the client.

Returns:

Type Description
Packet

pyrad2.packet.Packet: A new empty packet instance.
Source code in pyrad2/host.py 
43
44
45
46
47
48
49
50
51
52
53
def create_auth_packet(self, **args) -> packet.Packet:
    """Create a new authentication RADIUS packet.
    This utility function creates a new RADIUS authentication
    packet which can be used to communicate with the RADIUS server
    this client talks to. This is initializing the new packet with
    the dictionary and secret used for the client.

    Returns:
        pyrad2.packet.Packet: A new empty packet instance.
    """
    return packet.AuthPacket(dict=self.dict, **args)

create_acct_packet(**args)

Create a new accounting RADIUS packet. This utility function creates a new accounting RADIUS packet which can be used to communicate with the RADIUS server this client talks to. This is initializing the new packet with the dictionary and secret used for the client.

Returns:

Type Description
Packet

packet.Packet: A new empty packet instance.
Source code in pyrad2/host.py 
55
56
57
58
59
60
61
62
63
64
65
def create_acct_packet(self, **args) -> packet.Packet:
    """Create a new accounting RADIUS packet.
    This utility function creates a new accounting RADIUS packet
    which can be used to communicate with the RADIUS server this
    client talks to. This is initializing the new packet with the
    dictionary and secret used for the client.

    Returns:
        packet.Packet: A new empty packet instance.
    """
    return packet.AcctPacket(dict=self.dict, **args)

create_coa_packet(**args)

Create a new CoA RADIUS packet. This utility function creates a new CoA RADIUS packet which can be used to communicate with the RADIUS server this client talks to. This is initializing the new packet with the dictionary and secret used for the client.

Returns:

Type Description
Packet

packet.Packet: A new empty packet instance.
Source code in pyrad2/host.py 
67
68
69
70
71
72
73
74
75
76
77
def create_coa_packet(self, **args) -> packet.Packet:
    """Create a new CoA RADIUS packet.
    This utility function creates a new CoA RADIUS packet
    which can be used to communicate with the RADIUS server this
    client talks to. This is initializing the new packet with the
    dictionary and secret used for the client.

    Returns:
        packet.Packet: A new empty packet instance.
    """
    return packet.CoAPacket(dict=self.dict, **args)

create_status_packet(**args)

Create a new Status-Server RADIUS packet.

Status-Server packets are used for RFC 5997 health checks and always include Message-Authenticator when encoded for transmission.

Source code in pyrad2/host.py 
79
80
81
82
83
84
85
def create_status_packet(self, **args) -> packet.Packet:
    """Create a new Status-Server RADIUS packet.

    Status-Server packets are used for RFC 5997 health checks and always
    include Message-Authenticator when encoded for transmission.
    """
    return packet.StatusPacket(dict=self.dict, **args)

send_packet(fd, pkt)

Send a packet.

Parameters:

Name Type Description Default
fd socket

Socket to send packet with

 required
pkt Packet

The packet instance

 required
Source code in pyrad2/host.py 
87
88
89
90
91
92
93
94
def send_packet(self, fd: socket.socket, pkt) -> None:
    """Send a packet.

    Args:
        fd (socket.socket): Socket to send packet with
        pkt (packet.Packet): The packet instance
    """
    fd.sendto(pkt.Packet(), pkt.source)

send_reply_packet(fd, pkt)

Send a packet.

Parameters:

Name Type Description Default
fd socket

Socket to send packet with

 required
pkt Packet

The packet instance

 required
Source code in pyrad2/host.py 
 96
 97
 98
 99
100
101
102
103
def send_reply_packet(self, fd: socket.socket, pkt: packet.Packet) -> None:
    """Send a packet.

    Args:
        fd (socket.socket): Socket to send packet with
        pkt (packet.Packet): The packet instance
    """
    fd.sendto(pkt.reply_packet(), pkt.source)  # type: ignore