add protocol claim filtering logic

Author: brockallen

src/UserInfoService.js

@@ -2,7 +2,9 @@ import JsonService from './JsonService';
 import MetadataService from './MetadataService';
 import Log from './Log';
 
-export default class UserInfoService{
+const ProtocolClaims = ["nonce", "at_hash", "iat", "nbf", "exp", "aud", "iss"];
+
+export default class UserInfoService {
     constructor(settings, JsonServiceCtor = JsonService, MetadataServiceCtor = MetadataService) {
         if (!settings) {
             Log.error("No settings passed to UserInfoService");
@@ -13,8 +15,34 @@ export default class UserInfoService{
         this._jsonService = new JsonServiceCtor();
         this._metadataService = new MetadataServiceCtor(this._settings);
     }
-    
-    getUserInfo(){
-        return Promise.resolve();
+
+    getClaims(token) {
+        Log.info("UserInfoService.getClaims");
+
+        if (!token) {
+            Log.error("No token passed");
+            return Promise.reject(new Error("A token is required"));
+        }
+
+        return this._metadataService.getUserInfoUrl().then(url => {
+            Log.info("received userinfo url", url);
+
+            return this._jsonService.getJson(url, token).then(claims => {
+                Log.info("claims received", claims);
+
+                if (claims && this._settings.filterProtocolClaims) {
+                    ProtocolClaims.forEach(type => {
+                        delete claims[type];
+                    });
+
+                    Log.info("protocol claims filtered", claims);
+                }
+
+                return claims;
+            });
+        }, err => {
+            Log.error("Failed to get claims", err);
+            throw new Error("Failed to get claims");
+        });
     }
 }

test/StubJsonService.js

@@ -1,6 +1,7 @@
 export default class StubJsonService {
-    getJson(url) {
+    getJson(url, token) {
         this.url = url;
+        this.token = token;
         return this.result;
     }
 }

test/StubMetadataService.js

@@ -0,0 +1,5 @@
+export default class StubMetadataService{
+    getUserInfoUrl(){
+        return this.userInfoUrlResult;
+    }
+}

test/UserInfoService.spec.js

@@ -2,6 +2,7 @@ import Log from '../src/Log';
 import UserInfoService from '../src/UserInfoService';
 
 import StubJsonService from './StubJsonService';
+import StubMetadataService from './StubMetadataService';
 
 import chai from 'chai';
 chai.should();
@@ -11,11 +12,13 @@ describe("UserInfoService", function() {
     let subject;
     let settings;
     let stubJsonService;
+    let stubMetadataService;
 
     beforeEach(function() {
         settings = {};
         stubJsonService = new StubJsonService();
-        subject = new UserInfoService(settings, ()=>stubJsonService);
+        stubMetadataService = new StubMetadataService();
+        subject = new UserInfoService(settings, () => stubJsonService, () => stubMetadataService);
     });
 
     describe("constructor", function() {
@@ -32,10 +35,90 @@ describe("UserInfoService", function() {
 
     });
 
-    describe("getUserInfo", function() {
+    describe("getClaims", function() {
 
         it("should return a promise", function() {
-            subject.getUserInfo().should.be.instanceof(Promise);
+            subject.getClaims().should.be.instanceof(Promise);
+        });
+
+        it("should require a token", function(done) {
+            subject.getClaims().then(null,
+                err => {
+                    err.message.should.contain("token");
+                    done();
+                });
+        });
+
+        it("should call userinfo url and pass token", function(done) {
+            stubMetadataService.userInfoUrlResult = Promise.resolve("http://sts/userinfo");
+            stubJsonService.result = Promise.resolve("test");
+
+            subject.getClaims("token").then(claims => {
+                stubJsonService.url.should.equal("http://sts/userinfo");
+                stubJsonService.token.should.equal("token");
+                done();
+            });
+
+        });
+
+        it("should fail when dependencies fail", function(done) {
+            stubMetadataService.userInfoUrlResult = Promise.reject("test");
+
+            subject.getClaims("token").then(null,
+                err => {
+                    err.message.should.contain('claims');
+                    done();
+                }
+            );
+
+        });
+
+        it("should return claims", function(done) {
+            stubMetadataService.userInfoUrlResult = Promise.resolve("http://sts/userinfo");
+            stubJsonService.result = Promise.resolve({
+                foo: 1, bar: 'test',
+                aud:'some_aud', iss:'issuer', 
+                sub:'123', email:'foo@gmail.com',
+                role:['admin', 'dev'],
+                nonce:'nonce', at_hash:"athash", 
+                iat:5, nbf:10, exp:20
+            });
+
+            subject.getClaims("token").then(claims => {
+                claims.should.deep.equal({
+                    foo: 1, bar: 'test',
+                    aud:'some_aud', iss:'issuer', 
+                    sub:'123', email:'foo@gmail.com',
+                    role:['admin', 'dev'],
+                    nonce:'nonce', at_hash:"athash", 
+                    iat:5, nbf:10, exp:20
+                });
+                done();
+            });
+
+        });
+        
+        it("should filter protocol claims", function(done) {
+            stubMetadataService.userInfoUrlResult = Promise.resolve("http://sts/userinfo");
+            stubJsonService.result = Promise.resolve({
+                foo: 1, bar: 'test',
+                aud:'some_aud', iss:'issuer', 
+                sub:'123', email:'foo@gmail.com',
+                role:['admin', 'dev'],
+                nonce:'nonce', at_hash:"athash", 
+                iat:5, nbf:10, exp:20
+            });
+            settings.filterProtocolClaims = true;
+
+            subject.getClaims("token").then(claims => {
+                claims.should.deep.equal({
+                    foo: 1, bar: 'test',
+                    sub:'123', email:'foo@gmail.com',
+                    role:['admin', 'dev']
+                });
+                done();
+            });
+
         });
 
     });