Permalink
Browse files

initial commit

  • Loading branch information...
fffonion committed Apr 7, 2018
0 parents commit 5bf0d06d78973e8b4431fc959552b68b6cb802cd
282 README.md
@@ -0,0 +1,282 @@
Name
====
lua-resty-multiplexer - Port service multiplexer for stream subsystem
Table of Contents
=================
- [Description](#description)
- [Status](#status)
- [Synopsis](#synopsis)
- [Protocol](#protocol)
* [Add new protocol](#add-new-protocol)
- [Matcher](#matcher)
* [client-host](#client-host)
* [protocol](#protocol)
* [time](#time)
* [default](#default)
* [Add new matcher](#add-new-matcher)
- [API](#api)
- [TODO](#todo)
- [Copyright and License](#copyright-and-license)
- [See Also](#see-also)
Description
===========
This library is used to run multiple TCP services on the same port.
Note that nginx [stream module](https://nginx.org/en/docs/stream/ngx_stream_core_module.html) and [stream-lua-nginx-module](https://github.com/openresty/stream-lua-nginx-module) is required.
Also a customed [patch](patches/stream-lua-readpartial.patch) from [fcicq](https://github.com/fcicq) is needed. The origin discussion can be found [here](https://github.com/fffonion/lua-resty-sniproxy/issues/1).
Tested on Openresty 1.13.6.1.
[Back to TOC](#table-of-contents)
Status
========
Experimental.
Synopsis
========
```lua
stream {
init_by_lua_block {
local mul = require("resty.multiplexer")
mul.load_protocols(
"http", "ssh", "dns", "tls", "xmpp"
)
mul.set_rules(
{{"client-host", "10.0.0.1"}, "internal-host", 80},
{{"protocol", "http"}, {"client-host", "10.0.0.2"}, "internal-host", 8001},
{{"protocol", "http"}, "example.com", 80},
{{"protocol", "ssh"}, "github.com", 22},
{{"protocol", "dns"}, "1.1.1.1", 53},
{{"protocol", "tls"}, {"time", nil}, "twitter.com", 443},
{{"protocol", "tls"}, "www.google.com", 443},
{{"default", nil}, "127.0.0.1", 80}
)
mul.matcher_config.time = {
minute_match = {0, 30},
minute_not_match = {{31, 59}},
}
}
resolver 8.8.8.8;
server {
listen 80;
content_by_lua_block {
local mul = require("resty.multiplexer")
local mp = mul:new()
mp:run()
}
}
}
```
This module consists of two parts: protocol identifiers and matchers.
Protocol identifies need to loaded through `load_protocols` in `init_by_lua_block` directive. See [protocol](#protocol) section for currently supported protocols and guide to add a new protocol.
Rules are defined through `set_rules` to route traffic to different upstreams. For every matcher that is defined in the rule, the corresponding matcher is loaded automatically. See [matcher](#matcher) section for currently implmented matchers and guide to add a new matcher.
See [API](#api) section for syntax of `load_protocols` and `set_rules`.
The rules defined is prioritized. In the example above, we defined a rule such that:
- If client address is `10.0.0.1`, proxy to **internal-host.com:80**
- If protocol is `HTTP` and client address is `10.0.0.2`, proxy to **internal-host:8001**
- If protocol is `SSH`, proxy to **github.com:22**
- If protocol is `DNS`, proxy to **1.1.1.1:53**
- If protocol is `SSL/TLS` and current minute is between **0** and **30**, proxy to **www.google.com:443**
- If protocol is `SSL/TLS` and current minute is between **31** and **59**, proxy to **www.google.com:443**
- Otherwise, proxy to **127.0.0.1:80**
[Back to TOC](#table-of-contents)
Protocol
=======
The protocol part analyzes the first request that is sent from client and try to match it using known protocol signatures.
Currently supported: `dns`, `http`, `ssh`, `tls`, `xmpp`. Based on the bytes of signature, each protocol may have different possibilities to be falsely identified.
| Protocol | Length of signature | False rate |
|---|---|---|
| dns | 9 1/4 | 5.29e-23 |
| http | 4 | 2.33e-10 |
| ssh | 4 | 2.33e-10 |
| tls | 6 | 3.55e-15 |
| xmpp | 6 in 8 1/4 | ? |
[Back to TOC](#table-of-contents)
Add new protocol
-----------------
Create a new `protocol_name.lua` file under `resty/multiplexer/protocol` in the format of:
```lua
return {
required_bytes = ?,
check = function(buf)
-- check with the buf and return true if the protocol is identified
end
}
```
`required_bytes` is the length of bytes we need to read before identifying the protocol.
[Back to TOC](#table-of-contents)
Matcher
=======
client-host
-----------
Match if `$remote_addr` equals to expected value.
[Back to TOC](#table-of-contents)
protocol
--------
Match if protocol equals to expected value.
[Back to TOC](#table-of-contents)
time
----
Match if current time is in configured range in `mul.matcher_config.time`. If no range is defined, the matcher will always return *false*.
For example, to match year `2018`, `January` and `March` and hour `6` to `24` except for hour `12`:
```lua
init_by_lua_block {
local mul = require("resty.multiplexer")
mul.load_protocols(
"http", "ssh", "dns", "tls", "xmpp"
)
mul.set_rules(
{{"time", ""}, "twitter.com", 443}
)
mul.matcher_config.time = {
year_match = {2018},
year_not_match = {},
month_match = {{1}, {3}},
month_not_match = {},
day_match = {}, -- day of month
day_not_match = {},
hour_match = {{6, 24}},
hour_not_match = {{12}},
minute_match = {},
minute_not_match = {},
second_match = {},
second_not_match = {},
}
}
```
[Back to TOC](#table-of-contents)
default
-------
Always matches.
[Back to TOC](#table-of-contents)
Add new matcher
---------------
Create a new `matcher_name.lua` file under `resty/multiplexer/matchers` in the format of:
```lua
local _M = {}
function _M.match(protocol, expected)
-- return true if it's a match
end
return _M
```
Where `protocol` is the identified protocol in lowercase string, and `expected` is the expected value for this matcher defined in `set_rules`.
[Back to TOC](#table-of-contents)
API
=======
multiplexer.load_protocols
--------------------------
**syntax:** *multiplexer:load_protocols("protocol-1", "protocol-2", ...)*
Load the protocol modules into memory.
Supported protocols can be found in [protocol](lib/resty/multiplexer/protocol).
[Back to TOC](#table-of-contents)
multiplexer.set_rules
--------------------------
**syntax:** *multiplexer:set_rules(rule1, rule2, ...)*
Load rules in order. Each *rule* is an array table that is in the format of:
```lua
{{"matcher-1", "expected-value-1"}, {"matcher-2", "expected-value-2"}, ..., "upstream_host", upstream_port}
```
Supported matchers can be found in [matcher](lib/resty/multiplexer/matcher).
[Back to TOC](#table-of-contents)
TODO
====
- Add tests.
[Back to TOC](#table-of-contents)
Copyright and License
=====================
This module is licensed under the BSD license.
Copyright (C) 2018, by fffonion <fffonion@gmail.com>.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[Back to TOC](#table-of-contents)
See Also
========
* [Original patch to add the read partial mode](https://gist.github.com/fcicq/82e1c6d0c85cbc2d3f8e9f1523bfd1d1)
* [stream-lua-nginx-module](https://github.com/openresty/stream-lua-nginx-module)
* [yrutschle/sslh](https://github.com/yrutschle/sslh)
[Back to TOC](#table-of-contents)
@@ -0,0 +1,10 @@
name = lua-resty-multiplexer
abstract = Port service multiplexer for stream subsystem
author = fffonion
is_original = yes
license = 3bsd
lib_dir = lib
doc_dir = lib
repo_link = https://github.com/fffonion/lua-resty-multiplexer
main_module = lib/resty/multiplexer/init.lua
requires = luajit
Oops, something went wrong.

0 comments on commit 5bf0d06

Please sign in to comment.