Sergey Pastor / 1

Webserver+3d print

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

web_socket_auth.c File Reference
Functions

web_socket_auth.c File Reference

HTTP authentication for WebSockets. More...

Go to the source code of this file.

Functions

error_t webSocketParseAuthenticateField (WebSocket *webSocket, char_t *value)
 Parse WWW-Authenticate header field.
size_t webSocketAddAuthorizationField (WebSocket *webSocket, char_t *output)
 Format Authorization header field.
void webSocketConvertArrayToHexString (const uint8_t *input, size_t inputLength, char_t *output)
 Convert byte array to hex string.

Detailed Description

HTTP authentication for WebSockets.

License

Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author:
Oryx Embedded SARL (www.oryx-embedded.com)
Version:
1.7.6

Definition in file web_socket_auth.c.

Function Documentation

size_t webSocketAddAuthorizationField ( WebSocket *  webSocket,
char_t *  output 
)

Format Authorization header field.

Parameters:
[in]webSocketHandle to a WebSocket
[out]outputBuffer where to format the header field
Returns:
Total length of the header field

Definition at line 165 of file web_socket_auth.c.

void webSocketConvertArrayToHexString ( const uint8_t *  input,
size_t  inputLength,
char_t *  output 
)

Convert byte array to hex string.

Parameters:
[in]inputPoint to the byte array
[in]inputLengthLength of the byte array
[out]outputNULL-terminated string resulting from the conversion
Returns:
Error code

Definition at line 309 of file web_socket_auth.c.

error_t webSocketParseAuthenticateField ( WebSocket *  webSocket,
char_t *  value 
)

Parse WWW-Authenticate header field.

Parameters:
[in]webSocketHandle to a WebSocket
[in]valueNULL-terminated string that contains the value of header field
Returns:
Error code

Definition at line 53 of file web_socket_auth.c.

Generated on Tue Jul 12 2022 17:10:23 by  doxygen 1.7.2