[3.2] DTLS support + optional ENet encryption #35091

Faless · 2020-01-13T17:20:05Z

DTLS

New UDPServer class, support for UDP connected socket (i.e. bound to a specific receive/send address).
New PacketPeerDTLS and DTLSServer classes (+ implementation via mbedtls module).
See old report for more details.

ENet

New implementation of custom godot sockets in thirdparty/enet/godot.cpp to allow optional socket upgrade to DTLS.
NetworkedMultiplayerENet now supports optional DTLS encryption via the set_dtls_enabled function. Allows setting key/certificate/verify options.

# server
var peer = NetworkedMultiplayerENet.new()
var key = load("key.key") # Required for server
var cert = load("cert.crt") # Required for server
peer.set_dtls_enabled(true)
peer.set_dtls_key(key)
peer.set_dtls_certificate(cert)
peer.create_server(port, 4)

# client
var peer = NetworkedMultiplayerENet.new()
peer.set_dtls_enabled(true)
peer.set_dtls_verify(true) # Off by default... should we change it?
var cert = load("cert.crt")
peer.set_dtls_certificate(cert)
peer.create_client(host, port) # If verify is on, host must match the one in cert.

Closes #19110

akien-mga · 2020-01-31T10:51:02Z

core/io/net_socket.h

@@ -61,7 +61,7 @@ class NetSocket : public Reference {
 virtual Error connect_to_host(IP_Address p_addr, uint16_t p_port) = 0;
 virtual Error poll(PollType p_type, int timeout) const = 0;
 virtual Error recv(uint8_t *p_buffer, int p_len, int &r_read) = 0;
- virtual Error recvfrom(uint8_t *p_buffer, int p_len, int &r_read, IP_Address &r_ip, uint16_t &r_port) = 0;
+ virtual Error recvfrom(uint8_t *p_buffer, int p_len, int &r_read, IP_Address &r_ip, uint16_t &r_port, bool peek = false) = 0;


Should be p_peek.

akien-mga · 2020-01-31T10:52:17Z

core/register_core_types.cpp

@@ -155,6 +158,9 @@ void register_core_types() {
 ClassDB::register_class<StreamPeerTCP>();
 ClassDB::register_class<TCP_Server>();
 ClassDB::register_class<PacketPeerUDP>();
+ ClassDB::register_class<UDPServer>();


We have TCP_Server and UDPServer using different naming conventions. The former should be fixed, breaking compat in 4.0, I guess?

The former should be fixed, breaking compat in 4.0, I guess?

Yeah, I agree, TCP_Server should become TCPServer

akien-mga · 2020-01-31T10:53:02Z

modules/mbedtls/ssl_context_mbedtls.cpp

@@ -38,6 +38,53 @@ static void my_debug(void *ctx, int level,
 fflush(stdout);
 }

+void SSLContextMbedTLS::print_mbedtls_error(int ret) {


Should be p_ret.

akien-mga · 2020-01-31T10:55:06Z

thirdparty/enet/godot.cpp

+ virtual Error bind(IP_Address p_ip, uint16_t p_port) = 0;
+ virtual Error sendto(const uint8_t *p_buffer, int p_len, int &r_sent, IP_Address p_ip, uint16_t p_port) = 0;
+ virtual Error recvfrom(uint8_t *p_buffer, int p_len, int &r_read, IP_Address &r_ip, uint16_t &r_port) = 0;
+ virtual int set_option(ENetSocketOption option, int value) = 0;


Malkverbena · 2020-02-11T15:47:30Z

Due the fact the Godot 4.0 will take a long tike to became stable again, is there any chance to to see DTLS support and ENet encryption on 3.2 branch?

Faless · 2020-02-11T16:38:01Z

@akien-mga I think this is ready now. I shall write documentation along with the post (we might want to wait for that, hopefully tomorrow).
It is also potentially cherry-pickable, as it's unlikely to cause regressions except for regular ENet (which is at low risk IMO, but I'll run more tests with this rebase), so we might test it for a while and then merge it with a bit "EXPERIMENTAL" notice in the docs.

Faless · 2020-02-11T16:41:28Z

meh... I failed the rebase... will update ASAP

UDP sockets can be "connected" to filter packets from a specific source. In case of a bound socket (e.g. server), a new socket can be created on the same address/port that will receive all packets that are not filtered by a more specific socket (e.g. the previously connect socket). This way, a UDPServer can listen to new packets, and return a new PacketPeerUDP when receiving one, knowing that is a "new client".

Custom instance implementation via the mbedtls module.

Non-DTLS implementation uses plain NetSocket for performance as before.

clofresh · 2020-02-25T22:39:34Z

This is awesome! I've always loved enet's simplicity but the lack of encryption was a big negative for it. Would it be possible to extract the server part into a standalone C library so we can make lightweight servers in other languages?

Faless · 2020-02-26T00:48:19Z

Would it be possible to extract the server part into a standalone C library so we can make lightweight servers in other languages?

Well, not really, the DTLS implementation is in C++ and largely relies on Godot data structures, if you need a C implementation you are probably better off making one from scratch.
If you are fine with C++ you would still need to replace or include quite a few things from core Ref/PoolVector/String/PacketPeer/etc.

rieniter · 2020-02-29T10:08:53Z

hello, I can't compile this module from 3.2 version

Faless · 2020-02-29T14:09:22Z

What do you mean by "from the 3.2 version"? Did you check out my branch or did you try to apply the patch to 3.2? It seems that you are missing some changes. What build options are you using?

…

On Sat, Feb 29, 2020, 11:08 rieniter ***@***.***> wrote: hello, I can't compile this module from 3.2 version [image: 2020-02-29_162245] <https://user-images.githubusercontent.com/34160378/75605513-17819d80-5b16-11ea-8212-11b243c9d8df.png> — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#35091?email_source=notifications&email_token=AAM4C3SM7QD4DEEMF3PNQR3RFDPDPA5CNFSM4KGF4N6KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENLV72Y#issuecomment-592928747>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAM4C3XYJPTQWPP5F6AYKKDRFDPDPANCNFSM4KGF4N6A> .

rieniter · 2020-02-29T16:11:19Z

What do you mean by "from the 3.2 version"? Did you check out my branch or did you try to apply the patch to 3.2? It seems that you are missing some changes. What build options are you using?
…
On Sat, Feb 29, 2020, 11:08 rieniter @.***> wrote: hello, I can't compile this module from 3.2 version [image: 2020-02-29_162245] https://user-images.githubusercontent.com/34160378/75605513-17819d80-5b16-11ea-8212-11b243c9d8df.png — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#35091?email_source=notifications&email_token=AAM4C3SM7QD4DEEMF3PNQR3RFDPDPA5CNFSM4KGF4N6KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENLV72Y#issuecomment-592928747>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAM4C3XYJPTQWPP5F6AYKKDRFDPDPANCNFSM4KGF4N6A .

Hello, thank you for your reply. I'm still a noober, so let me explain what i was done:
I have try to copy your branch to original godot 3.2 and then build it, but it look like have something more custom module error than above.
So, I checked and know that this PR was merged into master branch, and i decide to download only that enet module from master branch and copy to my godot 3.2 branch, now everything look good except above error

Faless · 2020-02-29T16:50:29Z

I see, it won't work like that, you can either checkout my branch directly (e.g.):
git clone https://github.com/Faless/godot.git -b dtls/enet godot-dtls
Or apply the diff for this PR to the 3.2 code

rieniter · 2020-02-29T20:04:03Z

I see, it won't work like that, you can either checkout my branch directly (e.g.):
git clone https://github.com/Faless/godot.git -b dtls/enet godot-dtls
Or apply the diff for this PR to the 3.2 code

Thank you, it worked great !

Malkverbena · 2020-04-29T21:24:20Z

I have done lots of tests with DTLS in Godot 3.2. So far everything works pretty well. Is there any way to help on this? any test?? I would love to see PR merged.

Calinou · 2020-04-30T07:11:47Z

@Malkverbena The master branch is currently undergoing refactoring, which means it may take a while for pull requests to be merged (even if this one targets 3.2).

akien-mga · 2020-05-05T11:41:16Z

Let's get this merged for 3.2.2-beta2 and tested further.

Thanks!

extremety1989 · 2020-06-11T14:50:05Z

@akien-mga does it works for beta4?

akien-mga · 2020-06-11T14:53:35Z

It's merged since beta2, so it's in beta4 too. Whether it works as you expect it to is for you as a user to ascertain ;)

extremety1989 · 2020-06-11T14:57:50Z

@akien-mga does not work for me, i used certificate generator for certs, can it cause problemes ?

extremety1989 · 2020-06-11T14:58:52Z

@akien-mga used same code from this site https://godotengine.org/article/enet-dtls-encryption

akien-mga · 2020-06-11T16:30:24Z

Please open an issue with a sample project that can trigger the bug.

Faless added enhancement topic:network labels Jan 13, 2020

Faless added this to the 4.0 milestone Jan 13, 2020

Faless requested review from akien-mga, hpvb and a team as code owners January 13, 2020 17:20

akien-mga reviewed Jan 31, 2020

View reviewed changes

This comment has been minimized.

Sign in to view

Faless force-pushed the dtls/enet branch 2 times, most recently from 19fddd1 to d3eae91 Compare February 11, 2020 16:32

Faless force-pushed the dtls/enet branch from d3eae91 to 6cca631 Compare February 11, 2020 16:53

Faless requested a review from a team as a code owner February 16, 2020 00:10

Faless force-pushed the dtls/enet branch from 833fe53 to 7acd20d Compare February 17, 2020 11:07

Faless changed the base branch from master to 3.2 February 17, 2020 11:08

Faless force-pushed the dtls/enet branch 2 times, most recently from 0616ddc to ffe3fe5 Compare February 17, 2020 11:22

Faless changed the title ~~DTLS support + optional ENet encryption~~ [3.2] DTLS support + optional ENet encryption Feb 17, 2020

Faless mentioned this pull request Feb 17, 2020

DTLS support + optional ENet encryption #36296

Merged

Faless force-pushed the dtls/enet branch from ffe3fe5 to 936e492 Compare February 17, 2020 11:46

akien-mga modified the milestones: 4.0, 3.2 Feb 18, 2020

akien-mga added the needs testing label Feb 18, 2020

Faless force-pushed the dtls/enet branch from 936e492 to 1b7f0c2 Compare February 25, 2020 10:24

Add peek option to NetSocket recv_from.

6b9240a

Faless force-pushed the dtls/enet branch from 1b7f0c2 to 5df4c5b Compare February 25, 2020 10:29

Faless added 6 commits February 25, 2020 11:35

Move mbedlts print func to SSLMbedTLSContext.

dbbd836

New PacketPeerDTLS and DTLSServer classes.

35a9f0f

Custom instance implementation via the mbedtls module.

Custom godot sockets for ENet now support DTLS.

aea3c4d

Non-DTLS implementation uses plain NetSocket for performance as before.

NetworkedMultiplayerENet dtls support.

5e721d0

Add documentation for new DTLS features.

3a73c3f

Faless force-pushed the dtls/enet branch from 5df4c5b to 3a73c3f Compare February 25, 2020 10:40

akien-mga force-pushed the 3.2 branch 2 times, most recently from 8eb193d to 69c1805 Compare March 6, 2020 23:01

akien-mga merged commit ef715f3 into godotengine:3.2 May 5, 2020

Faless deleted the dtls/enet branch July 13, 2021 00:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3.2] DTLS support + optional ENet encryption #35091

