Vai al contenuto
code-to-code

Apro l'indice…

↑ ↓ per scegliere, Invio per aprire, Esc per chiudere

Login e sicurezza2. La chiave: API Keyp. 54

La chiave, se qualcosa va storto

Gli errori della chiave e del controllore, e quelli che non fanno rumore

Gli errori che vedrai di più in questo capitolo. Per ognuno: cosa leggi, cosa vuol dire, cosa fai.

Ricorda come si legge un traceback: dal basso. L'ultima riga dice cosa, la riga con i ^^^ dice quale pezzo, la riga File … line … dice dove. Tutto il resto è nel capitolo Leggere un traceback. Con un server acceso, il traceback è nel terminale del server, non in quello di curl: al client arriva solo Internal Server Error.

Il codice

LeggiVuol direCosa fai
{"detail":[{"type":"missing","loc":["header","X-API-Key"],"msg":"Field required","input":null}]} con un 422L'header X-API-Key non c'era e il parametro non ha default=None: FastAPI risponde lui, e il tuo messaggio non escechiave: str | None = Header(default=None, alias="X-API-Key")
{"detail":"Manca la chiave"}, ma la chiave la stai mandandoL'header non ha il nome giusto, o il parametro non ha alias: FastAPI cerca un header che si chiama come il parametro (chiave), non X-API-KeyControlla alias="X-API-Key" nel controllore e -H "X-API-Key: …" nella richiesta
KeyError: 'CHIAVE_MAGAZZINO' accendendo il programma, o chiamando os.environ[…]La variabile non c'è nell'ambiente: manca il file .env, o load_dotenv() non è stato chiamato prima, o il nome nel .env è scritto diversols -a: c'è il .env? Dentro, il nome è identico? load_dotenv() viene prima di os.environ?
RuntimeError: Manca CHIAVE_MAGAZZINO: crea il file .envÈ il tuo messaggio: il programma si è fermato apposta, perché la chiave non c'è o è vuotaCrea il .env con il comando della chiave. Se lo hai creato, controlla di essere nella cartella giusta
KeyError: 'chiave-sbagliata' (nel terminale del server, e 500 per il client)Nel controllore con più chiavi cerchi con le quadre: CHIAVI[chiave]. Una chiave che non c'è è un KeyError, non un 401CHIAVI.get(chiave), e poi if … is None: con il 401
{"detail":[{"type":"missing","loc":["query","fornitore"],"msg":"Field required",…}]}Il parametro della rotta (qui fornitore) non ha = Depends(controlla_chiave): per FastAPI è un parametro di queryfornitore: str = Depends(controlla_chiave)
NameError: name 'controlla_chiave' is not definedLa rotta usa il controllore, ma nel file c'è sotto: Python legge il file dall'alto, e al momento del @app.get il nome non esiste ancoraIl controllore va scritto prima delle rotte che lo usano
ModuleNotFoundError: No module named 'dotenv'La libreria non è installata, o il venv è spento (il pacchetto si chiama python-dotenv, il modulo dotenv)source .venv/bin/activate, poi pip install python-dotenv
assert 501 == 200C'è ancora la riga «da fare»: raise HTTPException(status_code=501, …)Al posto di quella riga, il tuo codice
Address already in useC'è già un server acceso, in un altro terminaleCtrl+C di là, oppure fastapi dev … --port 8001

La richiesta

LeggiVuol direCosa fai
{"detail":"Chiave sbagliata"}, ma la chiave è quella giustaQuasi sempre: uno spazio o un a capo in più, copiato insieme alla chiave; oppure la chiave del .env è stata rifatta dopo aver copiato la vecchia; oppure il server non è stato riavviato dopo aver cambiato il .envConfronta lettera per lettera. Riavvia il server. Il confronto è esatto: anche una maiuscola conta
{"detail":"Manca la chiave"} da PostmanL'Auth Type non è API Key, oppure Add to è su Query Params invece di Header, oppure {{chiave}} è una variabile che non esisteAuthorization → API Key, Key X-API-Key, Value {{chiave}}, Add to Header. Se {{chiave}} resta rosso, la variabile non c'è nella collezione
{"detail":"Manca la chiave"} da /docsIl campo X-API-Key è vuotoScrivi la chiave nel campo, sotto i parametri della rotta, poi Execute
Il programma del client stampa 401 e {'detail': 'Chiave sbagliata'}Non è un guasto del tuo programma: il server ha risposto no, perché la chiave nel tuo .env non è quella del serverChiedi di nuovo la chiave a chi gestisce il server, e rimettila nel .env
{"detail":"Not Found"} e 404, con la chiave giustaL'indirizzo è sbagliato: manca o è di troppo un pezzo (/magazzino, non /magazzini). Il 404 qui non c'entra con la chiaveControlla il percorso, lettera per lettera
curl: (7) Failed to connect to 127.0.0.1 port 8000Il server non è acceso, o è su un'altra portafastapi dev … in un altro terminale, e controlla la porta

Gli errori che non danno errori

I più difficili sono quelli senza traceback: il programma gira, le richieste vanno, il test (se c'è) resta verde. Qui sono quasi tutti buchi di sicurezza, e si vedono solo se qualcuno li cerca.

La chiave nel codice. CHIAVE = "9f2c…" scritta nel programma: tutto funziona, ma basta caricarlo su GitHub e la chiave è pubblica. Se è già successo, cambiala: toglierla dal file non basta, resta nella storia di Git.

Il .env su GitHub. Il .gitignore non ha la riga .env, e il file finisce nel repository insieme al resto. Prima di fare git add, git status: se vedi .env, fermati.

La chiave nell'indirizzo. ?chiave=… funziona, ma finisce nei registri del server e nella cronologia. L'header non ci finisce.

La chiave fatta con random. Sembra a caso, e si può prevedere. Per le chiavi si usa secrets.

Una chiave sola, per sempre. Se la perde un solo programma, la devi cambiare per tutti. Una chiave per programma, e la si toglie quando serve.

Il controllore dimenticato su una rotta. Tre rotte, e una senza il parametro con Depends: la porta di servizio rimasta aperta. Nessun errore: la rotta risponde a tutti. L'unico modo di scoprirlo è un test che chiede ogni rotta senza chiave.

Il 401 al posto del 403. Quando la chiave è buona ma non può fare quella cosa, la risposta giusta è 403. Un 401 farebbe credere che basti cambiare la chiave.

Per trovarli, nell'ordine: un test che prova ogni rotta senza chiave, con una chiave sbagliata e con quella giusta. E il debugger, se la risposta è strana: un breakpoint dentro controlla_chiave, e in WATCH chiave. Come si fa: Il debugger con FastAPI e i test.

Se il problema non è il codice

pytest: command not found, No module named 'dotenv', il pannello Testing vuoto, No module named 'controllore': non è il tuo codice, è l'ambiente. Ha una pagina sua nel Pronto soccorso: pytest non parte, o non trova niente. Le cure brevi per Postman e le richieste a un'API sono nel Pronto soccorso.