http_server_auth.h
Go to the documentation of this file.
1 /**
2  * @file http_server_auth.h
3  * @brief HTTP authentication
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.6
29  **/
30 
31 #ifndef _HTTP_SERVER_AUTH_H
32 #define _HTTP_SERVER_AUTH_H
33 
34 //Dependencies
35 #include "http/http_server.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //HTTP authentication related functions
44  const char_t *password, HttpAuthMode mode);
45 
47 size_t httpAddAuthenticateField(HttpConnection *connection, char_t *output);
48 
50  char_t *output, size_t *length);
51 
53  const char_t *nonce, const char_t *nc);
54 
55 //C++ guard
56 #ifdef __cplusplus
57 }
58 #endif
59 
60 #endif
uint8_t length
Definition: dtls_misc.h:149
int bool_t
Definition: compiler_port.h:49
HTTP server (HyperText Transfer Protocol)
#define HttpServerContext
Definition: http_server.h:314
error_t httpVerifyNonce(HttpServerContext *context, const char_t *nonce, const char_t *nc)
Nonce verification.
void httpParseAuthorizationField(HttpConnection *connection, char_t *value)
Parse Authorization header field.
error_t
Error codes.
Definition: error.h:42
#define HttpConnection
Definition: http_server.h:318
bool_t httpCheckPassword(HttpConnection *connection, const char_t *password, HttpAuthMode mode)
Password verification.
char char_t
Definition: compiler_port.h:43
size_t httpAddAuthenticateField(HttpConnection *connection, char_t *output)
Format WWW-Authenticate header field.
uint8_t mode
Definition: ntp_common.h:149
error_t httpGenerateNonce(HttpServerContext *context, char_t *output, size_t *length)
Nonce generation.
uint8_t value[]
Definition: dtls_misc.h:150
HttpAuthMode
HTTP authentication schemes.
Definition: http_common.h:71