https://github.com/benoitc/sieve
sieve is a simple TCP routing proxy (layer 7) in erlang
https://github.com/benoitc/sieve
Last synced: 5 months ago
JSON representation
sieve is a simple TCP routing proxy (layer 7) in erlang
- Host: GitHub
- URL: https://github.com/benoitc/sieve
- Owner: benoitc
- License: other
- Created: 2013-07-08T21:58:42.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-07-03T07:50:22.000Z (over 10 years ago)
- Last Synced: 2025-10-08T00:38:17.690Z (5 months ago)
- Language: Erlang
- Size: 89.8 KB
- Stars: 26
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sieve
sieve is a simple TCP routing proxy (layer 7) in erlang and using
[barrel](http://github.com/benoitc/barrel) connection handling. It lets
you configure the routine logic in Erlang.
If you need to proxy connections to different backend servers depending
on the contents of the transmission, then sieve will helps
you. It's heavily inspidered from [proxymachine](https://github.com/mojombo/proxymachine).
## Build
You need [rebar](http://github.com/rebar/rebar) to build
cowboy_revproxy:
$ rebar get-deps
$ rebar compile
## Usage
The idea is simple, once a request is coming to the proxy the data is
passed to a proxy function until this function return a remote
connection or tell to the proxy to close the connection.
**Valid returns values** are :
* `continue` or `ok` -> wait for next chunk
* `stop` -> close the connection
* `{stop, Reply}` -> send Reply to the client and close the connection
* `{remote, Remote}` -> return the address of the remote connection to
proxy. Remote can be one of the following:
- `{ip, port}`
- `{ssl, Ip, Port, Options}`, where options are ssl options
(keyfile, certfile & password).
* `[{remote, Remote}, {data, Data}]` -> same as above, but data passed to
the proxy function is replaced by `Data` and will be send to the remote
connection.
* `[{remote, Remote}, {data, Data}, {reply, Reply}]` -> same as above
but reply `Reply` to the client.
## Example
Here is a simple example of function proxying the port 8080 to google.com:
-module(cowboy_revproxy_example).
-export([start/0, proxy/1]).
proxy(_Data) ->
{remote, {"openbsd.org", 80}}.
start() ->
barrel:start(),
application:start(lager),
barrel:start_listener(http, 100, barrel_tcp, [{port, 8080}],
sieve_revproxy, [{proxy, {?MODULE, proxy}}]).
To test it do, in the source folder:
$ rebar get-deps compile
$ erl -pa ebin -pa deps/barrel/ebin
Then in the erlang shell:
1> sieve_example:start().
and go on http://127.0.0.1:8080/ , it should display the
[OpenBSD](http://openbsd.org) website.