Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Black reformatting with Python 3 target. #12

Merged
merged 1 commit into from
Apr 10, 2020
Merged

Black reformatting with Python 3 target. #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
346 changes: 189 additions & 157 deletions adafruit_wiznet5k/adafruit_wiznet5k.py
View file
Open in desktop

Large diffs are not rendered by default.

134 changes: 75 additions & 59 deletions adafruit_wiznet5k/adafruit_wiznet5k_dhcp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,57 +39,58 @@
# pylint: disable=bad-whitespace

# DHCP State Machine
STATE_DHCP_START = const(0x00)
STATE_DHCP_DISCOVER = const(0x01)
STATE_DHCP_REQUEST = const(0x02)
STATE_DHCP_LEASED = const(0x03)
STATE_DHCP_START = const(0x00)
STATE_DHCP_DISCOVER = const(0x01)
STATE_DHCP_REQUEST = const(0x02)
STATE_DHCP_LEASED = const(0x03)
STATE_DHCP_REREQUEST = const(0x04)
STATE_DHCP_RELEASE = const(0x05)
STATE_DHCP_RELEASE = const(0x05)

# DHCP Message Types
DHCP_DISCOVER = const(1)
DHCP_OFFER = const(2)
DHCP_REQUEST = const(3)
DHCP_DECLINE = const(4)
DHCP_ACK = const(5)
DHCP_NAK = const(6)
DHCP_RELEASE = const(7)
DHCP_INFORM = const(8)
DHCP_OFFER = const(2)
DHCP_REQUEST = const(3)
DHCP_DECLINE = const(4)
DHCP_ACK = const(5)
DHCP_NAK = const(6)
DHCP_RELEASE = const(7)
DHCP_INFORM = const(8)

# DHCP Message OP Codes
DHCP_BOOT_REQUEST = const(0x01)
DHCP_BOOT_REPLY = const(0x02)
DHCP_BOOT_REPLY = const(0x02)

DHCP_HTYPE10MB = const(0x01)
DHCP_HTYPE10MB = const(0x01)
DHCP_HTYPE100MB = const(0x02)

DHCP_HLENETHERNET = const(0x06)
DHCP_HOPS = const(0x00)
DHCP_HOPS = const(0x00)

MAGIC_COOKIE = const(0x63825363)
MAX_DHCP_OPT = const(0x10)

# Default DHCP Server port
DHCP_SERVER_PORT = const(67)
DHCP_SERVER_PORT = const(67)
# DHCP Lease Time, in seconds
DEFAULT_LEASE_TIME = const(900)
BROADCAST_SERVER_ADDR = '255.255.255.255'
BROADCAST_SERVER_ADDR = "255.255.255.255"

# DHCP Response Options
MSG_TYPE = 53
SUBNET_MASK = 1
MSG_TYPE = 53
SUBNET_MASK = 1
ROUTERS_ON_SUBNET = 3
DNS_SERVERS = 6
DHCP_SERVER_ID = 54
T1_VAL = 58
T2_VAL = 59
LEASE_TIME = 51
OPT_END = 255
DNS_SERVERS = 6
DHCP_SERVER_ID = 54
T1_VAL = 58
T2_VAL = 59
LEASE_TIME = 51
OPT_END = 255


# pylint: enable=bad-whitespace
_BUFF = bytearray(317)


