@warren-bank/hls-proxy 3.5.2 → 3.5.4

package/README.md

@@ -113,6 +113,7 @@ options:
 --tls
 --host <host>
 --port <number>
+--copy-req-headers
 --req-headers <filepath>
 --origin <header>
 --referer <header>
@@ -167,6 +168,7 @@ options:
   * when this option is not specified:
     * HTTP proxy binds to: `80`
     * HTTPS proxy binds to: `443`
+* _--copy-req-headers_ is a flag to enable the duplication of all HTTP request headers sent to the proxy &rarr; to the request made by the proxy to the video server
 * _--req-headers_ is the filepath to a JSON data _Object_ containing key:value pairs
   * each _key_ is the name of an HTTP header to send in every outbound request
 * _--origin_ is the value of the corresponding HTTP request header

package/hls-proxy/bin/hlsd.js

@@ -34,6 +34,7 @@ const server = (use_tls)
 const middleware = require('../proxy')({
   is_secure:                            use_tls,
   host:                                 normalize_host(argv_vals["--host"], argv_vals["--port"]),
+  copy_req_headers:                     argv_vals["--copy-req-headers"],
   req_headers:                          argv_vals["--req-headers"],
   req_options:                          argv_vals["--req-options"],
   hooks:                                argv_vals["--hooks"],

package/hls-proxy/bin/lib/help.js

@@ -8,6 +8,7 @@ options:
 --tls
 --host <host>
 --port <number>
+--copy-req-headers
 --req-headers <filepath>
 --origin <header>
 --referer <header>

package/hls-proxy/bin/lib/process_argv.js

@@ -2,6 +2,8 @@ const process_argv = require('@warren-bank/node-process-argv')
 
 const {HttpProxyAgent, HttpsProxyAgent} = require('hpagent')
 
+const {normalize_req_headers} = require('../../utils')
+
 const argv_flags = {
   "--help":                                 {bool: true},
   "--version":                              {bool: true},
@@ -10,6 +12,7 @@ const argv_flags = {
   "--host":                                 {},
   "--port":                                 {num:  "int"},
 
+  "--copy-req-headers":                     {bool: true},
   "--req-headers":                          {file: "json"},
   "--origin":                               {},
   "--referer":                              {},
@@ -74,7 +77,7 @@ if (argv_vals["--version"]) {
 }
 
 if (argv_vals["--origin"] || argv_vals["--referer"] || argv_vals["--useragent"] || (Array.isArray(argv_vals["--header"]) && argv_vals["--header"].length)) {
-  argv_vals["--req-headers"] = argv_vals["--req-headers"] || {}
+  argv_vals["--req-headers"] = normalize_req_headers( argv_vals["--req-headers"] || {} )
 
   if (argv_vals["--origin"]) {
     argv_vals["--req-headers"]["origin"] = argv_vals["--origin"]
@@ -151,13 +154,8 @@ if (argv_vals["--req-secure-honor-server-cipher-order"] || argv_vals["--req-secu
   }
 }
 
-if (argv_vals["--req-options"] && argv_vals["--req-options"]["headers"]) {
-  const lc_headers = {}
-  for (let key in argv_vals["--req-options"]["headers"]) {
-    lc_headers[ key.toLowerCase() ] = argv_vals["--req-options"]["headers"][key]
-  }
-  argv_vals["--req-options"]["headers"] = lc_headers
-}
+if (argv_vals["--req-options"] && argv_vals["--req-options"]["headers"])
+  argv_vals["--req-options"]["headers"] = normalize_req_headers( argv_vals["--req-options"]["headers"] )
 
 if (typeof argv_vals["--max-segments"] !== 'number')
   argv_vals["--max-segments"] = 20

package/hls-proxy/manifest_parser.js

@@ -382,7 +382,7 @@ const modify_m3u8_line = function(embedded_url, m3u8_lines) {
   }
 }
 
-const modify_m3u8_content = function(params, segment_cache, m3u8_content, m3u8_url, referer_url, redirected_base_url, qs_password) {
+const modify_m3u8_content = function(params, segment_cache, m3u8_content, m3u8_url, referer_url, inbound_req_headers, redirected_base_url, qs_password) {
   const {hooks, cache_segments, max_segments, debug_level, manifest_extension, segment_extension} = params
 
   const {has_cache, get_time_since_last_access, is_expired, prefetch_segment} = segment_cache
@@ -424,13 +424,13 @@ const modify_m3u8_content = function(params, segment_cache, m3u8_content, m3u8_u
           const matching_url = urls[0]
           urls[0] = undefined
 
-          promise = prefetch_segment(m3u8_url, matching_url, referer_url, dont_touch_access)
+          promise = prefetch_segment(m3u8_url, matching_url, referer_url, inbound_req_headers, dont_touch_access)
         }
 
         promise.then(() => {
           urls.forEach((matching_url, index) => {
             if (matching_url) {
-              prefetch_segment(m3u8_url, matching_url, referer_url, dont_touch_access)
+              prefetch_segment(m3u8_url, matching_url, referer_url, inbound_req_headers, dont_touch_access)
 
               urls[index] = undefined
             }

package/hls-proxy/proxy.js

@@ -79,7 +79,7 @@ const get_middleware = function(params) {
       }
     }
 
-    const options = get_request_options(url, is_m3u8, referer_url)
+    const options = get_request_options(url, is_m3u8, referer_url, req.headers)
     debug(1, 'proxying:', url)
     debug(3, 'm3u8:', (is_m3u8 ? 'true' : 'false'))
 
@@ -107,7 +107,7 @@ const get_middleware = function(params) {
           : url
 
         res.writeHead(200, { "content-type": "application/x-mpegURL" })
-        res.end( modify_m3u8_content(response.toString().trim(), m3u8_url, referer_url, redirected_base_url, qs_password) )
+        res.end( modify_m3u8_content(response.toString().trim(), m3u8_url, referer_url, req.headers, redirected_base_url, qs_password) )
       }
     })
     .catch((e) => {

package/hls-proxy/segment_cache.js

@@ -161,7 +161,7 @@ module.exports = function(params) {
     }
   }
 
-  const prefetch_segment = function(m3u8_url, url, referer_url, dont_touch_access) {
+  const prefetch_segment = function(m3u8_url, url, referer_url, inbound_req_headers, dont_touch_access) {
     let promise = Promise.resolve()
 
     if (cache[m3u8_url] === undefined) {
@@ -184,7 +184,7 @@ module.exports = function(params) {
       index = ts.length
       ts[index] = {key: get_privatekey_from_url(url), has: false, cb: [], type: null, state: {}}
 
-      let options = get_request_options(url, /* is_m3u8= */ false, referer_url)
+      let options = get_request_options(url, /* is_m3u8= */ false, referer_url, inbound_req_headers)
       promise = request(options, '', {binary: true, stream: false, cookieJar: cookies.getCookieJar()})
       .then(({redirects, response}) => {
         debug(1, `prefetch (complete, ${response.length} bytes):`, debug_url)

package/hls-proxy/timers.js

@@ -11,7 +11,7 @@ const initialize_timers = function(params) {
     const get_request_options = utils.get_request_options.bind(null, params)
 
     const request_wrapper = function(url, POST_data, user_config) {
-      const options = get_request_options(url, /* is_m3u8= */ false, /* referer_url= */ null)
+      const options = get_request_options(url, /* is_m3u8= */ false, /* referer_url= */ null, /* inbound_req_headers= */ null)
       const config  = Object.assign(
         {},
         (user_config || {}),

package/hls-proxy/utils.js

@@ -120,8 +120,32 @@ const debug = function() {
   }
 }
 
-const get_request_options = function(params, url, is_m3u8, referer_url) {
-  const {req_headers, req_options, hooks, http_proxy} = params
+const normalize_req_headers = function(req_headers, blacklist) {
+  const normalized = {}
+
+  if (blacklist && !Array.isArray(blacklist))
+    blacklist = null
+  if (blacklist)
+    blacklist = blacklist.filter(val => val && (typeof val === 'string')).map(val => val.toLowerCase())
+  if (blacklist && !blacklist.length)
+    blacklist = null
+
+  for (let name in req_headers) {
+    const lc_name = name.toLowerCase()
+
+    if (!blacklist || (blacklist.indexOf(lc_name) === -1))
+      normalized[lc_name] = req_headers[name]
+  }
+
+  return normalized
+}
+
+const get_request_options = function(params, url, is_m3u8, referer_url, inbound_req_headers) {
+  const {copy_req_headers, req_headers, req_options, hooks, http_proxy} = params
+
+  const copied_req_headers = (copy_req_headers && inbound_req_headers && (inbound_req_headers instanceof Object))
+    ? normalize_req_headers(inbound_req_headers, ['host'])
+    : null
 
   const additional_req_options = (hooks && (hooks instanceof Object) && hooks.add_request_options && (typeof hooks.add_request_options === 'function'))
     ? hooks.add_request_options(url, is_m3u8)
@@ -131,7 +155,7 @@ const get_request_options = function(params, url, is_m3u8, referer_url) {
     ? hooks.add_request_headers(url, is_m3u8)
     : null
 
-  if (!req_options && !http_proxy && !additional_req_options && !req_headers && !additional_req_headers && !referer_url) return url
+  if (!req_options && !http_proxy && !additional_req_options && !copied_req_headers && !req_headers && !additional_req_headers && !referer_url) return url
 
   const request_options = Object.assign(
     {},
@@ -142,6 +166,7 @@ const get_request_options = function(params, url, is_m3u8, referer_url) {
 
   request_options.headers = Object.assign(
     {},
+    (copied_req_headers      || {}),
     ((           req_options &&            req_options.headers) ?            req_options.headers : {}),
     ((additional_req_options && additional_req_options.headers) ? additional_req_options.headers : {}),
     (req_headers             || {}),
@@ -186,6 +211,7 @@ module.exports = {
   get_content_type,
   add_CORS_headers,
   debug,
+  normalize_req_headers,
   get_request_options,
   should_prefetch_url
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@warren-bank/hls-proxy",
   "description": "Node.js server to proxy HLS video streams",
-  "version":     "3.5.2",
+  "version":     "3.5.4",
   "scripts": {
     "start":     "node hls-proxy/bin/hlsd.js",
     "sudo": "sudo node hls-proxy/bin/hlsd.js"