View Source ExDTLS (ExDTLS v0.14.0)
Module that allows performing DTLS handshake including a DTLS-SRTP one.
ExDTLS
executes native OpenSSL functions to perform DTLS handshake.
It doesn't create or require any socket.
Instead, it returns generated DTLS packets, which then have to be transported to the peer.
Link to this section Summary
Link to this section Types
@type dtls() :: reference()
A reference to ExDTLS
native.
Type describing ExDTLS configuration.
See init/1
for the meaning of each option
@type protection_profile_t() :: 1 | 2 | 7 | 8
Supported protection profiles.
For meaning of these values please refer to https://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
Link to this section Functions
Starts performing DTLS handshake.
Generates initial DTLS packets that have to be passed to the second host. Has to be called by a host working in the client mode.
timeout
is a time in ms after which handle_timeout/1
should be called.
@spec generate_cert() :: binary()
Generates new certificate.
Returns DER representation in binary format.
Gets current certificate.
Returns DER representation in binary format.
Returns a digest of the DER representation of the X509 certificate.
Gets current private key.
Returns key specific representation in binary format.
@spec handle_data(dtls(), packets :: binary()) :: {:ok, packets :: binary()} | :handshake_want_read | {:handshake_packets, packets :: binary(), timeout :: integer()} | {:handshake_finished, local_keying_material :: binary(), remote_keying_material :: binary(), protection_profile_t(), packets :: binary()} | {:handshake_finished, local_keying_material :: binary(), remote_keying_material :: binary(), protection_profile_t()} | {:connection_closed, reason :: atom()}
Handles peer's packets.
If handshake is finished it returns {:ok, binary()}
which is decoded data
or {:error, value}
if error occurred.
:handshake_packets
contains handshake data that has to be sent to the peer.
:handshake_want_read
means some additional data is needed for continuing handshake.
It can be returned when retransmitted packet was passed but timer didn't expired yet.
timeout
is a time in ms after which handle_timeout/1
should be called.
Both local and remote keying materials consist of master key
and master salt
.
Handles timeout.
If there is a timeout to handle, this function will return packets
that has
to be retransmitted and a new timeout in ms after which handle_timeout/1
should
be called once agian.
If there is no timeout to handle, simple {:ok, dtls()}
tuple is returned.
Initializes ExDTLS
.
Accepts a keyword list with the following options (opts_t/0
):
client_mode
-true
if ExDTLS module should work as a client orfalse
if as a serverdtls_srtp
-true
if DTLS-SRTP handshake should be performed orfalse
if a normal onepkey
- private key to use in this SSL context. Must correspond tocert
cert
- certificate to use in this SSL context. Must correspond topkey
If both pkey
and cert
are not passed ExDTLS
will generate key and certificate on its own.