feat: add proxy option to jwksClient

auth0 · Feb 13, 2020 · c7c7ba5 · c7c7ba5
1 parent 73a087d
commit c7c7ba5
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,8 @@ const client = jwksClient({
   strictSsl: true, // Default value
   jwksUri: 'https://sandrino.auth0.com/.well-known/jwks.json',
   requestHeaders: {}, // Optional
-  requestAgentOptions: {} // Optional
+  requestAgentOptions: {}, // Optional
+  proxy: '[protocol]://[username]:[pass]@[address]:[port]', // Optional
 });
 
 const kid = 'RkI5MjI5OUY5ODc1N0Q4QzM0OUYzNkVGMTJDOUEzQkFCOTU3NjE2Rg';

diff --git a/index.d.ts b/index.d.ts
@@ -22,6 +22,7 @@ declare namespace JwksRsa {
     cacheMaxEntries?: number;
     cacheMaxAge?: number;
     jwksRequestsPerMinute?: number;
+    proxy?: string;
     strictSsl?: boolean;
     requestHeaders?: Headers;
   }

diff --git a/src/JwksClient.js b/src/JwksClient.js
@@ -40,7 +40,8 @@ export class JwksClient {
       uri: this.options.jwksUri,
       strictSSL: this.options.strictSsl,
       headers: this.options.requestHeaders,
-      agentOptions: this.options.requestAgentOptions
+      agentOptions: this.options.requestAgentOptions,
+      proxy: this.options.proxy,
     }, (err, res) => {
       if (err || res.statusCode < 200 || res.statusCode >= 300) {
         this.logger('Failure:', res && res.body || err);

diff --git a/tests/jwksClient.tests.js b/tests/jwksClient.tests.js
@@ -6,6 +6,7 @@ import { JwksClient } from "../src/JwksClient";
 
 describe("JwksClient", () => {
   const jwksHost = "http://my-authz-server";
+  const proxy = "my-proxy-server:2815";
 
   beforeEach(() => {
     nock.cleanAll();
@@ -182,8 +183,51 @@ describe("JwksClient", () => {
         done();
       });
     });
-  });
 
+    it("should add a proxy", done => {
+      nock(jwksHost)
+        .get("/.well-known/jwks.json")
+        .reply(function(uri, requestBody) {
+          expect(this.req.headers).not.to.be.null;
+          expect(this.req.headers["user-agent"]).to.be.equal("My-bot");
+          expect(Object.keys(this.req.headers).length).to.be.equal(3);
+          return (
+            200,
+            {
+              keys: [
+                {
+                  alg: "RS256",
+                  kty: "RSA",
+                  use: "sig",
+                  x5c: ["pk1"],
+                  kid: "ABC"
+                },
+                {
+                  alg: "RS256",
+                  kty: "RSA",
+                  use: "sig",
+                  x5c: [],
+                  kid: "123"
+                }
+              ]
+            }
+          );
+        });
+
+      const client = new JwksClient({
+        jwksUri: `${jwksHost}/.well-known/jwks.json`,
+        requestHeaders: {
+          "User-Agent": "My-bot"
+        },
+        proxy: `http://username:password@${proxy}`,
+      });
+
+      client.getKeys((err, keys) => {
+        done();
+      });
+    });
+  });
+
   describe("#getSigningKeys", () => {
     it("should handle errors", done => {
       nock(jwksHost)