Added username and primary email address to SSO token data

Author: Max Scholz

README.MD

@@ -1,5 +1,3 @@
-[![Build Status](https://travis-ci.org/Staffbase/plugins-sdk-nodejs.svg?branch=master)](https://travis-ci.org/Staffbase/plugins-sdk-nodejs)
-
 # Staffbase Plugins SDK for Node.js.
 
 If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/api/plugin-sso/. While this documentation just covers the conceptual ideas of the interface of plugins though – the so called Plugin SSO – we want to provide a library to help you develop your first plugin for Staffbase even faster. This SDK provides the basic functionality to parse and verify a provided token for Node.js.
@@ -87,6 +85,8 @@ The following data can be retrieved from the token:
 |CLAIM_INSTANCE_NAME|instance_name|getInstanceName()|Get the (plugin) instance name for which the token was issued.|
 |CLAIM_USER_ID|sub|getUserId()|Get the id of the authenticated user.|
 |CLAIM_USER_EXTERNAL_ID|external_id|getUserExternalId()|Get the id of the user in an external system.|
+|CLAIM_USER_USERNAME|username|getUserUsername()|Get the username of the user accessing.|
+|CLAIM_USER_PRIMARY_EMAIL_ADDRESS|primary_email_address|getUserPrimaryEmailAddress()|Get the primary email address of the user accessing.|
 |CLAIM_USER_FULL_NAME|name|getFullName()|Get either the combined name of the user or the name of the token.|
 |CLAIM_USER_FIRST_NAME|given_name|getFirstName()|Get the first name of the user accessing.|
 |CLAIM_USER_LAST_NAME|family_name|getLastName()|Get the last name of the user accessing.|

docSrc/sections/usage.tpl

@@ -63,6 +63,8 @@ The following data can be retrieved from the token:
 |CLAIM_INSTANCE_NAME|instance_name|getInstanceName()|Get the (plugin) instance name for which the token was issued.|
 |CLAIM_USER_ID|sub|getUserId()|Get the id of the authenticated user.|
 |CLAIM_USER_EXTERNAL_ID|external_id|getUserExternalId()|Get the id of the user in an external system.|
+|CLAIM_USER_USERNAME|username|getUserUsername()|Get the username of the user accessing.|
+|CLAIM_USER_PRIMARY_EMAIL_ADDRESS|primary_email_address|getUserPrimaryEmailAddress()|Get the primary email address of the user accessing.|
 |CLAIM_USER_FULL_NAME|name|getFullName()|Get either the combined name of the user or the name of the token.|
 |CLAIM_USER_FIRST_NAME|given_name|getFirstName()|Get the first name of the user accessing.|
 |CLAIM_USER_LAST_NAME|family_name|getLastName()|Get the last name of the user accessing.|

docs/API.MD

@@ -1,20 +1,4 @@
 
-## Classes
-Global | Description
------- | -----------
-SSOToken | SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
-SSOTokenData : SSOTokenData | SSOTokenData Class used to host the token data values and provide getter functions to extract correspinding values.
-
-## Functions
-Global | Description
------- | -----------
-ssoMiddleWare(secret, audience) ⇒ function | Mountable express middleware functions
-readKeyFile(path, cb) ⇒ String | Reads public key file from the specified path and returns a string representation
-of the key to be used to decode token.
-asCert(cert, type) ⇒ string | asCert converts a binary encoded key to PKCS8 format
-isPKCS8Format(key, type) ⇒ Boolean | Checks if the format of the key is similar to PKCS8 Format.
-transformKeyToFormat(key, type) ⇒ String | Transforms the provided key to PKCS8 format for supported jwt algorithm.
-
 ## SSOToken
 SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
 
@@ -60,6 +44,8 @@ SSOTokenData Class used to host the token data values and provide getter functio
     * [.getInstanceName()](#markdown-header-ssotokendatagetinstancename-nullstring) ⇒ null ⎮ string
     * [.getUserId()](#markdown-header-ssotokendatagetuserid-nullstring) ⇒ null ⎮ string
     * [.getUserExternalId()](#markdown-header-ssotokendatagetuserexternalid-nullstring) ⇒ null ⎮ string
+    * [.getUserUsername()](#markdown-header-ssotokendatagetuserusername-nullstring) ⇒ null ⎮ string
+    * [.getUserPrimaryEmailAddress()](#markdown-header-ssotokendatagetuserprimaryemailaddress-nullstring) ⇒ null ⎮ string
     * [.getFullName()](#markdown-header-ssotokendatagetfullname-nullstring) ⇒ null ⎮ string
     * [.getFirstName()](#markdown-header-ssotokendatagetfirstname-nullstring) ⇒ null ⎮ string
     * [.getLastName()](#markdown-header-ssotokendatagetlastname-nullstring) ⇒ null ⎮ string
@@ -164,6 +150,14 @@ Get the id of the user in an external system.
 Example use case would be to map user from an external store
 to the entry defined in the token.
 
+**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
+### ssoTokenData.getUserUsername() ⇒ null ⎮ string
+Get the username of the user accessing.
+
+**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
+### ssoTokenData.getUserPrimaryEmailAddress() ⇒ null ⎮ string
+Get the primary email address of the user accessing.
+
 **Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
 ### ssoTokenData.getFullName() ⇒ null ⎮ string
 Get either the combined name of the user or the name of the token.

src/lib/SSOToken.js

@@ -85,6 +85,8 @@ class SSOToken {
       CLAIM_INSTANCE_NAME: decoded.instance_name || null,
       CLAIM_USER_ID: decoded.sub || null,
       CLAIM_USER_EXTERNAL_ID: decoded.external_id || null,
+      CLAIM_USER_USERNAME: decoded.username || null,
+      CLAIM_USER_PRIMARY_EMAIL_ADDRESS: decoded.primary_email_address || null,
       CLAIM_USER_FULL_NAME: decoded.name || null,
       CLAIM_USER_FIRST_NAME: decoded.given_name || null,
       CLAIM_USER_LAST_NAME: decoded.family_name || null,

src/lib/SSOTokenData.js

@@ -21,6 +21,8 @@ class SSOTokenData {
     this.instance_name = tokenVals.CLAIM_INSTANCE_NAME;
     this.sub = tokenVals.CLAIM_USER_ID;
     this.external_id = tokenVals.CLAIM_USER_EXTERNAL_ID;
+    this.username = tokenVals.CLAIM_USER_USERNAME;
+    this.primary_email_address = tokenVals.CLAIM_USER_PRIMARY_EMAIL_ADDRESS;
     this.name = tokenVals.CLAIM_USER_FULL_NAME;
     this.given_name = tokenVals.CLAIM_USER_FIRST_NAME;
     this.family_name = tokenVals.CLAIM_USER_LAST_NAME;
@@ -113,6 +115,8 @@ class SSOTokenData {
       instance_name: this.instance_name,
       sub: this.sub,
       external_id: this.external_id,
+      username: this.username,
+      primary_email_address: this.primary_email_address,
       name: this.name,
       given_name: this.given_name,
       family_name: this.family_name,
@@ -139,6 +143,8 @@ class SSOTokenData {
       CLAIM_INSTANCE_NAME: this.instance_name,
       CLAIM_USER_ID: this.sub,
       CLAIM_USER_EXTERNAL_ID: this.external_id,
+      CLAIM_USER_USERNAME: this.username,
+      CLAIM_USER_PRIMARY_EMAIL_ADDRESS: this.primary_email_address,
       CLAIM_USER_FULL_NAME: this.name,
       CLAIM_USER_FIRST_NAME: this.given_name,
       CLAIM_USER_LAST_NAME: this.family_name,
@@ -247,6 +253,24 @@ class SSOTokenData {
     return this._getClaim('CLAIM_USER_EXTERNAL_ID');
   }
 
+  /**
+   * Get the username of the user accessing.
+   *
+   * @return {null|string}
+   */
+  getUserUsername() {
+    return this._getClaim('CLAIM_USER_USERNAME');
+  }
+
+  /**
+   * Get the primary email address of the user accessing.
+   *
+   * @return {null|string}
+   */
+  getUserPrimaryEmailAddress() {
+    return this._getClaim('CLAIM_USER_PRIMARY_EMAIL_ADDRESS');
+  }
+
   /**
    * Get either the combined name of the user or the name of the token.
    *

src/tests/SSOToken.test.js

@@ -26,6 +26,8 @@ const tokenDataVals = {
   CLAIM_INSTANCE_NAME: 'Our locations',
   CLAIM_USER_ID: '541954c3e4b08bbdce1a340a',
   CLAIM_USER_EXTERNAL_ID: 'jdoe',
+  CLAIM_USER_USERNAME: 'john.doe',
+  CLAIM_USER_PRIMARY_EMAIL_ADDRESS: 'jdoe@email.com',
   CLAIM_USER_FULL_NAME: 'John Doe',
   CLAIM_USER_FIRST_NAME: 'John',
   CLAIM_USER_LAST_NAME: 'Doe',
@@ -150,6 +152,8 @@ describe('Testing SSOToken Class', () => {
         family_name: 'Doe',
         given_name: 'John',
         external_id: 'jdoe',
+        username: 'john.doe',
+        primary_email_address: 'jdoe@email.com',
         iat: curTime,
         instance_id: '55c79b6ee4b06c6fb19bd1e2',
         instance_name: 'Our locations',

src/tests/SSOTokenData.test.js

@@ -18,6 +18,8 @@ const tokenDataVals = {
   CLAIM_INSTANCE_NAME: 'Our locations',
   CLAIM_USER_ID: '541954c3e4b08bbdce1a340a',
   CLAIM_USER_EXTERNAL_ID: 'jdoe',
+  CLAIM_USER_USERNAME: 'john.doe',
+  CLAIM_USER_PRIMARY_EMAIL_ADDRESS: 'jdoe@email.com',
   CLAIM_USER_FULL_NAME: 'John Doe',
   CLAIM_USER_FIRST_NAME: 'John',
   CLAIM_USER_LAST_NAME: 'Doe',

src/utils/tokenDataConsts.js

@@ -8,6 +8,8 @@ const constants = {
   CLAIM_INSTANCE_NAME: 'instance_name',
   CLAIM_USER_ID: 'sub',
   CLAIM_USER_EXTERNAL_ID: 'external_id',
+  CLAIM_USER_USERNAME: 'username',
+  CLAIM_USER_PRIMARY_EMAIL_ADDRESS: 'primary_email_address',
   CLAIM_USER_FULL_NAME: 'name',
   CLAIM_USER_FIRST_NAME: 'given_name',
   CLAIM_USER_LAST_NAME: 'family_name',