Manifold Signature v1.0.3 ManifoldcoSignature View Source
Verifies incoming provider callback requests from the Manifold.co service.
https://docs.manifold.co/providers#section/Authentication
Link to this section Summary
Types
User friendly error reason
Master key provided by Manifold. This should be securely stored in your environment and
passed to validate/6
as the last argument
The Base64 decoded version of the master key. This should not be necessary to pass except for testing purposes, as this library defaults to the Manifold public master key
The raw request body
The key value of a request header
The value of a request header
Tuple form of the request headers, the default structure provided from Plug.Conn.headers
String representation of the method, case insensitive. This library will normalize the case to lower as described in the Manifold docs
The raw request path with a leading /
String representation of the URL query string (without the ?
). This library will normalize
the order of the parameters as described in the Manifold documentation
Option that can be passed to verify/6
Functions
Verifies the request. Each request part is required to build the canoncical form of the
request and the master_key
should be securetly stored in your environment and passed
as the last argument. The master_key
is provided by Manifold
Link to this section Types
User friendly error reason.
Master key provided by Manifold. This should be securely stored in your environment and
passed to validate/6
as the last argument.
The Base64 decoded version of the master key. This should not be necessary to pass except for testing purposes, as this library defaults to the Manifold public master key.
The raw request body.
The key value of a request header.
The value of a request header.
request_headers() :: [{request_header_key(), request_header_value()}]
Tuple form of the request headers, the default structure provided from Plug.Conn.headers
.
All headers must have string values and should not be parsed or coerced.
String representation of the method, case insensitive. This library will normalize the case to lower as described in the Manifold docs.
The raw request path with a leading /
.
String representation of the URL query string (without the ?
). This library will normalize
the order of the parameters as described in the Manifold documentation.
Option that can be passed to verify/6
.
Link to this section Functions
verify( request_method(), request_path(), request_query_string(), request_headers(), request_body(), [verify_opt()] ) :: :ok | {:error, error_reason()}
Verifies the request. Each request part is required to build the canoncical form of the
request and the master_key
should be securetly stored in your environment and passed
as the last argument. The master_key
is provided by Manifold.