Flask-Security

https://flask-security.readthedocs.io/en/stable/
Admin
Flask-Security is a Flask extension that quickly adds common security mechanisms to Flask...
Tokens:98,364
Snippets:781
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Flask-Security and MongoEngine

Source: https://flask-security.readthedocs.io/en/stable/quickstart.html

Create a virtual environment and install Flask-Security with MongoEngine support. Run these commands in a terminal before starting the application.

```bash
$ python3 -m venv pymyenv
$ . pymyenv/bin/activate
$ pip install flask-security[common] mongoengine

```

--------------------------------

### Install requirements with pip

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

Install the development, documentation, and testing dependencies. The command includes 'pip install' twice as shown in the source.

```bash
$ pip install pip install --group dev --group docs --group tests -U

```

--------------------------------

### Install Flask-Security with SQLAlchemy and common dependencies

Source: https://flask-security.readthedocs.io/en/stable/quickstart.html

Commands to create a virtual environment, activate it, and install Flask-Security with the fsqla and common extras.

```bash
$ python3 -m venv pymyenv
$ . pymyenv/bin/activate
$ pip install flask-security[fsqla,common]

```

--------------------------------

### Install Flask-Security and SQLAlchemy

Source: https://flask-security.readthedocs.io/en/stable/quickstart.html

Create a virtual environment and install Flask-Security with SQLAlchemy support. Requires Python 3.10 or higher.

```bash
$ python3 -m venv pymyenv
$ . pymyenv/bin/activate
$ pip install flask-security[common] sqlalchemy

```

--------------------------------

### Install Flask-Security and Peewee

Source: https://flask-security.readthedocs.io/en/stable/quickstart.html

Create a virtual environment, activate it, and install Flask-Security with the Peewee common extras and the peewee package.

```bash
$ python3 -m venv pymyenv
$ . pymyenv/bin/activate
$ pip install flask-security[common] peewee

```

--------------------------------

### Install pre-commit hooks

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

Install the git pre-commit hooks configured in the project.

```bash
$ pre-commit install

```

--------------------------------

### Install Flask-Security with pip

Source: https://flask-security.readthedocs.io/en/stable/installation.html

Installs the basic Flask-Security package along with its required dependencies (Flask, Flask-Login, Flask-Principal, Flask-WTF, email-validator, itsdangerous, passlib, Blinker). Use this as the starting point for any Flask-Security project.

```bash
pip install flask-security

```

--------------------------------

### Install Swagger editor and HTTP server

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

Installs the swagger editor and a simple HTTP server globally to update the Swagger API document.

```bash
$ npm -g install swagger-editor-dist http-server

```

--------------------------------

### Install Flask-Security with MFA and SQLAlchemy extras

Source: https://flask-security.readthedocs.io/en/stable/two_factor_configurations.html

Create a virtual environment and install Flask-Security with the common, mfa, and fsqla extras for SQLAlchemy two-factor support.

```bash
$ python3 -m venv pymyenv
$ . pymyenv/bin/activate
$ pip install flask-security[common,mfa,fsqla]

```

--------------------------------

### GET /tf-setup

Source: https://flask-security.readthedocs.io/en/stable/two_factor_configurations.html

This endpoint is used to retrieve the user's configured 2FA methods and existing configuration. It must be called with a GET request.

```APIDOC
## [GET] /tf-setup

### Description
Retrieves the list of configured two-factor authentication methods and the existing configuration for the authenticated user. This is the first step in changing the 2FA setup.

### Method
GET

### Endpoint
/tf-setup

### Parameters
No parameters documented.
```

--------------------------------

### Install Flask-Security with Flask-SQLAlchemy-Lite

Source: https://flask-security.readthedocs.io/en/stable/quickstart.html

Create a virtual environment and install the required packages for a Flask-SQLAlchemy-Lite application. Requires Python >= 3.10.

```bash
$ python3 -m venv pymyenv
$ . pymyenv/bin/activate
$ pip install flask-security[common] sqlalchemy flask-sqlalchemy-lite

```

