Drasyl

Upgrade Notes

1. We did it again: The overlay protocol has been changed with breaking changes making it impossible
to communicate with peers running older drasyl versions.
1. This version is introduces a new identity file format, every node will recreate a new identity on
first start. If you would like to reuse your pre-existing identity, you have to migrate the file
format by yourself. Asume you have the current file `drasyl.identity.json`:
json
{
"proofOfWork" : -2144920491,
"identityKeyPair" : {
"publicKey" : "feb2fa8a69e2a59ce7586349b8e8a44610d902ef2a30b1a46ebc5ff989813033",
"secretKey" : "d716fdc9a164bea60a179eacf868416695ad8757035d0d83abd5a2b362bfa221feb2fa8a69e2a59ce7586349b8e8a44610d902ef2a30b1a46ebc5ff989813033"
},
"keyAgreementKeyPair" : {
"publicKey" : "62c201382e37a50c3ed20f15ccb5ba970a264a2765f8f8c6f8e1c27b2454ca34",
"secretKey" : "105672a9d44c3be1ba4b777f0c7d6cf711fb73defd404db7644f546ea71f0f5d"
}
}

Then you need to create a **new** file `drasyl.identity` with the following format:
ini
[Identity]
SecretKey = d716fdc9a164bea60a179eacf868416695ad8757035d0d83abd5a2b362bfa221feb2fa8a69e2a59ce7586349b8e8a44610d902ef2a30b1a46ebc5ff989813033
ProofOfWork = -2144920491


Added

- CLI: `generate-identity` sub-command added.
- CLI: `generate-pow` sub-command added.
- CLI: `tun` sub-command added.
- CLI: `generate-completion` sub-command added.
- CLI: `--no-protocol-arming` option added.
- Broadcast-based LAN Discovery added. Can be used programatically. More
information: https://git.informatik.uni-hamburg.de/sane-public/drasyl/-/merge_requests/680

Changed

- Dependencies have been updated.
- Speed up direct connection establishment when traversing symmetrics NATs.
- Switch to more compact (INI-formatted) identity file format.
- CLI: `perf client`'s `--mps` option default value has changed to `0`. This causes the client to
send messages as quickly as possible. to send messages as fast as possible.

Fixed

- Fix endless identity creation, when none of the available nonces result in a valid identity.
- Fix IP multicast discovery for IPv6-only environments.
- Fix SSDP discovery for IPv6-only environments.
- Stop sending IP multicast messages to super peers when node is running in TCP-fallback mode.
- Fix problem with `null` message when using `BehavioralDrasylNode`.

Upgrade Notes

- We did it again: The overlay protocol has been changed with breaking changes making it impossible
to communicate with peers running older drasyl versions.
- New Javadoc website: https://api.drasyl.org/

Added

