Auth¶
Here is the auth interface definition in order to implement a new authentication backend. It is composed by two classes.
-
class
burpui.misc.auth.interface.
BUIhandler
(app=None)[source]¶ The
burpui.misc.auth.interface.BUIhandler
class maintains a list ofBurp-UI
users.-
user
(name=None)[source]¶ The
burpui.misc.auth.interface.BUIhandler.user()
function returns theflask_login.UserMixin
object corresponding to the given user name.Parameters: name (str) – Name of the user Returns: The corresponding user object
-
-
class
burpui.misc.auth.interface.
BUIuser
[source]¶ The
burpui.misc.auth.interface.BUIuser
class extends theflask_login.UserMixin
class.-
login
(name=None, passwd=None)[source]¶ The
burpui.misc.auth.interface.BUIuser.login()
function checks if the profided username and password match.Parameters: - name (str) – Username
- passwd (str) – Password
Returns: True if the name and password match, otherwise False
-