ff0a53c4fc7b11e4354a33aa381b2a7b73ecef27
[asterisk/asterisk.git] / res / ari / ari_websockets.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #include "asterisk.h"
20
21 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
22
23 #include "asterisk/ari.h"
24 #include "asterisk/astobj2.h"
25 #include "asterisk/http_websocket.h"
26 #include "internal.h"
27
28 /*! \file
29  *
30  * \brief WebSocket support for RESTful API's.
31  * \author David M. Lee, II <dlee@digium.com>
32  */
33
34 struct ast_ari_websocket_session {
35         struct ast_websocket *ws_session;
36         int (*validator)(struct ast_json *);
37 };
38
39 static void websocket_session_dtor(void *obj)
40 {
41         struct ast_ari_websocket_session *session = obj;
42
43         ast_websocket_unref(session->ws_session);
44         session->ws_session = NULL;
45 }
46
47 /*!
48  * \brief Validator that always succeeds.
49  */
50 static int null_validator(struct ast_json *json)
51 {
52         return 1;
53 }
54
55 struct ast_ari_websocket_session *ast_ari_websocket_session_create(
56         struct ast_websocket *ws_session, int (*validator)(struct ast_json *))
57 {
58         RAII_VAR(struct ast_ari_websocket_session *, session, NULL, ao2_cleanup);
59         RAII_VAR(struct ast_ari_conf *, config, ast_ari_config_get(), ao2_cleanup);
60
61         if (ws_session == NULL) {
62                 return NULL;
63         }
64
65         if (config == NULL || config->general == NULL) {
66                 return NULL;
67         }
68
69         if (validator == NULL) {
70                 validator = null_validator;
71         }
72
73         if (ast_websocket_set_nonblock(ws_session) != 0) {
74                 ast_log(LOG_ERROR,
75                         "ARI web socket failed to set nonblock; closing: %s\n",
76                         strerror(errno));
77                 return NULL;
78         }
79
80         if (ast_websocket_set_timeout(ws_session, config->general->write_timeout)) {
81                 ast_log(LOG_WARNING, "Failed to set write timeout %d on ARI web socket\n",
82                         config->general->write_timeout);
83         }
84
85         session = ao2_alloc(sizeof(*session), websocket_session_dtor);
86         if (!session) {
87                 return NULL;
88         }
89
90         ao2_ref(ws_session, +1);
91         session->ws_session = ws_session;
92         session->validator = validator;
93
94         ao2_ref(session, +1);
95         return session;
96 }
97
98 struct ast_json *ast_ari_websocket_session_read(
99         struct ast_ari_websocket_session *session)
100 {
101         RAII_VAR(struct ast_json *, message, NULL, ast_json_unref);
102
103         while (!message) {
104                 int res;
105                 char *payload;
106                 uint64_t payload_len;
107                 enum ast_websocket_opcode opcode;
108                 int fragmented;
109
110                 res = ast_wait_for_input(
111                         ast_websocket_fd(session->ws_session), -1);
112
113                 if (res <= 0) {
114                         ast_log(LOG_WARNING, "WebSocket poll error: %s\n",
115                                 strerror(errno));
116                         return NULL;
117                 }
118
119                 res = ast_websocket_read(session->ws_session, &payload,
120                         &payload_len, &opcode, &fragmented);
121
122                 if (res != 0) {
123                         ast_log(LOG_WARNING, "WebSocket read error: %s\n",
124                                 strerror(errno));
125                         return NULL;
126                 }
127
128                 switch (opcode) {
129                 case AST_WEBSOCKET_OPCODE_CLOSE:
130                         ast_debug(1, "WebSocket closed by peer\n");
131                         return NULL;
132                 case AST_WEBSOCKET_OPCODE_TEXT:
133                         message = ast_json_load_buf(payload, payload_len, NULL);
134                         if (message == NULL) {
135                                 ast_log(LOG_WARNING,
136                                         "WebSocket input failed to parse\n");
137                         }
138                         break;
139                 default:
140                         /* Ignore all other message types */
141                         break;
142                 }
143         }
144
145         return ast_json_ref(message);
146 }
147
148 #define VALIDATION_FAILED                               \
149         "{"                                             \
150         "  \"error\": \"InvalidMessage\","              \
151         "  \"message\": \"Message validation failed\""  \
152         "}" 
153
154 int ast_ari_websocket_session_write(struct ast_ari_websocket_session *session,
155         struct ast_json *message)
156 {
157         RAII_VAR(char *, str, NULL, ast_json_free);
158
159 #ifdef AST_DEVMODE
160         if (!session->validator(message)) {
161                 ast_log(LOG_ERROR, "Outgoing message failed validation\n");
162                 return ast_websocket_write(session->ws_session,
163                         AST_WEBSOCKET_OPCODE_TEXT, VALIDATION_FAILED,
164                         strlen(VALIDATION_FAILED));
165         }
166 #endif
167
168         str = ast_json_dump_string_format(message, ast_ari_json_format());
169
170         if (str == NULL) {
171                 ast_log(LOG_ERROR, "Failed to encode JSON object\n");
172                 return -1;
173         }
174
175         ast_debug(3, "Examining ARI event: \n%s\n", str);
176         return ast_websocket_write(session->ws_session,
177                 AST_WEBSOCKET_OPCODE_TEXT, str, strlen(str));
178 }
179
180 void ari_handle_websocket(struct ast_websocket_server *ws_server,
181         struct ast_tcptls_session_instance *ser, const char *uri,
182         enum ast_http_method method, struct ast_variable *get_params,
183         struct ast_variable *headers)
184 {
185         struct ast_http_uri fake_urih = {
186                 .data = ws_server,
187         };
188         ast_websocket_uri_cb(ser, &fake_urih, uri, method, get_params,
189                 headers);
190 }