flask allowed hosts

O frasco permitiu hosts

Esta extensão fornece uma maneira de restringir o acesso ao seu aplicativo de frasco com base no nome do host da solicitação de entrada ou no endereço IP ou no intervalo de endereços IP (rede).

Características

• Opções de configuração por rotas.
• Personalize o comportamento de acesso negado.
• Duas opções de uso: baseadas em classe ou decoradores.
• Restringir o acesso por nome do host, endereço IP ou intervalo de endereço IP (rede).

Instalação

Instale o pacote usando PIP:

pip install flask-allowed-hosts

Uso

Uso baseado em classe

1. Inicialize a classe AllowedHosts .
2. Definir hosts permitidos (opcional).
3. Defina uma função para o comportamento de acesso negado (opcional).
4. Aplique o controle de acesso às rotas usando @allowed_hosts.limit() decorador (opcional).

Exemplo:

 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 baseado em decoradores (legado)

AVISO : Essa abordagem pode causar comportamento inesperado quando combinado com o uso baseado em classe.

1. Definir hosts permitidos (opcional).
2. Defina uma função para o comportamento de acesso negado (opcional).
3. Aplique o controle de acesso às rotas usando o decorador @limit_hosts .

Exemplo:

 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

Mais exemplos

Você pode encontrar mais exemplos no diretório de exemplos.

Configuração

Parâmetros de inicialização

• app : A instância do aplicativo Flask (opcional).
• allowed_hosts : Lista de hosts permitidos (opcional, padrão para None que permita todos os hosts).
• on_denied : Função para o comportamento de acesso negado (opcional).

Variáveis ​​de configuração e ambiente de frasco

Configuração do frasco

A extensão respeita essas configurações:

• ALLOWED_HOSTS : Lista de hosts permitidos na configuração do Flask.
• ALLOWED_HOSTS_ON_DENIED : função para comportamento de acesso negado na configuração do Flask.

Precedência : valores fornecidos durante a inicialização substituem os valores de configuração do Flask.

Variáveis ​​de ambiente

Você pode ativar o modo de depuração definindo a variável de ambiente ALLOWED_HOSTS_DEBUG como True :

 export ALLOWED_HOSTS_DEBUG= " True "

Isso imprimirá mensagens úteis de depuração no console.

Contribuindo

As contribuições são bem -vindas! Sinta -se à vontade para enviar uma solicitação de tração.

Apoiar

Se você tiver alguma dúvida ou feedback, sinta -se à vontade para abrir um problema ou uma solicitação de tração.

Licença

Este projeto está licenciado sob a licença [MIT] - consulte o arquivo License.md para obter detalhes.