- [Netty](https://netty.io/) based channels are now used to process all overlay network I/O
operations. This change allows you to use/add many netty handlers with the drasyl overlay.
- [`DrasylNoderesolve(...)`](./drasyl-node/src/main/java/org/drasyl/DrasylNode.java) will now
return a dedicated [`Channel`](https://netty.io/4.1/api/io/netty/channel/Channel.html) for
communication with the given peer.
- The above mentioned [`Channel`](https://netty.io/4.1/api/io/netty/channel/Channel.html) comes with
a backpressure mechanism (`ChannelisWritable`/`ChannelbytesBeforeWritable`
/`ChannelbytesBeforeUnwritable`) allowing the application to control how fast traffic is written
to the overlay.
- The encryption of overlay management messages and application messages can now be disabled
separately in
the [config](drasyl-node/src/main/resources/reference.conf) (`drasyl.remote.message.arm.protocol.enabled`
/`drasyl.remote.message.arm.application.enabled`).
- CLI: `wormhole` sub-command is now able to send files as well.
- CLI: `tunnel` sub-command added.

Changed

- The classes `DrasylNode`, `DrasylConfig`, `DrasylException`, all `Event`s has been moved to the
Maven module `org.drasyl:drasyl-node` and java packages `org.drasyl.node.*`.
- Dependencies have been updated.
- The monitoring feature was outdated/mostly unusable and has therefore been removed.
- Replaced protobuf with own message serialization allowing us to reduce the overlay overhead.

Fixed

- Overwhelming application traffic will no longer cause the node to drop out of the overlay.

Changed

- Bump lazysodium-java from 5.0.1 to 5.1.1

Fixed

- Fix visibility of InboundExceptionEventgetError.
- Allow protobuf build on Apple Silicon and Linux ARM.
- Fix problem with lazysodium finding dependencies when drasyl is embedded in a fat jar.

Upgrade Notes

- The identities must be replaced by a new one. Just delete the old `drasyl.identity.json` and let
drasyl generate a new one.
- If you're using a custom configuration with super peer defined, make sure to use (our) super peers
running 0.5.0.

Added

- Multicast is used to discovery other nodes running within the same network.
- TCP is used as fallback if UDP traffic is blocked.
- Experimental support for native image added.
- All traffic is now end-to-end encrypted 🎉.
- kqueue is used on macOS based systems for better performance.
- epoll is used on linux based systems for better performance.
- An `InboundExceptionEvent` is emitted every time an inbound message could not be processed.
- Support for Apple Silicon added.
- Backpressure mechanism for outbound messages added.

Changed

- Switched to MIT License.
- `DrasylNodesend()` will now return an `CompletationStage` instead of an `CompletableFuture`.
- Dependencies have been updated.
- Maven module `parent` has been renamed to `drasyl-parent`.
- Class `CompressedPublicKey` has been renamed to `IdentityPublicKey`.

Changed

- Dependencies were updated.

Fixed

- Fixed an NPE when requesting a port forwarding if the Internet Gateway Device responds with an
error.
- Since the super peer sp-ham1 has connectivity problems, this has been replaced by the sp-fra1.
- Public and private keys are now displayed everywhere in the classic format.
- Unused dependencies removed.
- Some additional minor fixes.

Added

- Hole Punching is now used to traverse NATs. This should dramatically increase the proportion of
direct connections between peers.
- Messages that are too large for a single UDP datagram are now automatically split into multiple
datagrams (and re-assembled on the receiving side).
- When changing the network, new port mappings are now automatically created on the new network.
- `DrasylNode`'s API has been enhanced with `NotNull` and `Nullable` annotations.
- Messages that can be delivered within the same JVM are now passed by reference (previously these
messages have been unnecessarily serialized).
**So make sure you either send copies of your objects or it's fine for other nodes to make changes
to that object.**
- Static routes to other remote peers can now be defined. This allows discovery to be omitted in
static environments (or test setups).
- **Messages with content `null` are now possible.**
- `perf` command has been added to the CLI. This allows you to run performance tests of connections.
- Each node can now have several super peers simultaneously. The fastest super peer will
automatically be used. If one or more super peers fail (temporarily), one of the remaining super
peers will automatically be used. By default, each node will use two of our super peers.
- New examples have been added:
https://github.com/drasyl/drasyl/tree/master/drasyl-examples/src/main/java/org/drasyl/example
- Nodes can now be implemented as finite state machines (see our example of the philosopher
problem: https://github.com/drasyl/drasyl/tree/master/drasyl-examples/src/main/java/org/drasyl/example/diningphilosophers)
.

Changed

- By default, each node now listens on a port in the range 22528 and 65528, which is derived from
its identity. This means that the chance for a port collision is now reduced when multiple nodes
are running on one computer.
- UDP is now used instead of TCP for communication with remote peers.
- The entire protocol for constructing the overlay network has been revised (it's far better now!).
- Messages are now serialized in binary. This is faster and creates smaller messages on the wire.
- If possible, messages are processed using zero-copy.
- Documentation has been revised (Javadoc and/or documentation at https://docs.drasyl.org).
- Messages can now be additionally serialized by protobuf or Java. Furthermore, own serializers can
be implemented. Read more at https://docs.drasyl.org.
- The third-party portmapper library has been replaced with our own more lightweight and more
resilient implementation.
- All dependencies have been updated to the latest versions.

Fixed

- `IntraVmDiscovery`: Other nodes running within the same JVM that belongs to a different overlay
network are now ignored.
- `LocalHostDiscovery`: Other nodes running on the same local computer that belong to a different
overlay network are now ignored.
- Content of received messages is now better verified before it is deserialized.
- Unchecked exceptions thrown by `DrasylNode.onEvent` no longer produce ridiculously long error
messages.