engage-engine 1.228.90680001 → 1.230.90700001

package/engage.cpp

@@ -1125,6 +1125,18 @@ NAN_METHOD(hookEngineLogging)
     }
 }
 
+//--------------------------------------------------------
+NAN_METHOD(setFipsCrypto)
+{
+    NANRETI(engageSetFipsCrypto(STRVAL(0)));
+}
+
+//--------------------------------------------------------
+NAN_METHOD(isCryptoFipsValidated)
+{
+    NANRETI(engageIsCryptoFipsValidated());
+}
+
 //--------------------------------------------------------
 NAN_MODULE_INIT(Init)
 {
@@ -1194,6 +1206,9 @@ NAN_MODULE_INIT(Init)
 
     ENGAGE_BINDING(logMsg);
     ENGAGE_BINDING(hookEngineLogging);
+
+    ENGAGE_BINDING(setFipsCrypto);
+    ENGAGE_BINDING(isCryptoFipsValidated);
 }
 
 NODE_MODULE(engage, Init)

package/include/ConfigurationObjects.h

@@ -399,24 +399,32 @@ namespace AppConfigurationObjects
     };
 
     //-----------------------------------------------------------
-    JSON_SERIALIZED_CLASS(CryptoEngineSettings)
-    class CryptoEngineSettings : public ConfigurationObjectBase
+    JSON_SERIALIZED_CLASS(FipsCryptoSettings)
+    class FipsCryptoSettings : public ConfigurationObjectBase
     {
         IMPLEMENT_JSON_SERIALIZATION()
-        IMPLEMENT_JSON_DOCUMENTATION(CryptoEngineSettings)
+        IMPLEMENT_JSON_DOCUMENTATION(FipsCryptoSettings)
 
     public:
-        /** @brief [Optional] The signature of the crypto engine module. */
-        std::string                 signature;
+        /** @brief [Optional, Default false] If true, requires FIPS140-2 crypto operation. */
+        bool                        enabled;
+
+        /** @brief Path where the crypto engine module is located  */
+        std::string                 path;
+
+        /** @brief [Optional, Default false] If true, requests the crypto engine module to run in debugging mode. */
+        bool                        debug;
 
-        CryptoEngineSettings()
+        FipsCryptoSettings()
         {
             clear();
         }
 
         void clear()
         {
-            signature.clear();
+            enabled = false;
+            path.clear();
+            debug = false;
         }
 
         virtual void initForDocumenting()
@@ -425,16 +433,20 @@ namespace AppConfigurationObjects
         }
     };
 
-    static void to_json(nlohmann::json& j, const CryptoEngineSettings& p)
+    static void to_json(nlohmann::json& j, const FipsCryptoSettings& p)
     {
         j = nlohmann::json{
-            TOJSON_IMPL(signature)
+            TOJSON_IMPL(enabled),
+            TOJSON_IMPL(path),
+            TOJSON_IMPL(debug)
         };
     }
-    static void from_json(const nlohmann::json& j, CryptoEngineSettings& p)
+    static void from_json(const nlohmann::json& j, FipsCryptoSettings& p)
     {
         p.clear();
-        FROMJSON_IMPL_SIMPLE(signature);
+        FROMJSON_IMPL_SIMPLE(enabled);
+        FROMJSON_IMPL_SIMPLE(path);
+        FROMJSON_IMPL_SIMPLE(debug);
     }
 
 
@@ -3239,6 +3251,9 @@ namespace AppConfigurationObjects
         /** @brief The numeric specializer (if any) associated with the alias. */
         uint16_t    aliasSpecializer;
 
+        /** @brief Indicates if RX is muted for this talker. */
+        bool        rxMuted;
+
         TalkerInformation()
         {
             clear();
@@ -3253,6 +3268,7 @@ namespace AppConfigurationObjects
             txId = 0;
             duplicateCount = 0;
             aliasSpecializer = 0;
+            rxMuted = false;
         }
     };
 
@@ -3265,7 +3281,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(txPriority),
             TOJSON_IMPL(txId),
             TOJSON_IMPL(duplicateCount),
-            TOJSON_IMPL(aliasSpecializer)
+            TOJSON_IMPL(aliasSpecializer),
+            TOJSON_IMPL(rxMuted)
         };
     }
     static void from_json(const nlohmann::json& j, TalkerInformation& p)
