-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Add FIC sample for JS * Update Echo Proxy Bot references
- Loading branch information
1 parent
84fab35
commit 102b72b
Showing
61 changed files
with
2,255 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| MicrosoftAppType= | ||
| MicrosoftAppId= | ||
| MicrosoftAppClientId= | ||
| MicrosoftAppTenantId= |
15 changes: 15 additions & 0 deletions
15
samples/javascript_nodejs/86.bot-authentication-fic/.eslintrc.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| /* eslint-disable */ | ||
| module.exports = { | ||
| "extends": "standard", | ||
| "rules": { | ||
| "semi": [2, "always"], | ||
| "indent": [2, 4], | ||
| "no-return-await": 0, | ||
| "space-before-function-paren": [2, { | ||
| "named": "never", | ||
| "anonymous": "never", | ||
| "asyncArrow": "always" | ||
| }], | ||
| "template-curly-spacing": [2, "always"] | ||
| } | ||
| }; |
82 changes: 82 additions & 0 deletions
82
samples/javascript_nodejs/86.bot-authentication-fic/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| # Authentication Bot using Federation Identity Certificate (FIC) | ||
|
|
||
| Bot Framework v4 bot authentication using Federation Identity Certificate (FIC). Currently, FIC feature is supported for Microsoft tenants only. | ||
|
|
||
| This bot has been created using [Bot Framework](https://dev.botframework.com/), is shows how to use the bot authencation capabilities of Azure Bot Service. In this sample, we use federated identity certificate configuration to create the Bot Framework Authentication. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [Node.js](https://nodejs.org) version 18 or higher | ||
|
|
||
| ```bash | ||
| # determine node version | ||
| node --version | ||
| ``` | ||
|
|
||
| - [Bot Framework SDK](https://github.com/microsoft/botbuilder-dotnet/releases) version 4.23.1 onwards | ||
|
|
||
| ## To try this sample | ||
|
|
||
| - In a terminal, navigate to `samples/javascript_nodejs/86.bot-authentication-fic` | ||
|
|
||
| ```bash | ||
| cd samples/javascript_nodejs/86.bot-authentication-fic | ||
| ``` | ||
|
|
||
| - Install modules | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| - Create an user assigned managed identity. | ||
|
|
||
| - Record the client ID of the managed identity and add the same to .env file. | ||
|
|
||
| - Create Azure App and Bot | ||
|
|
||
| - Create App Registration | ||
| - This can be either Single or Multi tenant. | ||
| - Record the Application ID. | ||
| - Add the Federation Identity Certificate (FIC) to the App Registration. | ||
| - To create trust using the FIC, we need to link the managed identity to the App Registration. | ||
| - Click on the add credential under Federated Credential | ||
| - On the Add a credential page, select the Federated credential scenario as "Customer Managed Keys". | ||
| - Select the managed identity that you created in the previous step. | ||
| - Enter name for the credential and click on Add. | ||
| - Create an Azure Bot in the desired resource group. Use the App Registration from the previous step. | ||
|
|
||
| - Add the User managed identity created in previous step to the Azure App Service under Configuration -> Identity -> User Assigned Managed Identity. | ||
|
|
||
| - Set .env variables | ||
|
|
||
| - MicrosoftAppType: {SingTenant | MultiTenant} | ||
|
|
||
| - MicrosoftAppId: {appId} | ||
|
|
||
| - MicrosoftAppTenantId: {tenantId} | ||
|
|
||
| - MicrosoftAppClientId: {clientId of managed identity} | ||
|
|
||
| - Start the bot | ||
|
|
||
| ```bash | ||
| npm start | ||
| ``` | ||
|
|
||
| ## Deploy the bot to Azure | ||
|
|
||
| To learn more about deploying a bot to Azure, see [Deploy your bot to Azure](https://aka.ms/azuredeployment) for a complete list of deployment instructions. | ||
|
|
||
| ## Further reading | ||
|
|
||
| - [Bot Framework Documentation](https://docs.botframework.com) | ||
| - [Bot Basics](https://docs.microsoft.com/azure/bot-service/bot-builder-basics?view=azure-bot-service-4.0) | ||
| - [Activity processing](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-concept-activity-processing?view=azure-bot-service-4.0) | ||
| - [Azure Bot Service Introduction](https://docs.microsoft.com/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0) | ||
| - [Azure Bot Service Documentation](https://docs.microsoft.com/azure/bot-service/?view=azure-bot-service-4.0) | ||
| - [.NET Core CLI tools](https://docs.microsoft.com/en-us/dotnet/core/tools/?tabs=netcore2x) | ||
| - [Azure CLI](https://docs.microsoft.com/cli/azure/?view=azure-cli-latest) | ||
| - [Azure Portal](https://portal.azure.com) | ||
| - [Language Understanding using LUIS](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/) | ||
| - [Channels and Bot Connector Service](https://docs.microsoft.com/en-us/azure/bot-service/bot-concepts?view=azure-bot-service-4.0) |
32 changes: 32 additions & 0 deletions
32
samples/javascript_nodejs/86.bot-authentication-fic/bot.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| const { ActivityHandler, MessageFactory } = require('botbuilder'); | ||
|
|
||
| class EchoBot extends ActivityHandler { | ||
| constructor() { | ||
| super(); | ||
| // See https://aka.ms/about-bot-activity-message to learn more about the message and other activity types. | ||
| this.onMessage(async (context, next) => { | ||
| const replyText = `Echo: ${ context.activity.text }`; | ||
| const message = MessageFactory.text(replyText, replyText); | ||
| await context.sendActivity(message); | ||
| // By calling next() you ensure that the next BotHandler is run. | ||
| await next(); | ||
| }); | ||
|
|
||
| this.onMembersAdded(async (context, next) => { | ||
| const membersAdded = context.activity.membersAdded; | ||
| const welcomeText = 'Hello and welcome to Echo Bot Using Federated Identity Credentials !!'; | ||
| for (let cnt = 0; cnt < membersAdded.length; ++cnt) { | ||
| if (membersAdded[cnt].id !== context.activity.recipient.id) { | ||
| await context.sendActivity(MessageFactory.text(welcomeText, welcomeText)); | ||
| } | ||
| } | ||
| // By calling next() you ensure that the next BotHandler is run. | ||
| await next(); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| module.exports.EchoBot = EchoBot; |
2 changes: 2 additions & 0 deletions
2
samples/javascript_nodejs/86.bot-authentication-fic/deploymentScripts/linux/.deployment
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| [config] | ||
| command = ./deploy.sh |
100 changes: 100 additions & 0 deletions
100
samples/javascript_nodejs/86.bot-authentication-fic/deploymentScripts/linux/deploy.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| #!/bin/bash | ||
|
|
||
| # ---------------------- | ||
| # KUDU Deployment Script | ||
| # Version: 1.0.17 | ||
| # ---------------------- | ||
|
|
||
| # Helpers | ||
| # ------- | ||
|
|
||
| exitWithMessageOnError () { | ||
| if [ ! $? -eq 0 ]; then | ||
| echo "An error has occurred during web site deployment." | ||
| echo $1 | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| # Prerequisites | ||
| # ------------- | ||
|
|
||
| # Verify node.js installed | ||
| hash node 2>/dev/null | ||
| exitWithMessageOnError "Missing node.js executable, please install node.js, if already installed make sure it can be reached from current environment." | ||
|
|
||
| # Setup | ||
| # ----- | ||
|
|
||
| SCRIPT_DIR="${BASH_SOURCE[0]%\\*}" | ||
| SCRIPT_DIR="${SCRIPT_DIR%/*}" | ||
| ARTIFACTS=$SCRIPT_DIR/../artifacts | ||
| KUDU_SYNC_CMD=${KUDU_SYNC_CMD//\"} | ||
|
|
||
| if [[ ! -n "$DEPLOYMENT_SOURCE" ]]; then | ||
| DEPLOYMENT_SOURCE=$SCRIPT_DIR | ||
| fi | ||
|
|
||
| if [[ ! -n "$NEXT_MANIFEST_PATH" ]]; then | ||
| NEXT_MANIFEST_PATH=$ARTIFACTS/manifest | ||
|
|
||
| if [[ ! -n "$PREVIOUS_MANIFEST_PATH" ]]; then | ||
| PREVIOUS_MANIFEST_PATH=$NEXT_MANIFEST_PATH | ||
| fi | ||
| fi | ||
|
|
||
| if [[ ! -n "$DEPLOYMENT_TARGET" ]]; then | ||
| DEPLOYMENT_TARGET=$ARTIFACTS/wwwroot | ||
| else | ||
| KUDU_SERVICE=true | ||
| fi | ||
|
|
||
| if [[ ! -n "$KUDU_SYNC_CMD" ]]; then | ||
| # Install kudu sync | ||
| echo Installing Kudu Sync | ||
| npm install kudusync -g --silent | ||
| exitWithMessageOnError "npm failed" | ||
|
|
||
| if [[ ! -n "$KUDU_SERVICE" ]]; then | ||
| # In case we are running locally this is the correct location of kuduSync | ||
| KUDU_SYNC_CMD=kuduSync | ||
| else | ||
| # In case we are running on kudu service this is the correct location of kuduSync | ||
| KUDU_SYNC_CMD=$APPDATA/npm/node_modules/kuduSync/bin/kuduSync | ||
| fi | ||
| fi | ||
|
|
||
| # Node Helpers | ||
| # ------------ | ||
|
|
||
| selectNodeVersion () { | ||
| NPM_CMD=npm | ||
| NODE_EXE=node | ||
| } | ||
|
|
||
| ################################################################################################################################## | ||
| # Deployment | ||
| # ---------- | ||
|
|
||
| echo Handling node.js deployment. | ||
|
|
||
| # 1. KuduSync | ||
| if [[ "$IN_PLACE_DEPLOYMENT" -ne "1" ]]; then | ||
| "$KUDU_SYNC_CMD" -v 50 -f "$DEPLOYMENT_SOURCE" -t "$DEPLOYMENT_TARGET" -n "$NEXT_MANIFEST_PATH" -p "$PREVIOUS_MANIFEST_PATH" -i ".git;.hg;.deployment;deploy.sh" | ||
| exitWithMessageOnError "Kudu Sync failed" | ||
| fi | ||
|
|
||
| # 2. Select node version | ||
| selectNodeVersion | ||
|
|
||
| # 3. Install npm packages | ||
| if [ -e "$DEPLOYMENT_TARGET/package.json" ]; then | ||
| cd "$DEPLOYMENT_TARGET" | ||
| echo "Running $NPM_CMD install --production" | ||
| eval $NPM_CMD install --production | ||
| exitWithMessageOnError "npm failed" | ||
| cd - > /dev/null | ||
| fi | ||
|
|
||
| ################################################################################################################################## | ||
| echo "Finished successfully." |
2 changes: 2 additions & 0 deletions
2
samples/javascript_nodejs/86.bot-authentication-fic/deploymentScripts/windows/.deployment
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| [config] | ||
| command = deploy.cmd |
Oops, something went wrong.