engage-engine 1.233.90730006 → 1.234.90740002

package/engage.cpp

@@ -1161,6 +1161,27 @@ NAN_METHOD(getDeviceId)
 }
 
 
+//--------------------------------------------------------
+NAN_METHOD(verifyRiff)
+{
+    NANRETI(engageVerifyRiff(STRVAL(0)));
+}
+
+
+//--------------------------------------------------------
+NAN_METHOD(getRiffDescriptor)
+{
+    const char *rc = engageGetRiffDescriptor(STRVAL(0));
+
+    if(rc == nullptr)
+    {
+        rc = "";
+    }
+
+    NANRETS(rc);
+}
+
+
 //--------------------------------------------------------
 NAN_MODULE_INIT(Init)
 {
@@ -1236,6 +1257,9 @@ NAN_MODULE_INIT(Init)
     ENGAGE_BINDING(isCryptoFipsValidated);
 
     ENGAGE_BINDING(getDeviceId);
+
+    ENGAGE_BINDING(verifyRiff);
+    ENGAGE_BINDING(getRiffDescriptor);    
 }
 
 NODE_MODULE(engage, Init)

package/include/ConfigurationObjects.h

@@ -2188,6 +2188,196 @@ namespace AppConfigurationObjects
     }
 
 
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(TransportImpairment)
+    /**
+     * @brief Description of a transport impairment
+     *
+     * Helper C++ class to serialize and de-serialize TransportImpairment JSON.
+     *
+     * Example: @include[doc] examples/TransportImpairment.json
+     *
+     */
+    class TransportImpairment : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(TransportImpairment)
+
+    public:
+        int     applicationPercentage;
+        int     jitterMs;
+        int     lossPercentage;
+
+        TransportImpairment()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            applicationPercentage = 0;
+            jitterMs = 0;
+            lossPercentage = 0;
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const TransportImpairment& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(applicationPercentage),
+            TOJSON_IMPL(jitterMs),
+            TOJSON_IMPL(lossPercentage)
+        };
+    }
+    static void from_json(const nlohmann::json& j, TransportImpairment& p)
+    {
+        p.clear();
+        getOptional<int>("applicationPercentage", p.applicationPercentage, j, 0);
+        getOptional<int>("jitterMs", p.jitterMs, j, 0);
+        getOptional<int>("lossPercentage", p.lossPercentage, j, 0);
+    }
+
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(NsmNetworking)
+    /**
+     * @brief NsmNetworking
+     *
+     * Helper C++ class to serialize and de-serialize NsmNetworking JSON
+     * 
+     * Example: @include[doc] examples/NsmNetworking.json
+     *
+     */
+    class NsmNetworking : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(NsmNetworking)
+
+    public:        
+        std::string                         interfaceName;
+        NetworkAddress                      address;
+        int                                 ttl;
+        int                                 tos;
+        int                                 txOversend;
+        TransportImpairment                 rxImpairment;
+        TransportImpairment                 txImpairment;
+        std::string                         cryptoPassword;
+
+        NsmNetworking()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            interfaceName.clear();
+            address.clear();
+            ttl = 1;
+            tos = 56;
+            txOversend = 0;
+            rxImpairment.clear();
+            txImpairment.clear();
+            cryptoPassword.clear();
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const NsmNetworking& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(interfaceName),
+            TOJSON_IMPL(address),
+            TOJSON_IMPL(ttl),
+            TOJSON_IMPL(tos),
+            TOJSON_IMPL(txOversend),
+            TOJSON_IMPL(rxImpairment),
+            TOJSON_IMPL(txImpairment),
+            TOJSON_IMPL(cryptoPassword)
+        };
+    }
+    static void from_json(const nlohmann::json& j, NsmNetworking& p)
+    {
+        p.clear();
+        getOptional("interfaceName", p.interfaceName, j, EMPTY_STRING);
+        getOptional<NetworkAddress>("address", p.address, j);
+        getOptional<int>("ttl", p.ttl, j, 1);
+        getOptional<int>("tos", p.tos, j, 56);
+        getOptional<int>("txOversend", p.txOversend, j, 0);
+        getOptional<TransportImpairment>("rxImpairment", p.rxImpairment, j);
+        getOptional<TransportImpairment>("txImpairment", p.txImpairment, j);
+        getOptional("cryptoPassword", p.cryptoPassword, j, EMPTY_STRING);
+    }
+
+
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(NsmConfiguration)
+    /**
+     * @brief NsmConfiguration
+     *
+     * Helper C++ class to serialize and de-serialize NsmConfiguration JSON
+     * 
+     * Example: @include[doc] examples/NsmConfiguration.json
+     *
+     */
+    class NsmConfiguration : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(NsmConfiguration)
+
+    public:
+
+        std::string                         id;
+        bool                                favorUptime;
+        NsmNetworking                       networking;
+        std::vector<std::string>            resources;
+        int                                 tokenStart;
+        int                                 tokenEnd;
+        int                                 intervalSecs;
+        int                                 transitionSecsFactor;
+
+        NsmConfiguration()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            id.clear();
+            favorUptime = false;
+            networking.clear();
+            resources.clear();
+            tokenStart = 1000000;
+            tokenEnd = 2000000;
+            intervalSecs = 1;
+            transitionSecsFactor = 3;
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const NsmConfiguration& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(id),
+            TOJSON_IMPL(favorUptime),
+            TOJSON_IMPL(networking),
+            TOJSON_IMPL(resources),
+            TOJSON_IMPL(tokenStart),
+            TOJSON_IMPL(tokenEnd),
+            TOJSON_IMPL(intervalSecs),
+            TOJSON_IMPL(transitionSecsFactor)
+        };
+    }
+    static void from_json(const nlohmann::json& j, NsmConfiguration& p)
+    {
+        p.clear();
+        getOptional("id", p.id, j);
+        getOptional<bool>("favorUptime", p.favorUptime, j, false);
+        getOptional<NsmNetworking>("networking", p.networking, j);
+        getOptional<std::vector<std::string>>("resources", p.resources, j);
+        getOptional<int>("tokenStart", p.tokenStart, j, 1000000);
+        getOptional<int>("tokenEnd", p.tokenEnd, j, 2000000);
+        getOptional<int>("intervalSecs", p.intervalSecs, j, 1);
+        getOptional<int>("transitionSecsFactor", p.transitionSecsFactor, j, 3);
+    }
+
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(Rallypoint)
     /**
@@ -2564,55 +2754,6 @@ namespace AppConfigurationObjects
         getOptional("extra", p.extra, j);
     }
 
-    //-----------------------------------------------------------
-    JSON_SERIALIZED_CLASS(TransportImpairment)
-    /**
-     * @brief Description of a transport impairment
-     *
-     * Helper C++ class to serialize and de-serialize TransportImpairment JSON.
-     *
-     * Example: @include[doc] examples/TransportImpairment.json
-     *
-     */
-    class TransportImpairment : public ConfigurationObjectBase
-    {
-        IMPLEMENT_JSON_SERIALIZATION()
-        IMPLEMENT_JSON_DOCUMENTATION(NetworkDeviceDescriptor)
-
-    public:
-        int     applicationPercentage;
-        int     jitterMs;
-        int     lossPercentage;
-
-        TransportImpairment()
-        {
-            clear();
-        }
-
-        void clear()
-        {
-            applicationPercentage = 0;
-            jitterMs = 0;
-            lossPercentage = 0;
-        }
-    };
-
-    static void to_json(nlohmann::json& j, const TransportImpairment& p)
-    {
-        j = nlohmann::json{
-            TOJSON_IMPL(applicationPercentage),
-            TOJSON_IMPL(jitterMs),
-            TOJSON_IMPL(lossPercentage)
-        };
-    }
-    static void from_json(const nlohmann::json& j, TransportImpairment& p)
-    {
-        p.clear();
-        getOptional<int>("applicationPercentage", p.applicationPercentage, j, 0);
-        getOptional<int>("jitterMs", p.jitterMs, j, 0);
-        getOptional<int>("lossPercentage", p.lossPercentage, j, 0);
-    }
-
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(TxAudio)
     /**
@@ -7746,6 +7887,9 @@ namespace AppConfigurationObjects
         /** @brief [Optional] Settings for websocket operation */
         RallypointWebsocketSettings                 websocket;
 
