Skip to content

Commit ebe49db

Browse files
microdev1microdev1
authored
Merge pull request adafruit#7029 from jepler/client-certificate
Add support for SSL client certificate (load_cert_chain) and self-signed certificate (load_verify_locations)
2 parents 14c9028 + 0c8b261 commit ebe49db

7 files changed

Lines changed: 86 additions & 7 deletions

File tree

‎ports/espressif/common-hal/ssl/SSLContext.c‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,10 @@ bool common_hal_ssl_sslcontext_get_check_hostname(ssl_sslcontext_obj_t *self) {
8787
void common_hal_ssl_sslcontext_set_check_hostname(ssl_sslcontext_obj_t *self, bool value) {
8888
self->ssl_config.skip_common_name = !value;
8989
}
90+
91+
void common_hal_ssl_sslcontext_load_cert_chain(ssl_sslcontext_obj_t *self, mp_buffer_info_t *cert_buf, mp_buffer_info_t *key_buf) {
92+
self->ssl_config.clientcert_buf = cert_buf->buf;
93+
self->ssl_config.clientcert_bytes = cert_buf->len + 1;
94+
self->ssl_config.clientkey_buf = key_buf->buf;
95+
self->ssl_config.clientkey_bytes = key_buf->len + 1;
96+
}

‎ports/raspberrypi/common-hal/ssl/SSLContext.c‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,10 @@ void common_hal_ssl_sslcontext_construct(ssl_sslcontext_obj_t *self) {
3939

4040
void common_hal_ssl_sslcontext_load_verify_locations(ssl_sslcontext_obj_t *self,
4141
const char *cadata) {
42-
mp_raise_NotImplementedError(NULL);
43-
44-
// self->crt_bundle_attach = NULL;
45-
// self->use_global_ca_store = false;
46-
// self->cacert_buf = (const unsigned char *)cadata;
47-
// self->cacert_bytes = strlen(cadata) + 1;
42+
self->crt_bundle_attach = NULL;
43+
self->use_global_ca_store = false;
44+
self->cacert_buf = (const unsigned char *)cadata;
45+
self->cacert_bytes = strlen(cadata) + 1;
4846
}
4947

5048
void common_hal_ssl_sslcontext_set_default_verify_paths(ssl_sslcontext_obj_t *self) {
@@ -61,3 +59,8 @@ bool common_hal_ssl_sslcontext_get_check_hostname(ssl_sslcontext_obj_t *self) {
6159
void common_hal_ssl_sslcontext_set_check_hostname(ssl_sslcontext_obj_t *self, bool value) {
6260
self->check_name = value;
6361
}
62+
63+
void common_hal_ssl_sslcontext_load_cert_chain(ssl_sslcontext_obj_t *self, mp_buffer_info_t *cert_buf, mp_buffer_info_t *key_buf) {
64+
self->cert_buf = *cert_buf;
65+
self->key_buf = *key_buf;
66+
}

‎ports/raspberrypi/common-hal/ssl/SSLContext.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,5 @@ typedef struct {
3636
const unsigned char *cacert_buf;
3737
size_t cacert_bytes;
3838
int (*crt_bundle_attach)(mbedtls_ssl_config *conf);
39+
mp_buffer_info_t cert_buf, key_buf;
3940
} ssl_sslcontext_obj_t;

‎ports/raspberrypi/common-hal/ssl/SSLSocket.c‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,14 @@ ssl_sslsocket_obj_t *common_hal_ssl_sslcontext_wrap_socket(ssl_sslcontext_obj_t
174174
if (self->crt_bundle_attach != NULL) {
175175
mbedtls_ssl_conf_authmode(&o->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
176176
self->crt_bundle_attach(&o->conf);
177-
// } else if(self->cacert_buf && self->cacert_bytes) { // TODO: user bundle
177+
} else if (self->cacert_buf && self->cacert_bytes) {
178+
ret = mbedtls_x509_crt_parse(&o->cacert, self->cacert_buf, self->cacert_bytes);
179+
if (ret != 0) {
180+
goto cleanup;
181+
}
182+
mbedtls_ssl_conf_authmode(&o->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
183+
mbedtls_ssl_conf_ca_chain(&o->conf, &o->cacert, NULL);
184+
178185
} else {
179186
mbedtls_ssl_conf_authmode(&o->conf, MBEDTLS_SSL_VERIFY_NONE);
180187
}
@@ -197,6 +204,21 @@ ssl_sslsocket_obj_t *common_hal_ssl_sslcontext_wrap_socket(ssl_sslcontext_obj_t
197204

198205
mbedtls_ssl_set_bio(&o->ssl, &o->sock, _mbedtls_ssl_send, _mbedtls_ssl_recv, NULL);
199206

207+
if (self->cert_buf.buf != NULL) {
208+
ret = mbedtls_pk_parse_key(&o->pkey, self->key_buf.buf, self->key_buf.len + 1, NULL, 0);
209+
if (ret != 0) {
210+
goto cleanup;
211+
}
212+
ret = mbedtls_x509_crt_parse(&o->cert, self->cert_buf.buf, self->cert_buf.len + 1);
213+
if (ret != 0) {
214+
goto cleanup;
215+
}
216+
217+
ret = mbedtls_ssl_conf_own_cert(&o->conf, &o->cert, &o->pkey);
218+
if (ret != 0) {
219+
goto cleanup;
220+
}
221+
}
200222
return o;
201223
cleanup:
202224
mbedtls_pk_free(&o->pkey);

‎ports/raspberrypi/mbedtls/mbedtls_config.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@
7777
#define MBEDTLS_AES_C
7878
#define MBEDTLS_ASN1_PARSE_C
7979
#define MBEDTLS_ASN1_WRITE_C
80+
#define MBEDTLS_BASE64_C
8081
#define MBEDTLS_BIGNUM_C
8182
#define MBEDTLS_CIPHER_C
8283
#define MBEDTLS_CTR_DRBG_C
@@ -90,6 +91,7 @@
9091
#define MBEDTLS_MD5_C
9192
#define MBEDTLS_OID_C
9293
#define MBEDTLS_PKCS5_C
94+
#define MBEDTLS_PEM_PARSE_C
9395
#define MBEDTLS_PK_C
9496
#define MBEDTLS_PK_PARSE_C
9597
#define MBEDTLS_PLATFORM_C

‎shared-bindings/ssl/SSLContext.c‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
#include <stdio.h>
2828
#include <string.h>
2929

30+
#include "extmod/vfs.h"
3031
#include "py/objtuple.h"
3132
#include "py/objlist.h"
3233
#include "py/objproperty.h"
@@ -52,6 +53,47 @@ STATIC mp_obj_t ssl_sslcontext_make_new(const mp_obj_type_t *type, size_t n_args
5253
return MP_OBJ_FROM_PTR(s);
5354
}
5455

56+
//| def load_cert_chain(self, certfile: str, keyfile: str) -> None:
57+
//| """Load a private key and the corresponding certificate.
58+
//|
59+
//| The certfile string must be the path to a single file in PEM format
60+
//| containing the certificate as well as any number of CA certificates
61+
//| needed to establish the certificate's authenticity. The keyfile string
62+
//| must point to a file containing the private key.
63+
//| """
64+
65+
STATIC void get_file_contents(mp_obj_t name_obj, mp_buffer_info_t *bufinfo) {
66+
mp_obj_t file = mp_call_function_2(MP_OBJ_FROM_PTR(&mp_builtin_open_obj), name_obj, MP_OBJ_NEW_QSTR(MP_QSTR_rb));
67+
mp_obj_t dest[2];
68+
mp_load_method(file, MP_QSTR_read, dest);
69+
mp_obj_t result = mp_call_method_n_kw(0, 0, dest);
70+
mp_get_buffer_raise(result, bufinfo, MP_BUFFER_READ);
71+
}
72+
73+
STATIC mp_obj_t ssl_sslcontext_load_cert_chain(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
74+
enum { ARG_certfile, ARG_keyfile };
75+
static const mp_arg_t allowed_args[] = {
76+
{ MP_QSTR_certfile, MP_ARG_REQUIRED | MP_ARG_OBJ, {.u_obj = mp_const_none} },
77+
{ MP_QSTR_keyfile, MP_ARG_OBJ, {.u_obj = mp_const_none} },
78+
};
79+
ssl_sslcontext_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
80+
81+
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
82+
mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
83+
84+
mp_buffer_info_t cert_buf, key_buf;
85+
get_file_contents(args[ARG_certfile].u_obj, &cert_buf);
86+
if (args[ARG_keyfile].u_obj != mp_const_none) {
87+
get_file_contents(args[ARG_keyfile].u_obj, &key_buf);
88+
} else {
89+
key_buf = cert_buf;
90+
}
91+
92+
common_hal_ssl_sslcontext_load_cert_chain(self, &cert_buf, &key_buf);
93+
return mp_const_none;
94+
}
95+
STATIC MP_DEFINE_CONST_FUN_OBJ_KW(ssl_sslcontext_load_cert_chain_obj, 1, ssl_sslcontext_load_cert_chain);
96+
5597
//| def load_verify_locations(self, cadata: Optional[str] = None) -> None:
5698
//| """Load a set of certification authority (CA) certificates used to validate
5799
//| other peers' certificates."""
@@ -146,6 +188,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(ssl_sslcontext_wrap_socket_obj, 1, ssl_sslcont
146188

147189
STATIC const mp_rom_map_elem_t ssl_sslcontext_locals_dict_table[] = {
148190
{ MP_ROM_QSTR(MP_QSTR_wrap_socket), MP_ROM_PTR(&ssl_sslcontext_wrap_socket_obj) },
191+
{ MP_ROM_QSTR(MP_QSTR_load_cert_chain), MP_ROM_PTR(&ssl_sslcontext_load_cert_chain_obj) },
149192
{ MP_ROM_QSTR(MP_QSTR_load_verify_locations), MP_ROM_PTR(&ssl_sslcontext_load_verify_locations_obj) },
150193
{ MP_ROM_QSTR(MP_QSTR_set_default_verify_paths), MP_ROM_PTR(&ssl_sslcontext_set_default_verify_paths_obj) },
151194
{ MP_ROM_QSTR(MP_QSTR_check_hostname), MP_ROM_PTR(&ssl_sslcontext_check_hostname_obj) },

‎shared-bindings/ssl/SSLContext.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,6 @@ void common_hal_ssl_sslcontext_set_default_verify_paths(ssl_sslcontext_obj_t *se
4646

4747
bool common_hal_ssl_sslcontext_get_check_hostname(ssl_sslcontext_obj_t *self);
4848
void common_hal_ssl_sslcontext_set_check_hostname(ssl_sslcontext_obj_t *self, bool value);
49+
void common_hal_ssl_sslcontext_load_cert_chain(ssl_sslcontext_obj_t *self, mp_buffer_info_t *cert_buf, mp_buffer_info_t *key_buf);
4950

5051
#endif // MICROPY_INCLUDED_SHARED_BINDINGS_SSL_SSLCONTEXT_H

0 commit comments

Comments
 (0)