fastapi_auth

fastapi_auth2

Paquete de autenticación basado en la llave API para FASTAPI, centrado en la simplicidad y la facilidad de uso:

• Funcionalidad completa fuera de la caja, no se requiere configuración
• Seguridad clave de API con backend local de bases de datos sqlite o postgres , trabajando con parámetros de encabezado y consulta
• Deprecación predeterminada de 15 días para claves API generadas
• La creación clave, la revocación, la renovación y los registros de uso manejados a través de puntos finales del administrador
• Nombre de usuario, dirección de correo electrónico y características de verificación de contraseña (hashing + salting).
• Se requieren dependencias livianas y mínimas.

Actualizaciones

1. Se agregó soporte parcial para el backend de la base de datos MongoDB.
2. Se agregó soporte para variables de entorno a través de archivos .env.
3. Se agregó el archivo example.env para mostrar cómo usar las variables de entorno.
4. README.md actualizado para reflejar los cambios.
5. Documentación actualizada para reflejar cambios.
6. Trabajando para agregar soporte para el backend de la base de datos mysql .

Instalación

pip install fastapi_auth2

Uso

Creando una aplicación

 from fastapi import Depends , FastAPI
from fastapi_auth import api_key_router , api_key_security


app = FastAPI (
    description = "FastAPI Auth is a package that provides authentication based API security with FastAPI and Postgres Database, SQLite Database or MongoDB Database" ,
    title = "FastAPI Auth Example" ,  
    version = 1.0 ,
)


app . include_router ( api_key_router , prefix = "/auth" , tags = [ "_auth" ])

@ app . get ( "/unsecure" )
async def unsecure_endpoint ():
    return { "message" : "This is a unsecure endpoint" }

@ app . get ( "/secure" , dependencies = [ Depends ( api_key_security )])
async def secure_endpoint ():
    return { "message" : "This is a secure endpoint" }

La aplicación resultante es:

Creación clave de API a través de documentos

Inicie su API y verifique los registros de la clave secreta generada automáticamente si no proporcionó una a través de las variables de entorno.

Vaya a /docs en su API e informe esta clave secreta en el cuadro Authorize/Secret header . Todos los puntos finales del administrador solo admiten la seguridad del encabezado para asegurarse de que la clave secreta no se comparta inadvertidamente al compartir una URL.

Luego, puede usar /auth/new para generar una nueva clave API.

Y finalmente, puede usar esta clave API para acceder al punto final seguro.

Creación clave de API en Python

Por supuesto, puede automatizar la adquisición de clave API a través de Python con requests y consultar directamente los puntos finales.

Si lo hace, puede ocultar los puntos finales de su documentación de API con la variable de entorno FASTAPI_AUTH_HIDE_DOCS .

Configuración

Variables de entorno:

• FASTAPI_AUTH_SECRET : clave de administrador secreto

  • Generado automáticamente en el inicio del servidor si no se proporciona
  • Permite la generación de nuevas claves API, la revocación de las existentes y la vista de uso de la tecla API
  • Estar comprometido compromete la seguridad de la API

• FASTAPI_AUTH_HIDE_DOCS : si ocultar o no los puntos finales relacionados con la tecla API de la documentación

• FASTAPI_AUTH_DB_LOCATION : ubicación del archivo local de base de datos SQLite

  • sqlite.db en el directorio de ejecución de forma predeterminada
  • Al ejecutar la aplicación interior Docker, use un montaje de enlace para la persistencia

• FASTAPI_AUTH_AUTOMATIC_EXPIRATION : duración, en días, hasta que se considera una clave API expirada

  • 15 días por defecto

• DATABASE_MODE : si se establece en postgres , el paquete usará una base de datos Postgres en lugar de SQLite

• URI : Ubicación de la base de datos de Postgres

  • postgresql://postgres:postgres@localhost:5432/postgres por defecto
  • Solo se usa si DEV_MODE se establece en False

Que contribuye

Consulte CONTIBUTING.md para obtener más información.

Configuración de Python Environment

poetry install
poetry shell

Configuración de ganchos previos al comercio

pre-commit install

Pruebas de ejecución

pytest

Ejecutar el entorno de desarrollo

La imagen de Docker adjunta ejecuta una aplicación de prueba en localhost:8080 con la clave secreta TEST_SECRET . Ejecutarlo con:

docker-compose build && docker-compose up

HACER

• Agregar más pruebas
• Agregar más backends de la base de datos
• Agregar más métodos de autenticación