client.c 12.2 KB
Newer Older
1 2 3 4 5
/* Icecast
 *
 * This program is distributed under the GNU General Public License, version 2.
 * A copy of this license is included with this source.
 *
6
 * Copyright 2000-2004, Jack Moffitt <jack@xiph.org,
7 8 9 10
 *                      Michael Smith <msmith@xiph.org>,
 *                      oddsock <oddsock@xiph.org>,
 *                      Karl Heyes <karl@xiph.org>
 *                      and others (see AUTHORS for details).
11
 * Copyright 2011-2018, Philipp "ph3-der-loewe" Schafft <lion@lion.leolix.org>,
12 13
 */

Jack Moffitt's avatar
Jack Moffitt committed
14
/* client.c
15 16 17 18
 **
 ** client interface implementation
 **
 */
Jack Moffitt's avatar
Jack Moffitt committed
19

20 21 22 23
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

Jack Moffitt's avatar
Jack Moffitt committed
24 25 26
#include <stdlib.h>
#include <string.h>

Marvin Scholz's avatar
Marvin Scholz committed
27 28 29
#include "common/thread/thread.h"
#include "common/avl/avl.h"
#include "common/httpp/httpp.h"
Jack Moffitt's avatar
Jack Moffitt committed
30

31
#include "global.h"
32
#include "refobject.h"
33
#include "cfgfile.h"
Jack Moffitt's avatar
Jack Moffitt committed
34 35
#include "connection.h"
#include "refbuf.h"
Karl Heyes's avatar
Karl Heyes committed
36
#include "format.h"
37
#include "stats.h"
38
#include "fserve.h"
39
#include "errors.h"
Jack Moffitt's avatar
Jack Moffitt committed
40 41

#include "client.h"
Philipp Schafft's avatar
Philipp Schafft committed
42
#include "auth.h"
Jack Moffitt's avatar
Jack Moffitt committed
43
#include "logging.h"
44

45
#include "util.h"
46
#include "acl.h"
47

Philipp Schafft's avatar
Philipp Schafft committed
48 49 50
/* for ADMIN_COMMAND_ERROR */
#include "admin.h"

51 52 53
#ifdef _WIN32
#define snprintf _snprintf
#endif
Jack Moffitt's avatar
Jack Moffitt committed
54

55 56 57
#undef CATMODULE
#define CATMODULE "client"

58 59
static inline void client_send_500(client_t *client, const char *message);

60 61 62 63 64
/* create a client_t with the provided connection and parser details. Return
 * 0 on success, -1 if server limit has been reached.  In either case a
 * client_t is returned just in case a message needs to be returned. Should
 * be called with global lock held.
 */
65
int client_create(client_t **c_ptr, connection_t *con, http_parser_t *parser)
Jack Moffitt's avatar
Jack Moffitt committed
66
{
Marvin Scholz's avatar
Marvin Scholz committed
67 68 69
    ice_config_t    *config;
    client_t        *client = (client_t *) calloc(1, sizeof(client_t));
    int              ret    = -1;
70 71

    if (client == NULL)
72
        abort();
73

74
    config = config_get_config();
75 76

    global.clients++;
Marvin Scholz's avatar
Marvin Scholz committed
77
    if (config->client_limit < global.clients) {
78
        ICECAST_LOG_WARN("server client limit reached (%d/%d)", config->client_limit, global.clients);
Marvin Scholz's avatar
Marvin Scholz committed
79
    } else {
80
        ret = 0;
Marvin Scholz's avatar
Marvin Scholz committed
81
    }
Jack Moffitt's avatar
Jack Moffitt committed
82

83 84 85
    config_release_config ();

    stats_event_args (NULL, "clients", "%d", global.clients);
86 87
    client->con = con;
    client->parser = parser;
Philipp Schafft's avatar
Philipp Schafft committed
88 89
    client->protocol = ICECAST_PROTOCOL_HTTP;
    client->admin_command = ADMIN_COMMAND_ERROR;
90 91
    client->refbuf = refbuf_new (PER_CLIENT_REFBUF_SIZE);
    client->refbuf->len = 0; /* force reader code to ignore buffer contents */
92
    client->pos = 0;
93
    client->write_to_client = format_generic_write_to_client;
94
    *c_ptr = client;
Jack Moffitt's avatar
Jack Moffitt committed
95

96
    return ret;
Jack Moffitt's avatar
Jack Moffitt committed
97 98
}

