@microsoft/teamsfx 0.6.3-alpha.768a76f6e.0 → 0.6.3-alpha.81c48cbfc.0

package/dist/index.node.cjs.js

@@ -12,6 +12,7 @@ var botbuilder = require('botbuilder');
 var botbuilderDialogs = require('botbuilder-dialogs');
 var uuid = require('uuid');
 var axios = require('axios');
+var https = require('https');
 var path = require('path');
 var fs = require('fs');
 
@@ -121,6 +122,9 @@ ErrorMessage.FailToAcquireTokenOnBehalfOfUser = "Failed to acquire access token
 ErrorMessage.OnlyMSTeamsChannelSupported = "{0} is only supported in MS Teams Channel";
 // IdentityTypeNotSupported Error
 ErrorMessage.IdentityTypeNotSupported = "{0} identity is not supported in {1}";
+// InvalidParameter Error
+ErrorMessage.EmptyParameter = "Parameter {0} is empty";
+ErrorMessage.DuplicateHttpsOptionProperty = "Axios HTTPS agent already defined value for property {0}";
 /**
  * Error class with code and message thrown by the SDK.
  *
@@ -1506,6 +1510,105 @@ class BearerTokenAuthProvider {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+/**
+ * Provider that handles Certificate authentication
+ *
+ * @beta
+ */
+class CertificateAuthProvider {
+    /**
+     *
+     * @param { SecureContextOptions } certOption - information about the cert used in http requests
+     *
+     * @beta
+     */
+    constructor(certOption) {
+        if (certOption && Object.keys(certOption).length !== 0) {
+            this.certOption = certOption;
+        }
+        else {
+            throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "certOption"), exports.ErrorCode.InvalidParameter);
+        }
+    }
+    /**
+     * Adds authentication info to http requests.
+     *
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @returns Updated axios request config.
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when custom httpsAgent in the request has duplicate properties with certOption provided in constructor.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            if (!config.httpsAgent) {
+                config.httpsAgent = new https.Agent(this.certOption);
+            }
+            else {
+                const existingProperties = new Set(Object.keys(config.httpsAgent.options));
+                for (const property of Object.keys(this.certOption)) {
+                    if (existingProperties.has(property)) {
+                        throw new ErrorWithCode(formatString(ErrorMessage.DuplicateHttpsOptionProperty, property), exports.ErrorCode.InvalidParameter);
+                    }
+                }
+                Object.assign(config.httpsAgent.options, this.certOption);
+            }
+            return config;
+        });
+    }
+}
+/**
+ * Helper to create SecureContextOptions from PEM format cert
+ *
+ * @param { string | Buffer } cert - The cert chain in PEM format
+ * @param { string | Buffer } key - The private key for the cert chain
+ * @param { string? } passphrase - The passphrase for private key
+ * @param { string? | Buffer? } ca - Overrides the trusted CA certificates
+ *
+ * @returns Instance of SecureContextOptions
+ *
+ * @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
+ *
+ */
+function createPemCertOption(cert, key, passphrase, ca) {
+    if (cert.length === 0) {
+        throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "cert"), exports.ErrorCode.InvalidParameter);
+    }
+    if (key.length === 0) {
+        throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "key"), exports.ErrorCode.InvalidParameter);
+    }
+    return {
+        cert,
+        key,
+        passphrase,
+        ca,
+    };
+}
+/**
+ * Helper to create SecureContextOptions from PFX format cert
+ *
+ * @param { string | Buffer } pfx - The content of .pfx file
+ * @param { string? } passphrase - Optional. The passphrase of .pfx file
+ *
+ * @returns Instance of SecureContextOptions
+ *
+ * @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
+ *
+ */
+function createPfxCertOption(pfx, passphrase) {
+    if (pfx.length === 0) {
+        throw new ErrorWithCode(formatString(ErrorMessage.EmptyParameter, "pfx"), exports.ErrorCode.InvalidParameter);
+    }
+    return {
+        pfx,
+        passphrase,
+    };
+}
+
 // Copyright (c) Microsoft Corporation.
 /**
  * A class providing credential and configuration.
@@ -2703,6 +2806,7 @@ class MessageBuilder {
 
 exports.AppCredential = AppCredential;
 exports.BearerTokenAuthProvider = BearerTokenAuthProvider;
+exports.CertificateAuthProvider = CertificateAuthProvider;
 exports.Channel = Channel;
 exports.CommandBot = CommandBot;
 exports.ConversationBot = ConversationBot;
@@ -2718,6 +2822,8 @@ exports.TeamsFx = TeamsFx;
 exports.TeamsUserCredential = TeamsUserCredential;
 exports.createApiClient = createApiClient;
 exports.createMicrosoftGraphClient = createMicrosoftGraphClient;
+exports.createPemCertOption = createPemCertOption;
+exports.createPfxCertOption = createPfxCertOption;
 exports.getLogLevel = getLogLevel;
 exports.getTediousConnectionConfig = getTediousConnectionConfig;
 exports.sendAdaptiveCard = sendAdaptiveCard;