engage-engine 1.230.90700001 → 1.232.90720001

package/engage.cpp

@@ -575,9 +575,11 @@ NAN_METHOD(on)
 //--------------------------------------------------------
 NAN_METHOD(initialize)
 {
+    /*
     #if defined(WIN32)
         engageWin32LibraryInit();
     #endif
+    */
 
     memset(&g_eventCallbacks, 0, sizeof(g_eventCallbacks));
 
@@ -707,9 +709,11 @@ NAN_METHOD(shutdown)
 {
     NANRETI(engageShutdown());
 
+    /*
     #if defined(WIN32)
         engageWin32LibraryDeinit();
     #endif
+    */
 }
 
 //--------------------------------------------------------
@@ -1137,6 +1141,12 @@ NAN_METHOD(isCryptoFipsValidated)
     NANRETI(engageIsCryptoFipsValidated());
 }
 
+//--------------------------------------------------------
+NAN_METHOD(setCertStore)
+{
+    NANRETI(engageSetCertStore((uint8_t*) node::Buffer::Data(info[0]), INTVAL(1), STRVAL(2)));
+}
+
 //--------------------------------------------------------
 NAN_MODULE_INIT(Init)
 {
@@ -1189,6 +1199,7 @@ NAN_MODULE_INIT(Init)
 
     ENGAGE_BINDING(openCertStore);
     ENGAGE_BINDING(closeCertStore);
+    ENGAGE_BINDING(setCertStore);
     ENGAGE_BINDING(setCertStoreCertificatePem);
     ENGAGE_BINDING(setCertStoreCertificateP12);
     ENGAGE_BINDING(deleteCertStoreCertificate);

package/include/ConfigurationObjects.h

@@ -2510,7 +2510,7 @@ namespace AppConfigurationObjects
         {
             char buff[2048];
 
-            sprintf_s(buff, sizeof(buff), "deviceId=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, type=%s, extra=%s",
+            snprintf(buff, sizeof(buff), "deviceId=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, type=%s, extra=%s",
                         deviceId,
                         name.c_str(),
                         manufacturer.c_str(),
@@ -3034,7 +3034,7 @@ namespace AppConfigurationObjects
         {
             char buff[2048];
 
-            sprintf_s(buff, sizeof(buff), "deviceId=%d, samplingRate=%d, channels=%d, direction=%d, boostPercentage=%d, isAdad=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, isDefault=%d, type=%s, present=%d, extra=%s",
+            snprintf(buff, sizeof(buff), "deviceId=%d, samplingRate=%d, channels=%d, direction=%d, boostPercentage=%d, isAdad=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, isDefault=%d, type=%s, present=%d, extra=%s",
                         deviceId,
                         samplingRate,
                         channels,
@@ -4031,6 +4031,70 @@ namespace AppConfigurationObjects
         getOptional<int>("count", p.count, j, 5);
     }
 
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(Source)
+    /**
+     * @brief Options for Source
+     *
+     *  Helper C++ class to serialize and de-serialize Source JSON
+     *
+     *  TODO: Complete this Class
+     *
+     *  Example: @include[doc] examples/Source.json
+     *
+     *  @see Group
+     */
+    class Source : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(Source)
+
+    public:
+        /** @brief [Optional] A node ID */
+        std::string             nodeId;
+
+        /* NOTE: Not serialized ! */
+        uint8_t                 _internal_binary_nodeId[MAX_NODE_ID_SIZE];
+
+        /** @brief [Optional] An alias */
+        std::string             alias;
+        
+        /* NOTE: Not serialized ! */
+        uint8_t                 _internal_binary_alias[MAX_ALIAS_SIZE];
+
+        Source()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            nodeId.clear();
+            memset(_internal_binary_nodeId, 0, sizeof(_internal_binary_nodeId));
+            
+            alias.clear();
+            memset(_internal_binary_alias, 0, sizeof(_internal_binary_alias));
+        }
+
+        virtual void initForDocumenting()
+        {
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const Source& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(nodeId),
+            TOJSON_IMPL(alias)
+        };
+    }
+    static void from_json(const nlohmann::json& j, Source& p)
+    {
+        p.clear();
+        FROMJSON_IMPL_SIMPLE(nodeId);
+        FROMJSON_IMPL_SIMPLE(alias);
+    }
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(Group)
     /**
@@ -4076,7 +4140,10 @@ namespace AppConfigurationObjects
             bomPayloadTransformation    = 1,
 
             /** @brief Audio payloads are mixed - output is anonymous (i.e. no metadata) if if the target group(s) allow header extensions */
-            bomAnonymousMixing          = 2
+            bomAnonymousMixing          = 2,
+
+            /** @brief The bridge performs language translations between groups */
+            bomLanguageTranslation      = 3
         } BridgingOpMode_t;
 
         /** @brief Specifies the group type (see @ref Type_t). */
@@ -4096,6 +4163,9 @@ namespace AppConfigurationObjects
         /** @brief The human readable name for the group. */
         std::string                             name;
 
+        /** @brief The group name as spoken - typically by a text-to-speech system  */
+        std::string                             spokenName;
+
         /** @brief The name of the network interface to use for multicasting for this group.  If not provided, the Engine's default multicast NIC is used. */
         std::string                             interfaceName;
 
@@ -4220,6 +4290,13 @@ namespace AppConfigurationObjects
         /** @brief [Optional, Default: 0] The security classification level of the group. */
         uint32_t                                securityLevel;
 
+        /** @brief [Optional] List of sources to ignore for this group */
+        std::vector<Source>                     ignoreSources;
+
+        /** @brief ISO 639-2 lanuguage code for the group  */
+        std::string                             languageCode;
+
+
         Group()
         {
             clear();
@@ -4231,6 +4308,7 @@ namespace AppConfigurationObjects
             bom = bomRaw;
             id.clear();
             name.clear();
+            spokenName.clear();
             interfaceName.clear();
             rx.clear();
             tx.clear();
@@ -4287,6 +4365,10 @@ namespace AppConfigurationObjects
             specializerAffinities.clear();
 
             securityLevel = 0;
+
+            ignoreSources.clear();
+
+            languageCode.clear();
         }
     };
 
@@ -4297,6 +4379,7 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(bom),
             TOJSON_IMPL(id),
             TOJSON_IMPL(name),
+            TOJSON_IMPL(spokenName),
             TOJSON_IMPL(interfaceName),
             TOJSON_IMPL(rx),
             TOJSON_IMPL(tx),
@@ -4339,7 +4422,11 @@ namespace AppConfigurationObjects
 
             TOJSON_IMPL(specializerAffinities),
 
-            TOJSON_IMPL(securityLevel)
+            TOJSON_IMPL(securityLevel),
+
+            TOJSON_IMPL(ignoreSources),
+
+            TOJSON_IMPL(languageCode)
         };
 
         // TODO: need a better way to indicate whether rtpProfile is present
@@ -4373,6 +4460,7 @@ namespace AppConfigurationObjects
         getOptional<Group::BridgingOpMode_t>("bom", p.bom, j, Group::BridgingOpMode_t::bomRaw);
         j.at("id").get_to(p.id);
         getOptional<std::string>("name", p.name, j);
+        getOptional<std::string>("spokenName", p.spokenName, j);
         getOptional<std::string>("interfaceName", p.interfaceName, j);
         getOptional<NetworkAddress>("rx", p.rx, j);
         getOptional<NetworkAddress>("tx", p.tx, j);
@@ -4410,6 +4498,8 @@ namespace AppConfigurationObjects
         getOptional<TransportImpairment>("rxImpairment", p.rxImpairment, j);
         getOptional<std::vector<uint16_t>>("specializerAffinities", p.specializerAffinities, j);
         getOptional<uint32_t>("securityLevel", p.securityLevel, j, 0);
+        getOptional<std::vector<Source>>("ignoreSources", p.ignoreSources, j);
+        getOptional<std::string>("languageCode", p.languageCode, j);
     }
 
 
