flask allowed hosts

Frasco permitido anfitriones

Esta extensión proporciona una forma de restringir el acceso a su aplicación Flask en función del nombre de host o la dirección IP de la solicitud entrante o el rango de direcciones IP (red).

Características

• Opciones de configuración por ruta.
• Personalizar el comportamiento de acceso denegado.
• Dos opciones de uso: basadas en clase o basadas en el decorador.
• Restringir el acceso por nombre de host, dirección IP o rango de direcciones IP (red).

Instalación

Instale el paquete con PIP:

pip install flask-allowed-hosts

Uso

Uso basado en clases

1. Inicializar la clase AllowedHosts .
2. Defina hosts permitidos (opcionales).
3. Defina una función para el comportamiento de acceso denegado (opcional).
4. Aplique el control de acceso a las rutas usando @allowed_hosts.limit() decorador (opcional).

Ejemplo:

 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 )

Uso basado en el decorador (legado)

ADVERTENCIA : Este enfoque puede causar un comportamiento inesperado cuando se combina con el uso basado en la clase.

1. Defina hosts permitidos (opcionales).
2. Defina una función para el comportamiento de acceso denegado (opcional).
3. Aplique el control de acceso a las rutas usando el decorador @limit_hosts .

Ejemplo:

 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

Más ejemplos

Puede encontrar más ejemplos en el directorio de ejemplos.

Configuración

Parámetros de inicialización

• app : la instancia de la aplicación Flask (opcional).
• allowed_hosts : lista de hosts permitidos (opcionales, predeterminados a None que no permite a todos los hosts).
• on_denied : función para el comportamiento de acceso denegado (opcional).

Variables de configuración y entorno

Configuración de frascos

La extensión respeta estas configuraciones:

• ALLOWED_HOSTS : lista de hosts permitidos en la configuración de frascos.
• ALLOWED_HOSTS_ON_DENIED : función para el comportamiento de acceso denegado en la configuración frascos.

Precedencia : Valores proporcionados durante la inicialización Anulación de los valores de configuración del matraz.

Variables de entorno

Puede habilitar el modo de depuración configurando la variable de entorno ALLOWED_HOSTS_DEBUG a True :

 export ALLOWED_HOSTS_DEBUG= " True "

Esto imprimirá mensajes de depuración útiles en la consola.

Que contribuye

¡Las contribuciones son bienvenidas! No dude en enviar una solicitud de extracción.

Apoyo

Si tiene alguna pregunta o comentarios, no dude en abrir un problema o una solicitud de extracción.

Licencia

Este proyecto tiene licencia bajo la licencia [MIT]; consulte el archivo License.md para más detalles.