noisegate_protocol (noisegate v1.0.0)
View SourceSummary
Types
bit 0 last, 1 tick, 2 comp, 3 pad, 4 rekey, 5-7 reserved (0)
Types
-type compression() :: none | {zlib, 0..65518}.
-type flags() :: byte().
bit 0 last, 1 tick, 2 comp, 3 pad, 4 rekey, 5-7 reserved (0)
-type padding() :: none | {bucket, 1..65519} | {fixed, 4..65519}.
-opaque pending()
-opaque receiver()
-type receiver_policy() :: #{max_packet := pos_integer(), accept_compression := boolean(), max_bytes_without_rekey := pos_integer() | infinity}.
-type rekey_after() :: never | [rekey_limit(), ...].
-type rekey_limit() :: {frames, pos_integer()} | {bytes, pos_integer()} | {ms, pos_integer()}.
-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.
-type rx_event() :: {packet, iodata()} | tick.
-opaque sender()
-type sender_policy() :: #{chunk_size := 1..65518, padding := padding(), compression := compression(), rekey_after := rekey_after(), clock := fun(() -> integer())}.
-type suite() :: chachapoly_blake2b | aesgcm_sha512 | aesgcm_sha256 | aesgcm_blake2b.
Functions
-spec hello_header(1..4) -> <<_:64>>.
-spec known_suites() -> [suite()].
-spec limits() -> map().
-spec new_receiver(herrie_cipher_state:state(), map()) -> receiver().
-spec new_sender(herrie_cipher_state:state(), map()) -> sender().
-spec parse_msg3_prefix(binary()) -> {ok, 1..65535} | {error, bad_msg3_length}.
-spec parse_reply_header(binary()) -> {ok, 1..65535} | {error, unsupported_version | unsupported_suite | bad_reply_header}.
-spec receiver_policy([map()] | map()) -> {ok, receiver_policy()} | {error, policy_error()}.
-spec reply_reject(1 | 2) -> binary().
-spec sender_policy([map()] | map()) -> {ok, sender_policy()} | {error, policy_error()}.
-spec suite_atom(1..4) -> suite().
-spec suite_id(suite()) -> 1..4.