--------------------------------

### Install SMS packages with pip

Source: https://flask-security.readthedocs.io/en/stable/two_factor_configurations.html

Installs the additional packages needed for SMS two-factor authentication.

```bash
pip install phonenumberslite twilio

```

--------------------------------

### database.py - SQLAlchemy Session Setup

Source: https://flask-security.readthedocs.io/en/stable/quickstart.html

Sets up the SQLAlchemy engine, scoped session, and declarative base. Calls sqla.FsModels.set_db_info to configure Flask-Security models and provides init_db() to create tables.

```python
from sqlalchemy import create_engine
from sqlalchemy.orm import scoped_session, sessionmaker
from sqlalchemy.ext.declarative import declarative_base
from flask_security.models import sqla

engine = create_engine('sqlite:////tmp/test.db')
db_session = scoped_session(sessionmaker(autocommit=False,
                                         autoflush=False,
                                         bind=engine))
Base = declarative_base()
# This creates the RolesUser table and is where
# you would pass in non-standard tables names.
sqla.FsModels.set_db_info(base_model=Base)


def init_db():
    # import all modules here that might define models so that
    # they will be registered properly on the metadata.  Otherwise
    # you will have to import them first before calling init_db()
    import models
    Base.metadata.create_all(bind=engine)

```

--------------------------------

### Run the Flask application with flask run

Source: https://flask-security.readthedocs.io/en/stable/quickstart.html

Command to start the application using the Flask CLI.

```bash
flask run

```

--------------------------------

### Install Flask-Security with extras via pip

Source: https://flask-security.readthedocs.io/en/stable/installation.html

Shows the standard pip syntax to install Flask-Security with additional distribution 'extras' (e.g., babel, fsqla, common, mfa) that pull in extra packages needed for specific features. Replace extra1,extra2 with the actual extra names.

```bash
pip install flask-security[extra1,extra2, ...]

```

--------------------------------

### Change into the flask-security directory with cd

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

Change the current directory to the cloned flask-security directory to continue the setup.

```bash
$ cd flask-security

```

--------------------------------

### Navigate to Swagger editor in browser

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

Open this file URL in a browser to access the Swagger editor locally. The path assumes a global npm installation.

```bash
file:///usr/local/lib/node_modules/swagger-editor-dist/index.html#

```

--------------------------------

### POST /tf-setup/{state_token}

Source: https://flask-security.readthedocs.io/en/stable/two_factor_configurations.html

This endpoint finalizes the change of the two-factor authentication setup by validating the sent code. Use the state token returned in the response of the POST /tf-setup as a path parameter.

```APIDOC
## [POST] /tf-setup/{state_token}

### Description
Completes the two-factor setup by submitting the verification code sent via SMS or email. The state token obtained from the POST to /tf-setup is used to identify the pending configuration.
```

--------------------------------

### Nginx configuration for SPA with Flask-Security reverse proxy

Source: https://flask-security.readthedocs.io/en/stable/spa.html

Use this Nginx server block to serve a SPA and route /api/ requests to a Flask backend via reverse proxy. It handles static files, SPA fallback, and error pages. The example omits SSL setup for simplicity and is suitable for Kubernetes where Nginx acts as a load balancer.

```nginx
server {
    listen       80;
    server_name  www.example.com;

    #access_log  /var/log/nginx/host.access.log  main;

    root   /usr/share/nginx/html;
    index index.html;

    location / {
        try_files $uri $uri/ /index.html;
    }

    # Location of assets folder
    location ~ ^/(static)/  {
        gzip_static on;
        gzip_types text/plain text/xml text/css text/comma-separated-values
            text/javascript application/x-javascript application/atom+xml;
        expires max;
    }

    # redirect server error pages to the static page /50x.html
    # 400 error's will be handled from the SPA
    error_page   500 502 503 504  /50x.html;
        location = /50x.html {
    }

    # route all api requests to the flask app, served by gunicorn
    location /api/ {
        proxy_pass http://localhost:8080/api/;
    }

    # OR served via uwsgi
    location /api/ {
        include ..../uwsgi_params;
        uwsgi_pass unix:/tmp/uwsgi.sock;
        uwsgi_pass_header AUTHENTICATION-TOKEN;
    }
}
```

