ACL¶
Here is the acl interface definition in order to implement a new acl backend. It is composed by two classes.
-
class
burpui.misc.acl.interface.
BUIaclLoader
(app=None)[source]¶ The
burpui.misc.acl.interface.BUIaclLoader
class is used to load the actual ACL backend-
acl
¶ Property to retrieve the backend
-
-
class
burpui.misc.acl.interface.
BUIacl
[source]¶ The
burpui.misc.acl.interface.BUIacl
class represents the ACL engine.-
clients
(username=None, server=None)[source]¶ burpui.misc.acl.interface.BUIacl.clients()
returns a list of allowed clients for a given user.Parameters: - username (str) – Username to check
- server (str) – Server name. Used in multi-agent mode
Returns: A list of clients
-
is_admin
(username=None)[source]¶ burpui.misc.acl.interface.BUIacl.is_admin()
is used to know if a user has administrator rights.Parameters: username (str) – Username to check Returns: True if the user has admin rights, otherwise False
-
is_client_allowed
(username=None, client=None, server=None)[source]¶ burpui.misc.acl.interface.BUIacl.is_client_allowed()
tells us if a given user has access to a given client on a given server.Parameters: - username (str) – Username to check
- client (str) – Client to check
- server (str) – Server to check
Returns: True if username is granted, otherwise False
-
servers
(username=None)[source]¶ burpui.misc.acl.interface.BUIacl.servers()
returns a list of allowed servers for a given user.Parameters: username (str) – Username to check Returns: A list of servers
-