2 * HTTP protocol for ffmpeg client
3 * Copyright (c) 2000, 2001 Fabrice Bellard
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "libavutil/avstring.h"
27 #include "os_support.h"
30 #include "libavutil/opt.h"
32 /* XXX: POST protocol is not completely implemented because ffmpeg uses
33 only a subset of it. */
35 /* used for protocol handling */
36 #define BUFFER_SIZE 1024
37 #define MAX_REDIRECTS 8
42 unsigned char buffer[BUFFER_SIZE], *buf_ptr, *buf_end;
45 int64_t chunksize; /**< Used if "Transfer-Encoding: chunked" otherwise -1. */
47 int64_t off, filesize;
48 char location[MAX_URL_SIZE];
49 HTTPAuthState auth_state;
50 HTTPAuthState proxy_auth_state;
52 int willclose; /**< Set if the server correctly handles Connection: close and will close the connection after feeding us the content. */
54 int end_chunked_post; /**< A flag which indicates if the end of chunked encoding has been sent. */
55 int end_header; /**< A flag which indicates we have finished to read POST reply. */
56 int multiple_requests; /**< A flag which indicates if we use persistent connections. */
61 #define OFFSET(x) offsetof(HTTPContext, x)
62 #define D AV_OPT_FLAG_DECODING_PARAM
63 #define E AV_OPT_FLAG_ENCODING_PARAM
64 #define DEC AV_OPT_FLAG_DECODING_PARAM
65 static const AVOption options[] = {
66 {"chunked_post", "use chunked transfer-encoding for posts", OFFSET(chunked_post), AV_OPT_TYPE_INT, {.dbl = 1}, 0, 1, E },
67 {"headers", "custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { 0 }, 0, 0, D|E },
68 {"user-agent", "override User-Agent header", OFFSET(user_agent), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, DEC},
69 {"multiple_requests", "use persistent connections", OFFSET(multiple_requests), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, D|E },
70 {"post_data", "custom HTTP post data", OFFSET(post_data), AV_OPT_TYPE_BINARY, .flags = D|E },
73 #define HTTP_CLASS(flavor)\
74 static const AVClass flavor ## _context_class = {\
75 .class_name = #flavor,\
76 .item_name = av_default_item_name,\
78 .version = LIBAVUTIL_VERSION_INT,\
84 static int http_connect(URLContext *h, const char *path, const char *local_path,
85 const char *hoststr, const char *auth,
86 const char *proxyauth, int *new_location);
88 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
90 memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
91 &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
92 memcpy(&((HTTPContext*)dest->priv_data)->proxy_auth_state,
93 &((HTTPContext*)src->priv_data)->proxy_auth_state,
94 sizeof(HTTPAuthState));
97 /* return non zero if error */
98 static int http_open_cnx(URLContext *h)
100 const char *path, *proxy_path, *lower_proto = "tcp", *local_path;
101 char hostname[1024], hoststr[1024], proto[10];
102 char auth[1024], proxyauth[1024] = "";
104 char buf[1024], urlbuf[1024];
105 int port, use_proxy, err, location_changed = 0, redirects = 0, attempts = 0;
106 HTTPAuthType cur_auth_type, cur_proxy_auth_type;
107 HTTPContext *s = h->priv_data;
109 proxy_path = getenv("http_proxy");
110 use_proxy = (proxy_path != NULL) && !getenv("no_proxy") &&
111 av_strstart(proxy_path, "http://", NULL);
113 /* fill the dest addr */
115 /* needed in any case to build the host string */
116 av_url_split(proto, sizeof(proto), auth, sizeof(auth),
117 hostname, sizeof(hostname), &port,
118 path1, sizeof(path1), s->location);
119 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
121 if (!strcmp(proto, "https")) {
130 if (path1[0] == '\0')
136 /* Reassemble the request URL without auth string - we don't
137 * want to leak the auth to the proxy. */
138 ff_url_join(urlbuf, sizeof(urlbuf), proto, NULL, hostname, port, "%s",
141 av_url_split(NULL, 0, proxyauth, sizeof(proxyauth),
142 hostname, sizeof(hostname), &port, NULL, 0, proxy_path);
145 ff_url_join(buf, sizeof(buf), lower_proto, NULL, hostname, port, NULL);
148 err = ffurl_open(&s->hd, buf, AVIO_FLAG_READ_WRITE,
149 &h->interrupt_callback, NULL);
154 cur_auth_type = s->auth_state.auth_type;
155 cur_proxy_auth_type = s->auth_state.auth_type;
156 if (http_connect(h, path, local_path, hoststr, auth, proxyauth, &location_changed) < 0)
159 if (s->http_code == 401) {
160 if ((cur_auth_type == HTTP_AUTH_NONE || s->auth_state.stale) &&
161 s->auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
162 ffurl_closep(&s->hd);
167 if (s->http_code == 407) {
168 if ((cur_proxy_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
169 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
170 ffurl_closep(&s->hd);
175 if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
176 && location_changed == 1) {
177 /* url moved, get next */
178 ffurl_closep(&s->hd);
179 if (redirects++ >= MAX_REDIRECTS)
181 /* Restart the authentication process with the new target, which
182 * might use a different auth mechanism. */
183 memset(&s->auth_state, 0, sizeof(s->auth_state));
185 location_changed = 0;
191 ffurl_closep(&s->hd);
195 int ff_http_do_new_request(URLContext *h, const char *uri)
197 HTTPContext *s = h->priv_data;
200 av_strlcpy(s->location, uri, sizeof(s->location));
202 return http_open_cnx(h);
205 static int http_open(URLContext *h, const char *uri, int flags)
207 HTTPContext *s = h->priv_data;
212 av_strlcpy(s->location, uri, sizeof(s->location));
215 int len = strlen(s->headers);
216 if (len < 2 || strcmp("\r\n", s->headers + len - 2))
217 av_log(h, AV_LOG_WARNING, "No trailing CRLF found in HTTP header.\n");
220 return http_open_cnx(h);
222 static int http_getc(HTTPContext *s)
225 if (s->buf_ptr >= s->buf_end) {
226 len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
229 } else if (len == 0) {
232 s->buf_ptr = s->buffer;
233 s->buf_end = s->buffer + len;
236 return *s->buf_ptr++;
239 static int http_get_line(HTTPContext *s, char *line, int line_size)
251 if (q > line && q[-1] == '\r')
257 if ((q - line) < line_size - 1)
263 static int process_line(URLContext *h, char *line, int line_count,
266 HTTPContext *s = h->priv_data;
270 if (line[0] == '\0') {
276 if (line_count == 0) {
277 while (!isspace(*p) && *p != '\0')
281 s->http_code = strtol(p, &end, 10);
283 av_dlog(NULL, "http_code=%d\n", s->http_code);
285 /* error codes are 4xx and 5xx, but regard 401 as a success, so we
286 * don't abort until all headers have been parsed. */
287 if (s->http_code >= 400 && s->http_code < 600 && (s->http_code != 401
288 || s->auth_state.auth_type != HTTP_AUTH_NONE) &&
289 (s->http_code != 407 || s->proxy_auth_state.auth_type != HTTP_AUTH_NONE)) {
290 end += strspn(end, SPACE_CHARS);
291 av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
296 while (*p != '\0' && *p != ':')
306 if (!av_strcasecmp(tag, "Location")) {
307 strcpy(s->location, p);
309 } else if (!av_strcasecmp (tag, "Content-Length") && s->filesize == -1) {
310 s->filesize = strtoll(p, NULL, 10);
311 } else if (!av_strcasecmp (tag, "Content-Range")) {
312 /* "bytes $from-$to/$document_size" */
314 if (!strncmp (p, "bytes ", 6)) {
316 s->off = strtoll(p, NULL, 10);
317 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
318 s->filesize = strtoll(slash+1, NULL, 10);
320 h->is_streamed = 0; /* we _can_ in fact seek */
321 } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
323 } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
326 } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
327 ff_http_auth_handle_header(&s->auth_state, tag, p);
328 } else if (!av_strcasecmp (tag, "Authentication-Info")) {
329 ff_http_auth_handle_header(&s->auth_state, tag, p);
330 } else if (!av_strcasecmp (tag, "Proxy-Authenticate")) {
331 ff_http_auth_handle_header(&s->proxy_auth_state, tag, p);
332 } else if (!av_strcasecmp (tag, "Connection")) {
333 if (!strcmp(p, "close"))
340 static inline int has_header(const char *str, const char *header)
342 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
345 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
348 static int http_read_header(URLContext *h, int *new_location)
350 HTTPContext *s = h->priv_data;
357 if ((err = http_get_line(s, line, sizeof(line))) < 0)
360 av_dlog(NULL, "header='%s'\n", line);
362 err = process_line(h, line, s->line_count, new_location);
373 static int http_connect(URLContext *h, const char *path, const char *local_path,
374 const char *hoststr, const char *auth,
375 const char *proxyauth, int *new_location)
377 HTTPContext *s = h->priv_data;
379 char headers[1024] = "";
380 char *authstr = NULL, *proxyauthstr = NULL;
381 int64_t off = s->off;
386 /* send http header */
387 post = h->flags & AVIO_FLAG_WRITE;
390 /* force POST method and disable chunked encoding when
391 * custom HTTP post data is set */
396 method = post ? "POST" : "GET";
397 authstr = ff_http_auth_create_response(&s->auth_state, auth, local_path,
399 proxyauthstr = ff_http_auth_create_response(&s->proxy_auth_state, proxyauth,
402 /* set default headers if needed */
403 if (!has_header(s->headers, "\r\nUser-Agent: "))
404 len += av_strlcatf(headers + len, sizeof(headers) - len,
405 "User-Agent: %s\r\n",
406 s->user_agent ? s->user_agent : LIBAVFORMAT_IDENT);
407 if (!has_header(s->headers, "\r\nAccept: "))
408 len += av_strlcpy(headers + len, "Accept: */*\r\n",
409 sizeof(headers) - len);
410 if (!has_header(s->headers, "\r\nRange: ") && !post)
411 len += av_strlcatf(headers + len, sizeof(headers) - len,
412 "Range: bytes=%"PRId64"-\r\n", s->off);
414 if (!has_header(s->headers, "\r\nConnection: ")) {
415 if (s->multiple_requests) {
416 len += av_strlcpy(headers + len, "Connection: keep-alive\r\n",
417 sizeof(headers) - len);
419 len += av_strlcpy(headers + len, "Connection: close\r\n",
420 sizeof(headers) - len);
424 if (!has_header(s->headers, "\r\nHost: "))
425 len += av_strlcatf(headers + len, sizeof(headers) - len,
426 "Host: %s\r\n", hoststr);
427 if (!has_header(s->headers, "\r\nContent-Length: ") && s->post_data)
428 len += av_strlcatf(headers + len, sizeof(headers) - len,
429 "Content-Length: %d\r\n", s->post_datalen);
431 /* now add in custom headers */
433 av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
435 snprintf(s->buffer, sizeof(s->buffer),
444 post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
446 authstr ? authstr : "",
447 proxyauthstr ? "Proxy-" : "", proxyauthstr ? proxyauthstr : "");
450 av_freep(&proxyauthstr);
451 if ((err = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
455 if ((err = ffurl_write(s->hd, s->post_data, s->post_datalen)) < 0)
458 /* init input buffer */
459 s->buf_ptr = s->buffer;
460 s->buf_end = s->buffer;
465 s->end_chunked_post = 0;
467 if (post && !s->post_data) {
468 /* Pretend that it did work. We didn't read any header yet, since
469 * we've still to send the POST data, but the code calling this
470 * function will check http_code after we return. */
475 /* wait for header */
476 err = http_read_header(h, new_location);
480 return (off == s->off) ? 0 : -1;
484 static int http_buf_read(URLContext *h, uint8_t *buf, int size)
486 HTTPContext *s = h->priv_data;
488 /* read bytes from input buffer first */
489 len = s->buf_end - s->buf_ptr;
493 memcpy(buf, s->buf_ptr, len);
496 if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
498 len = ffurl_read(s->hd, buf, size);
502 if (s->chunksize > 0)
508 static int http_read(URLContext *h, uint8_t *buf, int size)
510 HTTPContext *s = h->priv_data;
511 int err, new_location;
516 if (s->end_chunked_post && !s->end_header) {
517 err = http_read_header(h, &new_location);
522 if (s->chunksize >= 0) {
528 if ((err = http_get_line(s, line, sizeof(line))) < 0)
530 } while (!*line); /* skip CR LF from last chunk */
532 s->chunksize = strtoll(line, NULL, 16);
534 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
541 size = FFMIN(size, s->chunksize);
543 return http_buf_read(h, buf, size);
546 /* used only when posting data */
547 static int http_write(URLContext *h, const uint8_t *buf, int size)
549 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
551 char crlf[] = "\r\n";
552 HTTPContext *s = h->priv_data;
554 if (!s->chunked_post) {
555 /* non-chunked data is sent without any special encoding */
556 return ffurl_write(s->hd, buf, size);
559 /* silently ignore zero-size data since chunk encoding that would
562 /* upload data using chunked encoding */
563 snprintf(temp, sizeof(temp), "%x\r\n", size);
565 if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
566 (ret = ffurl_write(s->hd, buf, size)) < 0 ||
567 (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
573 static int http_shutdown(URLContext *h, int flags)
576 char footer[] = "0\r\n\r\n";
577 HTTPContext *s = h->priv_data;
579 /* signal end of chunked encoding if used */
580 if ((flags & AVIO_FLAG_WRITE) && s->chunked_post) {
581 ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
582 ret = ret > 0 ? 0 : ret;
583 s->end_chunked_post = 1;
589 static int http_close(URLContext *h)
592 HTTPContext *s = h->priv_data;
594 if (!s->end_chunked_post) {
595 /* Close the write direction by sending the end of chunked encoding. */
596 ret = http_shutdown(h, h->flags);
600 ffurl_closep(&s->hd);
604 static int64_t http_seek(URLContext *h, int64_t off, int whence)
606 HTTPContext *s = h->priv_data;
607 URLContext *old_hd = s->hd;
608 int64_t old_off = s->off;
609 uint8_t old_buf[BUFFER_SIZE];
612 if (whence == AVSEEK_SIZE)
614 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
617 /* we save the old context in case the seek fails */
618 old_buf_size = s->buf_end - s->buf_ptr;
619 memcpy(old_buf, s->buf_ptr, old_buf_size);
621 if (whence == SEEK_CUR)
623 else if (whence == SEEK_END)
627 /* if it fails, continue on old connection */
628 if (http_open_cnx(h) < 0) {
629 memcpy(s->buffer, old_buf, old_buf_size);
630 s->buf_ptr = s->buffer;
631 s->buf_end = s->buffer + old_buf_size;
641 http_get_file_handle(URLContext *h)
643 HTTPContext *s = h->priv_data;
644 return ffurl_get_file_handle(s->hd);
647 #if CONFIG_HTTP_PROTOCOL
648 URLProtocol ff_http_protocol = {
650 .url_open = http_open,
651 .url_read = http_read,
652 .url_write = http_write,
653 .url_seek = http_seek,
654 .url_close = http_close,
655 .url_get_file_handle = http_get_file_handle,
656 .url_shutdown = http_shutdown,
657 .priv_data_size = sizeof(HTTPContext),
658 .priv_data_class = &http_context_class,
659 .flags = URL_PROTOCOL_FLAG_NETWORK,
662 #if CONFIG_HTTPS_PROTOCOL
663 URLProtocol ff_https_protocol = {
665 .url_open = http_open,
666 .url_read = http_read,
667 .url_write = http_write,
668 .url_seek = http_seek,
669 .url_close = http_close,
670 .url_get_file_handle = http_get_file_handle,
671 .url_shutdown = http_shutdown,
672 .priv_data_size = sizeof(HTTPContext),
673 .priv_data_class = &https_context_class,
674 .flags = URL_PROTOCOL_FLAG_NETWORK,
678 #if CONFIG_HTTPPROXY_PROTOCOL
679 static int http_proxy_close(URLContext *h)
681 HTTPContext *s = h->priv_data;
683 ffurl_closep(&s->hd);
687 static int http_proxy_open(URLContext *h, const char *uri, int flags)
689 HTTPContext *s = h->priv_data;
690 char hostname[1024], hoststr[1024];
691 char auth[1024], pathbuf[1024], *path;
693 int port, ret = 0, attempts = 0;
694 HTTPAuthType cur_auth_type;
700 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
701 pathbuf, sizeof(pathbuf), uri);
702 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
707 ff_url_join(lower_url, sizeof(lower_url), "tcp", NULL, hostname, port,
710 ret = ffurl_open(&s->hd, lower_url, AVIO_FLAG_READ_WRITE,
711 &h->interrupt_callback, NULL);
715 authstr = ff_http_auth_create_response(&s->proxy_auth_state, auth,
717 snprintf(s->buffer, sizeof(s->buffer),
718 "CONNECT %s HTTP/1.1\r\n"
720 "Connection: close\r\n"
725 authstr ? "Proxy-" : "", authstr ? authstr : "");
728 if ((ret = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
731 s->buf_ptr = s->buffer;
732 s->buf_end = s->buffer;
735 cur_auth_type = s->proxy_auth_state.auth_type;
737 /* Note: This uses buffering, potentially reading more than the
738 * HTTP header. If tunneling a protocol where the server starts
739 * the conversation, we might buffer part of that here, too.
740 * Reading that requires using the proper ffurl_read() function
741 * on this URLContext, not using the fd directly (as the tls
742 * protocol does). This shouldn't be an issue for tls though,
743 * since the client starts the conversation there, so there
744 * is no extra data that we might buffer up here.
746 ret = http_read_header(h, &new_loc);
751 if (s->http_code == 407 &&
752 (cur_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
753 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 2) {
754 ffurl_closep(&s->hd);
758 if (s->http_code < 400)
767 static int http_proxy_write(URLContext *h, const uint8_t *buf, int size)
769 HTTPContext *s = h->priv_data;
770 return ffurl_write(s->hd, buf, size);
773 URLProtocol ff_httpproxy_protocol = {
775 .url_open = http_proxy_open,
776 .url_read = http_buf_read,
777 .url_write = http_proxy_write,
778 .url_close = http_proxy_close,
779 .url_get_file_handle = http_get_file_handle,
780 .priv_data_size = sizeof(HTTPContext),
781 .flags = URL_PROTOCOL_FLAG_NETWORK,