--------------------------------

### Preview built docs and OpenAPI view in browser

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

Open these URLs in a browser to preview the built documentation and OpenAPI view. The 'or' separates two alternative URLs.

```bash
http://localhost:8081/docs/_build/html/index.html
or
http://localhost:8081/docs/_build/html/_static/openapi_view.html

```

--------------------------------

### init_app(app, datastore=None, register_blueprint=None, **kwargs)

Source: https://flask-security.readthedocs.io/en/stable/api.html

Initializes the Flask-Security extension for the specified application and datastore implementation.

```APIDOC
## init_app(app, datastore=None, register_blueprint=None, **kwargs)

### Description
Initializes the Flask-Security extension for the specified application and datastore implementation.

### Method
init_app

### Parameters
- **app** (flask.Flask) - Required - The application.
- **datastore** (UserDatastore | None) - Optional - An instance of a user datastore.
- **register_blueprint** (bool | None) - Optional - To register the Security blueprint or not.
- **kwargs** (t.Any) - Optional - Can be used to override/initialize any of the form names, or feature flags. All other kwargs are ignored.

### Return Type
None

### Notes
If you create the Security instance with both an 'app' and 'datastore' you shouldn't call this - it will be called as part of the constructor.
```

--------------------------------

### roles_required decorator example

Source: https://flask-security.readthedocs.io/en/stable/api.html

Requires the current user to have all specified roles. In this example, the user must have both 'admin' and 'editor' roles to access the dashboard.

```python
@app.route('/dashboard')
@roles_required('admin', 'editor')
def dashboard():
    return 'Dashboard'

```

--------------------------------

### Build docs and serve with HTTP server

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

After editing the Swagger document, rebuild the documentation and serve it on port 8081 to preview changes.

```bash
$ sphinx-build docs docs/_build/html
$ http-server -p 8081

```

--------------------------------

### auth_required decorator example

Source: https://flask-security.readthedocs.io/en/stable/api.html

Protects an endpoint with multiple authentication mechanisms. The example uses 'token' and 'session' methods; they are tried in that order regardless of specification. On failure, Security.unauthn_handler() is called.

```python
@app.route('/dashboard')
@auth_required('token', 'session')
def dashboard():
    return 'Dashboard'

```

--------------------------------

### roles_accepted decorator example

Source: https://flask-security.readthedocs.io/en/stable/api.html

Use @roles_accepted to require the current user to have at least one of the specified roles. In this example, the user must have either 'editor' or 'author' role to access the '/create_post' route.

```python
@app.route('/create_post')
@roles_accepted('editor', 'author')
def create_post():
    return 'Create Post'

```

--------------------------------

### Run tox commands for CI and style

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

Use tox to run all CI tests, test against older dependencies (py311-low), and run pre-commit/style checks. Comments indicate what each command does.

```bash
$ tox  # run everything CI does
$ tox -e py311-low  # make sure works with older dependencies
$ tox -e style  # run pre-commit/style checks

```

--------------------------------

### Create translation .po file

Source: https://flask-security.readthedocs.io/en/stable/customizing.html

Example contents of a French translation file for the custom message.

```po
msgid ""
msgstr ""

msgid "Password no-worky"
msgstr "Passe - no-worky"

```

--------------------------------

### Run full verification suite

Source: https://flask-security.readthedocs.io/en/stable/contributing.html

Verify unit tests, documentation, and syntax pass. Runs the full verification suite including installing the package in editable mode, building docs, compiling translation catalogs, running pytest, and pre-commit checks.

```bash
$ pip install --group dev --group docs --group tests
$ pip install -e .
$ sphinx-build docs docs/_build/html
$ tox -e compile_catalog
$ pytest tests
$ pre-commit run --all-files

```
Tokens:
Raw