edhoc 1.4.0 → 2.0.0

package/include/Binding.h

@@ -1,359 +0,0 @@
-#ifndef LIB_EDHOC_H
-#define LIB_EDHOC_H
-
-#include <napi.h>
-
-#include "EdhocCredentialManager.h"
-#include "EdhocCryptoManager.h"
-#include "EdhocEadManager.h"
-#include "RunningContext.h"
-
-extern "C" {
-#include "edhoc.h"
-}
-
-/**
- * @class Edhoc
- * @brief A class that represents the Edhoc object.
- *
- * The Edhoc class is a wrapper around the EDHOC library and provides
- * an interface for performing EDHOC operations. It allows users to
- * initialize the EDHOC context, set connection identifiers, set the
- * method used in EDHOC, set cipher suites, set a logger function, and
- * compose/process EDHOC messages.
- */
-class Edhoc : public Napi::ObjectWrap<Edhoc> {
- public:
-  /**
-   * @brief Initializes the Edhoc object.
-   *
-   * This static method is used to initialize the Edhoc object and
-   * bind it to the provided JavaScript environment.
-   *
-   * @param env The Napi::Env representing the JavaScript environment.
-   * @param exports The Napi::Object representing the exports object.
-   * @return Napi::Object The initialized Edhoc object.
-   */
-  static Napi::Object Init(Napi::Env env, Napi::Object exports);
-
-  /**
-   * @brief Constructs a Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   */
-  Edhoc(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Destroys the Edhoc object.
-   */
-  ~Edhoc();
-
-  /**
-   * @brief Gets the connection identifier (C_I or C_R depending on the role).
-   *
-   * This method returns the connection identifier (C_I or C_R depending on the
-   * role).
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The connection identifier (C_I or C_R depending on the
-   * role).
-   */
-  Napi::Value GetCID(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Sets the connection identifier (C_I or C_R depending on the role).
-   *
-   * This method sets the connection identifier (C_I or C_R depending on the
-   * role).
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @param value The Napi::Value representing the connection identifier (C_I or
-   * C_R depending on the role).
-   */
-  void SetCID(const Napi::CallbackInfo& info, const Napi::Value& value);
-
-  /**
-   * @brief Gets the peer connection identifier (C_I or C_R depending on the
-   * role).
-   *
-   * This method returns the peer connection identifier (C_I or C_R depending on
-   * the role).
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The peer connection identifier (C_I or C_R depending on
-   * the role).
-   */
-  Napi::Value GetPeerCID(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Gets the Method (RFC 9528: 3.2.) used in EDHOC.
-   *
-   * This method returns the Method (RFC 9528: 3.2.) used in EDHOC
-   * associated with the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The supported methods used in EDHOC.
-   */
-  Napi::Value GetMethods(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Sets the Method (RFC 9528: 3.2.) used in EDHOC.
-   *
-   * This method sets the supported methods (RFC 9528: 3.2.) used in EDHOC for
-   * the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @param value The Napi::Value representing the supported methods used in EDHOC.
-   */
-  void SetMethods(const Napi::CallbackInfo& info, const Napi::Value& value);
-
-  /**
-   * @brief Gets the selected method.
-   *
-   * This method returns the selected method associated with the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The selected method.
-   */
-  Napi::Value GetSelectedMethod(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Sets the cipher suites.
-   *
-   * This method sets the cipher suites for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @param value The Napi::Value representing the cipher suites.
-   */
-  void SetCipherSuites(const Napi::CallbackInfo& info, const Napi::Value& value);
-
-  /**
-   * @brief Gets the cipher suites.
-   *
-   * This method returns the cipher suites associated with the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The cipher suites.
-   */
-  Napi::Value GetCipherSuites(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Gets the selected cipher suite.
-   *
-   * This method returns the selected cipher suite associated with the Edhoc
-   * object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The selected cipher suite.
-   */
-  Napi::Value GetSelectedCipherSuite(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Gets the logger function.
-   *
-   * This method returns the logger function associated with the Edhoc
-   * object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The logger function.
-   */
-  Napi::Value GetLogger(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Sets the logger function.
-   *
-   * This method sets the logger function for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @param value The Napi::Value representing the logger function.
-   */
-  void SetLogger(const Napi::CallbackInfo& info, const Napi::Value& value);
-  
-  /**
-   * @brief Resets the EDHOC context.
-   *
-   * This method resets the EDHOC context for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value void.
-   */
-  void Reset(const Napi::CallbackInfo& info);
-  
-  /**
-   * @brief Composes EDHOC message 1.
-   *
-   * This method composes EDHOC message 1 for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The composed EDHOC message 1.
-   */
-  Napi::Value ComposeMessage1(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Processes EDHOC message 1.
-   *
-   * This method processes EDHOC message 1 for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The EAD data from message 1 or Null.
-   */
-  Napi::Value ProcessMessage1(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Composes EDHOC message 2.
-   *
-   * This method composes EDHOC message 2 for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The composed EDHOC message 2.
-   */
-  Napi::Value ComposeMessage2(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Processes EDHOC message 2.
-   *
-   * This method processes EDHOC message 2 for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The EAD data from message 2 or Null.
-   */
-  Napi::Value ProcessMessage2(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Composes EDHOC message 3.
-   *
-   * This method composes EDHOC message 3 for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The composed EDHOC message 3.
-   */
-  Napi::Value ComposeMessage3(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Processes EDHOC message 3.
-   *
-   * This method processes EDHOC message 3 for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The EAD data from message 3 or Null.
-   */
-  Napi::Value ProcessMessage3(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Composes EDHOC message 4.
-   *
-   * This method composes EDHOC message 4 for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The composed EDHOC message 4.
-   */
-  Napi::Value ComposeMessage4(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Processes EDHOC message 4.
-   *
-   * This method processes EDHOC message 4 for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The EAD data from message 4 or Null.
-   */
-  Napi::Value ProcessMessage4(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Exports OSCORE.
-   *
-   * This method exports an OSCORE context object containing the master key,
-   * salt, recipient ID, and sender ID for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The exported OSCORE context object.
-   */
-  Napi::Value ExportOSCORE(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Exports keying material using the EDHOC_Exporter interface.
-   *
-   * This method derives keying material using the EDHOC_Exporter, which
-   * utilizes an `exporter_label`, `context`, and `length` to generate the
-   * key.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The derived keying material.
-   */
-  Napi::Value ExportKey(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Exports the peer credentials used during the EDHOC exchange.
-   *
-   * Returns the last credentials object returned from the user-provided
-   * credential manager's verify() function. This is a synchronous call.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value The peer credentials object or Null if not available.
-   */
-  Napi::Value ExportUsedPeerCredentials(const Napi::CallbackInfo& info);
-
-  /**
-   * @brief Performs a key update.
-   *
-   * This method performs a key update for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @return Napi::Value void.
-   */
-  Napi::Value KeyUpdate(const Napi::CallbackInfo& info);
-
- private:
-  
-  std::unique_ptr<edhoc_context> edhocContext_;  ///< The EDHOC context.
-
-  std::unique_ptr<RunningContext> runningContext_;  ///< The running context.
-
-  struct edhoc_connection_id cid_;  ///< RFC 9528: 3.3.2. Representation of Byte String Identifiers.
-  
-  Napi::FunctionReference logger_;  ///< N-API reference to the logger function
-  
-  std::unique_ptr<EdhocCryptoManager> cryptoManager_;          ///< The crypto manager
-  
-  std::unique_ptr<EdhocEadManager> eadManager_;                ///< The EAD manager
-  
-  std::unique_ptr<EdhocCredentialManager> credentialManager_;  ///< The credential manager
-
-  void StartRunningContext(Napi::Env env);
-
-  /**
-   * @brief Logger function for the Edhoc object.
-   *
-   * This static method is used to log messages from the EDHOC library.
-   *
-   * @param user_context The user context.
-   * @param name The name of the logger.
-   * @param buffer The buffer containing the log message.
-   * @param buffer_length The length of the log message buffer.
-   */
-  static void Logger(void* user_context, const char* name, const uint8_t* buffer, size_t buffer_length);
-
-  /**
-   * @brief Composes an EDHOC message.
-   *
-   * This method is used to compose an EDHOC message for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @param message The EDHOC message to compose.
-   * @return Napi::Value The composed EDHOC message.
-   */
-  Napi::Value ComposeMessage(const Napi::CallbackInfo& info, enum edhoc_message message);
-
-  /**
-   * @brief Processes an EDHOC message.
-   *
-   * This method is used to process an EDHOC message for the Edhoc object.
-   *
-   * @param info The Napi::CallbackInfo representing the callback information.
-   * @param message The EDHOC message to process.
-   * @return Napi::Value The EAD data or Null for given EDHOC message.
-   */
-  Napi::Value ProcessMessage(const Napi::CallbackInfo& info, enum edhoc_message message);
-};
-
-#endif  // LIB_EDHOC_H

package/include/EdhocComposeAsyncWorker.h

@@ -1,49 +0,0 @@
-#ifndef EDHOC_COMPOSE_ASYNC_WORKER_H
-#define EDHOC_COMPOSE_ASYNC_WORKER_H
-
-#include <napi.h>
-#include <vector>
-
-#include "RunningContext.h"
-
-extern "C" {
-#include "edhoc.h"
-}
-
-/**
- * @class EdhocComposeAsyncWorker
- * @brief Asynchronous worker class for composing EDHOC messages.
- */
-class EdhocComposeAsyncWorker : public Napi::AsyncWorker {
- public:
-  /**
-   * @brief Constructor for EdhocComposeAsyncWorker.
-   * @param runningContext The pointer to the running context.
-   * @param messageNumber The message number.
-   */
-  EdhocComposeAsyncWorker(RunningContext* runningContext, int messageNumber);
-  
-  /**
-   * @brief Executes the asynchronous worker task.
-   */
-  void Execute() override;
-
-  /**
-   * @brief Executes when the asynchronous worker task is completed
-   * successfully.
-   */
-  void OnOK() override;
-
-  /**
-   * @brief Executes when an error occurs during the asynchronous worker task.
-   * @param error The Napi::Error object.
-   */
-  void OnError(const Napi::Error& error) override;
-
- private:
-  RunningContext* runningContext_;        ///< The pointer to the running context.
-  int messageNumber_;                     ///< The message number.
-  std::vector<uint8_t> composedMessage_;  ///< The composed message.
-};
-
-#endif  // EDHOC_COMPOSE_ASYNC_WORKER_H

package/include/EdhocCredentialManager.h

@@ -1,106 +0,0 @@
-#ifndef EDHOC_CREDENTIAL_MANAGER_H
-#define EDHOC_CREDENTIAL_MANAGER_H
-
-#include <napi.h>
-
-extern "C" {
-#include "edhoc.h"
-}
-
-class RunningContext;
-
-/**
- * @class EdhocCredentialManager
- * @brief The EdhocCredentialManager class manages the credentials required for
- * EDHOC protocol.
- */
-class EdhocCredentialManager {
- public:
-  friend class EdhocCredentialManagerWrapper;
-
-  /**
-   * @struct edhoc_credentials
-   * @brief Edhoc's bind structure for authentication credentials.
-   */
-  struct edhoc_credentials credentials;
-
-  /**
-   * @brief Constructs an EdhocCredentialManager object.
-   */
-  EdhocCredentialManager(Napi::Object& jsCredentialManager, Napi::Object& jsEdhoc);
-
-  /**
-   * @brief Destroys the EdhocCredentialManager object.
-   */
-  ~EdhocCredentialManager();
-
-  /**
-   * @brief Clears any cached credential objects from the previous EDHOC run.
-   *
-   * This is intended to be called from EDHOC::reset() to avoid leaking
-   * credential references across sessions and to ensure exported values
-   * reflect only the current session.
-   */
-  void ClearCachedCredentials();
-
-  /**
-   * @brief Returns the last peer credentials object returned from JS verify().
-   *
-   * @return Napi::Value The cached credentials object, or null if not available.
-   */
-  Napi::Value GetCachedPeerCredentials(Napi::Env env);
-
-  /**
-   * @brief Static function to fetch the credentials.
-   * @param user_context The user context.
-   * @param credentials Pointer to the edhoc_auth_creds structure to store the
-   * fetched credentials.
-   * @return EDHOC_SUCCESS if successful, otherwise an error code.
-   */
-  static int FetchCredentials(void* user_context, struct edhoc_auth_creds* credentials);
-
-  /**
-   * @brief Static function to verify the credentials.
-   * @param user_context The user context.
-   * @param credentials Pointer to the edhoc_auth_creds structure containing the
-   * credentials to verify.
-   * @param public_key_reference Pointer to the public key reference.
-   * @param public_key_length Pointer to the length of the public key.
-   * @return EDHOC_SUCCESS if successful, otherwise an error code.
-   */
-  static int VerifyCredentials(void* user_context,
-                               struct edhoc_auth_creds* credentials,
-                               const uint8_t** public_key_reference,
-                               size_t* public_key_length);
-
-  /**
-   * @brief Calls the FetchCredentials function.
-   * @param user_context The user context.
-   * @param credentials Pointer to the edhoc_auth_creds structure to store the
-   * fetched credentials.
-   * @return EDHOC_SUCCESS if successful, otherwise an error code.
-   */
-  int callFetchCredentials(RunningContext* runningContext, struct edhoc_auth_creds* credentials);
-
-  /**
-   * @brief Calls the VerifyCredentials function.
-   * @param user_context The user context.
-   * @param credentials Pointer to the edhoc_auth_creds structure containing the
-   * credentials to verify.
-   * @param public_key_reference Pointer to the public key reference.
-   * @param public_key_length Pointer to the length of the public key.
-   * @return EDHOC_SUCCESS if successful, otherwise an error code.
-   */
-  int callVerifyCredentials(RunningContext* runningContext,
-                            struct edhoc_auth_creds* credentials,
-                            const uint8_t** public_key_reference,
-                            size_t* public_key_length);
-
- private:
-  std::vector<Napi::Reference<Napi::Object>> credentialReferences_;  ///< References to the JS objects
-  Napi::ObjectReference credentialManagerRef_;                       ///< Reference to the JS object
-  Napi::ObjectReference edhocRef_;
-  Napi::ObjectReference cachedPeerCredentialsRef_;                   ///< Cached peer credential (post-verify)
-};
-
-#endif  // EDHOC_CREDENTIAL_MANAGER_H