99 100 101 102 103 104 105 106 107 108 109
static inline void client_reuseconnection(client_t *client) {
    connection_t *con;
    reuse_t reuse;

    if (!client)
        return;

    con = client->con;
    con = connection_create(con->sock, con->serversock, strdup(con->ip));
    reuse = client->reuse;
    client->con->sock = -1; /* TODO: do not use magic */
110 111

    /* handle to keep the TLS connection */
112
    if (client->con->tls) {
113
        /* AHhhggrr.. That pain....
114
         * stealing TLS state...
115
         */
116
        con->tls  = client->con->tls;
117 118
        con->read = client->con->read;
        con->send = client->con->send;
119
        client->con->tls  = NULL;
120 121 122 123
        client->con->read = NULL;
        client->con->send = NULL;
    }

124 125 126 127
    client->reuse = ICECAST_REUSE_CLOSE;

    client_destroy(client);

128
    if (reuse == ICECAST_REUSE_UPGRADETLS)
129
        connection_uses_tls(con);
130 131 132
    connection_queue(con);
}

Jack Moffitt's avatar
Jack Moffitt committed
133 134
void client_destroy(client_t *client)
{
Philipp Schafft's avatar
Philipp Schafft committed
135
    ICECAST_LOG_DEBUG("Called to destory client %p", client);
Karl Heyes's avatar
Karl Heyes committed
136 137
    if (client == NULL)
        return;
138

139 140 141 142 143
    if (client->reuse != ICECAST_REUSE_CLOSE) {
        client_reuseconnection(client);
        return;
    }

144 145
    /* release the buffer now, as the buffer could be on the source queue
     * and may of disappeared after auth completes */
Marvin Scholz's avatar
Marvin Scholz committed
146
    if (client->refbuf) {
147 148 149 150
        refbuf_release (client->refbuf);
        client->refbuf = NULL;
    }

Philipp Schafft's avatar
Philipp Schafft committed
151
    if (auth_release_client(client))
152 153
        return;

154
    /* write log entry if ip is set (some things don't set it, like outgoing
155 156
     * slave requests
     */
Karl Heyes's avatar
Karl Heyes committed
157
    if (client->respcode && client->parser)
158
        logging_access(client);
159 160
    if (client->con)
        connection_close(client->con);
Karl Heyes's avatar
Karl Heyes committed
161 162
    if (client->parser)
        httpp_destroy(client->parser);
163 164
    if (client->encoding)
        httpp_encoding_release(client->encoding);
Jack Moffitt's avatar
Jack Moffitt committed
165

166
    global_lock();
167
    global.clients--;
168 169
    stats_event_args(NULL, "clients", "%d", global.clients);
    global_unlock();
170

171 172
    /* we need to free client specific format data (if any) */
    if (client->free_client_data)
173
        client->free_client_data(client);
174

175 176
    refobject_unref(client->handler_module);
    free(client->handler_function);
Michael Smith's avatar
Michael Smith committed
177
    free(client->username);
Karl Heyes's avatar
Karl Heyes committed
178
    free(client->password);
Philipp Schafft's avatar
Philipp Schafft committed
179 180
    free(client->role);
    acl_release(client->acl);
Michael Smith's avatar
Michael Smith committed
181

182
    free(client);
Jack Moffitt's avatar
Jack Moffitt committed
183
}
184

185
/* helper function for reading data from a client */
186 187 188 189 190 191 192 193 194 195 196 197 198 199
static ssize_t __client_read_bytes_real(client_t *client, void *buf, size_t len)
{
    /* we have data to read from a refbuf first */
    if (client->refbuf->len < len)
        len = client->refbuf->len;
    memcpy (buf, client->refbuf->data, len);
    if (len < client->refbuf->len) {
        char *ptr = client->refbuf->data;
        memmove (ptr, ptr+len, client->refbuf->len - len);
    }
    client->refbuf->len -= len;
    return len;
}

