Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emqx/quic
QUIC protocol for Erlang & Elixir
https://github.com/emqx/quic
Last synced: 2 months ago
JSON representation
QUIC protocol for Erlang & Elixir
- Host: GitHub
- URL: https://github.com/emqx/quic
- Owner: emqx
- License: apache-2.0
- Created: 2020-01-27T07:02:02.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T14:51:41.000Z (3 months ago)
- Last Synced: 2024-10-25T07:49:59.987Z (3 months ago)
- Language: Erlang
- Homepage: https://www.emqx.com
- Size: 1.89 MB
- Stars: 222
- Watchers: 26
- Forks: 34
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- fucking-awesome-elixir - quicer - QUIC protocol erlang library. (QUIC)
- awesome-elixir - quicer - QUIC protocol erlang library. (QUIC)
README
# Quicer
QUIC (Next-generation transport protocol) erlang library.
[msquic](https://github.com/microsoft/msquic) NIF binding.
Project Status: Preview
[](https://opensource.org/licenses/Apache-2.0)
[](https://coveralls.io/r/emqx/quic?branch=main)
## OS Support
| OS | Status |
|---------|-------------|
| Linux | Supported |
| macOS | Supported |
| Windows | Help Needed |
# Add to your project
## rebar.config
``` erlang
{deps, [
{quicer, {git, "https://github.com/qzhuyan/quic.git", {tag, "0.1.0"}}},
...
```
# Examples
## Ping Pong server and client
### Server
``` erlang
application:ensure_all_started(quicer),
Port = 4567,
LOptions = [ {certfile, "cert.pem"}
, {keyfile, "key.pem"}
, {alpn, ["sample"]}
, {peer_bidi_stream_count, 1}
],
{ok, L} = quicer:listen(Port, LOptions),
{ok, Conn} = quicer:accept(L, [], 120000),
{ok, Conn} = quicer:handshake(Conn),
{ok, Stm} = quicer:accept_stream(Conn, []),
receive {quic, <<"ping">>, Stm, _Props} -> ok end,
{ok, 4} = quicer:send(Stm, <<"pong">>),
quicer:close_listener(L).
```
### Client
``` erlang
application:ensure_all_started(quicer),
Port = 4567,
{ok, Conn} = quicer:connect("localhost", Port, [{alpn, ["sample"]}, {verify, none}], 5000),
{ok, Stm} = quicer:start_stream(Conn, []),
{ok, 4} = quicer:send(Stm, <<"ping">>),
receive {quic, <<"pong">>, Stm, _Props} -> ok end,
ok = quicer:close_connection(Conn).
```
## Try connect to Google with QUIC transport
``` erlang
%% Connect to google and disconnect,
%% You could also tweak the parameters to see how it goes
{ok, Conn} = quicer:connect("google.com", 443, [{alpn, ["h3"]},
{verify, verify_peer},
{peer_unidi_stream_count, 3}], 5000),
quicer:shutdown_connection(Conn).
```
## More examples in test dir
refer to [test](./test) dir.
# Documentation
## Get Started
1. Understand the `handles` and the `ownership` in [Terminology](docs/Terminology.md)
1. Then check how to receives the data and signals: [Messages](docs/messages_to_owner.md)
1. Read more in [msquic doc](https://github.com/microsoft/msquic/tree/main/docs)
## Offline hex doc
``` sh
make doc
firefox doc/index.html
```
# Dependencies
1. OTP25+
1. rebar3
1. cmake3.16+
# Build and test
## Dev mode
``` sh
make ci
```
# Troubleshooting
### Log to `stdout`
Debug log could be enabled to print to `stdout` with the envvar `QUIC_LOGGING_TYPE=stdout`
``` sh
QUIC_LOGGING_TYPE=stdout make
```
``` sh
%% Debug one testcase
QUIC_LOGGING_TYPE=stdout rebar3 ct --suite test/quicer_connection_SUITE.erl --case tc_conn_basic_verify_peer
```
### Decrypt traffic with Wireshark
Client could specify the connect param `sslkeylogfile` to record tls secrets for wireshark to decrypt.
``` erlang
{ok, Conn} = quicer:connect(
"google.com",
443,
[
{verify, verify_peer},
{sslkeylogfile, "/tmp/SSLKEYLOGFILE"},
{peer_unidi_stream_count, 3},
{alpn, ["h3"]}
],
5000
)
```
# License
Apache License Version 2.0