View Source backwater_signatures (backwater v3.6.0)

Summary

Types

-type algorithm_failure() :: unknown_algorithm | headers_failure().
-type auth_parse_failure() :: invalid_auth_type | missing_authorization_header | header_params_failure().
-opaque config()
-type header_list() :: [{binary(), binary()}].
-type header_map() :: #{binary() => binary()}.
Link to this type

header_params_failure/0

View Source
-type header_params_failure() :: invalid_header_params.
-type headers_failure() :: missing_signed_header_list | mandatory_headers_failure().
-type key_id_failure() :: unknown_key | algorithm_failure().
Link to this type

mandatorily_signed_headers_failure/0

View Source
-type mandatorily_signed_headers_failure() ::
    {missing_mandatorily_signed_header, binary()} | signature_failure().
Link to this type

mandatory_headers_failure/0

View Source
-type mandatory_headers_failure() ::
    {missing_mandatory_header, binary()} | mandatorily_signed_headers_failure().
Link to this type

maybe_uncanonical_headers/0

View Source
-type maybe_uncanonical_headers() ::
    header_list() | header_map() | {headers | ci_headers, header_list() | header_map()}.
-type message() :: unsigned_message() | signed_message().
Link to this type

message_validation_success/0

View Source
-type message_validation_success() :: {ok, signed_message()}.
-type params() :: #{binary() => binary() | [binary()]}.
Link to this type

request_id_validation_failure/0

View Source
-type request_id_validation_failure() ::
    mismatched_request_id | missing_request_id | sig_parse_failure() | validation_failure().
Link to this type

request_validation_failure/0

View Source
-type request_validation_failure() :: auth_parse_failure() | validation_failure().
Link to this type

response_validation_failure/0

View Source
-type response_validation_failure() :: request_id_validation_failure().
-type sig_parse_failure() :: missing_signature_header | header_params_failure().
-type signature_failure() :: invalid_signature | signature_string_failure().
Link to this type

signature_string_failure/0

View Source
-type signature_string_failure() :: {missing_header, binary()}.
Link to this opaque

signed_message/0

View Source (opaque)
-opaque signed_message()
Link to this opaque

unsigned_message/0

View Source (opaque)
-opaque unsigned_message()
-type validation_failure() :: key_id_failure().