fastapi_auth

fastapi_auth2

基於API密鑰的FastApi的身份驗證軟件包，專注於簡單性和易用性：

• 開箱即用的完整功能，無需配置
• 使用本地sqlite或postgres數據庫後端的API密鑰安全性，與標題和查詢參數一起工作
• 生成的API鍵默認15天棄用
• 通過管理員端點處理的關鍵創建，撤銷，更新和使用日誌
• 用戶名，電子郵件地址和密碼（哈希 +鹽）驗證功能。
• 需要輕巧，最小的依賴性。

更新

1. 添加了對MongoDB數據庫後端的部分支持。
2. 通過.env文件增加了對環境變量的支持。
3. 添加了example.env文件以顯示如何使用環境變量。
4. 更新README.md以反映更改。
5. 更新的文檔以反映更改。
6. 致力於增加對mysql數據庫後端的支持。

安裝

pip install fastapi_auth2

用法

創建應用程序

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

結果應用是：

通過文檔創建API密鑰

啟動API，並檢查日誌是否通過環境變量提供一個自動生成的秘密密鑰。

轉到您的API上的/docs ，並在Authorize/Secret header框中通知此秘密密鑰。所有管理員端點僅支持標頭安全性，以確保共享URL時不會無意間共享秘密密鑰。

然後，您可以使用/auth/new生成新的API密鑰。

最後，您可以使用此API鍵來訪問安全端點。

python中的API密鑰創建

當然，您可以通過Python自動化API密鑰requests並直接查詢端點。

如果這樣做，則可以使用環境變量FASTAPI_AUTH_HIDE_DOCS隱藏API文檔中的端點。

配置

環境變量：

• FASTAPI_AUTH_SECRET ：秘密管理員密鑰

  • 如果未提供，則在服務器啟動上自動生成
  • 允許生成新的API鍵，吊銷現有鍵以及API鍵使用視圖
  • 它被妥協損害了API的安全性

• FASTAPI_AUTH_HIDE_DOCS ：是否從文檔中隱藏與API密鑰相關的終點

• FASTAPI_AUTH_DB_LOCATION ：本地sqlite數據庫文件的位置

  • 默認情況下，運行目錄中的sqlite.db
  • 在Docker內運行應用程序時，請使用綁定安裝座進行持久性

• FASTAPI_AUTH_AUTOMATIC_EXPIRATION ：持續時間，直到API鍵被視為過期

  • 默認為15天

• DATABASE_MODE ：如果設置為postgres ，則軟件包將使用Postgres數據庫代替SQLITE

• URI ：Postgres數據庫的位置

  • postgresql://postgres:postgres@localhost:5432/postgres默認情況下
  • 僅當將DEV_MODE設置為False時使用

貢獻

有關更多信息，請參見CONTIBUTING.md 。

設置Python環境

poetry install
poetry shell

設置預加入掛鉤

pre-commit install

運行測試

pytest

運行開發環境

隨附的Docker映像在localhost:8080 ，帶有秘密鍵TEST_SECRET 。運行它：

docker-compose build && docker-compose up

托多

• 添加更多測試
• 添加更多數據庫後端
• 添加更多身份驗證方法