Merge pull request #206 from ivan-gomes/feature/206-custom-headers

Command line option for custom headers

Author: minrk

README.md

@@ -143,6 +143,7 @@ Options:
   --auto-rewrite                     Rewrite the Location header host/port in redirect responses
   --change-origin                    Changes the origin of the host header to the target URL
   --protocol-rewrite <proto>         Rewrite the Location header protocol in redirect responses to the specified protocol
+  --custom-headers <headers>         Comma separated list of custom headers to add to proxied requests (k1:v1,k2:v2,...)
   --insecure                         Disable SSL cert verification
   --host-routing                     Use host routing (host as first level of path)
 

bin/configurable-http-proxy

@@ -81,6 +81,11 @@ args
     "--protocol-rewrite <proto>",
     "Rewrite the Location header protocol in redirect responses to the specified protocol"
   )
+  .option(
+    "--custom-header <header>",
+    "Custom header to add to proxied requests. Use same option for multiple headers (--custom-header k1:v1 --custom-header k2:v2)",
+    collect, []
+  )
   .option("--insecure", "Disable SSL cert verification")
   .option("--host-routing", "Use host routing (host as first level of path)")
   .option("--statsd-host <host>", "Host to send statsd statistics to")
@@ -102,6 +107,10 @@ args
     "Define an external storage class. Defaults to in-MemoryStore."
   );
 
+function collect(value, previous) {
+  return previous.concat([value]);
+}
+
 args.parse(process.argv);
 
 var ConfigurableProxy = require("../lib/configproxy.js").ConfigurableProxy;
@@ -300,6 +309,24 @@ if (!options.authToken) {
   log.warn("REST API is not authenticated.");
 }
 
+// custom headers option
+options.customHeader = [];
+if (args.customHeader) {
+  options.customHeader = args.customHeader.map(s => s.trim()).map(header => {
+    var i = header.indexOf(':');
+    var key, value;
+    if (i < 0) {
+      log.error("Custom header is invalid: " + header);
+      process.exit(1);
+    }
+    else {
+      var key = header.substr(0, i).trim();
+      var value = header.substr(i + 1).trim();
+    }
+    return { 'key': key, 'value': value };
+  }).filter(header => header.key);
+}
+
 // external backend class
 options.storageBackend = args.storageBackend;
 

lib/configproxy.js

@@ -145,6 +145,7 @@ class ConfigurableProxy extends EventEmitter {
     } else {
       this.includePrefix = true;
     }
+    this.customHeaders = this.options.customHeaders;
     this.hostRouting = this.options.hostRouting;
     this.errorTarget = options.errorTarget;
     if (this.errorTarget && this.errorTarget.slice(-1) !== "/") {
@@ -228,6 +229,9 @@ class ConfigurableProxy extends EventEmitter {
 
     this.proxy.on("proxyRes", function(proxyRes, req, res) {
       that.statsd.increment("requests." + proxyRes.statusCode, 1);
+      if (that.customHeaders) {
+        that.customHeaders.forEach(header => res.setHeader(header.key, header.value));
+      }
     });
   }