+        /** @brief [Optional] Settings for NSM. */
+        NsmConfiguration                            nsm;
+
         RallypointServer()
         {
             clear();
@@ -7799,6 +7943,7 @@ namespace AppConfigurationObjects
             peerRtTestIntervalMs = 60000;
             peerRtBehaviors.clear();
             websocket.clear();
+            nsm.clear();
         }
     };
 
@@ -7850,7 +7995,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(maxOutboundPeerConnectionIntervalDeltaSecs),
             TOJSON_IMPL(peerRtTestIntervalMs),
             TOJSON_IMPL(peerRtBehaviors),
-            TOJSON_IMPL(websocket)
+            TOJSON_IMPL(websocket),
+            TOJSON_IMPL(nsm)
         };
     }
     static void from_json(const nlohmann::json& j, RallypointServer& p)
@@ -7902,6 +8048,7 @@ namespace AppConfigurationObjects
         getOptional<int>("peerRtTestIntervalMs", p.peerRtTestIntervalMs, j, 60000);
         getOptional<std::vector<RallypointRpRtTimingBehavior>>("peerRtBehaviors", p.peerRtBehaviors, j);
         getOptional<RallypointWebsocketSettings>("websocket", p.websocket, j);
+        getOptional<NsmConfiguration>("nsm", p.nsm, j);
     }
 
     //-----------------------------------------------------------
