aboutsummaryrefslogtreecommitdiff
path: root/doc/libmicrohttpd.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/libmicrohttpd.texi')
-rw-r--r--doc/libmicrohttpd.texi15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/libmicrohttpd.texi b/doc/libmicrohttpd.texi
index 57cdb000..4e571a26 100644
--- a/doc/libmicrohttpd.texi
+++ b/doc/libmicrohttpd.texi
@@ -3114,21 +3114,24 @@ client certificates is presented in the MHD tutorial.
3114Free the memory given at @code{ptr}. Used to free data structures allocated by MHD. Calls @code{free(ptr)}. 3114Free the memory given at @code{ptr}. Used to free data structures allocated by MHD. Calls @code{free(ptr)}.
3115@end deftypefun 3115@end deftypefun
3116 3116
3117@deftypefun {char *} MHD_basic_auth_get_username_password (struct MHD_Connection *connection, char** password) 3117@deftypefun {char *} MHD_basic_auth_get_username_password3 (struct MHD_Connection *connection)
3118Get the username and password from the basic authorization header sent by the client. 3118Get the username and password from the basic authorization header sent by the client.
3119Return @code{NULL} if no username could be found, a pointer to the username if found. 3119Return @code{NULL} if no Basic Authorization header set by the client or if Base64
3120If returned value is not @code{NULL}, the value must be @code{MHD_free()}'ed. 3120encoding is invalid; a pointer to the structure with username and password
3121 3121if found values set by the client.
3122@var{password} reference a buffer to store the password. It can be @code{NULL}.
3123If returned value is not @code{NULL}, the value must be @code{MHD_free()}'ed. 3122If returned value is not @code{NULL}, the value must be @code{MHD_free()}'ed.
3124@end deftypefun 3123@end deftypefun
3125 3124
3126@deftypefun {enum MHD_Result} MHD_queue_basic_auth_fail_response (struct MHD_Connection *connection, const char *realm, struct MHD_Response *response) 3125@deftypefun {enum MHD_Result} MHD_queue_basic_auth_fail_response3 (struct MHD_Connection *connection, const char *realm, int prefer_utf8, struct MHD_Response *response)
3127Queues a response to request basic authentication from the client. 3126Queues a response to request basic authentication from the client.
3128Return @code{MHD_YES} if successful, otherwise @code{MHD_NO}. 3127Return @code{MHD_YES} if successful, otherwise @code{MHD_NO}.
3129 3128
3130@var{realm} must reference to a zero-terminated string representing the realm. 3129@var{realm} must reference to a zero-terminated string representing the realm.
3131 3130
3131@var{prefer_utf8} if set to @code{MHD_YES} then parameter @code{charset} with value
3132@code{UTF-8} will be added to the response authentication header which indicates
3133that UTF-8 encoding is preferred for username and password.
3134
3132@var{response} a response structure to specify what shall be presented to the 3135@var{response} a response structure to specify what shall be presented to the
3133client with a 401 HTTP status. 3136client with a 401 HTTP status.
3134@end deftypefun 3137@end deftypefun