mitmproxy2swagger

https://user-images.githubusercontent.com/5400940/168086818-c48f60ab-3f95-42eb-b435-c8b1a6326b81.mp4

Uno strumento per convertire automaticamente le catture di mitmproxy in specifiche OpenAPI 3.0. Ciò significa che puoi eseguire il reverse engineering automatico delle API REST semplicemente eseguendo le app e catturando il traffico.

🆕 NUOVO!

Aggiunto supporto per l'elaborazione di HAR esportati dagli strumenti di sviluppo del browser. Vedi Utilizzo - HAR per maggiori dettagli.

Installazione

Per prima cosa avrai bisogno di python3 e pip3.

$ pip install mitmproxy2swagger
# ... oppure ...
$ pip3 install mitmproxy2swagger
# ... oppure ...
$ git clone [email protected]:alufers/mitmproxy2swagger.git
$ cd mitmproxy2swagger
$ docker build -t mitmproxy2swagger .

Poi clona il repo ed esegui mitmproxy2swagger come negli esempi seguenti.

Utilizzo

Mitmproxy

Per creare una specifica ispezionando il traffico HTTP dovrai:

1. Catturare il traffico usando lo strumento mitmproxy. Personalmente consiglio di usare mitmweb, un'interfaccia web integrata in mitmproxy.

   root@kitploit:~

   $ mitmweb
   Web server listening at http://127.0.0.1:8081/
   Proxy server listening at http://*:9999
   ...
   

   IMPORTANTE

   Per configurare il tuo client affinché usi il proxy esposto da mitmproxy, consulta la documentazione di mitmproxy per maggiori informazioni.

2. Salvare il traffico in un file di flusso.

   In mitmweb puoi farlo usando il menu "File" e selezionando "Salva":

   

3. Eseguire il primo passaggio di mitmproxy2swagger:

   root@kitploit:~

   $ mitmproxy2swagger -i <percorso_del_flusso_mitmproxy> -o <percorso_dello_schema_output> -p <prefisso_api>
   # ... oppure ...
   $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i <percorso_del_flusso_mitmproxy> -o <percorso_dello_schema_output> -p <prefisso_api>
   

   Nota che puoi usare uno schema esistente, nel qual caso lo schema esistente verrà esteso con i nuovi dati. Puoi anche eseguirlo più volte con diverse catture di flusso; i dati catturati verranno uniti in modo sicuro.

   <prefisso_api> è l'URL di base dell'API di cui vuoi fare reverse engineering. Dovrai ottenerlo osservando le richieste effettuate in mitmproxy.

   Ad esempio, se un'app ha effettuato richieste come queste:

   root@kitploit:~

   https://api.example.com/v1/login
   https://api.example.com/v1/users/2
   https://api.example.com/v1/users/2/profile
   

HAR

1. Catturare ed esportare il traffico dagli strumenti di sviluppo del browser.

   Negli strumenti di sviluppo del browser, vai alla scheda "Rete" e clicca sul pulsante "Esporta HAR".

   

2. Continua nello stesso modo in cui faresti con il dump di mitmproxy. mitmproxy2swagger rileverà automaticamente il file HAR e lo elaborerà.

Output di esempio

Vedi gli esempi. Troverai uno schema generato e un file html con la documentazione generata (tramite redoc-cli).

Vedi il file html generato.

Sviluppo e contributi

Questo progetto utilizza:

• uv per la gestione delle dipendenze
• prek per formattazione e linting del codice
• pytest per i test unitari

Per installare le dipendenze:

uv sync

Esegui i linter:

uv run prek run --all-files

Installa gli hook di prek:

uv run prek install

Esegui i test:

uv run pytest

Esegui i test con copertura:

uv run pytest --cov=mitmproxy2swagger

Licenza

MIT