[3.2] DTLS support + optional ENet encryption #35091

Faless commented Jan 13, 2020 •

edited

Loading

akien-mga Jan 31, 2020

akien-mga Jan 31, 2020

Faless Jan 31, 2020

akien-mga Jan 31, 2020

akien-mga Jan 31, 2020

Malkverbena commented Feb 11, 2020

This comment has been minimized.

Faless commented Feb 11, 2020

Faless commented Feb 11, 2020

clofresh commented Feb 25, 2020

Faless commented Feb 26, 2020

rieniter commented Feb 29, 2020

Faless commented Feb 29, 2020 via email

rieniter commented Feb 29, 2020

Faless commented Feb 29, 2020

rieniter commented Feb 29, 2020

Malkverbena commented Apr 29, 2020

Calinou commented Apr 30, 2020 •

edited

Loading

akien-mga commented May 5, 2020

extremety1989 commented Jun 11, 2020

akien-mga commented Jun 11, 2020

extremety1989 commented Jun 11, 2020

extremety1989 commented Jun 11, 2020 •

edited

Loading

akien-mga commented Jun 11, 2020

[3.2] DTLS support + optional ENet encryption #35091

[3.2] DTLS support + optional ENet encryption #35091

Conversation

Faless commented Jan 13, 2020 • edited Loading

