fix: Remove Exposed Speech Service API Key from Network Calls (#1869)

Author: Prasanjeet-Microsoft

code/create_app.py

@@ -526,7 +526,6 @@ def speech_config():
             if response.status_code == 200:
                 return {
                     "token": response.text,
-                    "key": speech_key,
                     "region": env_helper.AZURE_SPEECH_SERVICE_REGION,
                     "languages": env_helper.AZURE_SPEECH_RECOGNIZER_LANGUAGES,
                 }

code/frontend/src/components/Answer/Answer.test.tsx

@@ -13,7 +13,7 @@ import { conversationResponseWithCitations } from "../../../__mocks__/SampleData
 jest.mock('microsoft-cognitiveservices-speech-sdk', () => {
   return {
     SpeechConfig: {
-      fromSubscription: jest.fn(),
+      fromAuthorizationToken: jest.fn(),
     },
     AudioConfig: {
       fromDefaultSpeakerOutput: jest.fn(),
@@ -51,7 +51,7 @@ const speechMockData = {
 jest.mock("microsoft-cognitiveservices-speech-sdk", () => {
   return {
     SpeechConfig: {
-      fromSubscription: jest.fn(),
+      fromAuthorizationToken: jest.fn(),
       fromSpeakerOutput: jest.fn().mockReturnValue({}),
     },
     AudioConfig: {

code/frontend/src/components/Answer/Answer.tsx

@@ -51,7 +51,7 @@ export const Answer = ({
   const [audioContext, setAudioContext] = useState<AudioContext | null>(null); //Manully  manage the audio context eg pausing resuming
 
   const [synthesizerData, setSynthesizerData] = useState({
-    key: "",
+    token: "",
     region: "",
   });
   const [synthesizer, setSynthesizer] =
@@ -70,8 +70,8 @@ export const Answer = ({
   };
 
   const initializeSynthesizer = () => {
-    const speechConfig = sdk.SpeechConfig.fromSubscription(
-      synthesizerData.key,
+    const speechConfig = sdk.SpeechConfig.fromAuthorizationToken(
+      synthesizerData.token,
       synthesizerData.region
     );
     const newAudioDestination = new SpeechSDK.SpeakerAudioDestination();
@@ -90,7 +90,7 @@ export const Answer = ({
   };
 
   useEffect(() => {
-    if (synthesizerData.key != "") {
+    if (synthesizerData.token != "") {
       initializeSynthesizer();
 
       return () => {
@@ -112,12 +112,12 @@ export const Answer = ({
       const response = await fetch("/api/speech");
       try {
         if (!response.ok) {
-         throw new Error("Network response was not ok");
+          throw new Error("Network response was not ok");
         }
-      const data = await response.json();
-      setSynthesizerData({ key: data.key, region: data.region });
-      } catch(e) {
-        console.log(e)
+        const data = await response.json();
+        setSynthesizerData({ token: data.token, region: data.region });
+      } catch (e) {
+        console.log(e);
       }
     };
     fetchSythesizerData();
@@ -334,7 +334,7 @@ export const Answer = ({
                   }
                   data-testid="toggle-citations-list"
                 >
-                  <Text  className={styles.accordionTitle}>
+                  <Text className={styles.accordionTitle}>
                     <span data-testid="no-of-references">
                       {parsedAnswer.citations.length > 1
                         ? parsedAnswer.citations.length + " references"
@@ -375,7 +375,7 @@ export const Answer = ({
                   onKeyDown={(e) =>
                     e.key === " " || e.key === "Enter"
                       ? onCitationClicked(citation)
-                      : () => {}
+                      : () => { }
                   }
                   tabIndex={0}
                   title={createCitationFilepath(citation, ++idx)}

code/tests/functional/tests/backend_api/default/test_speech_token.py

@@ -20,7 +20,6 @@ def test_speech_token_returned(app_url: str, app_config: AppConfig):
         "token": "speech-token",
         "region": app_config.get("AZURE_SPEECH_SERVICE_REGION"),
         "languages": app_config.get("AZURE_SPEECH_RECOGNIZER_LANGUAGES").split(","),
-        "key": "some-azure-speech-service-key",
     }
     assert response.headers["Content-Type"] == "application/json"
 

code/tests/test_app.py

@@ -115,7 +115,6 @@ def test_returns_speech_token_using_keys(
             "token": "speech-token",
             "region": AZURE_SPEECH_SERVICE_REGION,
             "languages": AZURE_SPEECH_RECOGNIZER_LANGUAGES,
-            "key": "mock-speech-key",
         }
 
         requests.post.assert_called_once_with(
@@ -159,7 +158,6 @@ def test_returns_speech_token_using_rbac(
             "token": "speech-token",
             "region": AZURE_SPEECH_SERVICE_REGION,
             "languages": AZURE_SPEECH_RECOGNIZER_LANGUAGES,
-            "key": "mock-key1",
         }
 
         requests.post.assert_called_once_with(