mirror of
https://github.com/esp8266/Arduino.git
synced 2025-07-01 03:26:58 +03:00
Due to popular demand, remove the hardcoded dependency on SPIFFS or SD from the CertStore by factoring out the file interface into a new class (CertStoreFile) that the user will need to implement as a thin wrapper around either a SPIFFS.file or a SD.file Combine the downloaded certificates into a UNIX "ar" archive and parse that on-the-fly to allow easy inspection and creation of the Cert Store database. Examples updated with a new certificate downloader that creates the certs.ar archive and with a single sample that can be built for either SPIFFS or SD with a #define. Users can copy the implementation of the CertStoreFile they need to their own code as it is self-contained. Also move the CertStore to the BearSSL namespace and remove the suffix and separate SPIFFS/SD sources. Remove the "deep+" change from the CI build as well (no special options needed on any PIO or makefile build). We'll revisit the filesystem wrapper for 2.5.0, hopefully having a unified template for both filesystem usage at a global level. For current users, be aware the interface may change (simplify!) in release 2.5.0. Fixes #4740
195 lines
5.0 KiB
C++
195 lines
5.0 KiB
C++
/*
|
|
CertStoreBearSSL.cpp - Library for Arduino ESP8266
|
|
Copyright (c) 2018 Earle F. Philhower, III
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#include "CertStoreBearSSL.h"
|
|
#include <memory>
|
|
|
|
namespace BearSSL {
|
|
|
|
extern "C" {
|
|
// Callback for the x509 decoder
|
|
static void dn_append(void *ctx, const void *buf, size_t len) {
|
|
br_sha256_context *sha1 = (br_sha256_context*)ctx;
|
|
br_sha256_update(sha1, buf, len);
|
|
}
|
|
}
|
|
|
|
CertStore::CertInfo CertStore::_preprocessCert(uint32_t length, uint32_t offset, const void *raw) {
|
|
CertStore::CertInfo ci;
|
|
|
|
// Clear the CertInfo
|
|
memset(&ci, 0, sizeof(ci));
|
|
|
|
// Process it using SHA256, same as the hashed_dn
|
|
br_x509_decoder_context *ctx = new br_x509_decoder_context;
|
|
br_sha256_context *sha256 = new br_sha256_context;
|
|
br_sha256_init(sha256);
|
|
br_x509_decoder_init(ctx, dn_append, sha256, nullptr, nullptr);
|
|
br_x509_decoder_push(ctx, (const void*)raw, length);
|
|
|
|
// Copy result to structure
|
|
br_sha256_out(sha256, &ci.sha256);
|
|
ci.length = length;
|
|
ci.offset = offset;
|
|
|
|
// Clean up allocated memory
|
|
delete sha256;
|
|
delete ctx;
|
|
|
|
// Return result
|
|
return ci;
|
|
}
|
|
|
|
// The certs.ar file is a UNIX ar format file, concatenating all the
|
|
// individual certificates into a single blob in a space-efficient way.
|
|
int CertStore::initCertStore(CertStoreFile *index, CertStoreFile *data) {
|
|
int count = 0;
|
|
uint32_t offset = 0;
|
|
|
|
_index = index;
|
|
_data = data;
|
|
|
|
if (!_index || !data) {
|
|
return 0;
|
|
}
|
|
|
|
if (!_index->open(true)) {
|
|
return 0;
|
|
}
|
|
|
|
if (!_data->open(false)) {
|
|
_index->close();
|
|
return 0;
|
|
}
|
|
|
|
char magic[8];
|
|
if (_data->read(magic, sizeof(magic)) != sizeof(magic) ||
|
|
memcmp(magic, "!<arch>\n", sizeof(magic)) ) {
|
|
_data->close();
|
|
_index->close();
|
|
return 0;
|
|
}
|
|
offset += sizeof(magic);
|
|
|
|
while (true) {
|
|
char fileHeader[60];
|
|
// 0..15 = filename in ASCII
|
|
// 48...57 = length in decimal ASCII
|
|
uint32_t length;
|
|
if (data->read(fileHeader, sizeof(fileHeader)) != sizeof(fileHeader)) {
|
|
break;
|
|
}
|
|
offset += sizeof(fileHeader);
|
|
fileHeader[58] = 0;
|
|
if (1 != sscanf(fileHeader + 48, "%d", &length) || !length) {
|
|
break;
|
|
}
|
|
|
|
void *raw = malloc(length);
|
|
if (!raw) {
|
|
break;
|
|
}
|
|
if (_data->read(raw, length) != (ssize_t)length) {
|
|
free(raw);
|
|
break;
|
|
}
|
|
|
|
// If the filename starts with "//" then this is a rename file, skip it
|
|
if (fileHeader[0] != '/' || fileHeader[1] != '/') {
|
|
CertStore::CertInfo ci = _preprocessCert(length, offset, raw);
|
|
if (_index->write(&ci, sizeof(ci)) != (ssize_t)sizeof(ci)) {
|
|
free(raw);
|
|
break;
|
|
}
|
|
count++;
|
|
}
|
|
|
|
offset += length;
|
|
free(raw);
|
|
if (offset & 1) {
|
|
char x;
|
|
_data->read(&x, 1);
|
|
offset++;
|
|
}
|
|
}
|
|
_data->close();
|
|
_index->close();
|
|
return count;
|
|
}
|
|
|
|
void CertStore::installCertStore(br_x509_minimal_context *ctx) {
|
|
br_x509_minimal_set_dynamic(ctx, (void*)this, findHashedTA, freeHashedTA);
|
|
}
|
|
|
|
const br_x509_trust_anchor *CertStore::findHashedTA(void *ctx, void *hashed_dn, size_t len) {
|
|
CertStore *cs = static_cast<CertStore*>(ctx);
|
|
CertStore::CertInfo ci;
|
|
|
|
if (!cs || len != sizeof(ci.sha256) || !cs->_index || !cs->_data) {
|
|
return nullptr;
|
|
}
|
|
|
|
if (!cs->_index->open(false)) {
|
|
return nullptr;
|
|
}
|
|
|
|
while (cs->_index->read(&ci, sizeof(ci)) == sizeof(ci)) {
|
|
if (!memcmp(ci.sha256, hashed_dn, sizeof(ci.sha256))) {
|
|
cs->_index->close();
|
|
uint8_t *der = (uint8_t*)malloc(ci.length);
|
|
if (!der) {
|
|
return nullptr;
|
|
}
|
|
if (!cs->_data->open(false)) {
|
|
free(der);
|
|
return nullptr;
|
|
}
|
|
if (!cs->_data->seek(ci.offset)) {
|
|
cs->_data->close();
|
|
free(der);
|
|
return nullptr;
|
|
}
|
|
if (cs->_data->read(der, ci.length) != (ssize_t)ci.length) {
|
|
free(der);
|
|
return nullptr;
|
|
}
|
|
cs->_data->close();
|
|
cs->_x509 = new BearSSLX509List(der, ci.length);
|
|
free(der);
|
|
|
|
br_x509_trust_anchor *ta = (br_x509_trust_anchor*)cs->_x509->getTrustAnchors();
|
|
memcpy(ta->dn.data, ci.sha256, sizeof(ci.sha256));
|
|
ta->dn.len = sizeof(ci.sha256);
|
|
|
|
return ta;
|
|
}
|
|
}
|
|
cs->_index->close();
|
|
return nullptr;
|
|
}
|
|
|
|
void CertStore::freeHashedTA(void *ctx, const br_x509_trust_anchor *ta) {
|
|
CertStore *cs = static_cast<CertStore*>(ctx);
|
|
(void) ta; // Unused
|
|
delete cs->_x509;
|
|
cs->_x509 = nullptr;
|
|
}
|
|
|
|
}
|