web_socket_auth.h
Go to the documentation of this file.
1 /**
2  * @file web_socket_auth.h
3  * @brief HTTP authentication for WebSockets
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 _WEB_SOCKET_AUTH_H
32 #define _WEB_SOCKET_AUTH_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "web_socket/web_socket.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //WebSocket related functions
45 
46 size_t webSocketAddAuthorizationField(WebSocket *webSocket, char_t *output);
47 
48 void webSocketConvertArrayToHexString(const uint8_t *input,
49  size_t inputLen, char_t *output);
50 
51 //C++ guard
52 #ifdef __cplusplus
53 }
54 #endif
55 
56 #endif
WebSocket API (client and server)
error_t webSocketParseAuthenticateField(WebSocket *webSocket, char_t *value)
Parse WWW-Authenticate header field.
error_t
Error codes.
Definition: error.h:42
#define WebSocket
Definition: web_socket.h:177
size_t webSocketAddAuthorizationField(WebSocket *webSocket, char_t *output)
Format Authorization header field.
char char_t
Definition: compiler_port.h:43
uint8_t value[]
Definition: dtls_misc.h:150
TCP/IP stack core.
void webSocketConvertArrayToHexString(const uint8_t *input, size_t inputLen, char_t *output)
Convert byte array to hex string.