class DHCP:
"""W5k DHCP Client implementation.
:param eth: Wiznet 5k object
Expand Down Expand Up @@ -148,16 +149,16 @@ def send_dhcp_message(self, state, time_elapsed):

# Transaction ID (xid)
self._initial_xid = htonl(self._transaction_id)
self._initial_xid = self._initial_xid.to_bytes(4, 'l')
self._initial_xid = self._initial_xid.to_bytes(4, "l")
_BUFF[4:7] = self._initial_xid

# seconds elapsed
_BUFF[8] = ((int(time_elapsed) & 0xff00) >> 8)
_BUFF[9] = (int(time_elapsed) & 0x00ff)
_BUFF[8] = (int(time_elapsed) & 0xFF00) >> 8
_BUFF[9] = int(time_elapsed) & 0x00FF

# flags
flags = htons(0x8000)
flags = flags.to_bytes(2, 'b')
flags = flags.to_bytes(2, "b")
_BUFF[10] = flags[1]
_BUFF[11] = flags[0]

Expand All @@ -170,10 +171,10 @@ def send_dhcp_message(self, state, time_elapsed):
# NOTE: 192 octets of 0's, BOOTP legacy

# Magic Cookie
_BUFF[236] = ((MAGIC_COOKIE >> 24)& 0xFF)
_BUFF[237] = ((MAGIC_COOKIE >> 16)& 0xFF)
_BUFF[238] = ((MAGIC_COOKIE >> 8)& 0xFF)
_BUFF[239] = (MAGIC_COOKIE& 0xFF)
_BUFF[236] = (MAGIC_COOKIE >> 24) & 0xFF
_BUFF[237] = (MAGIC_COOKIE >> 16) & 0xFF
_BUFF[238] = (MAGIC_COOKIE >> 8) & 0xFF
_BUFF[239] = MAGIC_COOKIE & 0xFF

# Option - DHCP Message Type
_BUFF[240] = 53
Expand All @@ -188,15 +189,15 @@ def send_dhcp_message(self, state, time_elapsed):
_BUFF[245] = 0x01
# Client MAC Address
for mac in range(0, len(self._mac_address)):
_BUFF[246+mac] = self._mac_address[mac]
_BUFF[246 + mac] = self._mac_address[mac]

# Option - Host Name
_BUFF[252] = 12
_BUFF[253] = len(b"Wiznet") + 6
_BUFF[254:260] = b"WIZnet"

for mac in range(0, 5):
_BUFF[260+mac] = self._mac_address[mac]
_BUFF[260 + mac] = self._mac_address[mac]

if state == DHCP_REQUEST:
# Set the parsed local IP addr
Expand Down Expand Up @@ -228,7 +229,9 @@ def send_dhcp_message(self, state, time_elapsed):
# Send DHCP packet
self._sock.send(_BUFF)

def parse_dhcp_response(self, response_timeout): # pylint: disable=too-many-branches, too-many-statements
def parse_dhcp_response(
self, response_timeout
): # pylint: disable=too-many-branches, too-many-statements
"""Parse DHCP response from DHCP server.
Returns DHCP packet type.

Expand All @@ -248,7 +251,9 @@ def parse_dhcp_response(self, response_timeout): # pylint: disable=too-many-bran

# -- Parse Packet, FIXED -- #
# Validate OP
assert _BUFF[0] == DHCP_BOOT_REPLY, "Malformed Packet - \
assert (
_BUFF[0] == DHCP_BOOT_REPLY
), "Malformed Packet - \
DHCP message OP is not expected BOOT Reply."

xid = _BUFF[4:8]
Expand All @@ -260,7 +265,7 @@ def parse_dhcp_response(self, response_timeout): # pylint: disable=too-many-bran
if _BUFF[28:34] == 0:
return 0, 0

if int.from_bytes(_BUFF[235:240], 'l') != MAGIC_COOKIE:
if int.from_bytes(_BUFF[235:240], "l") != MAGIC_COOKIE:
return 0, 0

# -- Parse Packet, VARIABLE -- #
Expand All @@ -276,43 +281,43 @@ def parse_dhcp_response(self, response_timeout): # pylint: disable=too-many-bran
ptr += 1
opt_len = _BUFF[ptr]
ptr += 1
self.subnet_mask = _BUFF[ptr:ptr+opt_len]
self.subnet_mask = _BUFF[ptr : ptr + opt_len]
ptr += opt_len
elif _BUFF[ptr] == DHCP_SERVER_ID:
ptr += 1
opt_len = _BUFF[ptr]
ptr += 1
self.dhcp_server_ip = _BUFF[ptr:ptr+opt_len]
self.dhcp_server_ip = _BUFF[ptr : ptr + opt_len]
ptr += opt_len
elif _BUFF[ptr] == LEASE_TIME:
ptr += 1
opt_len = _BUFF[ptr]
ptr += 1
self._lease_time = int.from_bytes(_BUFF[ptr:ptr+opt_len], 'l')
self._lease_time = int.from_bytes(_BUFF[ptr : ptr + opt_len], "l")
ptr += opt_len
elif _BUFF[ptr] == ROUTERS_ON_SUBNET:
ptr += 1
opt_len = _BUFF[ptr]
ptr += 1
self.gateway_ip = _BUFF[ptr:ptr+opt_len]
self.gateway_ip = _BUFF[ptr : ptr + opt_len]
ptr += opt_len
elif _BUFF[ptr] == DNS_SERVERS:
ptr += 1
opt_len = _BUFF[ptr]
ptr += 1
self.dns_server_ip = _BUFF[ptr:ptr+4]
ptr += opt_len # still increment even though we only read 1 addr.
self.dns_server_ip = _BUFF[ptr : ptr + 4]
ptr += opt_len # still increment even though we only read 1 addr.
elif _BUFF[ptr] == T1_VAL:
ptr += 1
opt_len = _BUFF[ptr]
ptr += 1
self._t1 = int.from_bytes(_BUFF[ptr:ptr+opt_len], 'l')
self._t1 = int.from_bytes(_BUFF[ptr : ptr + opt_len], "l")
ptr += opt_len
elif _BUFF[ptr] == T2_VAL:
ptr += 1
opt_len = _BUFF[ptr]
ptr += 1
self._t2 = int.from_bytes(_BUFF[ptr:ptr+opt_len], 'l')
self._t2 = int.from_bytes(_BUFF[ptr : ptr + opt_len], "l")
ptr += opt_len
elif _BUFF[ptr] == 0:
break
Expand All @@ -325,18 +330,26 @@ def parse_dhcp_response(self, response_timeout): # pylint: disable=too-many-bran
ptr += opt_len

