example of integration with websocket in C
[src/app-framework-binder.git] / src / afb-ws-client.c
1 /*
2  * Copyright 2016 IoT.bzh
3  * Author: José Bollo <jose.bollo@iot.bzh>
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #define _GNU_SOURCE
19
20 #include <stdlib.h>
21 #include <stdio.h>
22 #include <unistd.h>
23 #include <assert.h>
24 #include <errno.h>
25 #include <string.h>
26 #include <sys/types.h>
27 #include <sys/socket.h>
28 #include <netdb.h>
29
30 #include "afb-wsj1.h"
31
32 /**************** WebSocket handshake ****************************/
33
34 static const char *compkeys[32] = {
35         "lYKr2sn9+ILcLpkqdrE2VQ==", "G5J7ncQnmS/MubIYcqKWM+E6k8I=",
36         "gjN6eOU/6Yy7dBTJ+EaQSw==", "P5QzN7mRt4DeRWxKdG7s4/NCEwk=",
37         "ziLin6OQ0/a1+cGaI9Mupg==", "yvpxcFJAGam6huL77vz34CdShyU=",
38         "KMfd2bHKah0U5mk2Kg/LIg==", "lyYxfDP5YunhkBF+nAWb/w6K4yg=",
39         "fQ/ISF1mNCPRMyAj3ucqNg==", "91YY1EUelb4eMU24Z8WHhJ9cHmc=",
40         "RHlfiVVE1lM1AJnErI8dFg==", "UdZQc0JaihQJV5ETCZ84Av88pxQ=",
41         "NVy3L2ujXN7v3KEJwK92ww==", "+dE7iITxhExjBtf06VYNWChHqx8=",
42         "cCNAgttlgELfbDDIfhujww==", "W2JiswqbTAXx5u84EtjbtqAW2Bg=",
43         "K+oQvEDWJP+WXzRS5BJDFw==", "szgW10a9AuD+HtfS4ylaqWfzWAs=",
44         "nmg43S4DpVaxye+oQv9KTw==", "8XK74jB9xFfTzzl0wTqW04k3tPE=",
45         "LIqZ23sEppbF4YJR9LQ4/w==", "f8lJBQEbR8QmmvPHZpA0smlIeeA=",
46         "WY1vvvY2j/3V9DAGW3ZZcA==", "lROlE4vL4cjU1Vnk6rISc9gVKN0=",
47         "Ia+dgHnA9QaBrbxuqh4wgQ==", "GiGjxFdSaF0EGTl2cjvFsVmJnfM=",
48         "MfpIVG082jFTV7SxTNNijQ==", "f5I2h53hBsT5ES3EHhnxAJ2nqsw=",
49         "kFumnAw5d/WctG0yAUHPiQ==", "aQQmOjoABl7mrbliTPS1bOkndOs=",
50         "MHiEc+Qc8w/SJ3zMHEM8pA==", "FVCxLBmoil3gY0jSX3aNJ6kR/t4="
51 };
52
53 static const char websocket_s[] = "websocket";
54 static const char sec_websocket_key_s[] = "Sec-WebSocket-Key";
55 static const char sec_websocket_version_s[] = "Sec-WebSocket-Version";
56 static const char sec_websocket_accept_s[] = "Sec-WebSocket-Accept";
57 static const char sec_websocket_protocol_s[] = "Sec-WebSocket-Protocol";
58
59 static const char vseparators[] = " \t,";
60
61 /* get randomly a pair of key/accept value */
62 static void getkeypair(const char **key, const char **ack)
63 {
64         int r;
65         r = rand();
66         while (r > 15)
67                 r = (r & 15) + (r >> 4);
68         r = (r & 15) << 1;
69         *key = compkeys[r];
70         *ack = compkeys[r+1];
71 }
72
73 /* joins the strings using the separator */
74 static char *strjoin(int count, const char **strings, const char *separ)
75 {
76         char *result, *iter;
77         size_t length;
78         int idx;
79
80         /* creates the count if needed */
81         if (count < 0)
82                 for(count = 0 ; strings[count] != NULL ; count++);
83
84         /* compute the length of the result */
85         if (count == 0)
86                 length = 0;
87         else {
88                 length = (unsigned)(count - 1) * strlen(separ);
89                 for (idx = 0 ; idx < count ; idx ++)
90                         length += strlen(strings[idx]);
91         }
92
93         /* allocates the result */
94         result = malloc(length + 1);
95         if (result == NULL)
96                 errno = ENOMEM;
97         else {
98                 /* create the result */
99                 if (count != 0) {
100                         iter = stpcpy(result, strings[idx = 0]);
101                         while (++idx < count)
102                                 iter = stpcpy(stpcpy(iter, separ), strings[idx]);
103                         // assert(iter - result == length);
104                 }
105                 result[length] = 0;
106         }
107         return result;
108 }
109
110 /* creates the http message for the request */
111 static int make_request(char **request, const char *path, const char *host, const char *key, const char *protocols)
112 {
113         int rc = asprintf(request, 
114                         "GET %s HTTP/1.1\r\n"
115                         "Host: %s\r\n"
116                         "Upgrade: websocket\r\n"
117                         "Connection: Upgrade\r\n"
118                         "Sec-WebSocket-Version: 13\r\n"
119                         "Sec-WebSocket-Key: %s\r\n"
120                         "Sec-WebSocket-Protocol: %s\r\n"
121                         "Content-Length: 0\r\n"
122                         "\r\n"
123                         , path
124                         , host
125                         , key
126                         , protocols
127                 );
128         if (rc < 0) {
129                 errno = ENOMEM;
130                 *request = NULL;
131                 return -1;
132         }
133         return rc;
134 }
135
136 /* create the request and send it to fd, returns the expected accept string */
137 static const char *send_request(int fd, const char **protocols, const char *path, const char *host)
138 {
139         const char *key, *ack;
140         char *protolist, *request;
141         int length, rc;
142
143         /* make the list of accepted protocols */
144         protolist = strjoin(-1, protocols, ", ");
145         if (protolist == NULL)
146                 return NULL;
147
148         /* create the request */
149         getkeypair(&key, &ack);
150         length = make_request(&request, path, host, key, protolist);
151         free(protolist);
152         if (length < 0)
153                 return NULL;
154
155         /* send the request */
156         do { rc = (int)write(fd, request, length); } while(rc < 0 && errno == EINTR);
157         free(request);
158         return rc < 0 ? NULL : ack;
159 }
160
161 /* read a line not efficiently but without buffering */
162 static int receive_line(int fd, char *line, int size)
163 {
164         int rc, length = 0, cr = 0;
165         for(;;) {
166                 if (length >= size) {
167                         errno = EFBIG;
168                         return -1;
169                 }
170                 do { rc = (int)read(fd, line + length, 1); } while (rc < 0 && errno == EINTR);
171                 if (rc < 0)
172                         return -1;
173                 if (line[length] == '\r')
174                         cr = 1;
175                 else if (cr != 0 && line[length] == '\n') {
176                         line[--length] = 0;
177                         return length;
178                 } else
179                         cr = 0;
180                 length++;
181         }
182 }
183
184 /* check a header */
185 static inline int isheader(const char *head, size_t klen, const char *key)
186 {
187         return strncasecmp(head, key, klen) == 0 && key[klen] == 0;
188 }
189
190 /* receives and scan the response */
191 static int receive_response(int fd, const char **protocols, const char *ack)
192 {
193         char line[4096], *it;
194         int rc, haserr, result = -1;
195         size_t len, clen;
196
197         /* check the header line to be something like: "HTTP/1.1 101 Switching Protocols" */
198         rc = receive_line(fd, line, (int)sizeof(line));
199         if (rc < 0)
200                 goto error;
201         len = strcspn(line, " ");
202         if (len != 8 || 0 != strncmp(line, "HTTP/1.1", 8))
203                 goto error;
204         it = line + len;
205         len = strspn(it, " ");
206         if (len == 0)
207                 goto error;
208         it += len;
209         len = strcspn(it, " ");
210         if (len != 3 || 0 != strncmp(it, "101", 3))
211                 goto error;
212
213         /* reads the rest of the response until empty line */
214         clen = 0;
215         haserr = 0;
216         for(;;) {
217                 rc = receive_line(fd, line, (int)sizeof(line));
218                 if (rc < 0)
219                         goto error;
220                 if (rc == 0)
221                         break;
222                 len = strcspn(line, ": ");
223                 if (len != 0 && line[len] == ':') {
224                         /* checks the headers values */
225                         it = line + len + 1;
226                         it += strspn(it, " ,");
227                         it[strcspn(it, " ,")] = 0;
228                         if (isheader(line, len, "Sec-WebSocket-Accept")) {
229                                 if (strcmp(it, ack) != 0)
230                                         haserr = 1;
231                         } else if (isheader(line, len, "Sec-WebSocket-Protocol")) {
232                                 result = 0;
233                                 while(protocols[result] != NULL && strcmp(it, protocols[result]) != 0)
234                                         result++;
235                         } else if (isheader(line, len, "Upgrade")) {
236                                 if (strcmp(it, "websocket") != 0)
237                                         haserr = 1;
238                         } else if (isheader(line, len, "Content-Length")) {
239                                 clen = atol(it);
240                         }
241                 }
242         }
243
244         /* skips the remaining of the message */
245         while (clen >= sizeof line) {
246                 while (read(fd, line, sizeof line) < 0 && errno == EINTR);
247                 clen -= sizeof line;
248         }
249         if (clen > 0) {
250                 while (read(fd, line, len) < 0 && errno == EINTR);
251         }
252         if (haserr != 0)
253                 result = -1;
254         else if (result < 0) {
255                 result = 0;
256                 while(protocols[result] != NULL)
257                         result++;
258         }
259 error:
260         return result;
261 }
262
263 static int negociate(int fd, const char **protocols, const char *path, const char *host)
264 {
265         const char *ack = send_request(fd, protocols, path, host);
266         return ack == NULL ? -1 : receive_response(fd, protocols, ack);
267 }
268
269 /* tiny parse a "standard" websock uri ws://host:port/path... */
270 static int parse_uri(const char *uri, char **host, char **service, const char **path)
271 {
272         const char *h, *p;
273         size_t hlen, plen;
274
275         /* the scheme */
276         if (strncmp(uri, "ws://", 5) == 0)
277                 uri += 5;
278
279         /* the host */
280         h = uri;
281         hlen = strcspn(h, ":/");
282         if (hlen == 0)
283                 goto invalid;
284         uri += hlen;
285
286         /* the port (optional) */
287         if (*uri == ':') {
288                 p = ++uri;
289                 plen = strcspn(p, "/");
290                 if (plen == 0)
291                         goto invalid;
292                 uri += plen;
293         } else {
294                 p = NULL;
295                 plen = 0;
296         }
297
298         /* the path */
299         if (*uri != '/')
300                 goto invalid;
301
302         /* make the result */
303         *host = strndup(h, hlen);
304         if (*host != NULL) {
305                 *service = plen ? strndup(p, plen) : strdup("http");
306                 if (*service != NULL) {
307                         *path = uri;
308                         return 0;
309                 }
310                 free(*host);
311         }
312         errno = ENOMEM;
313         goto error;
314 invalid:
315         errno = EINVAL;
316 error:
317         return -1;
318         
319 }
320
321
322
323
324 static const char *proto_json1[2] = { "x-afb-ws-json1", NULL };
325
326 struct afb_wsj1 *afb_ws_client_connect_wsj1(const char *uri, struct afb_wsj1_itf *itf, void *closure)
327 {
328         int rc, fd;
329         char *host, *service, xhost[32];
330         const char *path;
331         struct addrinfo hint, *rai, *iai;
332         struct afb_wsj1 *result;
333
334         /* scan the uri */
335         rc = parse_uri(uri, &host, &service, &path);
336         if (rc < 0)
337                 return NULL;
338
339         /* get addr */
340         memset(&hint, 0, sizeof hint);
341         hint.ai_family = AF_INET;
342         hint.ai_socktype = SOCK_STREAM;
343         rc = getaddrinfo(host, service, &hint, &rai);
344         free(host);
345         free(service);
346         if (rc != 0) {
347                 errno = EINVAL;
348                 return NULL;
349         }
350
351         /* get the socket */
352         result = NULL;
353         iai = rai;
354         while (iai != NULL) {
355                 struct sockaddr_in *a = (struct sockaddr_in*)(iai->ai_addr);
356                 unsigned char *ipv4 = (unsigned char*)&(a->sin_addr.s_addr);
357                 unsigned char *port = (unsigned char*)&(a->sin_port);
358                 sprintf(xhost, "%d.%d.%d.%d:%d",
359                         (int)ipv4[0], (int)ipv4[1], (int)ipv4[2], (int)ipv4[3],
360                         (((int)port[0]) << 8)|(int)port[1]);
361                 fd = socket(iai->ai_family, iai->ai_socktype, iai->ai_protocol);
362                 if (fd >= 0) {
363                         rc = connect(fd, iai->ai_addr, iai->ai_addrlen);
364                         if (rc == 0) {
365                                 rc = negociate(fd, proto_json1, path, xhost);
366                                 if (rc == 0) {
367                                         result = afb_wsj1_create(fd, itf, closure);
368                                         if (result != NULL)
369                                                 break;
370                                 }
371                         }
372                         close(fd);
373                 }
374                 iai = iai->ai_next;
375         }
376         freeaddrinfo(rai);
377         return result;
378 }
379
380 #if 0
381 /* compute the queried path */
382 static char *makequery(const char *path, const char *uuid, const char *token)
383 {
384         char *result;
385         int rc;
386
387         while(*path == '/')
388                 path++;
389         if (uuid == NULL) {
390                 if (token == NULL)
391                         rc = asprintf(&result, "/%s", path);
392                 else
393                         rc = asprintf(&result, "/%s?x-afb-token=%s", path, token);
394         } else {
395                 if (token == NULL)
396                         rc = asprintf(&result, "/%s?x-afb-uuid=%s", path, uuid);
397                 else
398                         rc = asprintf(&result, "/%s?x-afb-uuid=%s&x-afb-token=%s", path, uuid, token);
399         }
400         if (rc < 0) {
401                 errno = ENOMEM;
402                 return NULL;
403         }
404         return result;
405 }
406 #endif
407
408