microsoft · axelsrz · Mar 11, 2020
diff --git a/...experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/README.md b/...experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/README.md
@@ -0,0 +1,38 @@
+# EchoBot
+
+Bot Framework v4 echo bot sample.
+
+This bot has been created using [Bot Framework](https://dev.botframework.com), it shows how to create a simple bot that accepts input from the user and echoes it back.
+
+## Running the sample
+- Clone the repository
+```bash
+git clone https://github.com/Microsoft/botbuilder-samples.git
+```
+- Bring up a terminal, navigate to `botbuilder-samples\samples\python\02.echo-bot` folder
+- Activate your desired virtual environment
+- In the terminal, type `pip install -r requirements.txt`
+- Run your bot with `python app.py`
+
+## Testing the bot using Bot Framework Emulator
+[Microsoft Bot Framework Emulator](https://github.com/microsoft/botframework-emulator) is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.
+
+- Install the Bot Framework emulator from [here](https://github.com/Microsoft/BotFramework-Emulator/releases)
+
+### Connect to bot using Bot Framework Emulator
+- Launch Bot Framework Emulator
+- Paste this URL in the emulator window - http://localhost:3978/api/messages
+
+## 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)
+- [Azure CLI](https://docs.microsoft.com/cli/azure/?view=azure-cli-latest)
+- [Azure Portal](https://portal.azure.com)
diff --git a/samples/experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/app.py b/samples/experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/app.py
@@ -0,0 +1,66 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from aiohttp import web
+from aiohttp.web import Request, Response, json_response
+from botbuilder.core import (
+    BotFrameworkAdapterSettings,
+    ConversationState,
+    MemoryStorage,
+    UserState,
+)
+from botbuilder.core.integration import aiohttp_error_middleware
+from botbuilder.schema import Activity
+from botframework.connector.auth import AuthenticationConfiguration
+
+from authentication import AllowedCallersClaimsValidator
+from bots import EchoBot
+from config import DefaultConfig
+from skill_adapter_with_error_handler import SkillAdapterWithErrorHandler
+
+CONFIG = DefaultConfig()
+
+# Create MemoryStorage, UserState and ConversationState
+MEMORY = MemoryStorage()
+USER_STATE = UserState(MEMORY)
+CONVERSATION_STATE = ConversationState(MEMORY)
+
+# Create adapter.
+# See https://aka.ms/about-bot-adapter to learn more about how bots work.
+VALIDATOR = AllowedCallersClaimsValidator(CONFIG).claims_validator
+SETTINGS = BotFrameworkAdapterSettings(
+    CONFIG.APP_ID,
+    CONFIG.APP_PASSWORD,
+    auth_configuration=AuthenticationConfiguration(claims_validator=VALIDATOR),
+)
+ADAPTER = SkillAdapterWithErrorHandler(SETTINGS, CONVERSATION_STATE)
+
+# Create the Bot
+BOT = EchoBot()
+
+
+# Listen for incoming requests on /api/messages
+async def messages(req: Request) -> Response:
+    # Main bot message handler.
+    if "application/json" in req.headers["Content-Type"]:
+        body = await req.json()
+    else:
+        return Response(status=415)
+
+    activity = Activity().deserialize(body)
+    auth_header = req.headers["Authorization"] if "Authorization" in req.headers else ""
+
+    response = await ADAPTER.process_activity(activity, auth_header, BOT.on_turn)
+    if response:
+        return json_response(data=response.body, status=response.status)
+    return Response(status=201)
+
+
+APP = web.Application(middlewares=[aiohttp_error_middleware])
+APP.router.add_post("/api/messages", messages)
+
+if __name__ == "__main__":
+    try:
+        web.run_app(APP, host="localhost", port=CONFIG.PORT)
+    except Exception as error:
+        raise error
diff --git a/...ental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/authentication/__init__.py b/...ental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/authentication/__init__.py
@@ -0,0 +1,3 @@
+from .allow_callers_claims_validation import AllowedCallersClaimsValidator
+
+__all__ = ["AllowedCallersClaimsValidator"]
diff --git a/.../dialog-to-dialog/dialog-echo-skill-bot/authentication/allow_callers_claims_validation.py b/.../dialog-to-dialog/dialog-echo-skill-bot/authentication/allow_callers_claims_validation.py
@@ -0,0 +1,39 @@
+from typing import Awaitable, Callable, Dict, List
+
+from botframework.connector.auth import JwtTokenValidation, SkillValidation
+
+from config import DefaultConfig
+
+
+class AllowedCallersClaimsValidator:
+
+    config_key = "ALLOWED_CALLERS"
+
+    def __init__(self, config: DefaultConfig):
+        if not config:
+            raise TypeError(
+                "AllowedCallersClaimsValidator: config object cannot be None."
+            )
+
+        # ALLOWED_CALLERS is the setting in config.py file
+        # that consists of the list of parent bot ids that are allowed to access the skill
+        # to add a new parent bot simply go to the AllowedCallers and add
+        # the parent bot's microsoft app id to the list
+        self._allowed_callers = config.ALLOWED_CALLERS
+
+    @property
+    def claims_validator(self) -> Callable[[List[Dict]], Awaitable]:
+        async def allow_callers_claims_validator(claims: Dict[str, object]):
+            # if _allowedCallers is None we allow all calls
+            if self._allowed_callers and SkillValidation.is_skill_claim(claims):
+                # Check that the appId claim in the skill request is in the list of skills configured for this bot.
+                app_id = JwtTokenValidation.get_app_id_from_claims(claims)
+                if app_id not in self._allowed_callers:
+                    raise PermissionError(
+                        f'Received a request from a bot with an app ID of "{app_id}".'
+                        f" To enable requests from this caller, add the app ID to your configuration file."
+                    )
+
+            return
+
+        return allow_callers_claims_validator
diff --git a/...es/experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/bots/__init__.py b/...es/experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/bots/__init__.py
@@ -0,0 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .echo_bot import EchoBot
+
+__all__ = ["EchoBot"]
diff --git a/...es/experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/bots/echo_bot.py b/...es/experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/bots/echo_bot.py
@@ -0,0 +1,35 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from botbuilder.core import ActivityHandler, TurnContext
+from botbuilder.schema import (
+    ChannelAccount,
+    Activity,
+    ActivityTypes,
+    EndOfConversationCodes,
+)
+
+
+class EchoBot(ActivityHandler):
+    async def on_members_added_activity(
+        self, members_added: [ChannelAccount], turn_context: TurnContext
+    ):
+        for member in members_added:
+            if member.id != turn_context.activity.recipient.id:
+                await turn_context.send_activity("Hello and welcome!")
+
+    async def on_message_activity(self, turn_context: TurnContext):
+        if "end" in turn_context.activity.text or "stop" in turn_context.activity.text:
+            await turn_context.send_activity("ending conversation from the skill...")
+            end_of_conversation = Activity(
+                type=ActivityTypes.end_of_conversation,
+                code=EndOfConversationCodes.completed_successfully,
+            )
+            await turn_context.send_activity(end_of_conversation)
+        else:
+            await turn_context.send_activity(
+                f"Echo: (Python) : {turn_context.activity.text}"
+            )
+            await turn_context.send_activity(
+                'Say "end" or "stop" and I\'ll end the conversation and back to the parent.'
+            )
diff --git a/samples/experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/config.py b/samples/experimental/skills-prototypes/dialog-to-dialog/dialog-echo-skill-bot/config.py
@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import os
+
+
+class DefaultConfig:
+    """ Bot Configuration """
+
+    PORT = 39793
+    APP_ID = os.environ.get("MicrosoftAppId", "")
+    APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "")
+
+    # If ALLOWED_CALLERS is empty, any bot can call this Skill.  Add MicrosoftAppIds to restrict
+    # callers to only those specified.
+    # Example: os.environ.get("AllowedCallers", ["54d3bb6a-3b6d-4ccd-bbfd-cad5c72fb53a"])
+    ALLOWED_CALLERS = os.environ.get("AllowedCallers", [])
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		from .allow_callers_claims_validation import AllowedCallersClaimsValidator

		__all__ = ["AllowedCallersClaimsValidator"]