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 4096
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. */
62 #define OFFSET(x) offsetof(HTTPContext, x)
63 #define D AV_OPT_FLAG_DECODING_PARAM
64 #define E AV_OPT_FLAG_ENCODING_PARAM
65 #define DEC AV_OPT_FLAG_DECODING_PARAM
66 static const AVOption options[] = {
67 {"chunked_post", "use chunked transfer-encoding for posts", OFFSET(chunked_post), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, E },
68 {"headers", "custom HTTP headers, can override built in default headers", OFFSET(headers), AV_OPT_TYPE_STRING, { 0 }, 0, 0, D|E },
69 {"user-agent", "override User-Agent header", OFFSET(user_agent), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, DEC},
70 {"multiple_requests", "use persistent connections", OFFSET(multiple_requests), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E },
71 {"post_data", "custom HTTP post data", OFFSET(post_data), AV_OPT_TYPE_BINARY, .flags = D|E },
74 #define HTTP_CLASS(flavor)\
75 static const AVClass flavor ## _context_class = {\
76 .class_name = #flavor,\
77 .item_name = av_default_item_name,\
79 .version = LIBAVUTIL_VERSION_INT,\
85 static int http_connect(URLContext *h, const char *path, const char *local_path,
86 const char *hoststr, const char *auth,
87 const char *proxyauth, int *new_location);
89 void ff_http_init_auth_state(URLContext *dest, const URLContext *src)
91 memcpy(&((HTTPContext*)dest->priv_data)->auth_state,
92 &((HTTPContext*)src->priv_data)->auth_state, sizeof(HTTPAuthState));
93 memcpy(&((HTTPContext*)dest->priv_data)->proxy_auth_state,
94 &((HTTPContext*)src->priv_data)->proxy_auth_state,
95 sizeof(HTTPAuthState));
98 /* return non zero if error */
99 static int http_open_cnx(URLContext *h)
101 const char *path, *proxy_path, *lower_proto = "tcp", *local_path;
102 char hostname[1024], hoststr[1024], proto[10];
103 char auth[1024], proxyauth[1024] = "";
105 char buf[1024], urlbuf[1024];
106 int port, use_proxy, err, location_changed = 0, redirects = 0, attempts = 0;
107 HTTPAuthType cur_auth_type, cur_proxy_auth_type;
108 HTTPContext *s = h->priv_data;
110 proxy_path = getenv("http_proxy");
111 use_proxy = (proxy_path != NULL) && !getenv("no_proxy") &&
112 av_strstart(proxy_path, "http://", NULL);
114 /* fill the dest addr */
116 /* needed in any case to build the host string */
117 av_url_split(proto, sizeof(proto), auth, sizeof(auth),
118 hostname, sizeof(hostname), &port,
119 path1, sizeof(path1), s->location);
120 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
122 if (!strcmp(proto, "https")) {
131 if (path1[0] == '\0')
137 /* Reassemble the request URL without auth string - we don't
138 * want to leak the auth to the proxy. */
139 ff_url_join(urlbuf, sizeof(urlbuf), proto, NULL, hostname, port, "%s",
142 av_url_split(NULL, 0, proxyauth, sizeof(proxyauth),
143 hostname, sizeof(hostname), &port, NULL, 0, proxy_path);
146 ff_url_join(buf, sizeof(buf), lower_proto, NULL, hostname, port, NULL);
149 err = ffurl_open(&s->hd, buf, AVIO_FLAG_READ_WRITE,
150 &h->interrupt_callback, NULL);
155 cur_auth_type = s->auth_state.auth_type;
156 cur_proxy_auth_type = s->auth_state.auth_type;
157 if (http_connect(h, path, local_path, hoststr, auth, proxyauth, &location_changed) < 0)
160 if (s->http_code == 401) {
161 if ((cur_auth_type == HTTP_AUTH_NONE || s->auth_state.stale) &&
162 s->auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
163 ffurl_closep(&s->hd);
168 if (s->http_code == 407) {
169 if ((cur_proxy_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
170 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 4) {
171 ffurl_closep(&s->hd);
176 if ((s->http_code == 301 || s->http_code == 302 || s->http_code == 303 || s->http_code == 307)
177 && location_changed == 1) {
178 /* url moved, get next */
179 ffurl_closep(&s->hd);
180 if (redirects++ >= MAX_REDIRECTS)
182 /* Restart the authentication process with the new target, which
183 * might use a different auth mechanism. */
184 memset(&s->auth_state, 0, sizeof(s->auth_state));
186 location_changed = 0;
192 ffurl_closep(&s->hd);
196 int ff_http_do_new_request(URLContext *h, const char *uri)
198 HTTPContext *s = h->priv_data;
201 av_strlcpy(s->location, uri, sizeof(s->location));
203 return http_open_cnx(h);
206 static int http_open(URLContext *h, const char *uri, int flags)
208 HTTPContext *s = h->priv_data;
213 av_strlcpy(s->location, uri, sizeof(s->location));
216 int len = strlen(s->headers);
217 if (len < 2 || strcmp("\r\n", s->headers + len - 2))
218 av_log(h, AV_LOG_WARNING, "No trailing CRLF found in HTTP header.\n");
221 return http_open_cnx(h);
223 static int http_getc(HTTPContext *s)
226 if (s->buf_ptr >= s->buf_end) {
227 len = ffurl_read(s->hd, s->buffer, BUFFER_SIZE);
230 } else if (len == 0) {
233 s->buf_ptr = s->buffer;
234 s->buf_end = s->buffer + len;
237 return *s->buf_ptr++;
240 static int http_get_line(HTTPContext *s, char *line, int line_size)
252 if (q > line && q[-1] == '\r')
258 if ((q - line) < line_size - 1)
264 static int process_line(URLContext *h, char *line, int line_count,
267 HTTPContext *s = h->priv_data;
271 if (line[0] == '\0') {
277 if (line_count == 0) {
278 while (!isspace(*p) && *p != '\0')
282 s->http_code = strtol(p, &end, 10);
284 av_dlog(NULL, "http_code=%d\n", s->http_code);
286 /* error codes are 4xx and 5xx, but regard 401 as a success, so we
287 * don't abort until all headers have been parsed. */
288 if (s->http_code >= 400 && s->http_code < 600 && (s->http_code != 401
289 || s->auth_state.auth_type != HTTP_AUTH_NONE) &&
290 (s->http_code != 407 || s->proxy_auth_state.auth_type != HTTP_AUTH_NONE)) {
291 end += strspn(end, SPACE_CHARS);
292 av_log(h, AV_LOG_WARNING, "HTTP error %d %s\n",
297 while (*p != '\0' && *p != ':')
307 if (!av_strcasecmp(tag, "Location")) {
308 strcpy(s->location, p);
310 } else if (!av_strcasecmp (tag, "Content-Length") && s->filesize == -1) {
311 s->filesize = strtoll(p, NULL, 10);
312 } else if (!av_strcasecmp (tag, "Content-Range")) {
313 /* "bytes $from-$to/$document_size" */
315 if (!strncmp (p, "bytes ", 6)) {
317 s->off = strtoll(p, NULL, 10);
318 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
319 s->filesize = strtoll(slash+1, NULL, 10);
321 if (!s->is_akamai || s->filesize != 2147483647)
322 h->is_streamed = 0; /* we _can_ in fact seek */
323 } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
325 } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
328 } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
329 ff_http_auth_handle_header(&s->auth_state, tag, p);
330 } else if (!av_strcasecmp (tag, "Authentication-Info")) {
331 ff_http_auth_handle_header(&s->auth_state, tag, p);
332 } else if (!av_strcasecmp (tag, "Proxy-Authenticate")) {
333 ff_http_auth_handle_header(&s->proxy_auth_state, tag, p);
334 } else if (!av_strcasecmp (tag, "Connection")) {
335 if (!strcmp(p, "close"))
337 } else if (!av_strcasecmp (tag, "Server") && !av_strcasecmp (p, "AkamaiGHost")) {
344 static inline int has_header(const char *str, const char *header)
346 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
349 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
352 static int http_read_header(URLContext *h, int *new_location)
354 HTTPContext *s = h->priv_data;
361 if ((err = http_get_line(s, line, sizeof(line))) < 0)
364 av_dlog(NULL, "header='%s'\n", line);
366 err = process_line(h, line, s->line_count, new_location);
377 static int http_connect(URLContext *h, const char *path, const char *local_path,
378 const char *hoststr, const char *auth,
379 const char *proxyauth, int *new_location)
381 HTTPContext *s = h->priv_data;
383 char headers[4096] = "";
384 char *authstr = NULL, *proxyauthstr = NULL;
385 int64_t off = s->off;
390 /* send http header */
391 post = h->flags & AVIO_FLAG_WRITE;
394 /* force POST method and disable chunked encoding when
395 * custom HTTP post data is set */
400 method = post ? "POST" : "GET";
401 authstr = ff_http_auth_create_response(&s->auth_state, auth, local_path,
403 proxyauthstr = ff_http_auth_create_response(&s->proxy_auth_state, proxyauth,
406 /* set default headers if needed */
407 if (!has_header(s->headers, "\r\nUser-Agent: "))
408 len += av_strlcatf(headers + len, sizeof(headers) - len,
409 "User-Agent: %s\r\n",
410 s->user_agent ? s->user_agent : LIBAVFORMAT_IDENT);
411 if (!has_header(s->headers, "\r\nAccept: "))
412 len += av_strlcpy(headers + len, "Accept: */*\r\n",
413 sizeof(headers) - len);
414 if (!has_header(s->headers, "\r\nRange: ") && !post)
415 len += av_strlcatf(headers + len, sizeof(headers) - len,
416 "Range: bytes=%"PRId64"-\r\n", s->off);
418 if (!has_header(s->headers, "\r\nConnection: ")) {
419 if (s->multiple_requests) {
420 len += av_strlcpy(headers + len, "Connection: keep-alive\r\n",
421 sizeof(headers) - len);
423 len += av_strlcpy(headers + len, "Connection: close\r\n",
424 sizeof(headers) - len);
428 if (!has_header(s->headers, "\r\nHost: "))
429 len += av_strlcatf(headers + len, sizeof(headers) - len,
430 "Host: %s\r\n", hoststr);
431 if (!has_header(s->headers, "\r\nContent-Length: ") && s->post_data)
432 len += av_strlcatf(headers + len, sizeof(headers) - len,
433 "Content-Length: %d\r\n", s->post_datalen);
435 /* now add in custom headers */
437 av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
439 snprintf(s->buffer, sizeof(s->buffer),
448 post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
450 authstr ? authstr : "",
451 proxyauthstr ? "Proxy-" : "", proxyauthstr ? proxyauthstr : "");
454 av_freep(&proxyauthstr);
455 if ((err = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
459 if ((err = ffurl_write(s->hd, s->post_data, s->post_datalen)) < 0)
462 /* init input buffer */
463 s->buf_ptr = s->buffer;
464 s->buf_end = s->buffer;
469 s->end_chunked_post = 0;
471 if (post && !s->post_data) {
472 /* Pretend that it did work. We didn't read any header yet, since
473 * we've still to send the POST data, but the code calling this
474 * function will check http_code after we return. */
479 /* wait for header */
480 err = http_read_header(h, new_location);
484 return (off == s->off) ? 0 : -1;
488 static int http_buf_read(URLContext *h, uint8_t *buf, int size)
490 HTTPContext *s = h->priv_data;
492 /* read bytes from input buffer first */
493 len = s->buf_end - s->buf_ptr;
497 memcpy(buf, s->buf_ptr, len);
500 if (!s->willclose && s->filesize >= 0 && s->off >= s->filesize)
502 len = ffurl_read(s->hd, buf, size);
506 if (s->chunksize > 0)
512 static int http_read(URLContext *h, uint8_t *buf, int size)
514 HTTPContext *s = h->priv_data;
515 int err, new_location;
520 if (s->end_chunked_post && !s->end_header) {
521 err = http_read_header(h, &new_location);
526 if (s->chunksize >= 0) {
532 if ((err = http_get_line(s, line, sizeof(line))) < 0)
534 } while (!*line); /* skip CR LF from last chunk */
536 s->chunksize = strtoll(line, NULL, 16);
538 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
545 size = FFMIN(size, s->chunksize);
547 return http_buf_read(h, buf, size);
550 /* used only when posting data */
551 static int http_write(URLContext *h, const uint8_t *buf, int size)
553 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
555 char crlf[] = "\r\n";
556 HTTPContext *s = h->priv_data;
558 if (!s->chunked_post) {
559 /* non-chunked data is sent without any special encoding */
560 return ffurl_write(s->hd, buf, size);
563 /* silently ignore zero-size data since chunk encoding that would
566 /* upload data using chunked encoding */
567 snprintf(temp, sizeof(temp), "%x\r\n", size);
569 if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
570 (ret = ffurl_write(s->hd, buf, size)) < 0 ||
571 (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
577 static int http_shutdown(URLContext *h, int flags)
580 char footer[] = "0\r\n\r\n";
581 HTTPContext *s = h->priv_data;
583 /* signal end of chunked encoding if used */
584 if ((flags & AVIO_FLAG_WRITE) && s->chunked_post) {
585 ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
586 ret = ret > 0 ? 0 : ret;
587 s->end_chunked_post = 1;
593 static int http_close(URLContext *h)
596 HTTPContext *s = h->priv_data;
598 if (!s->end_chunked_post) {
599 /* Close the write direction by sending the end of chunked encoding. */
600 ret = http_shutdown(h, h->flags);
604 ffurl_closep(&s->hd);
608 static int64_t http_seek(URLContext *h, int64_t off, int whence)
610 HTTPContext *s = h->priv_data;
611 URLContext *old_hd = s->hd;
612 int64_t old_off = s->off;
613 uint8_t old_buf[BUFFER_SIZE];
616 if (whence == AVSEEK_SIZE)
618 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
621 /* we save the old context in case the seek fails */
622 old_buf_size = s->buf_end - s->buf_ptr;
623 memcpy(old_buf, s->buf_ptr, old_buf_size);
625 if (whence == SEEK_CUR)
627 else if (whence == SEEK_END)
631 /* if it fails, continue on old connection */
632 if (http_open_cnx(h) < 0) {
633 memcpy(s->buffer, old_buf, old_buf_size);
634 s->buf_ptr = s->buffer;
635 s->buf_end = s->buffer + old_buf_size;
645 http_get_file_handle(URLContext *h)
647 HTTPContext *s = h->priv_data;
648 return ffurl_get_file_handle(s->hd);
651 #if CONFIG_HTTP_PROTOCOL
652 URLProtocol ff_http_protocol = {
654 .url_open = http_open,
655 .url_read = http_read,
656 .url_write = http_write,
657 .url_seek = http_seek,
658 .url_close = http_close,
659 .url_get_file_handle = http_get_file_handle,
660 .url_shutdown = http_shutdown,
661 .priv_data_size = sizeof(HTTPContext),
662 .priv_data_class = &http_context_class,
663 .flags = URL_PROTOCOL_FLAG_NETWORK,
666 #if CONFIG_HTTPS_PROTOCOL
667 URLProtocol ff_https_protocol = {
669 .url_open = http_open,
670 .url_read = http_read,
671 .url_write = http_write,
672 .url_seek = http_seek,
673 .url_close = http_close,
674 .url_get_file_handle = http_get_file_handle,
675 .url_shutdown = http_shutdown,
676 .priv_data_size = sizeof(HTTPContext),
677 .priv_data_class = &https_context_class,
678 .flags = URL_PROTOCOL_FLAG_NETWORK,
682 #if CONFIG_HTTPPROXY_PROTOCOL
683 static int http_proxy_close(URLContext *h)
685 HTTPContext *s = h->priv_data;
687 ffurl_closep(&s->hd);
691 static int http_proxy_open(URLContext *h, const char *uri, int flags)
693 HTTPContext *s = h->priv_data;
694 char hostname[1024], hoststr[1024];
695 char auth[1024], pathbuf[1024], *path;
697 int port, ret = 0, attempts = 0;
698 HTTPAuthType cur_auth_type;
704 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
705 pathbuf, sizeof(pathbuf), uri);
706 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
711 ff_url_join(lower_url, sizeof(lower_url), "tcp", NULL, hostname, port,
714 ret = ffurl_open(&s->hd, lower_url, AVIO_FLAG_READ_WRITE,
715 &h->interrupt_callback, NULL);
719 authstr = ff_http_auth_create_response(&s->proxy_auth_state, auth,
721 snprintf(s->buffer, sizeof(s->buffer),
722 "CONNECT %s HTTP/1.1\r\n"
724 "Connection: close\r\n"
729 authstr ? "Proxy-" : "", authstr ? authstr : "");
732 if ((ret = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
735 s->buf_ptr = s->buffer;
736 s->buf_end = s->buffer;
739 cur_auth_type = s->proxy_auth_state.auth_type;
741 /* Note: This uses buffering, potentially reading more than the
742 * HTTP header. If tunneling a protocol where the server starts
743 * the conversation, we might buffer part of that here, too.
744 * Reading that requires using the proper ffurl_read() function
745 * on this URLContext, not using the fd directly (as the tls
746 * protocol does). This shouldn't be an issue for tls though,
747 * since the client starts the conversation there, so there
748 * is no extra data that we might buffer up here.
750 ret = http_read_header(h, &new_loc);
755 if (s->http_code == 407 &&
756 (cur_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
757 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 2) {
758 ffurl_closep(&s->hd);
762 if (s->http_code < 400)
771 static int http_proxy_write(URLContext *h, const uint8_t *buf, int size)
773 HTTPContext *s = h->priv_data;
774 return ffurl_write(s->hd, buf, size);
777 URLProtocol ff_httpproxy_protocol = {
779 .url_open = http_proxy_open,
780 .url_read = http_buf_read,
781 .url_write = http_proxy_write,
782 .url_close = http_proxy_close,
783 .url_get_file_handle = http_get_file_handle,
784 .priv_data_size = sizeof(HTTPContext),
785 .flags = URL_PROTOCOL_FLAG_NETWORK,