fastapi_auth

Fastapi_Auth2

Paket Otentikasi Berbasis Kunci API untuk FastAPI, berfokus pada kesederhanaan dan kemudahan penggunaan:

• Fungsionalitas penuh di luar kotak, tidak diperlukan konfigurasi
• API Key Security dengan backend basis data sqlite atau postgres lokal, bekerja dengan parameter header dan kueri
• Default 15 Hari Pengececaan untuk Kunci API yang Dihasilkan
• Penciptaan kunci, pencabutan, pembaruan, dan log penggunaan yang ditangani melalui titik akhir administrator
• Nama pengguna, alamat email, dan kata sandi (hashing + salting) fitur verifikasi.
• Diperlukan dependensi ringan dan minimal.

Pembaruan

1. Menambahkan dukungan parsial untuk backend database MongoDB.
2. Menambahkan dukungan untuk variabel lingkungan melalui file .env.
3. Menambahkan file example.env untuk menunjukkan cara menggunakan variabel lingkungan.
4. README.md yang diperbarui untuk mencerminkan perubahan.
5. Dokumentasi yang diperbarui untuk mencerminkan perubahan.
6. Bekerja untuk menambahkan dukungan untuk backend database mysql .

Instalasi

pip install fastapi_auth2

Penggunaan

Membuat aplikasi

 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" }

Aplikasi yang dihasilkan adalah:

Penciptaan kunci API melalui dokumen

Mulai API Anda dan periksa log untuk kunci rahasia yang dihasilkan secara otomatis jika Anda tidak memberikannya melalui variabel lingkungan.

Pergi ke /docs di API Anda dan informasikan kunci rahasia ini di kotak Authorize/Secret header . Semua titik akhir administrator hanya mendukung keamanan header untuk memastikan kunci rahasia tidak secara tidak sengaja dibagikan saat berbagi URL.

Kemudian, Anda dapat menggunakan /auth/new untuk menghasilkan kunci API baru.

Dan akhirnya, Anda dapat menggunakan kunci API ini untuk mengakses titik akhir yang aman.

Kreasi Kunci API dalam Python

Anda tentu saja dapat mengotomatiskan akuisisi kunci API melalui Python dengan requests dan secara langsung menanyakan titik akhir.

Jika Anda melakukannya, Anda dapat menyembunyikan titik akhir dari dokumentasi API Anda dengan variabel lingkungan FASTAPI_AUTH_HIDE_DOCS .

Konfigurasi

Variabel Lingkungan:

• FASTAPI_AUTH_SECRET : Kunci Administrator Rahasia

  • Dihasilkan secara otomatis pada startup server jika tidak disediakan
  • Memungkinkan pembuatan kunci API baru, mencabut yang sudah ada, dan tampilan penggunaan kunci API
  • Itu dikompromikan mengkompromikan keamanan API

• FASTAPI_AUTH_HIDE_DOCS : Apakah untuk menyembunyikan titik akhir terkait kunci API dari dokumentasi atau tidak

• FASTAPI_AUTH_DB_LOCATION : Lokasi file database SQLite lokal

  • sqlite.db di direktori berjalan secara default
  • Saat menjalankan aplikasi di dalam Docker, gunakan bind mount untuk kegigihan

• FASTAPI_AUTH_AUTOMATIC_EXPIRATION : durasi, dalam beberapa hari, sampai kunci API dianggap kedaluwarsa

  • 15 hari secara default

• DATABASE_MODE : Jika diatur ke postgres , paket akan menggunakan database postgres alih -alih sqlite

• URI : Lokasi database Postgres

  • postgresql://postgres:postgres@localhost:5432/postgres secara default
  • Hanya digunakan jika DEV_MODE diatur ke False

Berkontribusi

Lihat CONTIBUTING.md untuk informasi lebih lanjut.

Menyiapkan Lingkungan Python

poetry install
poetry shell

Menyiapkan kait pra-komit

pre-commit install

Menjalankan tes

pytest

Menjalankan Lingkungan Dev

Gambar Docker terlampir menjalankan aplikasi uji di localhost:8080 dengan TEST_SECRET Kunci Rahasia. Jalankan dengan:

docker-compose build && docker-compose up

Todo

• Tambahkan lebih banyak tes
• Tambahkan lebih banyak backend database
• Tambahkan lebih banyak metode otentikasi