oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Format docstrings

Browse Source
This commit is contained in:
Marek Wolan
2023-07-04 11:11:52 +01:00
parent 91273b2f99
commit 9244c160b1
39 changed files with 208 additions and 409 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/primaite/acl/access_control_list.py
View File

@@ -13,8 +13,7 @@ class AccessControlList:
self.acl: Dict[str, AccessControlList] = {} # A dictionary of ACL Rules
def check_address_match(self, _rule, _source_ip_address, _dest_ip_address):
"""
Checks for IP address matches.
"""Checks for IP address matches.
Args:
_rule: The rule being checked
@@ -35,8 +34,7 @@ class AccessControlList:
return False
def is_blocked(self, _source_ip_address, _dest_ip_address, _protocol, _port):
"""
Checks for rules that block a protocol / port.
"""Checks for rules that block a protocol / port.
Args:
_source_ip_address: the source IP address to check
@@ -62,8 +60,7 @@ class AccessControlList:
return True
def add_rule(self, _permission, _source_ip, _dest_ip, _protocol, _port):
"""
Adds a new rule.
"""Adds a new rule.
Args:
_permission: the permission value (e.g. "ALLOW" or "DENY")
@@ -77,8 +74,7 @@ class AccessControlList:
self.acl[hash_value] = new_rule
def remove_rule(self, _permission, _source_ip, _dest_ip, _protocol, _port):
"""
Removes a rule.
"""Removes a rule.
Args:
_permission: the permission value (e.g. "ALLOW" or "DENY")
@@ -100,8 +96,7 @@ class AccessControlList:
self.acl.clear()
def get_dictionary_hash(self, _permission, _source_ip, _dest_ip, _protocol, _port):
"""
Produces a hash value for a rule.
"""Produces a hash value for a rule.
Args:
_permission: the permission value (e.g. "ALLOW" or "DENY")

21
src/primaite/acl/acl_rule.py
View File

@@ -6,8 +6,7 @@ class ACLRule:
"""Access Control List Rule class."""
def __init__(self, _permission, _source_ip, _dest_ip, _protocol, _port):
"""
Init.
"""Init.
Args:
_permission: The permission (ALLOW or DENY)
@@ -23,8 +22,7 @@ class ACLRule:
self.port = _port
def __hash__(self):
"""
Override the hash function.
"""Override the hash function.
Returns:
Returns hash of core parameters.
@@ -40,8 +38,7 @@ class ACLRule:
)
def get_permission(self):
"""
Gets the permission attribute.
"""Gets the permission attribute.
Returns:
Returns permission attribute
@@ -49,8 +46,7 @@ class ACLRule:
return self.permission
def get_source_ip(self):
"""
Gets the source IP address attribute.
"""Gets the source IP address attribute.
Returns:
Returns source IP address attribute
@@ -58,8 +54,7 @@ class ACLRule:
return self.source_ip
def get_dest_ip(self):
"""
Gets the desintation IP address attribute.
"""Gets the desintation IP address attribute.
Returns:
Returns destination IP address attribute
@@ -67,8 +62,7 @@ class ACLRule:
return self.dest_ip
def get_protocol(self):
"""
Gets the protocol attribute.
"""Gets the protocol attribute.
Returns:
Returns protocol attribute
@@ -76,8 +70,7 @@ class ACLRule:
return self.protocol
def get_port(self):
"""
Gets the port attribute.
"""Gets the port attribute.
Returns:
Returns port attribute