@warren-bank/hls-proxy 3.2.5 → 3.3.0

package/README.md

@@ -110,7 +110,7 @@ options:
 --help
 --version
 --tls
---host <ip_address>
+--host <host>
 --port <number>
 --req-headers <filepath>
 --origin <header>
@@ -130,6 +130,7 @@ options:
 --cache-key <number>
 -v <number>
 --acl-whitelist <ip_address_list>
+--http-proxy <http[s]://[user:pass@]hostname:port>
 --tls-cert <filepath>
 --tls-key <filepath>
 --tls-pass <filepath>
@@ -342,6 +343,9 @@ options:
     * show the content of .m3u8 files (both before and after URLs are modified)
 * _--acl-whitelist_ restricts proxy server access to clients at IP addresses in whitelist
   * ex: `"192.168.1.100,192.168.1.101,192.168.1.102"`
+* --http-proxy enables all outbound HTTP and HTTPS requests from HLS-Proxy to be tunnelled through an additional external web proxy server
+  * SOCKS proxies are not supported
+  * ex: `http://myusername:mypassword@myproxy.example.com:1234`
 * _--tls-cert_ is the filepath to a security certificate to use for HTTPS
 * _--tls-key_ is the filepath to the private key for the _--tls-cert_ security certificate
 * _--tls-pass_ is the filepath to a text file containing the security passphrase for the _--tls-key_ private key

package/hls-proxy/bin/hlsd.js

@@ -42,7 +42,8 @@ const middleware = require('../proxy')({
   cache_timeout:  argv_vals["--cache-timeout"],
   cache_key:      argv_vals["--cache-key"],
   debug_level:    argv_vals["-v"],
-  acl_whitelist:  argv_vals["--acl-whitelist"]
+  acl_whitelist:  argv_vals["--acl-whitelist"],
+  http_proxy:     argv_vals["--http-proxy"]
 })
 
 if (middleware.connection)

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

@@ -6,7 +6,7 @@ options:
 --help
 --version
 --tls
---host <ip_address>
+--host <host>
 --port <number>
 --req-headers <filepath>
 --origin <header>
@@ -26,6 +26,7 @@ options:
 --cache-key <number>
 -v <number>
 --acl-whitelist <ip_address_list>
+--http-proxy <http[s]://[user:pass@]hostname:port>
 --tls-cert <filepath>
 --tls-key <filepath>
 --tls-pass <filepath>

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

@@ -1,5 +1,7 @@
 const process_argv = require('@warren-bank/node-process-argv')
 
+const {HttpProxyAgent, HttpsProxyAgent} = require('hpagent')
+
 const argv_flags = {
   "--help":                                 {bool: true},
   "--version":                              {bool: true},
@@ -30,6 +32,7 @@ const argv_flags = {
 
   "-v":                                     {num:  "int"},
   "--acl-whitelist":                        {},
+  "--http-proxy":                           {},
 
   "--tls-cert":                             {file: "path-exists"},
   "--tls-key":                              {file: "path-exists"},
@@ -37,7 +40,8 @@ const argv_flags = {
 }
 
 const argv_flag_aliases = {
-  "--help":                                 ["-h"]
+  "--help":                                 ["-h"],
+  "--http-proxy":                           ["--https-proxy", "--proxy"]
 }
 
 let argv_vals = {}
@@ -160,4 +164,19 @@ if (typeof argv_vals["--cache-key"] !== 'number')
 if (typeof argv_vals["-v"] !== 'number')
   argv_vals["-v"] = 0
 
+if (argv_vals["--http-proxy"]) {
+  const proxy_options = {
+    keepAlive:      true,
+    keepAliveMsecs: 1000,
+    maxSockets:     256,
+    maxFreeSockets: 256,
+    proxy:          argv_vals["--http-proxy"]
+  }
+
+  argv_vals["--http-proxy"] = {
+    "http:":  new HttpProxyAgent( proxy_options),
+    "https:": new HttpsProxyAgent(proxy_options)
+  }
+}
+
 module.exports = argv_vals

package/hls-proxy/utils.js

@@ -97,7 +97,7 @@ const debug = function() {
 }
 
 const get_request_options = function(params, url, is_m3u8, referer_url) {
-  const {req_headers, req_options, hooks} = params
+  const {req_headers, req_options, hooks, http_proxy} = params
 
   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)
@@ -107,7 +107,7 @@ const get_request_options = function(params, url, is_m3u8, referer_url) {
     ? hooks.add_request_headers(url, is_m3u8)
     : null
 
-  if (!req_options && !additional_req_options && !req_headers && !additional_req_headers && !referer_url) return url
+  if (!req_options && !http_proxy && !additional_req_options && !req_headers && !additional_req_headers && !referer_url) return url
 
   const request_options = Object.assign(
     {},
@@ -125,6 +125,13 @@ const get_request_options = function(params, url, is_m3u8, referer_url) {
     (referer_url ? {"referer": referer_url, "origin": referer_url.replace(regexs.origin, '$1')} : {})
   )
 
+  // normalize
+  if (request_options.protocol)
+    request_options.protocol = request_options.protocol.toLowerCase()
+
+  if (!request_options.agent && http_proxy && request_options.protocol && http_proxy[request_options.protocol])
+    request_options.agent = http_proxy[request_options.protocol]
+
   return request_options
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@warren-bank/hls-proxy",
   "description": "Node.js server to proxy HLS video streams",
-  "version":     "3.2.5",
+  "version":     "3.3.0",
   "scripts": {
     "start":     "node hls-proxy/bin/hlsd.js",
     "sudo": "sudo node hls-proxy/bin/hlsd.js"
@@ -11,8 +11,9 @@
   },
   "dependencies": {
     "@warren-bank/node-process-argv": "^1.2.1",
-    "@warren-bank/node-request": "^2.0.10",
+    "@warren-bank/node-request": "^2.0.12",
     "@warren-bank/url": "^3.1.0",
+    "hpagent": "^1.2.0",
     "tough-cookie": "^3.0.1"
   },
   "license": "GPL-2.0",