200
int client_read_bytes(client_t *client, void *buf, unsigned len)
201
{
202 203
    ssize_t (*reader)(void*, void*, size_t) = (ssize_t(*)(void*,void*,size_t))__client_read_bytes_real;
    void *userdata = client;
204
    int bytes;
205

206 207 208 209 210 211 212 213 214
    if (!(client->refbuf && client->refbuf->len)) {
        reader = (ssize_t(*)(void*,void*,size_t))connection_read_bytes;
        userdata = client->con;
    }

    if (client->encoding) {
        bytes = httpp_encoding_read(client->encoding, buf, len, reader, userdata);
    } else {
        bytes = reader(userdata, buf, len);
215
    }
216

217
    if (bytes == -1 && client->con->error)
218
        ICECAST_LOG_DEBUG("reading from connection has failed");
219 220

    return bytes;
221 222
}

223
static inline void _client_send_error(client_t *client, int plain, const icecast_error_t *error)
224
{
225
    ssize_t ret;
226
    refbuf_t *data;
227

228 229
    if (error->http_status == 500) {
         client_send_500(client, error->message);
230 231 232
         return;
    }

233 234
    data = refbuf_new(PER_CLIENT_REFBUF_SIZE);
    if (!data) {
235
         client_send_500(client, error->message);
236 237 238
         return;
    }

239 240
    client->reuse = ICECAST_REUSE_KEEPALIVE;

241
    ret = util_http_build_header(client->refbuf->data, PER_CLIENT_REFBUF_SIZE, 0,
242
                                 0, error->http_status, NULL,
243
                                 plain ? "text/plain" : "text/html", "utf-8",
244
                                 NULL, NULL, client);
245

246 247 248 249 250 251
    if (ret == -1 || ret >= PER_CLIENT_REFBUF_SIZE) {
        ICECAST_LOG_ERROR("Dropping client as we can not build response headers.");
        client_send_500(client, "Header generation failed.");
        return;
    }

252
    if (plain) {
253 254 255
        snprintf(data->data, data->len, "Error %i\r\n---------\r\n\r\nMessage: %s\r\n\r\nError code: %s\r\n",
                 error->http_status, error->message, error->uuid
                );
256 257
    } else {
        snprintf(data->data, data->len,
258 259
                 "<html><head><title>Error %i</title></head><body><h1>Error %i</h1><hr><p><b>%s</b></p><p>Error code: %s</p></body></html>\r\n",
                 error->http_status, error->http_status, error->message, error->uuid);
260 261 262 263
    }
    data->len = strlen(data->data);

    snprintf(client->refbuf->data + ret, PER_CLIENT_REFBUF_SIZE - ret,
264
             "Content-Length: %llu\r\n\r\n",
265
             (long long unsigned int)data->len);
266

267
    client->respcode = error->http_status;
268
    client->refbuf->len = strlen (client->refbuf->data);
269 270
    client->refbuf->next = data;

271
    fserve_add_client (client, NULL);
272 273
}

274
void client_send_error_by_id(client_t *client, icecast_error_id_t id)
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
{
    const icecast_error_t *error = error_get_by_id(id);
    const char *pref;
    int plain;

    if (!error) {
         client_send_500(client, "Unknown error ID");
         return;
    }

    pref = util_http_select_best(httpp_getvar(client->parser, "accept"), "text/plain", "text/html", (const char*)NULL);

    if (strcmp(pref, "text/plain") == 0) {
        plain = 1;
    } else if (strcmp(pref, "text/html") == 0) {
        plain = 0;
    } else {
        plain = 1;
    }

295
    _client_send_error(client, plain, error);
296 297
}

298 299 300 301 302 303 304 305 306 307 308 309
void client_send_101(client_t *client, reuse_t reuse)
{
    ssize_t ret;

    if (!client)
        return;

    if (reuse != ICECAST_REUSE_UPGRADETLS) {
        client_send_500(client, "Bad reuse parameter");
        return;
    }

310 311
    client->reuse = reuse;

312 313 314 315 316 317
    ret = util_http_build_header(client->refbuf->data, PER_CLIENT_REFBUF_SIZE, 0,
                                 0, 101, NULL,
                                 "text/plain", "utf-8",
                                 NULL, NULL, client);

    snprintf(client->refbuf->data + ret, PER_CLIENT_REFBUF_SIZE - ret,
318
             "Content-Length: 0\r\nUpgrade: TLS/1.0, HTTP/1.0\r\n\r\n");
319 320 321 322 323 324 325

    client->respcode = 101;
    client->refbuf->len = strlen(client->refbuf->data);

    fserve_add_client(client, NULL);
}

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
void client_send_204(client_t *client)
{
    ssize_t ret;

    if (!client)
        return;

    client->reuse = ICECAST_REUSE_KEEPALIVE;

    ret = util_http_build_header(client->refbuf->data, PER_CLIENT_REFBUF_SIZE, 0,
                                 0, 204, NULL,
                                 NULL, NULL,
                                 NULL, NULL, client);

    snprintf(client->refbuf->data + ret, PER_CLIENT_REFBUF_SIZE - ret,
             "Content-Length: 0\r\n\r\n");

    client->respcode = 204;
    client->refbuf->len = strlen(client->refbuf->data);

    fserve_add_client(client, NULL);
}

