20639e12e8c13b980577899103de155c82ea8479
[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
60         if (ws_session == NULL) {
61                 return NULL;
62         }
63
64         if (validator == NULL) {
65                 validator = null_validator;
66         }
67
68         if (ast_websocket_set_nonblock(ws_session) != 0) {
69                 ast_log(LOG_ERROR,
70                         "ARI web socket failed to set nonblock; closing: %s\n",
71                         strerror(errno));
72                 return NULL;
73         }
74
75         session = ao2_alloc(sizeof(*session), websocket_session_dtor);
76         if (!session) {
77                 return NULL;
78         }
79
80         ao2_ref(ws_session, +1);
81         session->ws_session = ws_session;
82         session->validator = validator;
83
84         ao2_ref(session, +1);
85         return session;
86 }
87
88 struct ast_json *ast_ari_websocket_session_read(
89         struct ast_ari_websocket_session *session)
90 {
91         RAII_VAR(struct ast_json *, message, NULL, ast_json_unref);
92
93         while (!message) {
94                 int res;
95                 char *payload;
96                 uint64_t payload_len;
97                 enum ast_websocket_opcode opcode;
98                 int fragmented;
99
100                 res = ast_wait_for_input(
101                         ast_websocket_fd(session->ws_session), -1);
102
103                 if (res <= 0) {
104                         ast_log(LOG_WARNING, "WebSocket poll error: %s\n",
105                                 strerror(errno));
106                         return NULL;
107                 }
108
109                 res = ast_websocket_read(session->ws_session, &payload,
110                         &payload_len, &opcode, &fragmented);
111
112                 if (res != 0) {
113                         ast_log(LOG_WARNING, "WebSocket read error: %s\n",
114                                 strerror(errno));
115                         return NULL;
116                 }
117
118                 switch (opcode) {
119                 case AST_WEBSOCKET_OPCODE_CLOSE:
120                         ast_debug(1, "WebSocket closed by peer\n");
121                         return NULL;
122                 case AST_WEBSOCKET_OPCODE_TEXT:
123                         message = ast_json_load_buf(payload, payload_len, NULL);
124                         if (message == NULL) {
125                                 ast_log(LOG_WARNING,
126                                         "WebSocket input failed to parse\n");
127                         }
128                         break;
129                 default:
130                         /* Ignore all other message types */
131                         break;
132                 }
133         }
134
135         return ast_json_ref(message);
136 }
137
138 #define VALIDATION_FAILED                               \
139         "{"                                             \
140         "  \"error\": \"InvalidMessage\","              \
141         "  \"message\": \"Message validation failed\""  \
142         "}" 
143
144 int ast_ari_websocket_session_write(struct ast_ari_websocket_session *session,
145         struct ast_json *message)
146 {
147         RAII_VAR(char *, str, NULL, ast_json_free);
148
149 #ifdef AST_DEVMODE
150         if (!session->validator(message)) {
151                 ast_log(LOG_ERROR, "Outgoing message failed validation\n");
152                 return ast_websocket_write(session->ws_session,
153                         AST_WEBSOCKET_OPCODE_TEXT, VALIDATION_FAILED,
154                         strlen(VALIDATION_FAILED));
155         }
156 #endif
157
158         str = ast_json_dump_string_format(message, ast_ari_json_format());
159
160         if (str == NULL) {
161                 ast_log(LOG_ERROR, "Failed to encode JSON object\n");
162                 return -1;
163         }
164
165         return ast_websocket_write(session->ws_session,
166                 AST_WEBSOCKET_OPCODE_TEXT, str, strlen(str));
167 }
168
169 void ari_handle_websocket(struct ast_websocket_server *ws_server,
170         struct ast_tcptls_session_instance *ser, const char *uri,
171         enum ast_http_method method, struct ast_variable *get_params,
172         struct ast_variable *headers)
173 {
174         struct ast_http_uri fake_urih = {
175                 .data = ws_server,
176         };
177         ast_websocket_uri_cb(ser, &fake_urih, uri, method, get_params,
178                 headers);
179 }