@@ -7978,6 +8125,7 @@ namespace AppConfigurationObjects
         getOptional<uint32_t>("configurationVersion", p.configurationVersion, j, 0);
     }
 
+
     //-----------------------------------------------------------
     class TimelineEvent
     {
@@ -8420,6 +8568,94 @@ namespace AppConfigurationObjects
         getOptional<std::string>("fingerprint", p.fingerprint, j, EMPTY_STRING);
     }
 
+
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(RiffDescriptor)
+    /**
+    * @brief Helper class for serializing and deserializing the RiffDescriptor JSON
+    *
+    * Helper C++ class to serialize and de-serialize RiffDescriptor JSON
+    *
+    * Example: @include[doc] examples/RiffDescriptor.json
+    *
+    * @see TODO: engageGetRiffDescriptor
+    */
+    class RiffDescriptor : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(RiffDescriptor)
+
+    public:
+        /** @brief Name of the RIFF file. */
+        std::string                             file;
+
+        /** @brief True if the ECDSA signature is verified. */
+        bool                                    verified;
+
+        /** @brief Number of audio channels */
+        int                                     channels;
+
+        /** @brief Number of audio samples */
+        int                                     sampleCount;
+
+        /** @brief [Optional] Meta data associated with the file - typically a stringified JSON object. */
+        std::string                             meta;
+
+        /** @brief [Optional] X.509 certificate in PEM format used to sign the RIFF file. */
+        std::string                             certPem;
+
+        /** @brief [Optional] X.509 certificate parsed into a CertificateDescriptor object. */
+        CertificateDescriptor                   certDescriptor;
+
+        /** @brief [Optional] ECDSA signature */
+        std::string                             signature;
+
+        RiffDescriptor()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            file.clear();
+            verified = false;
+            channels = 0;
+            sampleCount = 0;
+            meta.clear();
+            certPem.clear();
+            certDescriptor.clear();
+            signature.clear();
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const RiffDescriptor& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(file),
+            TOJSON_IMPL(verified),
+            TOJSON_IMPL(channels),
+            TOJSON_IMPL(sampleCount),
+            TOJSON_IMPL(meta),
+            TOJSON_IMPL(certPem),
+            TOJSON_IMPL(certDescriptor),
+            TOJSON_IMPL(signature)
+        };
+    }
+
+    static void from_json(const nlohmann::json& j, RiffDescriptor& p)
+    {
+        p.clear();
+        FROMJSON_IMPL(file, std::string, EMPTY_STRING);
+        FROMJSON_IMPL(verified, bool, false);
+        FROMJSON_IMPL(channels, int, 0);
+        FROMJSON_IMPL(sampleCount, int, 0);
+        FROMJSON_IMPL(meta, std::string, EMPTY_STRING);
+        FROMJSON_IMPL(certPem, std::string, EMPTY_STRING);
+        getOptional<CertificateDescriptor>("certDescriptor", p.certDescriptor, j);
+        FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
+    }
+
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(BridgeCreationDetail)
     /**
@@ -9514,6 +9750,9 @@ namespace AppConfigurationObjects
         /** @brief Address and port of the proxy */
         NetworkAddress                              proxy;
 
