extmod/modussl_mbedtls: Wire in support for DTLS #10062

damz · 2022-11-23T19:43:57Z

What is this PR trying to solve?

This PR enables support for DTLS (i.e. TLS over datagram transport protocols like UDP). While support for DTLS is absent in cpython, it is worth supporting it in micropython because it is the basis of the ubiquitous CoAP protocol, used in many IOT projects. See #5270

How does this PR solve the problem?

A new set of "protocols" are added to SSLContext:

ssl.PROTOCOL_DTLS_CLIENT
ssl.PROTOCOL_DTLS_SERVER

They act as you expect. If one of these is set, the library assumes that the underlying socket is a datagram-like socket (i.e. UDP or similar).

Implement our own timer callbacks as the out of the box implementation relies on gettimeofday().

TODO: To fully support asyncio for DTLS socket, we will need to return a readable or writable event in poll(MP_STREAM_POLL, ...) if _mbedtls_timing_get_delay(self) >= 1. This is left for future work so as not to interfere with #9871.

damz · 2022-11-23T19:45:17Z

Note that I only enabled it on the esp32 port so far. The size increase of the micropython.elf file on that port is 8.68 kB. Do we think it is reasonable to enable on all mbedtls-based ports?

stigbjorlykke · 2023-01-29T19:51:08Z

extmod/modussl_mbedtls.c