@@ -4651,9 +4741,6 @@ namespace AppConfigurationObjects
         /** @brief [Optional, false] Enables UDP streaming if the RP supports it */
         bool                                enabled;
 
-        /** @brief [Optional, false] Allows for clear-packet streaming */
-        bool                                allowClear;
-
         /** @brief [Optional, EnginePolicyNetworking::defaultNic] Name of NIC to bind to - uses Engine defaultNic if empty */
         std::string                         nic;
 
@@ -4677,7 +4764,6 @@ namespace AppConfigurationObjects
         void clear()
         {
             enabled = false;
-            allowClear = false;
             nic.clear();
             keepAliveIntervalSecs = 10;
             priority = NetworkTxOptions::priVoice;
@@ -4693,7 +4779,6 @@ namespace AppConfigurationObjects
     {
         j = nlohmann::json{
             TOJSON_IMPL(enabled),
-            TOJSON_IMPL(allowClear),
             TOJSON_IMPL(nic),
             TOJSON_IMPL(port),
             TOJSON_IMPL(keepAliveIntervalSecs),
@@ -4705,7 +4790,6 @@ namespace AppConfigurationObjects
     {
         p.clear();
         getOptional<bool>("enabled", p.enabled, j, false);
-        getOptional<bool>("allowClear", p.allowClear, j, false);
         getOptional<std::string>("nic", p.nic, j, EMPTY_STRING);
         getOptional<int>("port", p.port, j, 0);
         getOptional<int>("keepAliveIntervalSecs", p.keepAliveIntervalSecs, j, 10);
@@ -6493,12 +6577,6 @@ namespace AppConfigurationObjects
         /** @brief Database settings */
         EnginePolicyDatabase        database;
 
-        /** @brief Path to the certificate store */
-        std::string                 certStoreFileName;
-
-        /** @brief Hex password for the certificate store (if any) */
-        std::string                 certStorePasswordHex;
-
         /** @brief Optional feature set */
         Featureset                  featureset;
 
@@ -6528,8 +6606,6 @@ namespace AppConfigurationObjects
             internals.clear();
             timelines.clear();
             database.clear();
-            certStoreFileName.clear();
-            certStorePasswordHex.clear();
             featureset.clear();
             namedAudioDevices.clear();
             externalCodecs.clear();
@@ -6550,8 +6626,6 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(internals),
             TOJSON_IMPL(timelines),
             TOJSON_IMPL(database),
-            TOJSON_IMPL(certStoreFileName),
-            TOJSON_IMPL(certStorePasswordHex),
             TOJSON_IMPL(featureset),
             TOJSON_IMPL(namedAudioDevices),
             TOJSON_IMPL(externalCodecs),
@@ -6571,8 +6645,6 @@ namespace AppConfigurationObjects
         FROMJSON_IMPL_SIMPLE(internals);
         FROMJSON_IMPL_SIMPLE(timelines);
         FROMJSON_IMPL_SIMPLE(database);
-        FROMJSON_IMPL_SIMPLE(certStoreFileName);
-        FROMJSON_IMPL_SIMPLE(certStorePasswordHex);
         FROMJSON_IMPL_SIMPLE(featureset);
         FROMJSON_IMPL_SIMPLE(namedAudioDevices);
         FROMJSON_IMPL_SIMPLE(externalCodecs);
@@ -7046,6 +7118,59 @@ namespace AppConfigurationObjects
         getOptional<std::string>("runCmd", p.runCmd, j);
     }
 
+
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(RallypointServerRouteMap)
+    class RallypointServerRouteMap : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(RallypointServerRouteMap)
+
+    public:
+        /** File name to use for the route map report. */
+        std::string                     fileName;
+
+        /** [Optional, Default: 5] Minimum update time for updates. */
+        int                             minRefreshSecs;
+
+        /** [Optional, Default: false] Indicates if reporting is enabled. */
+        bool                            enabled;
+
+        /** [Optional, Default: null] Command to be executed every time the report is produced. */
+        std::string                     runCmd;
+
+        RallypointServerRouteMap()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            fileName.clear();
+            minRefreshSecs = 5;
+            enabled = false;
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const RallypointServerRouteMap& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(fileName),
+            TOJSON_IMPL(minRefreshSecs),
+            TOJSON_IMPL(enabled),
+            TOJSON_IMPL(runCmd)
+        };
+    }
+    static void from_json(const nlohmann::json& j, RallypointServerRouteMap& p)
+    {
+        p.clear();
+        getOptional<std::string>("fileName", p.fileName, j);
+        getOptional<int>("minRefreshSecs", p.minRefreshSecs, j, 5);
+        getOptional<bool>("enabled", p.enabled, j, false);
+        getOptional<std::string>("runCmd", p.runCmd, j);
+    }
+
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(ExternalHealthCheckResponder)
     /**
@@ -7298,14 +7423,8 @@ namespace AppConfigurationObjects
             /** @brief Unknown */
             etUnknown,
 
-            /** @brief No encryption */
-            etClear,
-
             /** @brief Shared-key encryption */
-            etSharedKey,
-
-            /** @brief DTLS encryption*/
-            etDtls
+            etSharedKey
         } EnvelopeType_t;
 
         /** @brief Specifies the streaming mode type (see @ref EnvelopeType_t). */
