English | 繁中版 | 简中版 | Português (Brasil) | Français | 한국어 | Nederlands | ไทย | Русский | Українська | Español | Italiano | 日本語 | Deutsch | Türkçe | Tiếng Việt | Монгол | हिंदी | العربية | Polski | Македонски | ລາວ
Una checklist per le più importanti contromisure da mettere in pratica quando strutturiamo, testiamo e rilasciamo le nostre API.
- Non usare la
Basic AuthUtilizzare piuttosto dei sistemi standard di identificazione (es. JWT, OAuth). - Non re-inventarsi sistemi di
autenticazione,generazione token,salvataggio password. Utilizzare gli standard. - Utilizzare
Max Retrye le jail features per il Login. - Utilizzare la cifratura per tutti i dati sensibili.
- Utilizzare una chiave random complessa (
JWT Secret) per rendere assai difficile il brute force del token. - Non ricavare l'algoritmo dal payload. Forzare l'algoritmo nel backend (
HS256oRS256). - Rendere la scadenza del token (
TTL,RTTL) il più breve possibile. - Non memorizzare dati sensibili nel payload JWT, può essere decodificato facilmente.
- Validare sempre il valore di
redirect_urilato server permettendo solo url verificati nella whitelist. - Tentare sempre lo scambio attraverso il codice e non tramite token (non permettere
response_type=token). - Utilizzare il parametro
statecon un hash random per prevenire il CSRF durante il processo di autenticazione OAuth. - Definire lo scope di default e validare i parametri dello scope per ogni singola applicazione.
- Limitare le richieste (Throttling) per evitare attacchi DDoS o brute-force.
- Utilizzare il protocollo HTTPS per evitare attacchi MITM (Man In The Middle Attack).
- Utilizzare l'header
HSTSper evitare attacchi SSL Strip.
- Utilizzare il metodo HTTP appropriato in base all'azione:
GET (lettura),POST (scrittura),PUT/PATCH (sostituzione/modifica), eDELETE (cancellazione), e rispondere con uno status405 Method Not Allowedse il metodo della richiesta non è appropriato. - Validare il
content-typerispetto all' Accept header (Content Negotiation) per consentire solo i formati supportati (es.application/xml,application/json, ecc.) e rispondere con un406 Not Acceptablese la risposta non coincide. - Validare il
content-typein base alle strutture accettate (es.application/x-www-form-urlencoded,multipart/form-data,application/json, ecc.). - Validare sempre gli input dell'utente per evitare attacchi comuni (es.
XSS,SQL-Injection,Remote Code Execution, ecc.). - Non utilizzare mai dati sensibili (
credenziali,password,security tokens, oAPI keys) nell'url, utilizzare piuttosto gli Authorization header. - Utilizzare un gateway per abilitare il caching delle API, con sistema di controllo delle chiamate (es.
Quota,Spike Arrest,Concurrent Rate Limit).
- Verificare che tutti gli endpoints siano protetti dal sistema di autenticazione, per evitare eventuali falle.
- L'ID dell'utente corrente andrebbe sempre evitato nelle url. Utilizzare ad esempio
/me/orderspiuttosto che/user/654321/orders. - Non ricorrere all'autoincremento di un ID. Utilizzare piuttosto un
UUID. - Se stai effettuando il parsing di un file XML, controlla che l'entity parsing non sia attiva per evitare
XXE(XML external entity attack). - Se stai effettuando il parsing di un file XML, controlla che l'entity expansion non sia attiva per evitare il
Billion Laughs/XML bomb. - Utilizzare una CDN per l'upload dei file.
- Se stai gestendo grandi moli di dati, utilizza Workers e Queues per processare i dati in background evitando che la chiamata HTTP vada in blocco.
- Ricordarsi sempre di disattivare le eventuali modalità di DEBUG.
- Inviare l'header
X-Content-Type-Options: nosniff. - Inviare l'header
X-Frame-Options: deny. - Inviare l'header
Content-Security-Policy: default-src 'none'. - Rimuovere header che permettono il riconoscimento -
X-Powered-By,Server,X-AspNet-Versionecc. - Forzare il
content-typenella chiamata di risposta: se per esempio viene ritornato unapplication/jsonforzare ilcontent-typeaapplication/json. - Non ritornare mai dati sensibili come
credenziali,password,security tokens. - Ritornare sempre lo status code corretto in base all'esito della chiamata. (es.
200 OK,400 Bad Request,401 Unauthorized,405 Method Not Allowed, ecc).
- Verificare il design attraverso gli unit/integration tests.
- Definire e utilizzare una procedura di code review per il rilascio, evitando l'auto approvazione.
- Verificare che tutti i componenti dei servizi siano controllati da software AV prima di essere messi in produzione, incluse le librerie di terze parti.
- Definire una strategia di rollback per il deploy.
- yosriady/api-development-tools - Una collezione di risorse utili per la creazione di API RESTful HTTP+JSON.
Siate liberi di contribuire a questo progetto facendo un fork, modificandolo e inviando una pull request. Per qualsiasi dubbio inviare un'email all'indirizzo: team@shieldfy.io.