web_socket_misc.h

00001 /**
00002  * @file web_socket_misc.h
00003  * @brief Helper functions for WebSockets
00004  *
00005  * @section License
00006  *
00007  * Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
00008  *
00009  * This file is part of CycloneTCP Open.
00010  *
00011  * This program is free software; you can redistribute it and/or
00012  * modify it under the terms of the GNU General Public License
00013  * as published by the Free Software Foundation; either version 2
00014  * of the License, or (at your option) any later version.
00015  *
00016  * This program is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU General Public License
00022  * along with this program; if not, write to the Free Software Foundation,
00023  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
00024  *
00025  * @author Oryx Embedded SARL (www.oryx-embedded.com)
00026  * @version 1.7.6
00027  **/
00028 
00029 #ifndef _WEB_SOCKET_MISC_H
00030 #define _WEB_SOCKET_MISC_H
00031 
00032 //Dependencies
00033 #include "core/net.h"
00034 #include "web_socket/web_socket.h"
00035 
00036 
00037 /**
00038  * @brief HTTP status code
00039  **/
00040 
00041 typedef struct
00042 {
00043    uint_t value;
00044    const char_t message[28];
00045 } WebSocketStatusCodeDesc;
00046 
00047 
00048 //WebSocket related functions
00049 void webSocketChangeState(WebSocket *webSocket, WebSocketState newState);
00050 
00051 error_t webSocketParseHandshake(WebSocket *webSocket);
00052 error_t webSocketParseRequestLine(WebSocket *webSocket, char_t *line);
00053 error_t webSocketParseStatusLine(WebSocket *webSocket, char_t *line);
00054 error_t webSocketParseHeaderField(WebSocket *webSocket, char_t *line);
00055 
00056 void webSocketParseConnectionField(WebSocket *webSocket, char_t *value);
00057 
00058 error_t webSocketFormatClientHandshake(WebSocket *webSocket, uint16_t serverPort);
00059 error_t webSocketFormatServerHandshake(WebSocket *webSocket);
00060 
00061 error_t webSocketFormatErrorResponse(WebSocket *webSocket,
00062    uint_t statusCode, const char_t *message);
00063 
00064 error_t webSocketVerifyClientHandshake(WebSocket *webSocket);
00065 error_t webSocketVerifyServerHandshake(WebSocket *webSocket);
00066 
00067 error_t webSocketGenerateClientKey(WebSocket *webSocket);
00068 error_t webSocketGenerateServerKey(WebSocket *webSocket);
00069 
00070 error_t webSocketVerifyClientKey(WebSocket *webSocket);
00071 error_t webSocketVerifyServerKey(WebSocket *webSocket);
00072 
00073 bool_t webSocketCheckStatusCode(uint16_t statusCode);
00074 
00075 error_t webSocketDecodePercentEncodedString(const char_t *input,
00076    char_t *output, size_t outputSize);
00077 
00078 bool_t webSocketCheckUtf8Stream(WebSocketUtf8Context *context,
00079    const uint8_t *data, size_t length, size_t remaining);
00080 
00081 #endif
00082