if self._debug:
print("Msg Type: {}\nSubnet Mask: {}\nDHCP Server ID:{}\nDNS Server IP:{}\
\nGateway IP:{}\nT1:{}\nT2:{}\nLease Time:{}".format(msg_type, self.subnet_mask,
self.dhcp_server_ip,
self.dns_server_ip,
self.gateway_ip,
self._t1, self._t2,
self._lease_time))
print(
"Msg Type: {}\nSubnet Mask: {}\nDHCP Server ID:{}\nDNS Server IP:{}\
\nGateway IP:{}\nT1:{}\nT2:{}\nLease Time:{}".format(
msg_type,
self.subnet_mask,
self.dhcp_server_ip,
self.dns_server_ip,
self.gateway_ip,
self._t1,
self._t2,
self._lease_time,
)
)

gc.collect()
return msg_type, xid

def request_dhcp_lease(self): # pylint: disable=too-many-branches, too-many-statements
def request_dhcp_lease(
self,
): # pylint: disable=too-many-branches, too-many-statements
"""Request to renew or acquire a DHCP lease.

"""
Expand All @@ -353,8 +366,9 @@ def request_dhcp_lease(self): # pylint: disable=too-many-branches, too-many-stat
self._sock.connect(((BROADCAST_SERVER_ADDR), DHCP_SERVER_PORT))
if self._debug:
print("* DHCP: Discover")
self.send_dhcp_message(STATE_DHCP_DISCOVER,
((time.monotonic() - start_time) / 1000))
self.send_dhcp_message(
STATE_DHCP_DISCOVER, ((time.monotonic() - start_time) / 1000)
)
self._dhcp_state = STATE_DHCP_DISCOVER
elif self._dhcp_state == STATE_DHCP_DISCOVER:
if self._debug:
Expand All @@ -363,10 +377,12 @@ def request_dhcp_lease(self): # pylint: disable=too-many-branches, too-many-stat
if msg_type == DHCP_OFFER:
# use the _transaction_id the offer returned,
# rather than the current one
self._transaction_id = self._transaction_id.from_bytes(xid, 'l')
self._transaction_id = self._transaction_id.from_bytes(xid, "l")
if self._debug:
print("* DHCP: Request")
self.send_dhcp_message(DHCP_REQUEST, ((time.monotonic() - start_time) / 1000))
self.send_dhcp_message(
DHCP_REQUEST, ((time.monotonic() - start_time) / 1000)
)
self._dhcp_state = STATE_DHCP_REQUEST
else:
print("* Received DHCP Message is not OFFER")
Expand Down Expand Up @@ -396,7 +412,7 @@ def request_dhcp_lease(self): # pylint: disable=too-many-branches, too-many-stat
msg_type = 0
self._dhcp_state = STATE_DHCP_START

if (result != 1 and ((time.monotonic() - start_time > self._timeout))):
if result != 1 and ((time.monotonic() - start_time > self._timeout)):
break

self._transaction_id += 1
Expand Down
Loading