azure/runtime/ms-rest/lib/credentials/basicAuthenticationCredentials.js

Microsoft Azure Client Library for node

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

'use strict';

const Constants = require('../constants');
const HeaderConstants = Constants.HeaderConstants;
const DEFAULT_AUTHORIZATION_SCHEME = 'Basic';

/**
 * Creates a new BasicAuthenticationCredentials object.
 *
 * @constructor
 * @param {string} userName                 User name.
 * @param {string} password                 Password.
 * @param {string} [authorizationScheme]    The authorization scheme.
 */
class BasicAuthenticationCredentials {
  constructor(userName, password, authorizationScheme) {
    if (userName === null || userName === undefined || typeof userName.valueOf() !== 'string') {
      throw new Error('userName cannot be null or undefined and must be of type string.');
    }
    if (password === null || password === undefined || typeof password.valueOf() !== 'string') {
      throw new Error('password cannot be null or undefined and must be of type string.');
    }
    this.userName = userName;
    this.password = password;
    this.authorizationScheme = authorizationScheme;
    if (!this.authorizationScheme) {
      this.authorizationScheme = DEFAULT_AUTHORIZATION_SCHEME;
    }
  }

  /**
   * Signs a request with the Authentication header.
   *
   * @param {WebResource} The WebResource to be signed.
   * @param {function(error)}  callback  The callback function.
   * @return {undefined}
   */
  signRequest(webResource, callback) {
    let credentials = `${this.userName}:${this.password}`;
    let encodedCredentials = `${this.authorizationScheme} ${Buffer.from(credentials).toString('base64')}`;
    webResource.headers[HeaderConstants.AUTHORIZATION] = encodedCredentials;
    return callback(null);
  }
}

module.exports = BasicAuthenticationCredentials;