+        /** @brief [Optional] Settings for NSM. */
+        NsmConfiguration                            nsm;
+
         LingoServerConfiguration()
         {
             clear();
@@ -9532,9 +9771,10 @@ namespace AppConfigurationObjects
             certStoreFileName.clear();
             certStorePasswordHex.clear();
             enginePolicy.clear();
-            configurationCheckSignalName = "rts.6cc0651.${id}";
+            configurationCheckSignalName = "rts.22f4ec3.${id}";
             fipsCrypto.clear();
             proxy.clear();
+            nsm.clear();
         }
     };
 
@@ -9554,7 +9794,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(enginePolicy),
             TOJSON_IMPL(configurationCheckSignalName),
             TOJSON_IMPL(fipsCrypto),
-            TOJSON_IMPL(proxy)
+            TOJSON_IMPL(proxy),
+            TOJSON_IMPL(nsm)
         };
     }
     static void from_json(const nlohmann::json& j, LingoServerConfiguration& p)
@@ -9571,9 +9812,10 @@ namespace AppConfigurationObjects
         getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
         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<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.22f4ec3.${id}");
         getOptional<FipsCryptoSettings>("fipsCrypo", p.fipsCrypto, j);
         getOptional<NetworkAddress>("proxy", p.proxy, j);
+        getOptional<NsmConfiguration>("nsm", p.nsm, j);
     }
 
 
@@ -9938,7 +10180,10 @@ namespace AppConfigurationObjects
         std::string                                 configurationCheckSignalName;
 
         /** @brief [Optional] Settings for the FIPS crypto. */
-        FipsCryptoSettings                         fipsCrypto;
+        FipsCryptoSettings                          fipsCrypto;
+
+        /** @brief [Optional] Settings for NSM. */
+        NsmConfiguration                            nsm;
 
         BridgingServerConfiguration()
         {
@@ -9961,6 +10206,7 @@ namespace AppConfigurationObjects
             enginePolicy.clear();
             configurationCheckSignalName = "rts.6cc0651.${id}";
             fipsCrypto.clear();
+            nsm.clear();
         }
     };
 
@@ -9980,7 +10226,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(certStorePasswordHex),
             TOJSON_IMPL(enginePolicy),
             TOJSON_IMPL(configurationCheckSignalName),
-            TOJSON_IMPL(fipsCrypto)
+            TOJSON_IMPL(fipsCrypto),
+            TOJSON_IMPL(nsm)
         };
     }
     static void from_json(const nlohmann::json& j, BridgingServerConfiguration& p)
@@ -10000,6 +10247,7 @@ namespace AppConfigurationObjects
         j.at("enginePolicy").get_to(p.enginePolicy);
         getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.6cc0651.${id}");
         getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
