You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
misp/README.md

42 lines
1.2 KiB

### About
The goal of this project is to bypass the limitations caused by ISPs blocking incoming connections.
To do so have an adapter or reverse-proxy `reverse`.
It sends `Rides` to a forward-proxy servlet `forward`.
This servlet waits for a request, and fills the `Ride` with the request.
`reverse` can then forward the request to the `app`.
Upon recieving a reply with data from `app`, `reverse` will forward this data to `forward`,
which in turn will finally forward it to `user`.
<br>
### Overview
![](overview.png)
#### What works:
* Forwarding GET requests (including HTTPS).
#### What does not work:
* Handling 301 (Moved Permanently).
* Forwarding PUT requests - if needed, the logic might be quickly added to `doPut` in `forward`.
* The `forward.war` has issues - meanwhile run `forward` embedded with Jetty.
<br>
### Demo
[![IMAGE ALT TEXT](http://img.youtube.com/vi/WcSvzeu6nKo/0.jpg)](https://youtu.be/WcSvzeu6nKo "misp Demo")
<br>
### Run / Deploy
#### How to Run / Debug
* `com.olexyn.misp.embedded.RunAll.main()`
<br>
#### How to Deploy
* Set the URIs in code.
* Build (e.g. with `build-install-all.sh`)
* Put the generated `forward-0.1.war` in a servlet container (e.g. Jetty).
* Launch the `reverse-0.1.jar` on your host.