Go to file
Farid Zakaria 7fc355aa05 Introduce SslMasterKeyHandler (#8653)
Motivation

Debugging SSL/TLS connections through wireshark is a pain -- if the cipher used involves Diffie-Hellman then it is essentially impossible unless you can have the client dump out the master key [1]

This is a work-in-progress change (tests & comments to come!) that introduces a new handler you can set on the SslContext to receive the master key & session id. I'm hoping to get feedback if a change in this vein would be welcomed.

An implementation that conforms to Wireshark's NSS key log[2] file is also included.

Depending on feedback on the PR going forward I am planning to "clean it up" by adding documentation, example server & tests. Implementation will need to be finished as well for retrieving the master key from the OpenSSL context.

[1] https://jimshaver.net/2015/02/11/decrypting-tls-browser-traffic-with-wireshark-the-easy-way/
[2] https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format

Modification

- Added SslMasterKeyHandler
- An implementation of the handler that conforms to Wireshark's key log format is included.

Result:

Be able to debug SSL / TLS connections more easily.

Signed-off-by: Farid Zakaria <farid.m.zakaria@gmail.com>
2019-07-10 12:02:46 +02:00
.github Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
.mvn support publishing snapshots from docker based ci (#8634) 2018-12-07 05:43:06 +01:00
all [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
bom Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
buffer Correctly take length of ByteBufInputStream into account for readLine… (#9310) 2019-07-01 20:55:23 +02:00
codec Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
codec-dns Pre-decompressed DNS record RData that may contain compression pointers (#9311) 2019-07-02 19:38:50 +02:00
codec-haproxy [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
codec-http Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
codec-http2 Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
codec-memcache [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
codec-mqtt [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
codec-redis [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
codec-smtp optimize some code (#9289) 2019-06-28 13:48:23 +02:00
codec-socks [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
codec-stomp [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
codec-xml Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
common Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
dev-tools [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
docker Remove deprecated GraalVM native-image flags (#9118) 2019-05-22 19:20:54 +02:00
example [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
handler Introduce SslMasterKeyHandler (#8653) 2019-07-10 12:02:46 +02:00
handler-proxy [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
license Use Table lookup for HPACK decoder (#9307) 2019-07-02 20:09:44 +02:00
microbench Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
resolver [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
resolver-dns [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
tarball [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
testsuite [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
testsuite-autobahn [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
testsuite-http2 [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
testsuite-native-image [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
testsuite-osgi [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
testsuite-shading [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
transport #7285 Improved "Discarded inbound message" warning (#9286) 2019-07-01 20:38:58 +02:00
transport-native-epoll Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
transport-native-kqueue Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
transport-native-unix-common [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
transport-native-unix-common-tests [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
transport-rxtx [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
transport-sctp [maven-release-plugin] prepare for next development iteration 2019-06-28 05:57:21 +00:00
transport-udt Remove unnecessary code (#9303) 2019-07-04 08:51:47 +02:00
.fbprefs Updated Find Bugs configuration 2009-03-04 10:33:09 +00:00
.gitattributes Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
.gitignore Add .gitignore for docker-sync stuff 2019-03-19 14:03:15 +01:00
CONTRIBUTING.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
LICENSE.txt Relicensed to Apache License v2 2009-08-28 07:15:49 +00:00
mvnw Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
mvnw.cmd Include mvn wrapper to make setup of development env easier 2018-01-26 08:13:17 +01:00
NOTICE.txt Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
pom.xml Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
README.md Change the netty.io homepage scheme(http -> https) (#9344) 2019-07-09 21:09:42 +02:00
run-example.sh Add UptimeServer and adjust UptimeClient's code style. 2017-04-28 07:41:07 +02:00

Netty Project

Netty is an asynchronous event-driven network application framework for rapid development of maintainable high performance protocol servers & clients.

How to build

For the detailed information about building and developing Netty, please visit the developer guide. This page only gives very basic information.

You require the following to build Netty:

Note that this is build-time requirement. JDK 5 (for 3.x) or 6 (for 4.0+) is enough to run your Netty-based application.

Branches to look

Development of all versions takes place in each branch whose name is identical to <majorVersion>.<minorVersion>. For example, the development of 3.9 and 4.0 resides in the branch '3.9' and the branch '4.0' respectively.

Usage with JDK 9

Netty can be used in modular JDK9 applications as a collection of automatic modules. The module names follow the reverse-DNS style, and are derived from subproject names rather than root packages due to historical reasons. They are listed below:

  • io.netty.all
  • io.netty.buffer
  • io.netty.codec
  • io.netty.codec.dns
  • io.netty.codec.haproxy
  • io.netty.codec.http
  • io.netty.codec.http2
  • io.netty.codec.memcache
  • io.netty.codec.mqtt
  • io.netty.codec.redis
  • io.netty.codec.smtp
  • io.netty.codec.socks
  • io.netty.codec.stomp
  • io.netty.codec.xml
  • io.netty.common
  • io.netty.handler
  • io.netty.handler.proxy
  • io.netty.resolver
  • io.netty.resolver.dns
  • io.netty.transport
  • io.netty.transport.epoll (native omitted - reserved keyword in Java)
  • io.netty.transport.kqueue (native omitted - reserved keyword in Java)
  • io.netty.transport.unix.common (native omitted - reserved keyword in Java)
  • io.netty.transport.rxtx
  • io.netty.transport.sctp
  • io.netty.transport.udt

Automatic modules do not provide any means to declare dependencies, so you need to list each used module separately in your module-info file.