+        getOptional<NsmConfiguration>("nsm", p.nsm, j);
     }
 
 
@@ -10220,6 +10468,9 @@ namespace AppConfigurationObjects
         /** @brief [Optional] Settings for the FIPS crypto. */
         FipsCryptoSettings                          fipsCrypto;
 
+        /** @brief [Optional] Settings for NSM. */
+        NsmConfiguration                            nsm;
+
         EarServerConfiguration()
         {
             clear();
@@ -10240,6 +10491,7 @@ namespace AppConfigurationObjects
             enginePolicy.clear();
             configurationCheckSignalName = "rts.9a164fa.${id}";
             fipsCrypto.clear();
+            nsm.clear();
         }
     };
 
@@ -10258,7 +10510,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(certStorePasswordHex),
             TOJSON_IMPL(enginePolicy),
             TOJSON_IMPL(configurationCheckSignalName),
-            TOJSON_IMPL(fipsCrypto)
+            TOJSON_IMPL(fipsCrypto),
+            TOJSON_IMPL(nsm)
         };
     }
     static void from_json(const nlohmann::json& j, EarServerConfiguration& p)
@@ -10275,7 +10528,9 @@ namespace AppConfigurationObjects
         getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
         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<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.9a164fa.${id}");
+        getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
+        getOptional<NsmConfiguration>("nsm", p.nsm, j);
     }
 
     //-----------------------------------------------------------

package/include/EngageInterface.h

@@ -1259,9 +1259,23 @@ ENGAGE_API int engageSetMissionId(const char * _Nullable missionId);
 
 
 /**
- * @brief [SYNC] Opens/creates a certificate store
+ * @brief [SYNC] Creates a certificate store
  *
- * This function opens (or creates) a certificate store and makes it the active certificate store used for the Engine.  The function fails
+ * This function creates a certificate store and makes it the active certificate store used for the Engine.
+ *
+ * No events are generated by this API call.
+ *
+ * @param fileName The full path to the file
+ * @param passwordHexByteString Password as a hex byte string (if the file is to be password protected with an additional application password)
+ * @return ENGAGE_RESULT_OK if the store was opened
+ */
+ENGAGE_API int engageCreateCertStore(const char * _Nonnull fileName, const char * _Nullable passwordHexByteString);
+
+
+/**
+ * @brief [SYNC] Opens a certificate store
+ *
+ * This function opensa certificate store and makes it the active certificate store used for the Engine.  The function fails
  * if the file already exists and it cannot be opened due to file corruption, password mismatch, or invalid content.
  *
  * No events are generated by this API call.
@@ -1612,6 +1626,34 @@ ENGAGE_API int engageIsCryptoFipsValidated(void);
  */
 ENGAGE_API int engageSetCertStore(const uint8_t * _Nonnull buffer, size_t size, const char * _Nullable passwordHexByteString);
 
+/**
+ * @brief [SYNC] Verifies a recorded RIFF file.
+ *
+ * This function verifies a signed, recorded RIFF file.  It returns ENGAGE_RESULT_OK (0) on success.
+ *
+ * No events are generated by this API call.
+ *
+ * @param fn The path to the file.
+ * @return ENGAGE_RESULT_OK if operation was successful.
+ */
+ENGAGE_API int engageVerifyRiff(const char * _Nonnull fn);
+
+/**
+ * @brief [SYNC] Returns a descriptor for a RIFF file
+ *
+ * Call this function to obtain a JSON descriptor of the RIFF file.
+ *
+ * No events are generated by this API call.
+ *
+ * @param fn The path to the file.
+ * @return Zero-terminated string representing a JSON object describing the RIFF file
+ * <P>
+ * Example: @include[doc] examples/RiffDescriptor.json
+ * </P>
+ */
+
+ENGAGE_API const char * _Nonnull engageGetRiffDescriptor(const char * _Nonnull fn);
+
 // TODO: Engage compression/decompression functions not available at this time
 #if 0
 /**

package/package.json

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