Move to new BearSSL:: namespace for classes

esp8266 · earlephilhower · Dec 3, 2018 · Oct 6, 2018 · Oct 6, 2018 · Oct 6, 2018
commit b3b7477c3c96e65deee90d1cdcf5876f955494eb
diff --git a/cores/esp8266/Updater.cpp b/cores/esp8266/Updater.cpp
@@ -13,9 +13,9 @@
 
 #if ARDUINO_SIGNING
   #include "../../libraries/ESP8266WiFi/src/BearSSLHelpers.h"
-  static BearSSLPublicKey signPubKey(signing_pubkey);
-  static BearSSLHashSHA256 hash;
-  static BearSSLSigningVerifier sign(&signPubKey);
+  static BearSSL::PublicKey signPubKey(signing_pubkey);
+  static BearSSL::HashSHA256 hash;
+  static BearSSL::SigningVerifier sign(&signPubKey);
 #endif
 
 extern "C" {

diff --git a/doc/ota_updates/readme.rst b/doc/ota_updates/readme.rst
@@ -110,9 +110,9 @@ Users may also manually sign executables and require the OTA process to verify t
 .. code:: cpp
 
     <in globals>
-    BearSSLPublicKey signPubKey( ... key contents ... );
-    BearSSLHashSHA256 hash;
-    BearSSLSigningVerifier sign( &signPubKey );
+    BearSSL::PublicKey signPubKey( ... key contents ... );
+    BearSSL::HashSHA256 hash;
+    BearSSL::SigningVerifier sign( &signPubKey );
     ...
     <in setup()>
     Update.installSignature( &hash, &sign );

diff --git a/libraries/ESP8266WiFi/src/BearSSLHelpers.cpp b/libraries/ESP8266WiFi/src/BearSSLHelpers.cpp
@@ -826,29 +826,29 @@ bool X509List::append(const uint8_t *derCert, size_t derLen) {
 }
 
 // SHA256 hash for updater
-void BearSSLHashSHA256::begin() {
+void HashSHA256::begin() {
   br_sha256_init( &_cc );
   memset( _sha256, 0, sizeof(_sha256) );
 }
 
-void BearSSLHashSHA256::add(const void *data, uint32_t len) {
+void HashSHA256::add(const void *data, uint32_t len) {
   br_sha256_update( &_cc, data, len );
 }
 
-void BearSSLHashSHA256::end() {
+void HashSHA256::end() {
   br_sha256_out( &_cc, _sha256 );
 }
 
-int BearSSLHashSHA256::len() {
+int HashSHA256::len() {
   return sizeof(_sha256);
 }
 
-const void *BearSSLHashSHA256::hash() {
+const void *HashSHA256::hash() {
   return (const void*) _sha256;
 }
 
 // SHA256 verifier
-uint32_t BearSSLSigningVerifier::length()
+uint32_t SigningVerifier::length()
 {
   if (!_pubKey) {
     return 0;
@@ -861,7 +861,7 @@ uint32_t BearSSLSigningVerifier::length()
   }
 }
 
-bool BearSSLSigningVerifier::verify(UpdaterHashClass *hash, const void *signature, uint32_t signatureLen) {
+bool SigningVerifier::verify(UpdaterHashClass *hash, const void *signature, uint32_t signatureLen) {
   if (!_pubKey || !hash || !signature || signatureLen != length()) return false;
 
   if (_pubKey->isRSA()) {

diff --git a/libraries/ESP8266WiFi/src/BearSSLHelpers.h b/libraries/ESP8266WiFi/src/BearSSLHelpers.h
@@ -139,7 +139,7 @@ class Session {
 };
 
 // Updater SHA256 hash and signature verification
-class BearSSLHashSHA256 : public UpdaterHashClass {
+class HashSHA256 : public UpdaterHashClass {
   public:
     virtual void begin() override;
     virtual void add(const void *data, uint32_t len) override;
@@ -151,16 +151,16 @@ class BearSSLHashSHA256 : public UpdaterHashClass {
     unsigned char _sha256[32];
 };
 
-class BearSSLSigningVerifier : public UpdaterVerifyClass {
+class SigningVerifier : public UpdaterVerifyClass {
   public:
     virtual uint32_t length() override;
     virtual bool verify(UpdaterHashClass *hash, const void *signature, uint32_t signatureLen) override;
 
   public:
-    BearSSLSigningVerifier(BearSSLPublicKey *pubKey) { _pubKey = pubKey; }
+    SigningVerifier(PublicKey *pubKey) { _pubKey = pubKey; }
 
   private:
-    BearSSLPublicKey *_pubKey;
+    PublicKey *_pubKey;
 };
 
 };

diff --git a/libraries/ESP8266httpUpdate/examples/httpUpdateSigned/httpUpdateSigned.ino b/libraries/ESP8266httpUpdate/examples/httpUpdateSigned/httpUpdateSigned.ino
@@ -40,9 +40,9 @@ TQIDAQAB
 -----END PUBLIC KEY-----
 )EOF";
 #if MANUAL_SIGNING
-BearSSLPublicKey *signPubKey = nullptr;
-BearSSLHashSHA256 *hash;
-BearSSLSigningVerifier *sign;
+BearSSL::PublicKey *signPubKey = nullptr;
+BearSSL::HashSHA256 *hash;
+BearSSL::SigningVerifier *sign;
 #endif
 
 void setup() {
@@ -64,9 +64,9 @@ void setup() {
   WiFiMulti.addAP("SSID", "PASS");
 
   #if MANUAL_SIGNING
-  signPubKey = new BearSSLPublicKey(pubkey);
-  hash = new BearSSLHashSHA256();
-  sign = new BearSSLSigningVerifier(signPubKey);
+  signPubKey = new BearSSL::PublicKey(pubkey);
+  hash = new BearSSL::HashSHA256();
+  sign = new BearSSL::SigningVerifier(signPubKey);
   #endif
 }