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"
28 #include "os_support.h"
31 #include "libavutil/opt.h"
33 /* XXX: POST protocol is not completely implemented because ffmpeg uses
34 only a subset of it. */
36 /* used for protocol handling */
37 #define BUFFER_SIZE 1024
38 #define MAX_REDIRECTS 8
43 unsigned char buffer[BUFFER_SIZE], *buf_ptr, *buf_end;
46 int64_t chunksize; /**< Used if "Transfer-Encoding: chunked" otherwise -1. */
48 int64_t off, filesize;
49 char location[MAX_URL_SIZE];
50 HTTPAuthState auth_state;
51 HTTPAuthState proxy_auth_state;
53 int willclose; /**< Set if the server correctly handles Connection: close and will close the connection after feeding us the content. */
55 int end_chunked_post; /**< A flag which indicates if the end of chunked encoding has been sent. */
56 int end_header; /**< A flag which indicates we have finished to read POST reply. */
57 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, {.dbl = 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, {.dbl = 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 = atoll(p);
312 } else if (!av_strcasecmp (tag, "Content-Range")) {
313 /* "bytes $from-$to/$document_size" */
315 if (!strncmp (p, "bytes ", 6)) {
318 if ((slash = strchr(p, '/')) && strlen(slash) > 0)
319 s->filesize = atoll(slash+1);
321 h->is_streamed = 0; /* we _can_ in fact seek */
322 } else if (!av_strcasecmp(tag, "Accept-Ranges") && !strncmp(p, "bytes", 5)) {
324 } else if (!av_strcasecmp (tag, "Transfer-Encoding") && !av_strncasecmp(p, "chunked", 7)) {
327 } else if (!av_strcasecmp (tag, "WWW-Authenticate")) {
328 ff_http_auth_handle_header(&s->auth_state, tag, p);
329 } else if (!av_strcasecmp (tag, "Authentication-Info")) {
330 ff_http_auth_handle_header(&s->auth_state, tag, p);
331 } else if (!av_strcasecmp (tag, "Proxy-Authenticate")) {
332 ff_http_auth_handle_header(&s->proxy_auth_state, tag, p);
333 } else if (!av_strcasecmp (tag, "Connection")) {
334 if (!strcmp(p, "close"))
341 static inline int has_header(const char *str, const char *header)
343 /* header + 2 to skip over CRLF prefix. (make sure you have one!) */
346 return av_stristart(str, header + 2, NULL) || av_stristr(str, header);
349 static int http_read_header(URLContext *h, int *new_location)
351 HTTPContext *s = h->priv_data;
356 if ((err = http_get_line(s, line, sizeof(line))) < 0)
359 av_dlog(NULL, "header='%s'\n", line);
361 err = process_line(h, line, s->line_count, new_location);
372 static int http_connect(URLContext *h, const char *path, const char *local_path,
373 const char *hoststr, const char *auth,
374 const char *proxyauth, int *new_location)
376 HTTPContext *s = h->priv_data;
378 char headers[1024] = "";
379 char *authstr = NULL, *proxyauthstr = NULL;
380 int64_t off = s->off;
385 /* send http header */
386 post = h->flags & AVIO_FLAG_WRITE;
389 /* force POST method and disable chunked encoding when
390 * custom HTTP post data is set */
395 method = post ? "POST" : "GET";
396 authstr = ff_http_auth_create_response(&s->auth_state, auth, local_path,
398 proxyauthstr = ff_http_auth_create_response(&s->proxy_auth_state, proxyauth,
401 /* set default headers if needed */
402 if (!has_header(s->headers, "\r\nUser-Agent: "))
403 len += av_strlcatf(headers + len, sizeof(headers) - len,
404 "User-Agent: %s\r\n",
405 s->user_agent ? s->user_agent : LIBAVFORMAT_IDENT);
406 if (!has_header(s->headers, "\r\nAccept: "))
407 len += av_strlcpy(headers + len, "Accept: */*\r\n",
408 sizeof(headers) - len);
409 if (!has_header(s->headers, "\r\nRange: ") && !post)
410 len += av_strlcatf(headers + len, sizeof(headers) - len,
411 "Range: bytes=%"PRId64"-\r\n", s->off);
413 if (!has_header(s->headers, "\r\nConnection: ")) {
414 if (s->multiple_requests) {
415 len += av_strlcpy(headers + len, "Connection: keep-alive\r\n",
416 sizeof(headers) - len);
418 len += av_strlcpy(headers + len, "Connection: close\r\n",
419 sizeof(headers) - len);
423 if (!has_header(s->headers, "\r\nHost: "))
424 len += av_strlcatf(headers + len, sizeof(headers) - len,
425 "Host: %s\r\n", hoststr);
426 if (!has_header(s->headers, "\r\nContent-Length: ") && s->post_data)
427 len += av_strlcatf(headers + len, sizeof(headers) - len,
428 "Content-Length: %d\r\n", s->post_datalen);
430 /* now add in custom headers */
432 av_strlcpy(headers + len, s->headers, sizeof(headers) - len);
434 snprintf(s->buffer, sizeof(s->buffer),
443 post && s->chunked_post ? "Transfer-Encoding: chunked\r\n" : "",
445 authstr ? authstr : "",
446 proxyauthstr ? "Proxy-" : "", proxyauthstr ? proxyauthstr : "");
449 av_freep(&proxyauthstr);
450 if ((err = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
454 if ((err = ffurl_write(s->hd, s->post_data, s->post_datalen)) < 0)
457 /* init input buffer */
458 s->buf_ptr = s->buffer;
459 s->buf_end = s->buffer;
464 s->end_chunked_post = 0;
466 if (post && !s->post_data) {
467 /* Pretend that it did work. We didn't read any header yet, since
468 * we've still to send the POST data, but the code calling this
469 * 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;
513 if (s->end_chunked_post) {
514 if (!s->end_header) {
515 err = http_read_header(h, &new_location);
520 return http_buf_read(h, buf, size);
523 if (s->chunksize >= 0) {
529 if ((err = http_get_line(s, line, sizeof(line))) < 0)
531 } while (!*line); /* skip CR LF from last chunk */
533 s->chunksize = strtoll(line, NULL, 16);
535 av_dlog(NULL, "Chunked encoding data size: %"PRId64"'\n", s->chunksize);
542 size = FFMIN(size, s->chunksize);
544 return http_buf_read(h, buf, size);
547 /* used only when posting data */
548 static int http_write(URLContext *h, const uint8_t *buf, int size)
550 char temp[11] = ""; /* 32-bit hex + CRLF + nul */
552 char crlf[] = "\r\n";
553 HTTPContext *s = h->priv_data;
555 if (!s->chunked_post) {
556 /* non-chunked data is sent without any special encoding */
557 return ffurl_write(s->hd, buf, size);
560 /* silently ignore zero-size data since chunk encoding that would
563 /* upload data using chunked encoding */
564 snprintf(temp, sizeof(temp), "%x\r\n", size);
566 if ((ret = ffurl_write(s->hd, temp, strlen(temp))) < 0 ||
567 (ret = ffurl_write(s->hd, buf, size)) < 0 ||
568 (ret = ffurl_write(s->hd, crlf, sizeof(crlf) - 1)) < 0)
574 static int http_shutdown(URLContext *h, int flags)
577 char footer[] = "0\r\n\r\n";
578 HTTPContext *s = h->priv_data;
580 /* signal end of chunked encoding if used */
581 if ((flags & AVIO_FLAG_WRITE) && s->chunked_post) {
582 ret = ffurl_write(s->hd, footer, sizeof(footer) - 1);
583 ret = ret > 0 ? 0 : ret;
584 s->end_chunked_post = 1;
590 static int http_close(URLContext *h)
593 HTTPContext *s = h->priv_data;
595 if (!s->end_chunked_post) {
596 /* Close the write direction by sending the end of chunked encoding. */
597 ret = http_shutdown(h, h->flags);
601 ffurl_closep(&s->hd);
605 static int64_t http_seek(URLContext *h, int64_t off, int whence)
607 HTTPContext *s = h->priv_data;
608 URLContext *old_hd = s->hd;
609 int64_t old_off = s->off;
610 uint8_t old_buf[BUFFER_SIZE];
613 if (whence == AVSEEK_SIZE)
615 else if ((s->filesize == -1 && whence == SEEK_END) || h->is_streamed)
618 /* we save the old context in case the seek fails */
619 old_buf_size = s->buf_end - s->buf_ptr;
620 memcpy(old_buf, s->buf_ptr, old_buf_size);
622 if (whence == SEEK_CUR)
624 else if (whence == SEEK_END)
628 /* if it fails, continue on old connection */
629 if (http_open_cnx(h) < 0) {
630 memcpy(s->buffer, old_buf, old_buf_size);
631 s->buf_ptr = s->buffer;
632 s->buf_end = s->buffer + old_buf_size;
642 http_get_file_handle(URLContext *h)
644 HTTPContext *s = h->priv_data;
645 return ffurl_get_file_handle(s->hd);
648 #if CONFIG_HTTP_PROTOCOL
649 URLProtocol ff_http_protocol = {
651 .url_open = http_open,
652 .url_read = http_read,
653 .url_write = http_write,
654 .url_seek = http_seek,
655 .url_close = http_close,
656 .url_get_file_handle = http_get_file_handle,
657 .url_shutdown = http_shutdown,
658 .priv_data_size = sizeof(HTTPContext),
659 .priv_data_class = &http_context_class,
660 .flags = URL_PROTOCOL_FLAG_NETWORK,
663 #if CONFIG_HTTPS_PROTOCOL
664 URLProtocol ff_https_protocol = {
666 .url_open = http_open,
667 .url_read = http_read,
668 .url_write = http_write,
669 .url_seek = http_seek,
670 .url_close = http_close,
671 .url_get_file_handle = http_get_file_handle,
672 .url_shutdown = http_shutdown,
673 .priv_data_size = sizeof(HTTPContext),
674 .priv_data_class = &https_context_class,
675 .flags = URL_PROTOCOL_FLAG_NETWORK,
679 #if CONFIG_HTTPPROXY_PROTOCOL
680 static int http_proxy_close(URLContext *h)
682 HTTPContext *s = h->priv_data;
684 ffurl_closep(&s->hd);
688 static int http_proxy_open(URLContext *h, const char *uri, int flags)
690 HTTPContext *s = h->priv_data;
691 char hostname[1024], hoststr[1024];
692 char auth[1024], pathbuf[1024], *path;
694 int port, ret = 0, attempts = 0;
695 HTTPAuthType cur_auth_type;
701 av_url_split(NULL, 0, auth, sizeof(auth), hostname, sizeof(hostname), &port,
702 pathbuf, sizeof(pathbuf), uri);
703 ff_url_join(hoststr, sizeof(hoststr), NULL, NULL, hostname, port, NULL);
708 ff_url_join(lower_url, sizeof(lower_url), "tcp", NULL, hostname, port,
711 ret = ffurl_open(&s->hd, lower_url, AVIO_FLAG_READ_WRITE,
712 &h->interrupt_callback, NULL);
716 authstr = ff_http_auth_create_response(&s->proxy_auth_state, auth,
718 snprintf(s->buffer, sizeof(s->buffer),
719 "CONNECT %s HTTP/1.1\r\n"
721 "Connection: close\r\n"
726 authstr ? "Proxy-" : "", authstr ? authstr : "");
729 if ((ret = ffurl_write(s->hd, s->buffer, strlen(s->buffer))) < 0)
732 s->buf_ptr = s->buffer;
733 s->buf_end = s->buffer;
736 cur_auth_type = s->proxy_auth_state.auth_type;
738 /* Note: This uses buffering, potentially reading more than the
739 * HTTP header. If tunneling a protocol where the server starts
740 * the conversation, we might buffer part of that here, too.
741 * Reading that requires using the proper ffurl_read() function
742 * on this URLContext, not using the fd directly (as the tls
743 * protocol does). This shouldn't be an issue for tls though,
744 * since the client starts the conversation there, so there
745 * is no extra data that we might buffer up here.
747 ret = http_read_header(h, &new_loc);
752 if (s->http_code == 407 &&
753 (cur_auth_type == HTTP_AUTH_NONE || s->proxy_auth_state.stale) &&
754 s->proxy_auth_state.auth_type != HTTP_AUTH_NONE && attempts < 2) {
755 ffurl_closep(&s->hd);
759 if (s->http_code < 400)
768 static int http_proxy_write(URLContext *h, const uint8_t *buf, int size)
770 HTTPContext *s = h->priv_data;
771 return ffurl_write(s->hd, buf, size);
774 URLProtocol ff_httpproxy_protocol = {
776 .url_open = http_proxy_open,
777 .url_read = http_buf_read,
778 .url_write = http_proxy_write,
779 .url_close = http_proxy_close,
780 .url_get_file_handle = http_get_file_handle,
781 .priv_data_size = sizeof(HTTPContext),
782 .flags = URL_PROTOCOL_FLAG_NETWORK,