add ENCRYPTION_SECRET variable (#283)

* add ENCRYPTION_SECRET variable

* add env for tests

lib/tasks/gather.js

@@ -104,6 +104,10 @@ class TaskGather extends Task {
 
   get needsStt() { return this.input.includes('speech'); }
 
+  get wantsMultipleUtterances() {
+    return this.data.recognizer?.singleUtterance === false;
+  }
+
   get earlyMedia() {
     return (this.sayTask && this.sayTask.earlyMedia) ||
       (this.playTask && this.playTask.earlyMedia);
@@ -661,14 +665,18 @@ class TaskGather extends Task {
       this._killAudio(cs);
     }
 
-    // DCH: commenting out because my experience is that the google STT engine
-    // will keep listening after it detects end of utterance, and will return a final transcript
-    // My earlier understanding that we needed to stop and restart the recognizer appears incorrect.
-    /*
-    if (!this.resolved && !this.killed && !this._bufferedTranscripts.length) {
+    /**
+     * By default, Gather asks google for a single utterance.  On getting an end of utterance event,
+     * the mod_google_transcribe plugin will send a WritesDone to the grpc stream, which will usually
+     * cause google to return a final transcript.  So even though we have not received a final
+     * transcript at this point (because otherwise resolved() would be true), we do not need to
+     * restart the recognizer - we should get the final transcript shortly.
+     * The exception is if the Gather was specifically configured to listen
+     * to multiple utterances, in which case we need to restart the recognizer.
+     */
+    if (!this.resolved && !this.killed && !this._bufferedTranscripts.length && this.wantsMultipleUtterances) {
       this._startTranscribing(ep);
     }
-    */
   }
 
   _onStartOfSpeech(cs, ep) {
@@ -780,6 +788,10 @@ class TaskGather extends Task {
     if (this.resolved) return;
 
     this.resolved = true;
+    // Clear dtmf event
+    if (this.dtmfBargein) {
+      this.ep.removeAllListeners('dtmf');
+    }
     clearTimeout(this.interDigitTimer);
     this._clearTimer();
 

lib/utils/encrypt-decrypt.js

@@ -2,9 +2,9 @@ const crypto = require('crypto');
 const algorithm = process.env.LEGACY_CRYPTO ? 'aes-256-ctr' : 'aes-256-cbc';
 const iv = crypto.randomBytes(16);
 const secretKey = crypto.createHash('sha256')
-  .update(String(process.env.JWT_SECRET))
+  .update(process.env.ENCRYPTION_SECRET || process.env.JWT_SECRET)
   .digest('base64')
-  .substr(0, 32);
+  .substring(0, 32);
 
 const encrypt = (text) => {
   const cipher = crypto.createCipheriv(algorithm, secretKey, iv);
@@ -25,8 +25,8 @@ const decrypt = (data) => {
     throw err;
   }
   const decipher = crypto.createDecipheriv(algorithm, secretKey, Buffer.from(hash.iv, 'hex'));
-  const decrpyted = Buffer.concat([decipher.update(Buffer.from(hash.content, 'hex')), decipher.final()]);
-  return decrpyted.toString();
+  const decrypted = Buffer.concat([decipher.update(Buffer.from(hash.content, 'hex')), decipher.final()]);
+  return decrypted.toString();
 };
 
 module.exports = {

lib/utils/transcription-utils.js

@@ -337,53 +337,38 @@ module.exports = (logger) => {
     if ('google' === vendor) {
       opts = {
         ...opts,
-        ...(sttCredentials &&
-          {GOOGLE_APPLICATION_CREDENTIALS: JSON.stringify(sttCredentials.credentials)}),
-        ...(rOpts.enhancedModel &&
-            {GOOGLE_SPEECH_USE_ENHANCED: 1}),
-        ...(rOpts.separateRecognitionPerChannel &&
-          {GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL: 1}),
-        ...(rOpts.profanityFilter &&
-          {GOOGLE_SPEECH_PROFANITY_FILTER: 1}),
-        ...(rOpts.punctuation &&
-          {GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION: 1}),
-        ...(rOpts.words &&
-          {GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS: 1}),
-        ...((rOpts.singleUtterance ||  task.name === TaskName.Gather) &&
+        ...(sttCredentials && {GOOGLE_APPLICATION_CREDENTIALS: JSON.stringify(sttCredentials.credentials)}),
+        ...(rOpts.separateRecognitionPerChannel && {GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL: 1}),
+        ...(rOpts.separateRecognitionPerChanne === false && {GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL: 0}),
+        ...(rOpts.profanityFilter && {GOOGLE_SPEECH_PROFANITY_FILTER: 1}),
+        ...(rOpts.punctuation && {GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION: 1}),
+        ...(rOpts.words && {GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS: 1}),
+        ...((rOpts.singleUtterance || task.name === TaskName.Gather) &&
           {GOOGLE_SPEECH_SINGLE_UTTERANCE: 1}),
-        ...(rOpts.diarization &&
-          {GOOGLE_SPEECH_SPEAKER_DIARIZATION: 1}),
+        ...(rOpts.singleUtterance === false && {GOOGLE_SPEECH_SINGLE_UTTERANCE: 0}),
+        ...(rOpts.diarization && {GOOGLE_SPEECH_SPEAKER_DIARIZATION: 1}),
         ...(rOpts.diarization && rOpts.diarizationMinSpeakers > 0 &&
           {GOOGLE_SPEECH_SPEAKER_DIARIZATION_MIN_SPEAKER_COUNT: rOpts.diarizationMinSpeakers}),
         ...(rOpts.diarization && rOpts.diarizationMaxSpeakers > 0 &&
           {GOOGLE_SPEECH_SPEAKER_DIARIZATION_MAX_SPEAKER_COUNT: rOpts.diarizationMaxSpeakers}),
-        ...(rOpts.enhancedModel === false &&
-          {GOOGLE_SPEECH_USE_ENHANCED: 0}),
-        ...(rOpts.separateRecognitionPerChannel === false &&
-          {GOOGLE_SPEECH_SEPARATE_RECOGNITION_PER_CHANNEL: 0}),
-        ...(rOpts.profanityFilter === false &&
-          {GOOGLE_SPEECH_PROFANITY_FILTER: 0}),
-        ...(rOpts.punctuation === false &&
-          {GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION: 0}),
-        ...(rOpts.words  == false &&
-          {GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS: 0}),
-        ...((rOpts.singleUtterance === false || task.name === TaskName.Transcribe) &&
-          {GOOGLE_SPEECH_SINGLE_UTTERANCE: 0}),
-        ...(rOpts.diarization === false &&
-          {GOOGLE_SPEECH_SPEAKER_DIARIZATION: 0}),
+        ...(rOpts.enhancedModel === false && {GOOGLE_SPEECH_USE_ENHANCED: 0}),
+        ...(rOpts.enhancedModel !== false && {GOOGLE_SPEECH_USE_ENHANCED: 1}),
+        ...(rOpts.profanityFilter === false && {GOOGLE_SPEECH_PROFANITY_FILTER: 0}),
+        ...(rOpts.punctuation === false && {GOOGLE_SPEECH_ENABLE_AUTOMATIC_PUNCTUATION: 0}),
+        ...(rOpts.words  == false && {GOOGLE_SPEECH_ENABLE_WORD_TIME_OFFSETS: 0}),
+        ...(rOpts.diarization === false && {GOOGLE_SPEECH_SPEAKER_DIARIZATION: 0}),
         ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'string' &&
           {GOOGLE_SPEECH_HINTS: rOpts.hints.join(',')}),
         ...(rOpts.hints.length > 0 && typeof rOpts.hints[0] === 'object' &&
           {GOOGLE_SPEECH_HINTS: JSON.stringify(rOpts.hints)}),
-        ...(typeof rOpts.hintsBoost === 'number' &&
-          {GOOGLE_SPEECH_HINTS_BOOST: rOpts.hintsBoost}),
+        ...(typeof rOpts.hintsBoost === 'number' && {GOOGLE_SPEECH_HINTS_BOOST: rOpts.hintsBoost}),
         ...(rOpts.altLanguages.length > 0 &&
           {GOOGLE_SPEECH_ALTERNATIVE_LANGUAGE_CODES: [...new Set(rOpts.altLanguages)].join(',')}),
         ...(rOpts.interactionType &&
           {GOOGLE_SPEECH_METADATA_INTERACTION_TYPE: rOpts.interactionType}),
-        ...{GOOGLE_SPEECH_MODEL: rOpts.model || (task.name === TaskName.Gather ? 'latest_short' : 'phone_call')},
-        ...(rOpts.naicsCode > 0 &&
-          {GOOGLE_SPEECH_METADATA_INDUSTRY_NAICS_CODE: rOpts.naicsCode}),
+        ...{GOOGLE_SPEECH_MODEL: rOpts.model || (task.name === TaskName.Gather ? 'command_and_search' : 'latest_long')},
+        ...(rOpts.naicsCode > 0 && {GOOGLE_SPEECH_METADATA_INDUSTRY_NAICS_CODE: rOpts.naicsCode}),
+        GOOGLE_SPEECH_METADATA_RECORDING_DEVICE_TYPE: 'phone_line',
       };
     }
     else if (['aws', 'polly'].includes(vendor)) {
@@ -432,12 +417,9 @@ module.exports = (logger) => {
       const {nuanceOptions = {}} = rOpts;
       opts = {
         ...opts,
-        ...(sttCredentials.access_token) &&
-          {NUANCE_ACCESS_TOKEN: sttCredentials.access_token},
-        ...(sttCredentials.krypton_endpoint) &&
-          {NUANCE_KRYPTON_ENDPOINT: sttCredentials.krypton_endpoint},
-        ...(nuanceOptions.topic) &&
-          {NUANCE_TOPIC: nuanceOptions.topic},
+        ...(sttCredentials.access_token) && {NUANCE_ACCESS_TOKEN: sttCredentials.access_token},
+        ...(sttCredentials.nuance_stt_uri) && {NUANCE_KRYPTON_ENDPOINT: sttCredentials.nuance_stt_uri},
+        ...(nuanceOptions.topic) && {NUANCE_TOPIC: nuanceOptions.topic},
         ...(nuanceOptions.utteranceDetectionMode) &&
           {NUANCE_UTTERANCE_DETECTION_MODE: nuanceOptions.utteranceDetectionMode},
         ...(nuanceOptions.punctuation || rOpts.punctuation) && {NUANCE_PUNCTUATION: nuanceOptions.punctuation},
@@ -661,7 +643,7 @@ module.exports = (logger) => {
     if (recognizer.vendor === 'nuance') {
       const {clientId, secret, kryptonEndpoint} = recognizer.nuanceOptions || {};
       if (clientId && secret) return {client_id: clientId, secret};
-      if (kryptonEndpoint) return {krypton_endpoint: kryptonEndpoint};
+      if (kryptonEndpoint) return {nuance_stt_uri: kryptonEndpoint};
     }
     else if (recognizer.vendor === 'nvidia') {
       const {rivaUri} = recognizer.nvidiaOptions || {};

package.json

@@ -19,7 +19,7 @@
   "bugs": {},
   "scripts": {
     "start": "node app",
-    "test": "NODE_ENV=test JAMBONES_HOSTING=1 HTTP_POOL=1 DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 DRACHTIO_SECRET=cymru JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=127.0.0.1 JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=error ENABLE_METRICS=0 HTTP_PORT=3000 JAMBONES_SBCS=172.38.0.10 JAMBONES_FREESWITCH=127.0.0.1:8022:JambonzR0ck$:docker-host JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_NETWORK_CIDR=172.38.0.0/16 node test/ ",
+    "test": "NODE_ENV=test JAMBONES_HOSTING=1 HTTP_POOL=1 ENCRYPTION_SECRET=foobar DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 DRACHTIO_SECRET=cymru JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=127.0.0.1 JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=error ENABLE_METRICS=0 HTTP_PORT=3000 JAMBONES_SBCS=172.38.0.10 JAMBONES_FREESWITCH=127.0.0.1:8022:JambonzR0ck$:docker-host JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_NETWORK_CIDR=172.38.0.0/16 node test/ ",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
     "jslint": "eslint app.js lib"
   },