@@ -7346,6 +7465,77 @@ namespace AppConfigurationObjects
         j.at("external").get_to(p.external);
     }    
 
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(RallypointRpRtTimingBehavior)
+    /**
+     * @brief Defines a behavior for a Rallypoint peer roundtrip time
+     *
+     * Example: @include[doc] examples/RallypointRpRtTimingBehavior.json
+     *
+     */
+    class RallypointRpRtTimingBehavior : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(RallypointRpRtTimingBehavior)
+
+    public:
+        /** @brief Enum describing behavior types. */
+        typedef enum
+        {
+            /** @brief Unknown */
+            btNone,
+
+            /** @brief Report at level info */
+            btReportInfo,
+
+            /** @brief Report at level warning */
+            btReportWarn,
+
+            /** @brief Report at level error */
+            btReportError,  
+
+            /** @brief Report at level fatal and drop connection */
+            btDrop = 99        
+        } BehaviorType_t;
+
+        /** @brief Specifies the streaming mode type (see @ref BehaviorType_t). */
+        BehaviorType_t                          behavior;
+
+        /** @brief Network address for listening */
+        uint32_t                                atOrAboveMs;
+
+        /** [Optional, Default: null] Command to be executed. */
+        std::string                             runCmd;
+
+        RallypointRpRtTimingBehavior()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            behavior = btNone;
+            atOrAboveMs = 0;
+            runCmd.clear();
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const RallypointRpRtTimingBehavior& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(behavior),
+            TOJSON_IMPL(atOrAboveMs),
+            TOJSON_IMPL(runCmd)
+        };
+    }
+    static void from_json(const nlohmann::json& j, RallypointRpRtTimingBehavior& p)
+    {
+        p.clear();
+        getOptional<RallypointRpRtTimingBehavior::BehaviorType_t>("behavior", p.behavior, j, RallypointRpRtTimingBehavior::BehaviorType_t::btNone);
+        getOptional<uint32_t>("atOrAboveMs", p.atOrAboveMs, j, 0);
+        getOptional<std::string>("runCmd", p.runCmd, j);
+    }
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(RallypointServer)
     /**
@@ -7485,6 +7675,18 @@ namespace AppConfigurationObjects
         /** @brief [Optional, Default 0] Sets the maximum item security level that can be registered with the RP */
         uint32_t                                    maxSecurityLevel;
 
