Uwierzytelnianie kluczem API

Wdrażanie AI na produkcję z FastAPI

Matt Eckerle

Software and Data Engineering Leader

Dlaczego zabezpieczać API?

Blokowanie nieautoryzowanych użytkowników
Zabezpieczanie punktów końcowych kluczem API

Bezpieczny sejf

Jak działają klucze API

Jak cyfrowe hasło do API
Przesyłany w nagłówkach żądania
Weryfikowany przed dostępem do punktów końcowych

Diagram przepływu przedstawiający działanie kluczy API

Klasa APIKeyHeader

from fastapi import FastAPI
from fastapi.security import APIKeyHeader
header_scheme = APIKeyHeader(

                      name="X-API-Key",

                      auto_error=True

                 )

Uwierzytelnianie punktu końcowego

from fastapi.security import APIKeyHeader
from fastapi import Depends, HTTPException


header_scheme = APIKeyHeader(name="X-API-Key",
                             auto_error=True)

API_SECRET_KEY = "your-secret-key"


@app.get("/items/")
def read_items(
    api_key: str = Depends(header_scheme)
):

    if api_key != API_SECRET_KEY:
        raise HTTPException(
            status_code=403,
            detail="Invalid API key")

    return {"api_key": api_key}

ApiKeyHeader
Depends dodaje schemat nagłówka
HTTPException do obsługi wyjątków
Definiuje nagłówek i tajny klucz API
Weryfikuje klucze API za pomocą test_api_key
Zwraca 403, gdy klucz nie pasuje do API_SECRET_KEY

Uwierzytelnianie aplikacji

def verify_api_key(api_key: str = Depends(header_scheme)):
    if api_key != API_KEY:
        raise HTTPException(status_code=403,  detail="Invalid API key")
    return api_key


app = FastAPI(
    dependencies=[Depends(verify_api_key)]
)

@app.post("/predict")
def predict_sentiment(text: str):

    return {
        "text": text,
        "sentiment": "positive",
        "status": "success"
    }

Testowanie punktu końcowego

Polecenie z nieprawidłowym kluczem API:

curl -X POST \
  http://localhost:8000/predict \
  -H "X-API-Key: wrong-key" \
  -H "Content-Type: application/json" \
  -d '{"text": "This product is amazing!"}'

Polecenie z prawidłowym kluczem API:

curl -X POST \
  http://localhost:8000/predict \
  -H "X-API-Key: your-secret-key" \
  -H "Content-Type: application/json" \
  -d '{"text": "This product is amazing!"}'

Wynik dla nieprawidłowego klucza:

{"detail":"Invalid API key"}

Wynik dla prawidłowego klucza:

{"text":"This product is amazing!",
 "sentiment":"positive",
 "status":"success"}

Czas na ćwiczenia!

Wdrażanie AI na produkcję z FastAPI