|
RESTinio
|
Namespaces | |
| namespace | impl |
Classes | |
| struct | params_t |
| Parameters for basic authentification. More... | |
Enumerations | |
| enum class | extraction_error_t { no_auth_http_field , illegal_http_field_value , not_basic_auth_scheme , invalid_basic_auth_param , token68_decode_error , invalid_username_password_pair , empty_username } |
| Error codes for failures of extraction of basic authentification parameters. More... | |
Error codes for failures of extraction of basic authentification parameters.
Definition at line 65 of file basic_auth.hpp.
|
inlinenoexcept |
Helper function to get a string name of extraction_error enum.
Definition at line 99 of file basic_auth.hpp.
|
inline |
Helper function for getting parameters of basic authentification from an already parsed HTTP-field.
Usage example:
Definition at line 183 of file basic_auth.hpp.
|
inline |
Helper function for getting parameters of basic authentification from a request.
Usage example:
| req | A request that should hold a HTTP-field with authentification parameters. |
| auth_field_id | The ID of a HTTP-field with authentification parameters. |
Definition at line 362 of file basic_auth.hpp.
|
inline |
Helper function for getting parameters of basic authentification from a request.
This helper function is intended to be used for cases when authentification parameters are stored inside a HTTP-field with a custom name. For example:
| req | A request that should hold a HTTP-field with authentification parameters. |
| auth_field_name | The name of a HTTP-field with authentification parameters. |
Definition at line 295 of file basic_auth.hpp.
|
inline |
Helper function for getting parameters of basic authentification from a set of HTTP-fields.
Usage example:
| fields | A set of HTTP-fields. |
| auth_field_id | The ID of a HTTP-field with authentification parameters. |
Definition at line 328 of file basic_auth.hpp.
|
inline |
Helper function for getting parameters of basic authentification from a set of HTTP-fields.
This helper function is intended to be used for cases when authentification parameters are stored inside a HTTP-field with a custom name. For example:
| fields | A set of HTTP-fields. |
| auth_field_name | The name of a HTTP-field with authentification parameters. |
Definition at line 261 of file basic_auth.hpp.