+        /** @brief Details for producing a report containing the route map. @see RallypointServerRouteMap */
+        RallypointServerRouteMap                    routeMap;
+
+        /** @brief [Optional, Default 15] Sets the delta value for the maximum number of seconds to delay when attempting outbound peer connections */
+        uint32_t                                    maxOutboundPeerConnectionIntervalDeltaSecs;
+
+        /** @brief [Optional, Default: 60000] Milliseconds between sending round-trip test requests to peers */
+        int                                         peerRtTestIntervalMs;
+
+        /** @brief [Optional] Array of behaviors for roundtrip times to peers */
+        std::vector<RallypointRpRtTimingBehavior>   peerRtBehaviors;
+
         RallypointServer()
         {
             clear();
@@ -7533,6 +7735,10 @@ namespace AppConfigurationObjects
             enableLeafReflectionReverseSubscription = false;
             disableLoopDetection = false;
             maxSecurityLevel = 0;
+            routeMap.clear();
+            maxOutboundPeerConnectionIntervalDeltaSecs = 15;
+            peerRtTestIntervalMs = 60000;
+            peerRtBehaviors.clear();
         }
     };
 
@@ -7579,7 +7785,11 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(normalTaskQueueBias),
             TOJSON_IMPL(enableLeafReflectionReverseSubscription),
             TOJSON_IMPL(disableLoopDetection),
