Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AnalogJ/lantern
Peer into your requests.
https://github.com/AnalogJ/lantern
Last synced: 18 days ago
JSON representation
Peer into your requests.
- Host: GitHub
- URL: https://github.com/AnalogJ/lantern
- Owner: AnalogJ
- License: mit
- Created: 2019-03-18T23:24:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-05-06T13:20:09.000Z (over 5 years ago)
- Last Synced: 2024-05-09T20:55:42.867Z (6 months ago)
- Language: Go
- Size: 3.68 MB
- Stars: 23
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lantern
[](https://circleci.com/gh/AnalogJ/lantern)
[](https://hub.docker.com/r/analogj/lantern)
[](https://hub.docker.com/r/analogj/lantern)
[](https://microbadger.com/images/analogj/lantern)
Peer into your requests.
# Introduction
Lantern is an open-source debugging proxy (similar to Fiddler/Charles Proxy) that is written in Go and can be
hosted on a server. It uses the Chrome DevTools Inspector as a frontend UI, providing developers with a familiar
interface for inspecting their network traffic.
# Features
- Open Source (MIT License)
- Familiar Devtools UI
- SSL/HTTPS Interception
- Hostable MITM Proxy (run on a server)
- Request/Responses persist between sessions.
- Dockerized
- Generates a `.mobileconfig` file for use with macOS and iOS
# Setup
Lantern is designed to run via Docker, and as such we've created a [`docker-compose.yml`](./docker-compose.yml) file to get you started.
```
docker-compose up
```
# Usage
After you've started up Lantern, there are 3 important URL's you'll want to be familiar with:
- [http://localhost:8080](http://localhost:8080) is the URL for the Lantern WebUI. From here you can view any request/response that are sent through the proxy
- [http://localhost:8081](http://localhost:8081) is the HTTP Proxy URL. On your test device, you'll want to configure a HTTP proxy. In a standard deployment, this will usually be assigned to a easy-to-remember URL that you can enter into your various devices: `http://proxy.corp.example.com:8081`
- [http://localhost:5050](http://localhost:5050) is the URL for the (optional) Database Admin UI. From here you can view the content of the Lantern DB, where network traffic is stored.
- **database name:** lantern
- **username:** lantern
- **password**: lantern-password
Here's a quick test you can run to ensure that everything is working correctly:
`curl -k -x localhost:8081 https://www.google.com`
Please note, the `-k` flag forces curl to ignore SSL certificates. If you're interested in intercepting SSL traffic (and removing the `-k` flag), you'll want to check the [SSL_INTERCEPTION.md](./docs/SSL_INTERCEPTION.md) file in the docs directory.
# TroubleShooting & Useful Tools
# TODO:
- Documentation
- [-] README.md documentation.
- Proxy Code
- [x] SSL interception
- [ ] better error handling.
- [ ] **STRETCH** live request interception/hijacking & modification.
- Frontend/Websocket Code
- [x] Add links to the mobileprofile & CA certificate in the Web UI
- [x] backfill requests when new Websocket connection opened
- [x] command responses should be separated from event responses.
- [x] reorganize code, cleanup of event generation
- [x] Use embedded version of Devtools UI.
- [ ] Add support for HAR archive.
- [ ] variables for connection strings.
- [ ] better error handling.
- [ ] Ability to delete/remove recordings (without wiping the DB)
- ```
UI.panels.network._networkLogView._dataGrid.setRowContextMenuCallback(console.log)
```
- [-] Hide tabs that we do not support
- https://github.com/ChromeDevTools/devtools-frontend/blob/master/front_end/ui/View.js#L798-L806
- ```
var viewid = UI.viewManager._views.get('network').viewId()
UI.viewManager._views.delete(viewid)
UI.inspectorView._tabbedPane.closeTab(viewid)
```
- [ ] Devtools Theme
- https://chrome.google.com/webstore/detail/devtools-author/egfhcfdfnajldliefpdoaojgahefjhhi
- https://chrome.google.com/webstore/detail/devtools-theme-zero-dark/bomhdjeadceaggdgfoefmpeafkjhegbo
- [ ] **STRETCH** live request interception/hijacking & modification.
# License
[MIT](./LICENSE)
# Contributing
Please consider contributing by opening a pull request.
# References
- Logo: [Lantern by zidney](https://thenounproject.com/zidney0721/uploads/?i=1500728)
## Web Frontend
- https://chromedevtools.github.io/devtools-protocol/
- https://github.com/ChromeDevTools
- https://github.com/christian-bromann/devtools-backend
- https://github.com/ChromeDevTools/awesome-chrome-devtools
- https://github.com/ChromeDevTools/devtools-frontend/issues/95
- https://github.com/chromedp/cdproto-gen
- https://blog.hqcodeshop.fi/archives/402-iPhone-Mobile-Profile-for-a-new-CA-root-certificate-Case-CAcert.org.html
- https://www.howtogeek.com/253325/how-to-create-an-ios-configuration-profile-and-alter-hidden-settings/
- https://mdzlog.alcor.net/2012/11/15/decoding-a-mobileconfig-file-containing-a-cisco-ipsec-vpn-configuration/
- https://stackoverflow.com/questions/16727038/how-to-make-mobileconfig-file-on-ios-device
- https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/iPhoneOTAConfiguration/Introduction/Introduction.html
- https://github.com/mritd/strongswan/blob/master/generate-mobileconfig.sh
- https://github.com/ChromeDevTools/devtools-protocol/tree/master/pdl
- https://github.com/ChromeDevTools/devtools-frontend
- https://bit.ly/devtools-contribution-guide
- https://groups.google.com/forum/#!forum/google-chrome-developer-tools
- https://twitter.com/DevToolsCommits
- https://gist.github.com/vbsessa/e337d0add70a71861b8c580d5e16996e
- ```
src="https://chrome-devtools-frontend.appspot.com/serve_file/@1c32c539ce0065a41cb79da7bfcd2c71af1afe62/devtools_app.html?ws=localhost:8081/ws"
src="https://chrome-devtools-frontend.appspot.com/serve_file/@1c32c539ce0065a41cb79da7bfcd2c71af1afe62/inspector.html?ws=localhost:9000/ws&remoteFrontend=true">
src="https://chrome-devtools-frontend.appspot.com/serve_rev/@195284/devtools.html?ws=localhost:9000/ws"
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222 --no-first-run --no-default-browser-check --user-data-dir=$(mktemp -d -t 'chrome-remote_data_dir')
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --user-data-dir=chrome-remote_data_dir
```
## API/Websockets
- https://github.com/ChromeDevTools/awesome-chrome-devtools#chrome-devtools-protocol
- https://medium.freecodecamp.org/million-websockets-and-go-cc58418460bb
- https://scotch.io/bar-talk/build-a-realtime-chat-server-with-go-and-websockets
- https://github.com/chromedp/cdproto
- https://godoc.org/github.com/chromedp/cdproto
- https://gobyexample.com/non-blocking-channel-operations
- https://github.com/kdzwinel/betwixt/blob/master/src/main.js
- https://chromedevtools.github.io/devtools-protocol/tot/Network
- https://medium.com/rungo/anatomy-of-channels-in-go-concurrency-in-go-1ec336086adb
## Database
- http://coussej.github.io/2015/09/15/Listening-to-generic-JSON-notifications-from-PostgreSQL-in-Go/
## Proxy
- https://github.com/elazarl/goproxy
- https://gist.github.com/Soulou/6048212
- https://github.com/docker/go-docker/blob/master/hijack.go
- https://stackoverflow.com/questions/23812330/go-hijack-client-connection
- https://golang.org/pkg/net/http/httptest/#NewRequest
- https://medium.com/@mlowicki/http-s-proxy-in-golang-in-less-than-100-lines-of-code-6a51c2f2c38c
- https://medium.com/@mlowicki/https-proxies-support-in-go-1-10-b956fb501d6bv
- https://github.com/sethgrid/fakettp
- https://github.com/go-httpproxy/httpproxy
- http://speakmy.name/2014/07/29/http-request-debugging-in-go/
- https://github.com/roglew/pappy-proxy/tree/master/pappyproxy/interface/repeater
- https://github.com/elazarl/goproxy/issues/9
- `curl -v -L -x http://localhost:8082 -p --proxy-insecure -k https://www.example.com`
## Install Certificates
- https://knowledge.digicert.com/solution/SO13734.html