hmac_sha256.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/defines.h"
#if defined(USE_ESP32) || defined(USE_ESP8266) || defined(USE_RP2040) || defined(USE_LIBRETINY) || defined(USE_HOST)
 
#include <string>
 
#if defined(USE_ESP32)
#include <esp_idf_version.h>
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0)
// mbedtls 4.0 (IDF 6.0) removed the legacy mbedtls_md HMAC API.
// Use the PSA Crypto MAC API instead.
#define USE_HMAC_SHA256_PSA
#include <psa/crypto.h>
#else
#define USE_HMAC_SHA256_MBEDTLS
#include "mbedtls/md.h"
#endif
#elif defined(USE_LIBRETINY)
#define USE_HMAC_SHA256_MBEDTLS
#include "mbedtls/md.h"
#else
#include "esphome/components/sha256/sha256.h"
#endif
 
namespace esphome::hmac_sha256 {
 
class HmacSHA256 {
 public:
  HmacSHA256() = default;
  ~HmacSHA256();
 
  void init(const uint8_t *key, size_t len);
  void init(const char *key, size_t len) { this->init((const uint8_t *) key, len); }
  void init(const std::string &key) { this->init(key.c_str(), key.length()); }
 
  void add(const uint8_t *data, size_t len);
  void add(const char *data, size_t len) { this->add((const uint8_t *) data, len); }
 
  void calculate();
 
  void get_bytes(uint8_t *output);
 
  void get_hex(char *output);
 
  bool equals_bytes(const uint8_t *expected);
 
  bool equals_hex(const char *expected);
 
 protected:
#if defined(USE_HMAC_SHA256_PSA)
  static constexpr size_t SHA256_DIGEST_SIZE = 32;
  psa_mac_operation_t op_ = PSA_MAC_OPERATION_INIT;
  mbedtls_svc_key_id_t key_id_ = MBEDTLS_SVC_KEY_ID_INIT;
  uint8_t digest_[SHA256_DIGEST_SIZE]{};
#elif defined(USE_HMAC_SHA256_MBEDTLS)
  static constexpr size_t SHA256_DIGEST_SIZE = 32;
  mbedtls_md_context_t ctx_{};
  uint8_t digest_[SHA256_DIGEST_SIZE]{};
#else
  sha256::SHA256 ihash_;
  sha256::SHA256 ohash_;
#endif
};
 
}  // namespace esphome::hmac_sha256
#endif