-            TOJSON_IMPL(maxSecurityLevel)
+            TOJSON_IMPL(maxSecurityLevel),
+            TOJSON_IMPL(routeMap),
+            TOJSON_IMPL(maxOutboundPeerConnectionIntervalDeltaSecs),
+            TOJSON_IMPL(peerRtTestIntervalMs),
+            TOJSON_IMPL(peerRtBehaviors)
         };
     }
     static void from_json(const nlohmann::json& j, RallypointServer& p)
@@ -7626,9 +7836,12 @@ namespace AppConfigurationObjects
         getOptional<bool>("enableLeafReflectionReverseSubscription", p.enableLeafReflectionReverseSubscription, j, false);
         getOptional<bool>("disableLoopDetection", p.disableLoopDetection, j, false);
         getOptional<uint32_t>("maxSecurityLevel", p.maxSecurityLevel, j, 0);
+        getOptional<RallypointServerRouteMap>("routeMap", p.routeMap, j);
+        getOptional<uint32_t>("maxOutboundPeerConnectionIntervalDeltaSecs", p.maxOutboundPeerConnectionIntervalDeltaSecs, j, 15);        
+        getOptional<int>("peerRtTestIntervalMs", p.peerRtTestIntervalMs, j, 60000);
+        getOptional<std::vector<RallypointRpRtTimingBehavior>>("peerRtBehaviors", p.peerRtBehaviors, j);
     }
 
-
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(PlatformDiscoveredService)
     /**
@@ -9147,7 +9360,10 @@ namespace AppConfigurationObjects
             omPayloadTransformation     = 1,
 
             /** @brief Audio payloads are mixed - output is anonymous (i.e. no metadata) if if the target group(s) allow header extensions */
-            omAnonymousMixing           = 2
+            omAnonymousMixing           = 2,
+
+            /** @brief Audio payloads are translated between group-specific languages */
+            omLanguageTranslation       = 3
         } OpMode_t;
 
         /** @brief A unqiue identifier for the bridge server */

package/include/EngageInterface.h

@@ -1564,7 +1564,7 @@ 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
+ * @return ENGAGE_RESULT_OK on success, other values on failure
  */
 ENGAGE_API int engageSetFipsCrypto(const char * _Nonnull jsonParams);
 
@@ -1577,6 +1577,21 @@ ENGAGE_API int engageSetFipsCrypto(const char * _Nonnull jsonParams);
  */
 ENGAGE_API int engageIsCryptoFipsValidated(void);
 
+/**
+ * @brief [SYNC] Set the certstore content via buffer
+ *
+ * An alternative to engageOpenCertStore whereby a buffer is passed to the Engine containing
+ * a certificate store's binary data rather having it loaded from file.
+ *
+ * No events are generated by this API call.
+ *
+ * @param buffer Pointer to the certificate store byte array
+ * @param size Number of bytes in the buffer
+ * @param passwordHexByteString Hexadecimal representation of the password to be used to decrypt the buffer
+ * @return ENGAGE_RESULT_OK on success, other values on failure
+ * @see engageOpenCertStore()
+ */
+ENGAGE_API int engageSetCertStore(const uint8_t * _Nonnull buffer, size_t size, const char * _Nullable passwordHexByteString);
 
 // TODO: Engage compression/decompression functions not available at this time
 #if 0

package/package.json

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