@@ -3278,6 +3295,7 @@ namespace AppConfigurationObjects
         getOptional<uint32_t>("txId", p.txId, j, 0);
         getOptional<int>("duplicateCount", p.duplicateCount, j, 0);
         getOptional<uint16_t>("aliasSpecializer", p.aliasSpecializer, j, 0);
+        getOptional<bool>("rxMuted", p.rxMuted, j, false);
     }
 
     //-----------------------------------------------------------
@@ -6493,10 +6511,6 @@ namespace AppConfigurationObjects
         /** @brief Optional RTP - overrides the default */
         std::vector<RtpMapEntry>    rtpMap;
 
-        /** @brief [Optional] Settings for the crypto engine. */
-        CryptoEngineSettings        cryptoEngine;
-    
-
         EnginePolicy()
         {
             clear();
@@ -6520,7 +6534,6 @@ namespace AppConfigurationObjects
             namedAudioDevices.clear();
             externalCodecs.clear();
             rtpMap.clear();
-            cryptoEngine.clear();
         }
     };
 
@@ -6542,8 +6555,7 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(featureset),
             TOJSON_IMPL(namedAudioDevices),
             TOJSON_IMPL(externalCodecs),
-            TOJSON_IMPL(rtpMap),
-            TOJSON_IMPL(cryptoEngine)
+            TOJSON_IMPL(rtpMap)
         };
     }
     static void from_json(const nlohmann::json& j, EnginePolicy& p)
@@ -6565,7 +6577,6 @@ namespace AppConfigurationObjects
         FROMJSON_IMPL_SIMPLE(namedAudioDevices);
         FROMJSON_IMPL_SIMPLE(externalCodecs);
         FROMJSON_IMPL_SIMPLE(rtpMap);
-        FROMJSON_IMPL_SIMPLE(cryptoEngine);
     }
 
 
@@ -7351,8 +7362,8 @@ namespace AppConfigurationObjects
         IMPLEMENT_JSON_DOCUMENTATION(RallypointServer)
 
     public:
-        /** @brief [Optional] Settings for the crypto engine. */
-        CryptoEngineSettings                        cryptoEngine;
+        /** @brief [Optional] Settings for the FIPS crypto. */
+        FipsCryptoSettings                         fipsCrypto;
     
         /** @brief [Optional] Settings for the Rallypoint's watchdog. */
         WatchdogSettings                            watchdog;
@@ -7366,9 +7377,6 @@ namespace AppConfigurationObjects
         /** @brief Name of the NIC to bind to for listening for incoming TCP connections. */
         std::string                                 interfaceName;
 
-        /** @brief Indicate whether FIPS140-2 mode is required for security. */
-        bool                                        requireFips;
-
         /** @brief X.509 certificate and private key that identifies the Rallypoint.  @see SecurityCertificate*/
         SecurityCertificate                         certificate;
 
@@ -7484,12 +7492,11 @@ namespace AppConfigurationObjects
 
         void clear()
         {
-            cryptoEngine.clear();
+            fipsCrypto.clear();
             watchdog.clear();
             id.clear();
             listenPort = 7443;
             interfaceName.clear();
-            requireFips = false;
             certificate.clear();
             allowMulticastForwarding = false;
             peeringConfiguration.clear();
@@ -7532,12 +7539,11 @@ namespace AppConfigurationObjects
     static void to_json(nlohmann::json& j, const RallypointServer& p)
     {
         j = nlohmann::json{            
-            TOJSON_IMPL(cryptoEngine),
+            TOJSON_IMPL(fipsCrypto),
             TOJSON_IMPL(watchdog),
             TOJSON_IMPL(id),
             TOJSON_IMPL(listenPort),
             TOJSON_IMPL(interfaceName),
-            TOJSON_IMPL(requireFips),
             TOJSON_IMPL(certificate),
             TOJSON_IMPL(allowMulticastForwarding),
             // TOJSON_IMPL(peeringConfiguration),               // NOTE: Not serialized!
@@ -7579,11 +7585,10 @@ namespace AppConfigurationObjects
     static void from_json(const nlohmann::json& j, RallypointServer& p)
     {
         p.clear();
-        getOptional<CryptoEngineSettings>("cryptoEngine", p.cryptoEngine, j);
+        getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
         getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
         getOptional<std::string>("id", p.id, j);
         getOptional<SecurityCertificate>("certificate", p.certificate, j);
-        getOptional<bool>("requireFips", p.requireFips, j, false);
         getOptional<std::string>("interfaceName", p.interfaceName, j);
         getOptional<int>("listenPort", p.listenPort, j, 7443);
         getOptional<bool>("allowMulticastForwarding", p.allowMulticastForwarding, j, false);
@@ -9184,6 +9189,9 @@ namespace AppConfigurationObjects
         /** @brief Name to use for signalling a configuration check */
         std::string                                 configurationCheckSignalName;
 
+        /** @brief [Optional] Settings for the FIPS crypto. */
+        FipsCryptoSettings                         fipsCrypto;
+
         BridgingServerConfiguration()
         {
             clear();
@@ -9204,6 +9212,7 @@ namespace AppConfigurationObjects
             certStorePasswordHex.clear();
             enginePolicy.clear();
             configurationCheckSignalName = "rts.6cc0651.${id}";
+            fipsCrypto.clear();
         }
     };
 
@@ -9222,7 +9231,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(certStoreFileName),
             TOJSON_IMPL(certStorePasswordHex),
             TOJSON_IMPL(enginePolicy),
-            TOJSON_IMPL(configurationCheckSignalName)
+            TOJSON_IMPL(configurationCheckSignalName),
+            TOJSON_IMPL(fipsCrypto)
         };
     }
     static void from_json(const nlohmann::json& j, BridgingServerConfiguration& p)
@@ -9241,6 +9251,7 @@ namespace AppConfigurationObjects
         getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
         j.at("enginePolicy").get_to(p.enginePolicy);
         getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.6cc0651.${id}");
+        getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
     }
 
 