@@ -187,7 +230,7 @@ STATIC mp_obj_ssl_socket_t *socket_new(mp_obj_t sock, struct ssl_args *args) {

    ret = mbedtls_ssl_config_defaults(&o->conf,
        args->server_side.u_bool ? MBEDTLS_SSL_IS_SERVER : MBEDTLS_SSL_IS_CLIENT,
-        MBEDTLS_SSL_TRANSPORT_STREAM,
+        args->dtls.u_bool ? MBEDTLS_SSL_TRANSPORT_DATAGRAM : MBEDTLS_SSL_TRANSPORT_STREAM,


Is it possible to check the underlying socket type (SOCK_DGRAM) instead of adding a new variable for dtls?

Hey @stigbjorlykke after looking into this a bit, I don't believe that it is possible. DTLS lives on top of UDP, so the SOCK_DGRAM type doesn't have that context needed.

keenanjohnson · 2023-04-19T20:20:17Z

Hey all! I would really like to see this change go through and I'm happy to help jump in and push this through. @stigbjorlykke is your comment a requirement before we merge this or is it a suggestion we are ok with accepting for now?

Are there any other changes needed by the reviewers?

stigbjorlykke · 2023-04-29T19:43:23Z

@stigbjorlykke is your comment a requirement before we merge this or is it a suggestion we are ok with accepting for now?

This is not a requirement, it's a suggestion for a better API. The socket already know it's type, and adding an extra (superfluous) variable makes it easier to write faulty code. I have no idea how easy it is to check this, which is why I ask.

keenanjohnson · 2023-07-30T22:25:01Z

I've looked into the comment and I don't believe that the socket does know it's DTLS type, so I believe the extra variable is required.

Are you looking at an additional set of the defined SOCK_DGRAM types @stigbjorlykke?

Any help to get this merged as soon as possible would really help out our project :)

Thanks!

mynameisvasco · 2023-11-01T22:09:57Z

Any update on this?

codecov · 2024-01-07T03:58:20Z

Codecov Report

Attention: Patch coverage is 63.15789% with 7 lines in your changes missing coverage. Please review.

Project coverage is 98.33%. Comparing base (42eab32) to head (ddb064f).
Report is 1167 commits behind head on master.

Files with missing lines	Patch %	Lines
extmod/modssl_mbedtls.c	63.15%	7 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #10062      +/-   ##
==========================================
- Coverage   98.36%   98.33%   -0.04%     
==========================================
  Files         159      159              
  Lines       21088    21106      +18     
==========================================
+ Hits        20743    20754      +11     
- Misses        345      352       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2024-01-07T04:05:05Z

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64: +8720 +1.079% standard[incl +192(data)]
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS

Signed-off-by: Damien Tournoud <damien@platform.sh>

projectgus · 2024-03-07T23:51:09Z

This is an automated heads-up that we've just merged a Pull Request
that removes the STATIC macro from MicroPython's C API.

See #13763

A search suggests this PR might apply the STATIC macro to some C code. If it
does, then next time you rebase the PR (or merge from master) then you should
please replace all the STATIC keywords with static.

Although this is an automated message, feel free to @-reply to me directly if
you have any questions about this.

keenanjohnson · 2024-09-02T20:23:25Z

Hey @damz are you still able to update this for the static keyword change that @projectgus mentioned above? If not, I can fork and take this on, as I still think this would be a big win to merge upstream as we use it every day in our projects.

keenanjohnson · 2024-09-02T20:24:37Z

What else are we waiting on to merge this in @stigbjorlykke or any other maintainers? I haven't seen any concrete feedback and I would like to help get this over the finish line.

keenanjohnson · 2024-09-02T21:27:57Z

I created #15764 which makes the updates to the static keyword and handles a file renaming that occurred in the upstream repo.

This commit enables support for DTLS, i.e. TLS over datagram transport protocols like UDP. While support for DTLS is absent in CPython, it is worth supporting it in MicroPython because it is the basis of the ubiquitous CoAP protocol, used in many IoT projects. To select DTLS, a new set of "protocols" are added to SSLContext: - ssl.PROTOCOL_DTLS_CLIENT - ssl.PROTOCOL_DTLS_SERVER If one of these is set, the library assumes that the underlying socket is a datagram-like socket (i.e. UDP or similar). Our own timer callbacks are implemented because the out of the box implementation relies on `gettimeofday()`. This new DTLS feature is enabled on all ports that use mbedTLS. This commit is an update to a previous PR micropython#10062. Addresses issue micropython#5270 which requested DTLS support. Signed-off-by: Keenan Johnson <keenan.johnson@gmail.com>

dpgeorge · 2025-02-14T02:49:21Z

A revised version of this PR was merged in 321b30c

Thanks @damz for the original work here.

…vi-rebased Add supervisor.runtime.display & RP2350 DVI autoconfig (rebased version)

keenanjohnson · 2025-02-15T21:24:28Z

Yes thank you so much to @damz for the original PR, and @dpgeorge and @projectgus for the help reviewing! It's been a long time in the making but hopefully this is of use to many people! It's already of great use to me and my project!

This commit enables support for DTLS, i.e. TLS over datagram transport protocols like UDP. While support for DTLS is absent in CPython, it is worth supporting it in MicroPython because it is the basis of the ubiquitous CoAP protocol, used in many IoT projects. To select DTLS, a new set of "protocols" are added to SSLContext: - ssl.PROTOCOL_DTLS_CLIENT - ssl.PROTOCOL_DTLS_SERVER If one of these is set, the library assumes that the underlying socket is a datagram-like socket (i.e. UDP or similar). Our own timer callbacks are implemented because the out of the box implementation relies on `gettimeofday()`. This new DTLS feature is enabled on all ports that use mbedTLS. This commit is an update to a previous PR micropython#10062. Addresses issue micropython#5270 which requested DTLS support. Signed-off-by: Keenan Johnson <keenan.johnson@gmail.com>

damz force-pushed the pr/dtls branch 2 times, most recently from fa2ad97 to ba0772f Compare November 25, 2022 15:49

dpgeorge added the extmod Relates to extmod/ directory in source label Jan 18, 2023

stigbjorlykke reviewed Jan 29, 2023

View reviewed changes

keenanjohnson mentioned this pull request Mar 30, 2023

Support for DTLS in Micropython goliothlabs/golioth-micropython#2

Open

damz force-pushed the pr/dtls branch from ba0772f to 25f1e4a Compare January 7, 2024 03:58

damz force-pushed the pr/dtls branch 3 times, most recently from b81b204 to 69aefcf Compare January 7, 2024 04:43

extmod/modussl_mbedtls: Wire in support for DTLS.

ddb064f

Signed-off-by: Damien Tournoud <damien@platform.sh>

damz force-pushed the pr/dtls branch from 69aefcf to ddb064f Compare January 7, 2024 04:48

damz mentioned this pull request Jan 8, 2024

Upgrade MicroPython Ribbit-Network/ribbit-network-frog-software#45

Merged

Gadgetoid mentioned this pull request Feb 29, 2024

global: Remove the STATIC macro. #13763

Merged

dpgeorge mentioned this pull request Jul 15, 2024

Adds TLS-PSK support to Python SSL context #14396

Open

keenanjohnson mentioned this pull request Sep 2, 2024

extmod/modussl_mbedtls: Updated Wire in support for DTLS. #15764

Merged

dpgeorge closed this Feb 14, 2025

tannewt added a commit to tannewt/circuitpython that referenced this pull request Feb 14, 2025

Merge pull request micropython#10062 from jepler/feather-rp2350-autod…

e5e7c9e

…vi-rebased Add supervisor.runtime.display & RP2350 DVI autoconfig (rebased version)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

extmod/modussl_mbedtls: Wire in support for DTLS #10062

extmod/modussl_mbedtls: Wire in support for DTLS #10062

damz commented Nov 23, 2022 •

edited

Loading

damz commented Nov 23, 2022

stigbjorlykke Jan 29, 2023

keenanjohnson Jul 30, 2023

keenanjohnson commented Apr 19, 2023 •

edited

Loading

stigbjorlykke commented Apr 29, 2023

keenanjohnson commented Jul 30, 2023

mynameisvasco commented Nov 1, 2023

codecov bot commented Jan 7, 2024 •

edited

Loading

github-actions bot commented Jan 7, 2024

projectgus commented Mar 7, 2024

keenanjohnson commented Sep 2, 2024

keenanjohnson commented Sep 2, 2024

keenanjohnson commented Sep 2, 2024

dpgeorge commented Feb 14, 2025

keenanjohnson commented Feb 15, 2025

extmod/modussl_mbedtls: Wire in support for DTLS #10062

extmod/modussl_mbedtls: Wire in support for DTLS #10062

Conversation

damz commented Nov 23, 2022 • edited Loading

What is this PR trying to solve?

How does this PR solve the problem?

damz commented Nov 23, 2022

stigbjorlykke Jan 29, 2023

Choose a reason for hiding this comment

keenanjohnson Jul 30, 2023

Choose a reason for hiding this comment

keenanjohnson commented Apr 19, 2023 • edited Loading

stigbjorlykke commented Apr 29, 2023

keenanjohnson commented Jul 30, 2023

mynameisvasco commented Nov 1, 2023

codecov bot commented Jan 7, 2024 • edited Loading

Codecov Report

github-actions bot commented Jan 7, 2024

projectgus commented Mar 7, 2024

keenanjohnson commented Sep 2, 2024

keenanjohnson commented Sep 2, 2024

keenanjohnson commented Sep 2, 2024

dpgeorge commented Feb 14, 2025

keenanjohnson commented Feb 15, 2025

damz commented Nov 23, 2022 •

edited

Loading

keenanjohnson commented Apr 19, 2023 •

edited

Loading

codecov bot commented Jan 7, 2024 •

edited

Loading