noisegate_protocol (noisegate v1.0.0)

View Source

Summary

Types

compression/0

-type compression() :: none | {zlib, 0..65518}.

flags/0

-type flags() :: byte().

bit 0 last, 1 tick, 2 comp, 3 pad, 4 rekey, 5-7 reserved (0)

padding/0

-type padding() :: none | {bucket, 1..65519} | {fixed, 4..65519}.

pending/0

-opaque pending()

policy_error/0

-type policy_error() :: {invalid_setting, Key :: atom(), Value :: term(), Allowed :: string()}.

receiver/0

-opaque receiver()

receiver_policy/0

-type receiver_policy() ::
          #{max_packet := pos_integer(),
            accept_compression := boolean(),
            max_bytes_without_rekey := pos_integer() | infinity}.

rekey_after/0

-type rekey_after() :: never | [rekey_limit(), ...].

rekey_limit/0

-type rekey_limit() :: {frames, pos_integer()} | {bytes, pos_integer()} | {ms, pos_integer()}.

rx_error/0

-type rx_error() ::
          decrypt_failed | bad_length | reserved_flags | tick_with_payload | bad_padding |
          compression_not_accepted | bad_compression | packet_too_large | rekey_required |
          rekey_unsupported.

rx_event/0

-type rx_event() :: {packet, iodata()} | tick.

sender/0

-opaque sender()

sender_policy/0

-type sender_policy() ::
          #{chunk_size := 1..65518,
            padding := padding(),
            compression := compression(),
            rekey_after := rekey_after(),
            clock := fun(() -> integer())}.

suite/0

-type suite() :: chachapoly_blake2b | aesgcm_sha512 | aesgcm_sha256 | aesgcm_blake2b.

Functions

decode_name(_)

-spec decode_name(binary()) -> {ok, binary()} | {error, bad_name | bad_payload}.

encode_name(Name)

-spec encode_name(binary()) -> binary().

hello(SuiteId, Msg1)

-spec hello(1..4, binary()) -> binary().

hello_header(SuiteId)

-spec hello_header(1..4) -> <<_:64>>.

known_suites()

-spec known_suites() -> [suite()].

limits()

-spec limits() -> map().

msg3_frame(Msg3)

-spec msg3_frame(binary()) -> binary().

new_receiver(CS, Policy)

-spec new_receiver(herrie_cipher_state:state(), map()) -> receiver().

new_sender(CS, Policy)

-spec new_sender(herrie_cipher_state:state(), map()) -> sender().

noise_name(_)

-spec noise_name(suite()) -> binary().

parse_hello_header(_, AcceptedIds)

-spec parse_hello_header(binary(), [byte()]) ->
                            {ok, suite(), 32} | {reject, 1} | {reject, 2} | {error, bad_hello_header}.

parse_msg3_prefix(_)

-spec parse_msg3_prefix(binary()) -> {ok, 1..65535} | {error, bad_msg3_length}.

parse_reply_header(_)

-spec parse_reply_header(binary()) ->
                            {ok, 1..65535} |
                            {error, unsupported_version | unsupported_suite | bad_reply_header}.

prologue(HelloHeader, Target)

-spec prologue(binary(), binary()) -> binary().

receiver_policy(Layers)

-spec receiver_policy([map()] | map()) -> {ok, receiver_policy()} | {error, policy_error()}.

reply_ok(Msg2)

-spec reply_ok(binary()) -> binary().

reply_reject(Status)

-spec reply_reject(1 | 2) -> binary().

rx_feed(Rx, Bytes)

-spec rx_feed(receiver(), binary()) -> {ok, [rx_event()], receiver()} | {error, rx_error(), receiver()}.

rx_start(Rx)

-spec rx_start(receiver()) -> receiver().

sender_policy(Layers)

-spec sender_policy([map()] | map()) -> {ok, sender_policy()} | {error, policy_error()}.

suite_atom(_)

-spec suite_atom(1..4) -> suite().

suite_id(_)

-spec suite_id(suite()) -> 1..4.

tx_next(Tx, Pending)

-spec tx_next(sender(), pending()) -> {iolist(), sender(), more, pending()} | {iolist(), sender(), done}.

tx_packet(Packet)

-spec tx_packet(iodata()) -> pending().

tx_start(Tx)

-spec tx_start(sender()) -> sender().

tx_tick(S)

-spec tx_tick(sender()) -> {iolist(), sender()}.