edhoc 1.0.0 → 1.0.2

package/include/EdhocComposeAsyncWorker.h

@@ -0,0 +1,61 @@
+#ifndef EDHOC_COMPOSE_ASYNC_WORKER_H
+#define EDHOC_COMPOSE_ASYNC_WORKER_H
+
+#include <napi.h>
+#include <vector>
+
+extern "C" {
+#include "edhoc.h"
+}
+
+/**
+ * @class EdhocComposeAsyncWorker
+ * @brief Asynchronous worker class for composing EDHOC messages.
+ */
+class EdhocComposeAsyncWorker : public Napi::AsyncWorker {
+ public:
+  /**
+   * @brief The type definition for the callback function.
+   */
+  using CallbackType = std::function<void(Napi::Env&)>;
+
+  /**
+   * @brief Constructor for EdhocComposeAsyncWorker.
+   * @param env The Napi::Env object.
+   * @param deferred The deferred promise object.
+   * @param context The EDHOC context.
+   * @param messageNumber The message number.
+   * @param callback The callback function.
+   */
+  EdhocComposeAsyncWorker(Napi::Env& env,
+                          Napi::Promise::Deferred deferred,
+                          struct edhoc_context& context,
+                          int messageNumber,
+                          CallbackType callback);
+
+  /**
+   * @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:
+  Napi::Promise::Deferred deferred;      ///< The deferred promise object.
+  struct edhoc_context& context;         ///< The EDHOC context.
+  int messageNumber;                     ///< The message number.
+  CallbackType callback;                 ///< The callback function.
+  std::vector<uint8_t> composedMessage;  ///< The composed message.
+};
+
+#endif  // EDHOC_COMPOSE_ASYNC_WORKER_H

package/include/EdhocCredentialManager.h

@@ -0,0 +1,100 @@
+#ifndef EDHOC_CREDENTIAL_MANAGER_H
+#define EDHOC_CREDENTIAL_MANAGER_H
+
+#include <napi.h>
+
+extern "C" {
+#include "edhoc.h"
+}
+
+/**
+ * @class EdhocCredentialManager
+ * @brief The EdhocCredentialManager class manages the credentials required for
+ * EDHOC protocol.
+ */
+class EdhocCredentialManager {
+ public:
+  friend class EdhocCredentialManagerWrapper;
+
+  /**
+   * @struct edhoc_credentials
+   * @brief Libedhoc's bind structure for authentication credentials.
+   */
+  struct edhoc_credentials credentials;
+
+  /**
+   * @brief Constructs an EdhocCredentialManager object.
+   */
+  EdhocCredentialManager(Napi::Object& jsCredentialManager);
+
+  /**
+   * @brief Destroys the EdhocCredentialManager object.
+   */
+  ~EdhocCredentialManager();
+
+  /**
+   * @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(const void* user_context,
+                           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(const void* user_context,
+                            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::ThreadSafeFunction
+      fetchTsfn;  ///< Thread-safe function for FetchCredentials
+  Napi::ThreadSafeFunction
+      verifyTsfn;  ///< Thread-safe function for VerifyCredentials
+
+  /**
+   * @brief Assosciates the thread-safe function with the JS object function.
+   * @param name The name of the function in the JS credential manager object.
+   * @param tsfn The thread-safe function.
+   */
+  void SetFunction(const char* name, Napi::ThreadSafeFunction& tsfn);
+};
+
+#endif  // EDHOC_CREDENTIAL_MANAGER_H

package/include/EdhocCryptoManager.h

@@ -0,0 +1,504 @@
+#ifndef EDHOC_CRYPTO_MANAGER_H
+#define EDHOC_CRYPTO_MANAGER_H
+
+#include <napi.h>
+
+extern "C" {
+#include "edhoc.h"
+}
+
+/**
+ * @class EdhocCryptoManager
+ * @brief Manages cryptographic operations for EDHOC protocol.
+ *
+ * The EdhocCryptoManager class provides methods to perform cryptographic
+ * operations required for the EDHOC protocol. It includes static callback
+ * functions for generating keys, key pairs, key agreement, signing, verifying,
+ * extracting, expanding, encrypting, decrypting, and hashing data.
+ */
+class EdhocCryptoManager {
+ public:
+  friend class EdhocCryptoManagerWrapper;
+
+  /**
+   * @struct edhoc_crypto
+   * @brief Libedhoc's bind structure for cryptographics operations.
+   */
+  struct edhoc_crypto crypto;
+
+  /**
+   * @struct edhoc_keys
+   * @brief Libedhoc's bind structure for cryptographic key identifiers.
+   */
+  struct edhoc_keys keys;
+
+  /**
+   * @brief Constructs an EdhocCryptoManager object.
+   */
+  EdhocCryptoManager(Napi::Object& jsCryptoManager);
+
+  /**
+   * @brief Destroys the EdhocCryptoManager object.
+   */
+  ~EdhocCryptoManager();
+
+  /**
+   * @brief Generate a key.
+   *
+   * @param user_context The user context.
+   * @param key_type The type of the key to generate.
+   * @param raw_key The raw key data.
+   * @param raw_key_length The length of the raw key data.
+   * @param key_id The generated key ID.
+   * @return int The result code.
+   */
+  static int GenerateKey(void* user_context,
+                         enum edhoc_key_type key_type,
+                         const uint8_t* raw_key,
+                         size_t raw_key_length,
+                         void* key_id);
+
+  /**
+   * @brief Destroy a key.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID to destroy.
+   * @return int The result code.
+   */
+  static int DestroyKey(void* user_context, void* key_id);
+
+  /**
+   * @brief Make a key pair.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param private_key The buffer to store the private key.
+   * @param private_key_size The size of the private key buffer.
+   * @param private_key_length The length of the generated private key.
+   * @param public_key The buffer to store the public key.
+   * @param public_key_size The size of the public key buffer.
+   * @param public_key_length The length of the generated public key.
+   * @return int The result code.
+   */
+  static int MakeKeyPair(void* user_context,
+                         const void* key_id,
+                         uint8_t* private_key,
+                         size_t private_key_size,
+                         size_t* private_key_length,
+                         uint8_t* public_key,
+                         size_t public_key_size,
+                         size_t* public_key_length);
+
+  /**
+   * @brief Perform key agreement.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param peer_public_key The peer's public key.
+   * @param peer_public_key_length The length of the peer's public key.
+   * @param shared_secret The buffer to store the shared secret.
+   * @param shared_secret_size The size of the shared secret buffer.
+   * @param shared_secret_length The length of the generated shared secret.
+   * @return int The result code.
+   */
+  static int KeyAgreement(void* user_context,
+                          const void* key_id,
+                          const uint8_t* peer_public_key,
+                          size_t peer_public_key_length,
+                          uint8_t* shared_secret,
+                          size_t shared_secret_size,
+                          size_t* shared_secret_length);
+
+  /**
+   * @brief Sign data.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param input The input data to sign.
+   * @param input_length The length of the input data.
+   * @param signature The buffer to store the signature.
+   * @param signature_size The size of the signature buffer.
+   * @param signature_length The length of the generated signature.
+   * @return int The result code.
+   */
+  static int Sign(void* user_context,
+                  const void* key_id,
+                  const uint8_t* input,
+                  size_t input_length,
+                  uint8_t* signature,
+                  size_t signature_size,
+                  size_t* signature_length);
+
+  /**
+   * @brief Verify a signature.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param input The input data.
+   * @param input_length The length of the input data.
+   * @param signature The signature to verify.
+   * @param signature_length The length of the signature.
+   * @return int The result code.
+   */
+  static int Verify(void* user_context,
+                    const void* key_id,
+                    const uint8_t* input,
+                    size_t input_length,
+                    const uint8_t* signature,
+                    size_t signature_length);
+
+  /**
+   * @brief Extract a pseudo-random key.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param salt The salt data.
+   * @param salt_len The length of the salt data.
+   * @param pseudo_random_key The buffer to store the pseudo-random key.
+   * @param pseudo_random_key_size The size of the pseudo-random key buffer.
+   * @param pseudo_random_key_length The length of the generated pseudo-random
+   * key.
+   * @return int The result code.
+   */
+  static int Extract(void* user_context,
+                     const void* key_id,
+                     const uint8_t* salt,
+                     size_t salt_len,
+                     uint8_t* pseudo_random_key,
+                     size_t pseudo_random_key_size,
+                     size_t* pseudo_random_key_length);
+
+  /**
+   * @brief Expand a key.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param info The info data.
+   * @param info_length The length of the info data.
+   * @param output_keying_material The buffer to store the output keying
+   * material.
+   * @param output_keying_material_length The length of the generated output
+   * keying material.
+   * @return int The result code.
+   */
+  static int Expand(void* user_context,
+                    const void* key_id,
+                    const uint8_t* info,
+                    size_t info_length,
+                    uint8_t* output_keying_material,
+                    size_t output_keying_material_length);
+
+  /**
+   * @brief Encrypt data.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param nonce The nonce data.
+   * @param nonce_length The length of the nonce data.
+   * @param additional_data The additional data.
+   * @param additional_data_length The length of the additional data.
+   * @param plaintext The plaintext data to encrypt.
+   * @param plaintext_length The length of the plaintext data.
+   * @param ciphertext The buffer to store the ciphertext.
+   * @param ciphertext_size The size of the ciphertext buffer.
+   * @param ciphertext_length The length of the generated ciphertext.
+   * @return int The result code.
+   */
+  static int Encrypt(void* user_context,
+                     const void* key_id,
+                     const uint8_t* nonce,
+                     size_t nonce_length,
+                     const uint8_t* additional_data,
+                     size_t additional_data_length,
+                     const uint8_t* plaintext,
+                     size_t plaintext_length,
+                     uint8_t* ciphertext,
+                     size_t ciphertext_size,
+                     size_t* ciphertext_length);
+
+  /**
+   * @brief Decrypt data.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param nonce The nonce data.
+   * @param nonce_length The length of the nonce data.
+   * @param additional_data The additional data.
+   * @param additional_data_length The length of the additional data.
+   * @param ciphertext The ciphertext to decrypt.
+   * @param ciphertext_length The length of the ciphertext.
+   * @param plaintext The buffer to store the plaintext.
+   * @param plaintext_size The size of the plaintext buffer.
+   * @param plaintext_length The length of the generated plaintext.
+   * @return int The result code.
+   */
+  static int Decrypt(void* user_context,
+                     const void* key_id,
+                     const uint8_t* nonce,
+                     size_t nonce_length,
+                     const uint8_t* additional_data,
+                     size_t additional_data_length,
+                     const uint8_t* ciphertext,
+                     size_t ciphertext_length,
+                     uint8_t* plaintext,
+                     size_t plaintext_size,
+                     size_t* plaintext_length);
+
+  /**
+   * @brief Hash data.
+   *
+   * @param user_context The user context.
+   * @param input The input data to hash.
+   * @param input_length The length of the input data.
+   * @param hash The buffer to store the hash.
+   * @param hash_size The size of the hash buffer.
+   * @param hash_length The length of the generated hash.
+   * @return int The result code.
+   */
+  static int Hash(void* user_context,
+                  const uint8_t* input,
+                  size_t input_length,
+                  uint8_t* hash,
+                  size_t hash_size,
+                  size_t* hash_length);
+
+  /**
+   * @brief Calls the GenerateKey function.
+   *
+   * @param user_context The user context.
+   * @param key_type The type of the key to generate.
+   * @param raw_key The raw key data.
+   * @param raw_key_length The length of the raw key data.
+   * @param key_id The generated key ID.
+   * @return int The result code.
+   */
+  int callGenerateKey(const void* user_context,
+                      enum edhoc_key_type key_type,
+                      const uint8_t* raw_key,
+                      size_t raw_key_length,
+                      void* key_id);
+
+  /**
+   * @brief Calls the DestroyKey function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID to destroy.
+   * @return int The result code.
+   */
+  int callDestroyKey(const void* user_context, void* key_id);
+
+  /**
+   * @brief Calls the MakeKeyPair function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param private_key The buffer to store the private key.
+   * @param private_key_size The size of the private key buffer.
+   * @param private_key_length The length of the generated private key.
+   * @param public_key The buffer to store the public key.
+   * @param public_key_size The size of the public key buffer.
+   * @param public_key_length The length of the generated public key.
+   * @return int The result code.
+   */
+  int callMakeKeyPair(const void* user_context,
+                      const void* key_id,
+                      uint8_t* private_key,
+                      size_t private_key_size,
+                      size_t* private_key_length,
+                      uint8_t* public_key,
+                      size_t public_key_size,
+                      size_t* public_key_length);
+
+  /**
+   * @brief Calls the KeyAgreement function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param peer_public_key The peer's public key.
+   * @param peer_public_key_length The length of the peer's public key.
+   * @param shared_secret The buffer to store the shared secret.
+   * @param shared_secret_size The size of the shared secret buffer.
+   * @param shared_secret_length The length of the generated shared secret.
+   * @return int The result code.
+   */
+  int callKeyAgreement(const void* user_context,
+                       const void* key_id,
+                       const uint8_t* peer_public_key,
+                       size_t peer_public_key_length,
+                       uint8_t* shared_secret,
+                       size_t shared_secret_size,
+                       size_t* shared_secret_length);
+
+  /**
+   * @brief Calls the Sign function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param input The input data to sign.
+   * @param input_length The length of the input data.
+   * @param signature The buffer to store the signature.
+   * @param signature_size The size of the signature buffer.
+   * @param signature_length The length of the generated signature.
+   * @return int The result code.
+   */
+  int callSign(const void* user_context,
+               const void* key_id,
+               const uint8_t* input,
+               size_t input_length,
+               uint8_t* signature,
+               size_t signature_size,
+               size_t* signature_length);
+
+  /**
+   * @brief Calls the Verify function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param input The input data.
+   * @param input_length The length of the input data.
+   * @param signature The signature to verify.
+   * @param signature_length The length of the signature.
+   * @return int The result code.
+   */
+  int callVerify(const void* user_context,
+                 const void* key_id,
+                 const uint8_t* input,
+                 size_t input_length,
+                 const uint8_t* signature,
+                 size_t signature_length);
+
+  /**
+   * @brief Calls the Extract function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param salt The salt data.
+   * @param salt_len The length of the salt data.
+   * @param pseudo_random_key The buffer to store the pseudo-random key.
+   * @param pseudo_random_key_size The size of the pseudo-random key buffer.
+   * @param pseudo_random_key_length The length of the generated pseudo-random
+   * key.
+   * @return int The result code.
+   */
+  int callExtract(const void* user_context,
+                  const void* key_id,
+                  const uint8_t* salt,
+                  size_t salt_len,
+                  uint8_t* pseudo_random_key,
+                  size_t pseudo_random_key_size,
+                  size_t* pseudo_random_key_length);
+
+  /**
+   * @brief Calls the Expand function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param info The info data.
+   * @param info_length The length of the info data.
+   * @param output_keying_material The buffer to store the output keying
+   * material.
+   * @param output_keying_material_length The length of the generated output
+   * keying material.
+   * @return int The result code.
+   */
+  int callExpand(const void* user_context,
+                 const void* key_id,
+                 const uint8_t* info,
+                 size_t info_length,
+                 uint8_t* output_keying_material,
+                 size_t output_keying_material_length);
+
+  /**
+   * @brief Calls the Encrypt function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param nonce The nonce data.
+   * @param nonce_length The length of the nonce data.
+   * @param additional_data The additional data.
+   * @param additional_data_length The length of the additional data.
+   * @param plaintext The plaintext data to encrypt.
+   * @param plaintext_length The length of the plaintext data.
+   * @param ciphertext The buffer to store the ciphertext.
+   * @param ciphertext_size The size of the ciphertext buffer.
+   * @param ciphertext_length The length of the generated ciphertext.
+   * @return int The result code.
+   */
+  int callEncrypt(const void* user_context,
+                  const void* key_id,
+                  const uint8_t* nonce,
+                  size_t nonce_length,
+                  const uint8_t* additional_data,
+                  size_t additional_data_length,
+                  const uint8_t* plaintext,
+                  size_t plaintext_length,
+                  uint8_t* ciphertext,
+                  size_t ciphertext_size,
+                  size_t* ciphertext_length);
+
+  /**
+   * @brief Calls the Decrypt function.
+   *
+   * @param user_context The user context.
+   * @param key_id The key ID.
+   * @param nonce The nonce data.
+   * @param nonce_length The length of the nonce data.
+   * @param additional_data The additional data.
+   * @param additional_data_length The length of the additional data.
+   * @param ciphertext The ciphertext to decrypt.
+   * @param ciphertext_length The length of the ciphertext.
+   * @param plaintext The buffer to store the plaintext.
+   * @param plaintext_size The size of the plaintext buffer.
+   * @param plaintext_length The length of the generated plaintext.
+   * @return int The result code.
+   */
+  int callDecrypt(const void* user_context,
+                  const void* key_id,
+                  const uint8_t* nonce,
+                  size_t nonce_length,
+                  const uint8_t* additional_data,
+                  size_t additional_data_length,
+                  const uint8_t* ciphertext,
+                  size_t ciphertext_length,
+                  uint8_t* plaintext,
+                  size_t plaintext_size,
+                  size_t* plaintext_length);
+
+  /**
+   * @brief Calls the Hash function.
+   *
+   * @param user_context The user context.
+   * @param input The input data to hash.
+   * @param input_length The length of the input data.
+   * @param hash The buffer to store the hash.
+   * @param hash_size The size of the hash buffer.
+   * @param hash_length The length of the generated hash.
+   * @return int The result code.
+   */
+  int callHash(const void* user_context,
+               const uint8_t* input,
+               size_t input_length,
+               uint8_t* hash,
+               size_t hash_size,
+               size_t* hash_length);
+
+ private:
+  Napi::ObjectReference cryptoManagerRef;  ///< Reference to the JS object
+
+  std::vector<Napi::Reference<Napi::Buffer<uint8_t>>>
+      bufferReferences;  ///< References to the JS buffers
+
+  /* Thread-safe functions */
+  Napi::ThreadSafeFunction generateTsfn, destroyTsfn, makeKeyPairTsfn,
+      keyAgreementTsfn, signTsfn, verifyTsfn, extractTsfn, expandTsfn,
+      encryptTsfn, decryptTsfn, hashTsfn;
+
+  /**
+   * @brief Assosciates the thread-safe function with the JS object function.
+   * @param name The name of the function in the JS credential manager object.
+   * @param tsfn The thread-safe function.
+   */
+  void SetFunction(const char* name, Napi::ThreadSafeFunction& tsfn);
+};
+
+#endif  // EDHOC_CRYPTO_MANAGER_H