Authentication¶

Bowtie provides simple basic authentication out of the box. Better support for other authentication methods is planned for future releases. Adding basic authentication to your app is designed to be easy and simple. Simply create a BasicAuth instance and pass it the Bowtie app and a dictionary with usernames as keys and passwords as values:

from bowtie import App
from bowtie.auth import BasicAuth
app = App(__name__)
basic_auth = BasicAuth(app, {
    'alice': 'secret1',
    'bob': 'secret2',
})

To provide your own authentication you can implement the interface required by the abstract Auth class. This is not well supported or well documented at this time unfortunately.

class bowtie.auth.Auth(app: bowtie._app.App)[source]¶

Abstract Authentication class.

Create Auth class to protect flask routes and socketio connect.

before_request()[source]¶

Determine if a user is allowed to view this route.

Name is subject to change.

Returns:
Return type:	None, if no protection is needed.

socketio_auth() → bool[source]¶

Determine if a user is allowed to establish socketio connection.

Name is subject to change.

class bowtie.auth.BasicAuth(app: bowtie._app.App, credentials: Dict[str, str])[source]¶

Basic Authentication.

Create basic auth with credentials.

Parameters:	credentials (dict) – Usernames and passwords should be passed in as a dictionary.

Examples

>>> from bowtie import App
>>> from bowtie.auth import BasicAuth
>>> app = App(__name__)
>>> auth = BasicAuth(app, {'alice': 'secret1', 'bob': 'secret2'})

before_request() → Optional[flask.wrappers.Response][source]¶: Determine if a user is allowed to view this route.

socketio_auth() → bool[source]¶: Determine if a user is allowed to establish socketio connection.