DTLS

ENet

akien-mga Jan 31, 2020

Choose a reason for hiding this comment

akien-mga Jan 31, 2020

Choose a reason for hiding this comment

Faless Jan 31, 2020

Choose a reason for hiding this comment

akien-mga Jan 31, 2020

Choose a reason for hiding this comment

akien-mga Jan 31, 2020

Choose a reason for hiding this comment

Malkverbena commented Feb 11, 2020

This comment has been minimized.

Faless commented Feb 11, 2020

Faless commented Feb 11, 2020

clofresh commented Feb 25, 2020

Faless commented Feb 26, 2020

rieniter commented Feb 29, 2020

Faless commented Feb 29, 2020 via email

rieniter commented Feb 29, 2020

Faless commented Feb 29, 2020

rieniter commented Feb 29, 2020

Malkverbena commented Apr 29, 2020

Calinou commented Apr 30, 2020 • edited Loading

akien-mga commented May 5, 2020

extremety1989 commented Jun 11, 2020

akien-mga commented Jun 11, 2020

extremety1989 commented Jun 11, 2020

extremety1989 commented Jun 11, 2020 • edited Loading

akien-mga commented Jun 11, 2020

Faless commented Jan 13, 2020 •

edited

Loading

Calinou commented Apr 30, 2020 •

edited

Loading

extremety1989 commented Jun 11, 2020 •

edited

Loading