src/afb-websock.c

   1 /*
   2  * Copyright (C) 2016, 2017 "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 <assert.h>
  22 #include <errno.h>
  23 #include <string.h>
  24
  25 #include <openssl/sha.h>
  26 #include <microhttpd.h>
  27
  28 #include "afb-method.h"
  29 #include "afb-context.h"
  30 #include "afb-hreq.h"
  31 #include "afb-websock.h"
  32 #include "afb-ws-json1.h"
  33
  34 /**************** WebSocket connection upgrade ****************************/
  35
  36 static const char websocket_s[] = "websocket";
  37 static const char sec_websocket_key_s[] = "Sec-WebSocket-Key";
  38 static const char sec_websocket_version_s[] = "Sec-WebSocket-Version";
  39 static const char sec_websocket_accept_s[] = "Sec-WebSocket-Accept";
  40 static const char sec_websocket_protocol_s[] = "Sec-WebSocket-Protocol";
  41 static const char websocket_guid[] = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  42
  43 static void enc64(unsigned char *in, char *out)
  44 {
  45         static const char tob64[] =
  46                 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  47                 "abcdefghijklmnopqrstuvwxyz"
  48                 "0123456789+/";
  49         out[0] = tob64[in[0] >> 2];
  50         out[1] = tob64[((in[0] & 0x03) << 4) | ((in[1] & 0xf0) >> 4)];
  51         out[2] = tob64[((in[1] & 0x0f) << 2) | ((in[2] & 0xc0) >> 6)];
  52         out[3] = tob64[in[2] & 0x3f];
  53 }
  54
  55 static void make_accept_value(const char *key, char result[29])
  56 {
  57         unsigned char md[SHA_DIGEST_LENGTH+1];
  58         size_t len = strlen(key);
  59         char *buffer = alloca(len + sizeof websocket_guid - 1);
  60         memcpy(buffer, key, len);
  61         memcpy(buffer + len, websocket_guid, sizeof websocket_guid - 1);
  62         SHA1((const unsigned char *)buffer, (unsigned long)(len + sizeof websocket_guid - 1), md);
  63         assert(SHA_DIGEST_LENGTH == 20);
  64         md[20] = 0;
  65         enc64(&md[0], &result[0]);
  66         enc64(&md[3], &result[4]);
  67         enc64(&md[6], &result[8]);
  68         enc64(&md[9], &result[12]);
  69         enc64(&md[12], &result[16]);
  70         enc64(&md[15], &result[20]);
  71         enc64(&md[18], &result[24]);
  72         result[27] = '=';
  73         result[28] = 0;
  74 }
  75
  76 static const char vseparators[] = " \t,";
  77
  78 static int headerhas(const char *header, const char *needle)
  79 {
  80         size_t len, n;
  81
  82         n = strlen(needle);
  83         for(;;) {
  84                 header += strspn(header, vseparators);
  85                 if (!*header)
  86                         return 0;
  87                 len = strcspn(header, vseparators);
  88                 if (n == len && 0 == strncasecmp(needle, header, n))
  89                         return 1;
  90                 header += len;
  91         }
  92 }
  93
  94 struct protodef
  95 {
  96         const char *name;
  97         void *(*create)(int fd, struct afb_apiset *apiset, struct afb_context *context, void (*cleanup)(void*), void *cleanup_closure);
  98 };
  99
 100 static const struct protodef *search_proto(const struct protodef *protodefs, const char *protocols)
 101 {
 102         int i;
 103         size_t len;
 104
 105         if (protocols == NULL) {
 106                 /* return NULL; */
 107                 return protodefs != NULL && protodefs->name != NULL ? protodefs : NULL;
 108         }
 109         for(;;) {
 110                 protocols += strspn(protocols, vseparators);
 111                 if (!*protocols)
 112                         return NULL;
 113                 len = strcspn(protocols, vseparators);
 114                 for (i = 0 ; protodefs[i].name != NULL ; i++)
 115                         if (!strncasecmp(protodefs[i].name, protocols, len)
 116                          && !protodefs[i].name[len])
 117                                 return &protodefs[i];
 118                 protocols += len;
 119         }
 120 }
 121
 122 struct memo_websocket {
 123         const struct protodef *proto;
 124         struct afb_hreq *hreq;
 125         struct afb_apiset *apiset;
 126 };
 127
 128 static void close_websocket(void *closure)
 129 {
 130         struct MHD_UpgradeResponseHandle *urh = closure;
 131         MHD_upgrade_action (urh, MHD_UPGRADE_ACTION_CLOSE);
 132 }
 133
 134 static void upgrade_to_websocket(
 135                         void *cls,
 136                         struct MHD_Connection *connection,
 137                         void *con_cls,
 138                         const char *extra_in,
 139                         size_t extra_in_size,
 140                         MHD_socket sock,
 141                         struct MHD_UpgradeResponseHandle *urh)
 142 {
 143         struct memo_websocket *memo = cls;
 144         void *ws;
 145
 146         ws = memo->proto->create(sock, memo->apiset, &memo->hreq->xreq.context, close_websocket, urh);
 147         if (ws == NULL) {
 148                 /* TODO */
 149                 close_websocket(urh);
 150         }
 151         afb_hreq_unref(memo->hreq);
 152         free(memo);
 153 }
 154
 155 static int check_websocket_upgrade(struct MHD_Connection *con, const struct protodef *protodefs, struct afb_hreq *hreq, struct afb_apiset *apiset)
 156 {
 157         struct memo_websocket *memo;
 158         struct MHD_Response *response;
 159         const char *connection, *upgrade, *key, *version, *protocols;
 160         char acceptval[29];
 161         int vernum;
 162         const struct protodef *proto;
 163
 164         /* is an upgrade to websocket ? */
 165         upgrade = MHD_lookup_connection_value(con, MHD_HEADER_KIND, MHD_HTTP_HEADER_UPGRADE);
 166         if (upgrade == NULL || strcasecmp(upgrade, websocket_s))
 167                 return 0;
 168
 169         /* is a connection for upgrade ? */
 170         connection = MHD_lookup_connection_value(con, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONNECTION);
 171         if (connection == NULL
 172          || !headerhas (connection, MHD_HTTP_HEADER_UPGRADE))
 173                 return 0;
 174
 175         /* has a key and a version ? */
 176         key = MHD_lookup_connection_value(con, MHD_HEADER_KIND, sec_websocket_key_s);
 177         version = MHD_lookup_connection_value(con, MHD_HEADER_KIND, sec_websocket_version_s);
 178         if (key == NULL || version == NULL)
 179                 return 0;
 180
 181         /* is a supported version ? */
 182         vernum = atoi(version);
 183         if (vernum != 13) {
 184                 response = MHD_create_response_from_buffer(0, NULL, MHD_RESPMEM_PERSISTENT);
 185                 MHD_add_response_header(response, sec_websocket_version_s, "13");
 186                 MHD_queue_response(con, MHD_HTTP_UPGRADE_REQUIRED, response);
 187                 MHD_destroy_response(response);
 188                 return 1;
 189         }
 190
 191         /* is the protocol supported ? */
 192         protocols = MHD_lookup_connection_value(con, MHD_HEADER_KIND, sec_websocket_protocol_s);
 193         proto = search_proto(protodefs, protocols);
 194         if (proto == NULL) {
 195                 response = MHD_create_response_from_buffer(0, NULL, MHD_RESPMEM_PERSISTENT);
 196                 MHD_queue_response(con, MHD_HTTP_PRECONDITION_FAILED, response);
 197                 MHD_destroy_response(response);
 198                 return 1;
 199         }
 200
 201         /* record context */
 202         memo = malloc(sizeof *memo);
 203         if (memo == NULL) {
 204                 response = MHD_create_response_from_buffer(0, NULL, MHD_RESPMEM_PERSISTENT);
 205                 MHD_queue_response(con, MHD_HTTP_INTERNAL_SERVER_ERROR, response);
 206                 MHD_destroy_response(response);
 207                 return 1;
 208         }
 209         memo->proto = proto;
 210         memo->hreq = hreq;
 211         memo->apiset = apiset;
 212
 213         /* send the accept connection */
 214         response = MHD_create_response_for_upgrade(upgrade_to_websocket, memo);
 215         make_accept_value(key, acceptval);
 216         MHD_add_response_header(response, sec_websocket_accept_s, acceptval);
 217         MHD_add_response_header(response, sec_websocket_protocol_s, proto->name);
 218         MHD_add_response_header(response, MHD_HTTP_HEADER_CONNECTION, MHD_HTTP_HEADER_UPGRADE);
 219         MHD_add_response_header(response, MHD_HTTP_HEADER_UPGRADE, websocket_s);
 220         MHD_queue_response(con, MHD_HTTP_SWITCHING_PROTOCOLS, response);
 221         MHD_destroy_response(response);
 222
 223         return 1;
 224 }
 225
 226 static const struct protodef protodefs[] = {
 227         { "x-afb-ws-json1",     afb_ws_json1_create },
 228         { NULL, NULL }
 229 };
 230
 231 int afb_websock_check_upgrade(struct afb_hreq *hreq, struct afb_apiset *apiset)
 232 {
 233         int rc;
 234
 235         /* is a get ? */
 236         if (hreq->method != afb_method_get
 237          || strcasecmp(hreq->version, MHD_HTTP_VERSION_1_1))
 238                 return 0;
 239
 240         rc = check_websocket_upgrade(hreq->connection, protodefs, hreq, apiset);
 241         if (rc == 1) {
 242                 hreq->replied = 1;
 243         }
 244         return rc;
 245 }
 246