Autentizace pomocí API klíče

Nasazení AI do produkce s FastAPI

Matt Eckerle

Software and Data Engineering Leader

Proč zabezpečovat API?

Zamezení neoprávněnému přístupu
Zabezpečení endpointů pomocí API klíče

Zabezpečený trezor

Jak fungují API klíče

Digitální heslo pro API
Odesílán v hlavičkách požadavku
Ověřen před přístupem k endpointu

Diagram toku znázorňující princip fungování API klíčů

Třída APIKeyHeader

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

                      name="X-API-Key",

                      auto_error=True

                 )

Autentizace endpointu

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 přidává schéma hlavičky
HTTPException pro výjimky
Definuje hlavičku a tajný klíč API
Ověřuje API klíče pomocí test_api_key
Vyvolá 403, pokud klíč neodpovídá API_SECRET_KEY

Autentizace aplikace

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

Testování endpointu

Příkaz s neplatným API klíčem:

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

Příkaz s platným API klíčem:

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

Výstup při neplatném klíči:

{"detail":"Invalid API key"}

Výstup při platném klíči:

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

Lass uns üben!

Nasazení AI do produkce s FastAPI