Merge pull request #194 from AzureAD/dev

Release 0.1.28

Author: lovemaths

README.md

@@ -2,7 +2,7 @@
 The ADAL for node.js library makes it easy for node.js applications to authenticate to AAD in order to access AAD protected web resources.  It supports 3 authentication modes shown in the quickstart code below.
 
 ## Versions
-Current version - 0.1.27  
+Current version - 0.1.28  
 Minimum recommended version - 0.1.22  
 You can find the changes for each version in the [change log](https://github.com/AzureAD/azure-activedirectory-library-for-nodejs/blob/master/changelog.txt).
 
@@ -29,6 +29,20 @@ All code is licensed under the Apache 2.0 license and we triage actively on GitH
 
 ``` $ npm install adal-node ```
 
+### Configure the logging
+
+```javascript
+var logging = require('adal-node').Logging;
+
+logging.setLoggingOptions({
+  log: function(level, message, error) {
+    // provide your own implementation of the log function
+  },
+  level: logging.LOGGING_LEVEL.VERBOSE, // provide the logging level
+  loggingWithPII: false  // Determine if you want to log personal identitification information. The default value is false.
+});
+```
+
 ### Authorization Code
 
 See the [website sample](https://github.com/MSOpenTech/azure-activedirectory-library-for-nodejs/blob/master/sample/website-sample.js) for a complete bare bones express based web site that makes use of the code below.
@@ -103,7 +117,7 @@ app.get('/getAToken', function(req, res) {
 See the [client credentials sample](https://github.com/MSOpenTech/azure-activedirectory-library-for-nodejs/blob/master/sample/client-credentials-sample.js).
 
 ```javascript
-var adal = require('adal-node').AuthenticationContext;
+var AuthenticationContext = require('adal-node').AuthenticationContext;
 
 var authorityHostUrl = 'https://login.windows.net';
 var tenant = 'myTenant.onmicrosoft.com'; // AAD Tenant name.

changelog.md

@@ -1,3 +1,8 @@
+Version 0.1.28
+--------------
+Release Date: 26 Feburary 2018
+* Added GDPR support per Microsoft policy.
+
 Version 0.1.27
 --------------
 Release Date: 08 January 2018

lib/adal.d.ts

@@ -25,10 +25,12 @@ type LoggingCallback = (level: LoggingLevel, message: string, error?: Error) =>
  * @memberOf Logging
  * @property {LoggingCallback} [log] The function to call when ADAL generates a log entry.
  * @property {LoggingLevel} [level] The maximum level of log entries to generate.
+ * @property {boolean} [loggingWithPII] This value indicts if personal identity related information such as token and claims should be logged. The default value is false.
  */
 interface LoggingOptions {
   log?: LoggingCallback;
   level?: LoggingLevel;
+  loggingWithPII?: boolean;
 }
 
 export class Logging {

lib/authentication-parameters.js

@@ -236,19 +236,20 @@ exports.createAuthenticationParametersFromUrl = function(url, callback, correlat
     var logContext = log.createLogContext(correlationId);
     var logger = new log.Logger('AuthenticationParameters', logContext);
 
-    logger.verbose('Attempting to retrieve authentication parameters from: ' + challengeUrl);
+    logger.verbose('Attempting to retrieve authentication parameters');
+    logger.verbose('Attempting to retrieve authentication parameters from: ' + challengeUrl, true);
     var options = util.createRequestOptions( { _callContext : { _logContext: logContext } } );
     request.get(challengeUrl, options, function(err, response) {
       if (err) {
-        logger.error('Authentication parameters http get failed.', err);
+        logger.error('Authentication parameters http get failed.', err, true);
         callback(err);
         return;
       }
       var parameters;
       try {
         parameters = exports.createAuthenticationParametersFromResponse(response);
       } catch(creationErr) {
-        logger.error('Unable to parse response in to authentication paramaters.', creationErr);
+        logger.error('Unable to parse response in to authentication paramaters.', creationErr, true);
         callback(creationErr);
         return;
       }

lib/authority.js

@@ -135,7 +135,7 @@ Authority.prototype._performStaticInstanceDiscovery = function() {
 };
 
 Authority.prototype._createAuthorityUrl = function() {
-  return 'https://' + this._url.host + '/' + this._tenant + AADConstants.AUTHORIZE_ENDPOINT_PATH;
+  return 'https://' + this._url.host + '/' + encodeURIComponent(this._tenant) + AADConstants.AUTHORIZE_ENDPOINT_PATH;
 };
 
 /**
@@ -166,7 +166,8 @@ Authority.prototype._performDynamicInstanceDiscovery = function(callback) {
 
     var getOptions = util.createRequestOptions(self);
 
-    this._log.verbose('Attempting instance discover at: ' + url.format(discoveryEndpoint));
+    this._log.verbose('Attempting instance discover');
+    this._log.verbose('Attempting instance discover at: ' + url.format(discoveryEndpoint), true);
     request.get(discoveryEndpoint, getOptions, util.createRequestHandler('Instance Discovery', this._log, callback,
       function(response, body) {
         var discoveryResponse = JSON.parse(body);
@@ -227,11 +228,11 @@ Authority.prototype._getOAuthEndpoints = function(tenantDiscoveryEndpoint, callb
   } else {
     // fallback to the well known token endpoint path.
     if (!this._tokenEndpoint){
-       this._tokenEndpoint = url.format('https://' + this._url.host + '/' + this._tenant) + AADConstants.TOKEN_ENDPOINT_PATH;
+       this._tokenEndpoint = url.format('https://' + this._url.host + '/' + encodeURIComponent(this._tenant)) + AADConstants.TOKEN_ENDPOINT_PATH;
     }
 
     if (!this._deviceCodeEndpoint){
-       this._deviceCodeEndpoint = url.format('https://' + this._url.host + '/' + this._tenant) + AADConstants.DEVICE_ENDPOINT_PATH;
+       this._deviceCodeEndpoint = url.format('https://' + this._url.host + '/' + encodeURIComponent(this._tenant)) + AADConstants.DEVICE_ENDPOINT_PATH;
     }
 
     callback();
@@ -255,7 +256,8 @@ Authority.prototype.validate = function(callContext, callback) {
   var self = this;
 
   if (!this._validated) {
-    this._log.verbose('Performing instance discovery: ' + url.format(this._url));
+    this._log.verbose('Performing instance discovery');
+    this._log.verbose('Performing instance discovery: ' + url.format(this._url), true);
     this._validateViaInstanceDiscovery(function(err, tenantDiscoveryEndpoint) {
       if (err)
       {
@@ -267,7 +269,8 @@ Authority.prototype.validate = function(callContext, callback) {
       }
     });
   } else {
-    this._log.verbose('Instance discovery/validation has either already been completed or is turned off: ' + url.format(this._url));
+    this._log.verbose('Instance discovery/validation has either already been completed or is turned off');
+    this._log.verbose('Instance discovery/validation has either already been completed or is turned off: ' + url.format(this._url), true);
     this._getOAuthEndpoints(null, callback);
     return;
   }

lib/cache-driver.js

@@ -157,7 +157,7 @@ CacheDriver.prototype._getPotentialEntries = function(query, callback) {
   }
 
   this._log.verbose('Looking for potential cache entries:');
-  this._log.verbose(JSON.stringify(potentialEntriesQuery));
+  this._log.verbose(JSON.stringify(potentialEntriesQuery), true);
   this._find(potentialEntriesQuery, function(err, entries) {
     self._log.verbose('Found ' + entries.length + ' potential entries.');
     callback(err, entries);
@@ -225,7 +225,8 @@ CacheDriver.prototype._loadSingleEntryFromCache = function(query, callback) {
       }
     }
     if (returnVal) {
-      self._log.verbose('Returning token from cache lookup, ' + createTokenIdMessage(returnVal));
+      self._log.verbose('Returning token from cache lookup');
+      self._log.verbose('Returning token from cache lookup, ' + createTokenIdMessage(returnVal), true);
     }
     callback(null, returnVal, isResourceTenantSpecific);
   });
@@ -279,7 +280,7 @@ CacheDriver.prototype._refreshExpiredEntry = function(entry, callback) {
     var newEntry = self._createEntryFromRefresh(entry, tokenResponse);
     self._replaceEntry(entry, newEntry, function(err) {
       if (err) {
-        self._log.error('error refreshing expired token', err);
+        self._log.error('error refreshing expired token', err, true);
       } else {
         self._log.info('Returning token refreshed after expiry.');
       }
@@ -304,7 +305,7 @@ CacheDriver.prototype._acquireNewTokenFromMrrt = function(entry, callback) {
     var newEntry = self._createEntryFromRefresh(entry, tokenResponse);
     self.add(newEntry, function(err) {
       if (err) {
-        self._log.error('error refreshing mrrt', err);
+        self._log.error('error refreshing mrrt', err, true);
       } else {
         self._log.info('Returning token derived from mrrt refresh.');
       }
@@ -348,7 +349,8 @@ CacheDriver.prototype._refreshEntryIfNecessary = function(entry, isResourceSpeci
 CacheDriver.prototype.find = function(query, callback) {
   var self = this;
   query = query || {};
-  this._log.verbose('finding with query:' + JSON.stringify(query));
+  this._log.verbose('finding using query');
+  this._log.verbose('finding with query:' + JSON.stringify(query), true);
   this._loadSingleEntryFromCache(query, function(err, entry, isResourceTenantSpecific) {
     if (err) {
       callback(err);
@@ -499,6 +501,7 @@ CacheDriver.prototype._augmentEntryWithCacheMetadata = function(entry) {
  */
 CacheDriver.prototype.add = function(entry, callback) {
   var self = this;
+  this._log.verbose('Adding entry');
   this._log.verbose('Adding entry, ' + createTokenIdMessage(entry));
 
   this._augmentEntryWithCacheMetadata(entry);

lib/log.js

@@ -92,6 +92,10 @@ var Logging = {
       options.level = this.LOGGING_LEVEL.ERROR;
     }
 
+    if (options.loggingWithPII != true) {
+      options.loggingWithPII = false;
+    }
+    
     this.LogOptions = options;
   },
 
@@ -111,6 +115,7 @@ var Logging = {
   LogOptions : {
     log : function() {},
     level : 0,
+    loggingWithPII: false
   }
 };
 
@@ -141,8 +146,13 @@ Object.defineProperty(Logger.prototype, 'context', {
  * @param  {string|function} message A message string, or a function that returns a message string, to log.
  * @param  {Error} [error] If this is a {@link Logging.LOGGING_LEVEL.ERROR|ERROR} level log entry then the caller
  *                       should pass an error object in this parameter.
+ * @param  {boolean} [containsPII] Determines if the log message contains personal information. Default value is false.
  */
-Logger.prototype.log = function(level, message, error) {
+Logger.prototype.log = function (level, message, error, containsPII) {
+  if (containsPII == true && !Logging.LogOptions.loggingWithPII) {
+    return;
+  }
+
   if (level <= Logging.LogOptions.level) {
     if (_.isFunction(message)) {
       message = message();
@@ -163,43 +173,48 @@ Logger.prototype.log = function(level, message, error) {
  * Generate an {@link Logging.LOGGING_LEVEL.ERROR|ERROR} level log entry.
  * @param  {string} message A message to log
  * @param  {Error} error The Error object associated with this log entry
+ * @param  {boolean} [containsPII] Determines if the log message contains personal information. Default value is false.
  */
-Logger.prototype.error = function(message, error) {
-  this.log(Logging.LOGGING_LEVEL.ERROR, message, error);
+Logger.prototype.error = function (message, error, containsPII) {
+  this.log(Logging.LOGGING_LEVEL.ERROR, message, error, containsPII);
 };
 
 /**
  * Generate an {@link Logging.LOGGING_LEVEL.WARN|WARN} level log entry.
  * @param  {string} message A message to log
+ * @param  {boolean} [containsPII] Determines if the log message contains personal information. Default value is false.
  */
-Logger.prototype.warn = function(message) {
-  this.log(Logging.LOGGING_LEVEL.WARN, message, null);
+Logger.prototype.warn = function (message, containsPII) {
+  this.log(Logging.LOGGING_LEVEL.WARN, message, null, containsPII);
 };
 
 /**
  * Generate an {@link Logging.LOGGING_LEVEL.INFO|INFO} level log entry.
  * @param  {string} message A message to log
+ * @param  {boolean} [containsPII] Determines if the log message contains personal information. Default value is false.
  */
-Logger.prototype.info = function(message) {
-  this.log(Logging.LOGGING_LEVEL.INFO, message, null);
+Logger.prototype.info = function (message, containsPII) {
+  this.log(Logging.LOGGING_LEVEL.INFO, message, null, containsPII);
 };
 
 /**
  * Generate an {@link Logging.LOGGING_LEVEL.VERBOSE|VERBOSE} level log entry.
  * @param  {string} message A message to log
+ * @param  {boolean} [containsPII] Determines if the log message contains personal information. Default value is false.
  */
-Logger.prototype.verbose = function(message) {
-  this.log(Logging.LOGGING_LEVEL.VERBOSE, message, null);
+Logger.prototype.verbose = function (message, containsPII) {
+  this.log(Logging.LOGGING_LEVEL.VERBOSE, message, null, containsPII);
 };
 
 /**
  * Generate a {@link Logging.LOGGING_LEVEL.ERROR|ERROR} level log entry, as well as an
  * Error object to go with it.  This is a convenience method for throwing logged errors.
  * @param  {string} message A message to log
+ * @param  {boolean} [containsPII] Determines if the log message contains personal information. Default value is false.
  */
-Logger.prototype.createError = function(message) {
+Logger.prototype.createError = function(message, containsPII) {
   var err = new Error(message);
-  this.error(message, err);
+  this.error(message, err, containsPII);
   return err;
 };
 

lib/mex.js

@@ -47,7 +47,8 @@ function Mex(callContext, url) {
   this._dom = null;
   this._mexDoc = null;
   this._usernamePasswordPolicy = {};
-  this._log.verbose('Mex created with url: ' + url);
+  this._log.verbose('Mex created');
+  this._log.verbose('Mex created with url: ' + url, true);
 }
 
 /**
@@ -75,6 +76,7 @@ Object.defineProperty(Mex.prototype, 'usernamePasswordPolicy', {
 * @param {Mex.DiscoverCallback}  callback  Called when discover is complete.
 */
 Mex.prototype.discover = function (callback) {
+  this._log.verbose('Retrieving mex');
   this._log.verbose('Retrieving mex at: ' + this._url);
   var self = this;
   var options = util.createRequestOptions(self, { headers : { 'Content-Type' : 'application/soap+xml'} });
@@ -89,7 +91,7 @@ Mex.prototype.discover = function (callback) {
         self._parse(callback);
         return;
       } catch (err) {
-        self._log.error('Failed to parse mex response in to DOM', err);
+        self._log.error('Failed to parse mex response in to DOM', err, true);
         callback(err);
       }
     })
@@ -119,12 +121,14 @@ Mex.prototype._checkPolicy = function(policyNode) {
     }
   }
   if (policyId) {
-    this._log.verbose('found matching policy id: ' + policyId);
+    this._log.verbose('found matching policy id');
+    this._log.verbose('found matching policy id: ' + policyId, true);
   } else {
     if (!id) {
       id = '<no id>';
     }
-    this._log.verbose('potential policy did not match required transport binding: ' + id);
+    this._log.verbose('potential policy did not match required transport binding');
+    this._log.verbose('potential policy did not match required transport binding: ' + id, true);
   }
   return policyId;
 };

lib/oauth2client.js

@@ -228,8 +228,9 @@ OAuth2Client.prototype._parseIdToken = function(encodedIdToken) {
     }
 
     idToken = JSON.parse(base64Decoded);
-  } catch(err) {
-    this._log.warn('The returned id_token could not be decoded: ' + err.stack);
+  } catch (err) {
+    this._log.warn('the returned id_token could not be decoded');
+    this._log.warn('The returned id_token could not be decoded: ' + err.stack, true);
     return;
   }
 
@@ -379,7 +380,7 @@ OAuth2Client.prototype._handleGetTokenResponse = function(response, body, callba
   try {
     tokenResponse = this._validateTokenResponse(body);
   } catch (e) {
-    this._log.error('Error validating get token response', e);
+    this._log.error('Error validating get token response', e, true);
     callback(e);
     return;
   }
@@ -391,7 +392,7 @@ OAuth2Client.prototype._handleGetDeviceCodeResponse = function(response, body, c
    try {
       deviceCodeResponse = this._validateDeviceCodeResponse(body);
    } catch (e) {
-      this._log.error('Error validating get user code response', e);
+      this._log.error('Error validating get user code response', e, true);
       callback(e);
       return;
    }
@@ -421,7 +422,7 @@ OAuth2Client.prototype._getTokenWithPolling = function (postOptions, callback) {
           try {
              tokenResponse = self._handlePollingResponse(body);
           } catch (e) {
-             self._log.error('Error validating get token response', e);
+             self._log.error('Error validating get token response', e, true);
              callback(null, e);
              return;
           }

lib/self-signed-jwt.js

@@ -87,7 +87,8 @@ SelfSignedJwt.prototype._createHeader = function(thumbprint) {
   var x5t = this._createx5tValue(thumbprint);
   var header = { typ: 'JWT', alg: 'RS256', x5t : x5t };
 
-  this._log.verbose('Creating self signed JWT header.  x5t: ' + x5t);
+  this._log.verbose('Creating self signed JWT header');
+  this._log.verbose('Creating self signed JWT header.  x5t: ' + x5t, true);
 
   return header;
 };
@@ -129,7 +130,7 @@ SelfSignedJwt.prototype._signJwt = function(header, payload, certificate) {
      jwt = jws.sign({ header : header, payload : payload, secret : certificate });
   }
   catch (err) {
-     this._log.error(err);
+     this._log.error(err, true);
      throw this._log.createError('Failed to sign JWT.This is most likely due to an invalid certificate.');   
   }