349 350 351 352 353 354 355 356 357 358 359 360
void client_send_426(client_t *client, reuse_t reuse)
{
    ssize_t ret;

    if (!client)
        return;

    if (reuse != ICECAST_REUSE_UPGRADETLS) {
        client_send_500(client, "Bad reuse parameter");
        return;
    }

361 362
    client->reuse = reuse;

363 364 365 366 367 368
    ret = util_http_build_header(client->refbuf->data, PER_CLIENT_REFBUF_SIZE, 0,
                                 0, 426, NULL,
                                 "text/plain", "utf-8",
                                 NULL, NULL, client);

    snprintf(client->refbuf->data + ret, PER_CLIENT_REFBUF_SIZE - ret,
369
             "Content-Length: 0\r\nUpgrade: TLS/1.0, HTTP/1.0\r\n\r\n");
370 371 372 373 374 375 376 377 378

    client->respcode = 426;
    client->refbuf->len = strlen(client->refbuf->data);

    client->reuse = ICECAST_REUSE_KEEPALIVE;

    fserve_add_client(client, NULL);
}

379
/* this function is designed to work even if client is in bad state */
Marvin Scholz's avatar
Marvin Scholz committed
380 381
static inline void client_send_500(client_t *client, const char *message)
{
382 383
    const char header[] = "HTTP/1.0 500 Internal Server Error\r\nContent-Type: text/plain; charset=utf-8\r\n\r\n"
                          "500 - Internal Server Error\n---------------------------\n";
Philipp Schafft's avatar
Philipp Schafft committed
384 385
    const ssize_t header_len = sizeof(header) - 1;
    ssize_t ret;
386 387 388 389 390 391 392 393 394

    ret = client_send_bytes(client, header, header_len);

    /* only send message if we have one AND if header could have transmitted completly */
    if (message && ret == header_len)
        client_send_bytes(client, message, strlen(message));

    client_destroy(client);
}
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
admin_format_t client_get_admin_format_by_content_negotiation(client_t *client)
{
    const char *pref;

    if (!client || !client->parser)
        return CLIENT_DEFAULT_ADMIN_FORMAT;

    pref = util_http_select_best(httpp_getvar(client->parser, "accept"), "text/xml", "text/html", "text/plain", (const char*)NULL);

    if (strcmp(pref, "text/xml") == 0) {
        return ADMIN_FORMAT_RAW;
    } else if (strcmp(pref, "text/html") == 0) {
        return ADMIN_FORMAT_TRANSFORMED;
    } else if (strcmp(pref, "text/plain") == 0) {
        return ADMIN_FORMAT_PLAINTEXT;
    } else {
        return CLIENT_DEFAULT_ADMIN_FORMAT;
    }
}

416
/* helper function for sending the data to a client */
417
int client_send_bytes(client_t *client, const void *buf, unsigned len)
418
{
419
    int ret = client->con->send(client->con, buf, len);
420 421

    if (client->con->error)
422
        ICECAST_LOG_DEBUG("Client connection died");
423

424 425 426
    return ret;
}

427
void client_set_queue(client_t *client, refbuf_t *refbuf)
Karl Heyes's avatar
Karl Heyes committed
428 429 430 431
{
    refbuf_t *to_release = client->refbuf;

    client->refbuf = refbuf;
Karl Heyes's avatar
Karl Heyes committed
432
    if (refbuf)
433
        refbuf_addref(client->refbuf);
Karl Heyes's avatar
Karl Heyes committed
434 435
    client->pos = 0;
    if (to_release)
436
        refbuf_release(to_release);
Karl Heyes's avatar
Karl Heyes committed
437
}