FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
esp32_https_server/src/WebsocketHandler.cpp at master · george2209/esp32_https_server · GitHub
george2209
esp32_https_server
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
esp32_https_server
/
src
/
WebsocketHandler.cpp
Copy path
More file actions
More file actions
Latest commit
History
History
History
262 lines (231 loc) · 7.6 KB
Breadcrumbs
esp32_https_server
/
src
/
WebsocketHandler.cpp
Copy path
File metadata and controls
262 lines (231 loc) · 7.6 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
#
include
"
WebsocketHandler.hpp
"
namespace
httpsserver
{
/*
*
* @brief Dump the content of the WebSocket frame for debugging.
* @param [in] frame The frame to dump.
*/
static
void
dumpFrame
(WebsocketFrame frame) {
std::string opcode =
std::string
(
"
Unknown
"
);
switch
(frame.
opCode
) {
case
WebsocketHandler::
OPCODE_BINARY
: opcode =
std::string
(
"
BINARY
"
);
break
;
case
WebsocketHandler::
OPCODE_CONTINUE
: opcode =
std::string
(
"
CONTINUE
"
);
break
;
case
WebsocketHandler::
OPCODE_CLOSE
: opcode =
std::string
(
"
CLOSE
"
);
break
;
case
WebsocketHandler::
OPCODE_PING
: opcode =
std::string
(
"
PING
"
);
break
;
case
WebsocketHandler::
OPCODE_PONG
: opcode =
std::string
(
"
PONG
"
);
break
;
case
WebsocketHandler::
OPCODE_TEXT
: opcode =
std::string
(
"
TEXT
"
);
break
;
}
ESP_LOGI
(
TAG
,
"
Fin: %d, OpCode: %d (%s), Mask: %d, Len: %d
"
,
(
int
)frame.
fin
,
(
int
)frame.
opCode
,
opcode.
c_str
(),
(
int
)frame.
mask
,
(
int
)frame.
len
);
}
WebsocketHandler::WebsocketHandler
() {
_con =
nullptr
;
_receivedClose =
false
;
_sentClose =
false
;
}
WebsocketHandler::~WebsocketHandler
() {
}
//
~WebSocketHandler()
/*
*
* @brief The default onClose handler.
* If no over-riding handler is provided for the "close" event, this method is called.
*/
void
WebsocketHandler::onClose
() {
HTTPS_LOGD
(
"
WebsocketHandler close()
"
);
}
/*
*
* @brief The default onData handler.
* If no over-riding handler is provided for the "message" event, this method is called.
* A particularly useful pattern for using onMessage is:
* ```
* std::stringstream buffer;
* buffer << pWebSocketInputRecordStreambuf;
* ```
* This will read the whole message into the string stream.
*/
void
WebsocketHandler::onMessage
(WebsocketInputStreambuf* pWebsocketInputStreambuf) {
//
, Websocket *pWebSocket) {
HTTPS_LOGD
(
"
WebsocketHandler onMessage()
"
);
}
/*
*
* @brief The default onError handler.
* If no over-riding handler is provided for the "error" event, this method is called.
*/
void
WebsocketHandler::onError
(std::string error) {
HTTPS_LOGD
(
"
WebsocketHandler onError()
"
);
}
void
WebsocketHandler::initialize
(ConnectionContext * con) {
_con = con;
}
void
WebsocketHandler::loop
() {
if
(
read
() <
0
) {
close
();
}
}
int
WebsocketHandler::read
() {
WebsocketFrame frame;
int
length = _con->
readBuffer
((
uint8_t
*)&frame,
sizeof
(frame));
HTTPS_LOGD
(
"
Websocket: Read %d bytes
"
, length);
if
(length ==
0
)
return
0
;
else
if
(length !=
sizeof
(frame)) {
HTTPS_LOGE
(
"
Websocket read error
"
);
//
_con->closeConnection();
return
-
1
;
}
dumpFrame
(frame);
//
The following section parses the WebSocket frame.
uint32_t
payloadLen =
0
;
uint8_t
mask[
4
];
if
(frame.
len
<
126
) {
payloadLen = frame.
len
;
}
else
if
(frame.
len
==
126
) {
uint16_t
tempLen;
_con->
readBuffer
((
uint8_t
*)&tempLen,
sizeof
(tempLen));
payloadLen =
ntohs
(tempLen);
}
else
if
(frame.
len
==
127
) {
uint64_t
tempLen;
_con->
readBuffer
((
uint8_t
*)&tempLen,
sizeof
(tempLen));
payloadLen =
ntohl
((
uint32_t
)tempLen);
}
if
(frame.
mask
==
1
) {
_con->
readBuffer
(mask,
sizeof
(mask));
}
if
(payloadLen ==
0
) {
HTTPS_LOGW
(
"
WS payload not present
"
);
}
else
{
HTTPS_LOGI
(
"
WS payload: length=%d
"
, payloadLen);
}
switch
(frame.
opCode
) {
case
OPCODE_TEXT
:
case
OPCODE_BINARY
: {
HTTPS_LOGD
(
"
Creating Streambuf
"
);
WebsocketInputStreambuf
streambuf
(_con, payloadLen, frame.
mask
==
1
?mask:
nullptr
);
HTTPS_LOGD
(
"
Calling onMessage
"
);
onMessage
(&streambuf);
HTTPS_LOGD
(
"
Discarding Streambuf
"
);
streambuf.
discard
();
break
;
}
case
OPCODE_CLOSE
: {
//
If the WebSocket operation code is close then we are closing the connection.
_receivedClose =
true
;
onClose
();
//
close(); // Close the websocket.
return
-
1
;
break
;
}
case
OPCODE_CONTINUE
: {
break
;
}
case
OPCODE_PING
: {
break
;
}
case
OPCODE_PONG
: {
break
;
}
default
: {
HTTPS_LOGW
(
"
WebSocketReader: Unknown opcode: %d
"
, frame.
opCode
);
break
;
}
}
//
Switch opCode
return
0
;
}
//
Websocket::read
/*
*
* @brief Close the Web socket
* @param [in] status The code passed in the close request.
* @param [in] message A clarification message on the close request.
*/
void
WebsocketHandler::close
(
uint16_t
status, std::string message) {
HTTPS_LOGD
(
"
Websocket close()
"
);
_sentClose =
true
;
//
Flag that we have sent a close request.
WebsocketFrame frame;
//
Build the web socket frame indicating a close request.
frame.
fin
=
1
;
frame.
rsv1
=
0
;
frame.
rsv2
=
0
;
frame.
rsv3
=
0
;
frame.
opCode
=
OPCODE_CLOSE
;
frame.
mask
=
0
;
frame.
len
= message.
length
() +
2
;
int
rc = _con->
writeBuffer
((
uint8_t
*)&frame,
sizeof
(frame));
if
(rc >
0
) {
rc = _con->
writeBuffer
((byte *) &status,
2
);
}
if
(rc >
0
) {
_con->
writeBuffer
((byte *) message.
data
(), message.
length
());
}
}
//
Websocket::close
/*
*
* @brief Send data down the web socket
* See the WebSocket spec (RFC6455) section "6.1 Sending Data".
* We build a WebSocket frame, send the frame followed by the data.
* @param [in] data The data to send down the WebSocket.
* @param [in] sendType The type of payload. Either SEND_TYPE_TEXT or SEND_TYPE_BINARY.
*/
void
WebsocketHandler::send
(std::string data,
uint8_t
sendType) {
HTTPS_LOGD
(
"
>> Websocket.send(): length=%d
"
, data.
length
());
WebsocketFrame frame;
frame.
fin
=
1
;
frame.
rsv1
=
0
;
frame.
rsv2
=
0
;
frame.
rsv3
=
0
;
frame.
opCode
= sendType==
SEND_TYPE_TEXT
?
OPCODE_TEXT
:
OPCODE_BINARY
;
frame.
mask
=
0
;
if
(data.
length
() <
126
) {
frame.
len
= data.
length
();
_con->
writeBuffer
((
uint8_t
*)&frame,
sizeof
(frame));
}
else
{
frame.
len
=
126
;
_con->
writeBuffer
((
uint8_t
*)&frame,
sizeof
(frame));
uint16_t
net_len =
htons
((
uint16_t
)data.
length
());
_con->
writeBuffer
((
uint8_t
*)&net_len,
sizeof
(
uint16_t
));
//
Convert to network byte order from host byte order
}
_con->
writeBuffer
((
uint8_t
*)data.
data
(), data.
length
());
HTTPS_LOGD
(
"
<< Websocket.send()
"
);
}
//
Websocket::send
/*
*
* @brief Send data down the web socket
* See the WebSocket spec (RFC6455) section "6.1 Sending Data".
* We build a WebSocket frame, send the frame followed by the data.
* @param [in] data The data to send down the WebSocket.
* @param [in] sendType The type of payload. Either SEND_TYPE_TEXT or SEND_TYPE_BINARY.
*/
void
WebsocketHandler::send
(
uint8_t
* data,
uint16_t
length,
uint8_t
sendType) {
HTTPS_LOGD
(
"
>> Websocket.send(): length=%d
"
, length);
WebsocketFrame frame;
frame.
fin
=
1
;
frame.
rsv1
=
0
;
frame.
rsv2
=
0
;
frame.
rsv3
=
0
;
frame.
opCode
= sendType==
SEND_TYPE_TEXT
?
OPCODE_TEXT
:
OPCODE_BINARY
;
frame.
mask
=
0
;
if
(length <
126
) {
frame.
len
= length;
_con->
writeBuffer
((
uint8_t
*)&frame,
sizeof
(frame));
}
else
{
frame.
len
=
126
;
_con->
writeBuffer
((
uint8_t
*)&frame,
sizeof
(frame));
uint16_t
net_len =
htons
(length);
//
replaced by George2209 on 2019-11-11 (avoid forced/implicit conversion):
//
_con->writeBuffer((uint8_t *) net_len, sizeof(uint16_t)); // Convert to network byte order from host byte order
//
start of replacement of the upper line:
{
uint8_t
tmp_buffer[
sizeof
(
uint16_t
)];
memcpy
(tmp_buffer,&net_len,
sizeof
(
uint16_t
));
_con->
writeBuffer
(tmp_buffer,
sizeof
(
uint16_t
));
//
Convert to network byte order from host byte order
}
//
end of replacement of George2209
}
_con->
writeBuffer
(data, length);
HTTPS_LOGD
(
"
<< Websocket.send()
"
);
}
//
Websocket::send
/*
*
* Returns true if the connection has been closed, either by client or server
*/
bool
WebsocketHandler::closed
() {
return
_receivedClose || _sentClose;
}
}
Back
|
FazBrowse Home
|
New Git URL