flask allowed hosts Download - flask allowed hosts Quellcode Download

flask allowed hosts

AI-Quellcode

1.0.0

Herunterladen

Flask erlaubte Hosts

Diese Erweiterung bietet eine Möglichkeit, den Zugriff auf Ihre Flask -Anwendung auf der Grundlage des Hostnamens oder der IP -Adresse oder des IP -Adressbereichs (Network) der Incoming -Anforderung) einzuschränken.

Merkmale

Konfigurationsoptionen pro Route.
Anpassen verweigert das Verhalten des Verweigerung.
Zwei Nutzungsoptionen: Klassenbasierte oder Dekorateure basieren.
Beschränken Sie den Zugriff nach Hostname, IP -Adresse oder IP -Adressbereich (Netzwerk).

Installation

Installieren Sie das Paket mit PIP:

pip install flask-allowed-hosts

Verwendung

Klassenbasierte Verwendung

Initialisieren Sie die AllowedHosts -Klasse.
Definieren Sie erlaubte Hosts (optional).
Definieren Sie eine Funktion für verweigertes Zugriffsverhalten (optional).
Verwenden Sie die Zugriffskontrolle auf Routen mit @allowed_hosts.limit() Dekorateur (optional).

Beispiel:

 from flask import Flask , jsonify , abort
from flask_allowed_hosts import AllowedHosts

app = Flask ( __name__ )

ALLOWED_HOSTS = [ "93.184.215.14" , "api.example.com" ]


def custom_on_denied ():
    error = { "error" : "Oops! Looks like you are not allowed to access this page!" }
    return jsonify ( error ), 403


allowed_hosts = AllowedHosts ( app , allowed_hosts = ALLOWED_HOSTS , on_denied = custom_on_denied )


# Allows all incoming requests
@ app . route ( "/api/public" , methods = [ "GET" ])
def public_endpoint ():
    data = { "message" : "This is public!" }
    return jsonify ( data ), 200


# Only allows incoming requests from "93.184.215.14" and "api.example.com"
@ app . route ( "/api/private" , methods = [ "GET" ])
@ allowed_hosts . limit ()
def private_endpoint ():
    data = { "message" : "This is private!" }
    return jsonify ( data ), 200


# We can override the allowed_hosts list and the on_denied function for each route
@ app . route ( "/api/private/secret" , methods = [ "GET" ])
@ allowed_hosts . limit ( allowed_hosts = [ "127.0.0.1" ], on_denied = lambda : abort ( 404 ))
def secret_private_endpoint ():
    data = { "message" : "This is very private!" }
    return jsonify ( data ), 200


if __name__ == '__main__' :
    app . run ( host = '0.0.0.0' , port = 5000 , debug = True )

Nutzung der Dekorateur-Basis (Vermächtnis)

WARNUNG : Dieser Ansatz kann in Kombination mit der klassenbasierten Verwendung ein unerwartetes Verhalten verursachen.

Definieren Sie erlaubte Hosts (optional).
Definieren Sie eine Funktion für verweigertes Zugriffsverhalten (optional).
Verwenden Sie die Zugriffskontrolle auf Routen mit @limit_hosts Decorator.

Beispiel:

 from flask import Flask , jsonify
from flask_allowed_hosts import limit_hosts

app = Flask ( __name__ )

ALLOWED_HOSTS = [ "93.184.215.14" , "api.example.com" ]


def custom_on_denied ():
    error = { "error" : "Custom Denied Response" }
    return jsonify ( error ), 403


# Allows all incoming requests
@ app . route ( "/api/public" , methods = [ "GET" ])
def public_endpoint ():
    data = { "message" : "This is public!" }
    return jsonify ( data ), 200


# Only allows incoming requests from "93.184.215.14" and "api.example.com"
@ app . route ( "/api/private" , methods = [ "GET" ])
@ limit_hosts ( allowed_hosts = ALLOWED_HOSTS , on_denied = custom_on_denied )
def private_endpoint ():
    return jsonify ({ "message" : "This is private!" }), 200

Weitere Beispiele

Weitere Beispiele finden Sie im Beispielverzeichnis.

Konfiguration

Initialisierungsparameter

app : Die Flask -Anwendungsinstanz (optional).
allowed_hosts : Liste der zulässigen Hosts (optional, standardmäßig None , die allen Hosts erlaubt).
on_denied : Funktion für verweigertes Zugriffsverhalten (optional).

Flask -Konfigurations- und Umgebungsvariablen

Flask -Konfiguration

Die Erweiterung respektiert diese Konfigurationen:

ALLOWED_HOSTS : Liste der zulässigen Hosts in Flask -Konfiguration.
ALLOWED_HOSTS_ON_DENIED : Funktion für verweigertes Zugriffsverhalten in der Flask -Konfiguration.

Vorrang : Werte, die während der Initialisierungsüberschreibungskolbenkonfigurationswerte bereitgestellt werden.