fastapi_auth

fastapi_auth2

แพ็คเกจการรับรองความถูกต้องตามคีย์ API สำหรับ fastapi มุ่งเน้นไปที่ความเรียบง่ายและความสะดวกในการใช้งาน:

• ฟังก์ชั่นเต็มรูปแบบนอกกรอบไม่จำเป็นต้องมีการกำหนดค่า
• ความปลอดภัยคีย์ API พร้อมแบ็กเอนด์ฐานข้อมูล sqlite หรือ postgres ในท้องถิ่นทำงานกับพารามิเตอร์ทั้งส่วนหัวและแบบสอบถาม
• ค่าเริ่มต้น 15 วันเสียค่าใช้จ่ายสำหรับคีย์ API ที่สร้างขึ้น
• การสร้างที่สำคัญการเพิกถอนการต่ออายุและบันทึกการใช้งานที่จัดการผ่านจุดสิ้นสุดของผู้ดูแลระบบ
• ชื่อผู้ใช้ที่อยู่อีเมลและรหัสผ่าน (Hashing + Salting) คุณสมบัติการตรวจสอบ
• ต้องการการพึ่งพาที่มีน้ำหนักเบาน้อยที่สุด

การอัปเดต

1. เพิ่มการสนับสนุน บางส่วน สำหรับแบ็กเอนด์ฐานข้อมูล MongoDB
2. เพิ่มการสนับสนุนสำหรับตัวแปรสภาพแวดล้อมผ่านไฟล์. ENV
3. เพิ่ม example.env file เพื่อแสดงวิธีการใช้ตัวแปรสภาพแวดล้อม
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 ของคุณและตรวจสอบบันทึกสำหรับคีย์ลับที่สร้างขึ้นโดยอัตโนมัติหากคุณไม่ได้ให้หนึ่งผ่านตัวแปรสภาพแวดล้อม

ไปที่ /docs บน API ของคุณและแจ้งรหัสลับนี้ในกล่อง Authorize/Secret header จุดสิ้นสุดของผู้ดูแลระบบทั้งหมดรองรับความปลอดภัยส่วนหัวเท่านั้นเพื่อให้แน่ใจว่าคีย์ลับไม่ได้ใช้ร่วมกันโดยไม่ได้ตั้งใจเมื่อแชร์ URL

จากนั้นคุณสามารถใช้ /auth/new เพื่อสร้างคีย์ API ใหม่

และในที่สุดคุณสามารถใช้คีย์ API นี้เพื่อเข้าถึงจุดสิ้นสุดที่ปลอดภัย

การสร้างคีย์ API ใน Python

แน่นอนว่าคุณสามารถเข้าซื้อคีย์ API โดยอัตโนมัติผ่าน Python ด้วย requests และสอบถามจุดสิ้นสุดโดยตรง

หากคุณทำเช่นนั้นคุณสามารถซ่อนจุดสิ้นสุดจากเอกสาร API ของคุณด้วยตัวแปรสภาพแวดล้อม FASTAPI_AUTH_HIDE_DOCS

การกำหนดค่า

ตัวแปรสภาพแวดล้อม:

• FASTAPI_AUTH_SECRET : คีย์ผู้ดูแลระบบลับ

  • สร้างขึ้นโดยอัตโนมัติในการเริ่มต้นเซิร์ฟเวอร์หากไม่ได้ให้ไว้
  • อนุญาตให้สร้างคีย์ API ใหม่การเพิกถอนปุ่มที่มีอยู่และมุมมองการใช้คีย์ API
  • มันถูกบุกรุกประนีประนอมความปลอดภัยของ API

• FASTAPI_AUTH_HIDE_DOCS : ไม่ว่าจะซ่อนจุดปลายทางที่เกี่ยวข้องกับคีย์ API หรือไม่จากเอกสารประกอบ

• FASTAPI_AUTH_DB_LOCATION : ตำแหน่งของไฟล์ฐานข้อมูล sqlite local

  • sqlite.db ในไดเรกทอรีที่กำลังทำงานโดยค่าเริ่มต้น
  • เมื่อเรียกใช้แอพภายใน Docker ให้ใช้การติดตั้ง Bind เพื่อการคงอยู่

• 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

ใช้สภาพแวดล้อม dev

อิมเมจนักเทียบท่าที่แนบมาใช้แอพทดสอบบน localhost:8080 พร้อม Secret Key TEST_SECRET เรียกใช้กับ:

docker-compose build && docker-compose up

สิ่งที่ต้องทำ

• เพิ่มการทดสอบเพิ่มเติม
• เพิ่มแบ็กเอนด์ฐานข้อมูลเพิ่มเติม
• เพิ่มวิธีการรับรองความถูกต้องเพิ่มเติม