@@ -9458,6 +9469,9 @@ namespace AppConfigurationObjects
         /** @brief Name to use for signalling a configuration check */
         std::string                                 configurationCheckSignalName;
 
+        /** @brief [Optional] Settings for the FIPS crypto. */
+        FipsCryptoSettings                          fipsCrypto;
+
         EarServerConfiguration()
         {
             clear();
@@ -9477,6 +9491,7 @@ namespace AppConfigurationObjects
             certStorePasswordHex.clear();
             enginePolicy.clear();
             configurationCheckSignalName = "rts.9a164fa.${id}";
+            fipsCrypto.clear();
         }
     };
 
@@ -9494,7 +9509,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(certStoreFileName),
             TOJSON_IMPL(certStorePasswordHex),
             TOJSON_IMPL(enginePolicy),
-            TOJSON_IMPL(configurationCheckSignalName)
+            TOJSON_IMPL(configurationCheckSignalName),
+            TOJSON_IMPL(fipsCrypto)
         };
     }
     static void from_json(const nlohmann::json& j, EarServerConfiguration& p)

package/include/EngageConstants.h

@@ -35,8 +35,8 @@ static const int ENGAGE_RESULT_NOT_STARTED = -5;
 static const int ENGAGE_RESULT_ALREADY_STARTED = -6;
 /** @brief Insufficient space in destination */
 static const int ENGAGE_RESULT_INSUFFICIENT_DESTINATION_SPACE = -7;
-/** @brief Verification of the crypto module failed */
-static const int ENGAGE_RESULT_CRYPTO_VERIFICATION_FAILED = -8;
+/** @brief Initialization of the crypto module failed */
+static const int ENGAGE_RESULT_CRYPTO_MODULE_INITIALIZATION_FAILED = -8;
 /** @} */
 
 

package/include/EngageInterface.h

@@ -1560,6 +1560,14 @@ ENGAGE_API int engageEndFileRecording(const char * _Nonnull id);
  */
 ENGAGE_API const char * _Nonnull engageGetActiveFeatureset();
 
+/**
+ * @brief [SYNC] Enable FIPS crypto
+ *
+ * @param jsonParams A JSON object of type @ref ConfigurationObjects::FipsCryptoSettings
+ * @return ENGAGE_RESULT_OK on sucess, other values on failure
+ */
+ENGAGE_API int engageSetFipsCrypto(const char * _Nonnull jsonParams);
+
 /**
  * @brief [SYNC] Returns 1 if crypto is FIPS140-2 validated, otherwise 0
  *
@@ -1569,6 +1577,7 @@ ENGAGE_API const char * _Nonnull engageGetActiveFeatureset();
  */
 ENGAGE_API int engageIsCryptoFipsValidated(void);
 
+
 // TODO: Engage compression/decompression functions not available at this time
 #if 0
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "engage-engine",
-  "version": "1.228.90680001",
+  "version": "1.230.90700001",
   "description": "Use Engage to communicate with everyone, everywhere, from any device",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"