gstreamer/ext/dtls/gstdtlsconnection.h
Sebastian Dröge d66aa872ca dtls: Handle errors/close_notify at all steps and propagate through the layers properly
Previously we simply logged errors but never reported them to elements
or even to the user. Fatal errors are now properly reported.

Additionally proper connection closing is implemented based on EOS:
- dtlsenc: EOS will cause close_notify to be sent to the peer and only
           if the peer also sent back close_notify we will forward the
           EOS event.
- dtlsdec: EOS will be forwarded normally, this only means that the
           unterlying transport was closed. On receiving a DTLS packet
           containing close_notify, return EOS and send EOS downstream.
2020-01-19 11:16:34 +00:00

139 lines
5.3 KiB
C

/*
* Copyright (c) 2014, Ericsson AB. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*/
#ifndef gstdtlsconnection_h
#define gstdtlsconnection_h
#include <gst/gst.h>
G_BEGIN_DECLS
#define GST_TYPE_DTLS_CONNECTION (gst_dtls_connection_get_type())
#define GST_DTLS_CONNECTION(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_DTLS_CONNECTION, GstDtlsConnection))
#define GST_DTLS_CONNECTION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GST_TYPE_DTLS_CONNECTION, GstDtlsConnectionClass))
#define GST_IS_DTLS_CONNECTION(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_DTLS_CONNECTION))
#define GST_IS_DTLS_CONNECTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_DTLS_CONNECTION))
#define GST_DTLS_CONNECTION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GST_TYPE_DTLS_CONNECTION, GstDtlsConnectionClass))
typedef struct _GstDtlsConnection GstDtlsConnection;
typedef struct _GstDtlsConnectionClass GstDtlsConnectionClass;
typedef struct _GstDtlsConnectionPrivate GstDtlsConnectionPrivate;
/**
* GstDtlsSrtpCipher:
* @GST_DTLS_SRTP_CIPHER_AES_128_ICM: aes-128-icm
*
* SRTP Cipher selected by the DTLS handshake, should match the enums in gstsrtp
*/
typedef enum {
GST_DTLS_SRTP_CIPHER_AES_128_ICM = 1
} GstDtlsSrtpCipher;
/**
* GstDtlsSrtpAuth:
* @GST_DTLS_SRTP_AUTH_HMAC_SHA1_32: hmac-sha1-32
* @GST_DTLS_SRTP_AUTH_HMAC_SHA1_80: hmac-sha1-80
*
* SRTP Auth selected by the DTLS handshake, should match the enums in gstsrtp
*/
typedef enum {
GST_DTLS_SRTP_AUTH_HMAC_SHA1_32 = 1,
GST_DTLS_SRTP_AUTH_HMAC_SHA1_80 = 2
} GstDtlsSrtpAuth;
#define GST_DTLS_SRTP_MASTER_KEY_LENGTH 30
/*
* GstDtlsConnection:
*
* A class that handles a single DTLS connection.
* Any connection needs to be created with the agent property set.
* Once the DTLS handshake is completed, on-encoder-key and on-decoder-key will be signalled.
*/
struct _GstDtlsConnection {
GObject parent_instance;
GstDtlsConnectionPrivate *priv;
};
struct _GstDtlsConnectionClass {
GObjectClass parent_class;
};
GType gst_dtls_connection_get_type(void) G_GNUC_CONST;
gboolean gst_dtls_connection_start(GstDtlsConnection *, gboolean is_client, GError **err);
void gst_dtls_connection_check_timeout(GstDtlsConnection *);
/*
* Stops the connections, it is not required to call this function.
*/
void gst_dtls_connection_stop(GstDtlsConnection *);
/*
* Closes the connection, the function will block until the connection has been stopped.
* If stop is called some time before, close will return instantly.
*/
void gst_dtls_connection_close(GstDtlsConnection *);
typedef gboolean (*GstDtlsConnectionSendCallback) (GstDtlsConnection * connection, gconstpointer data, gsize length, gpointer user_data);
/*
* Sets the callback that will be called whenever data needs to be sent.
*/
void gst_dtls_connection_set_send_callback(GstDtlsConnection *, GstDtlsConnectionSendCallback, gpointer, GDestroyNotify);
/*
* Processes data that has been received, the transformation is done in-place.
*
* Returns:
* - GST_FLOW_EOS if the receive side of the DTLS connection was closed by
* the peer, i.e. close_notify was sent by the peer
* - GST_FLOW_ERROR + err if an error happened
* - GST_FLOW_OK + written >= 0 if processing was successful. ptr then
* contains the decoded bytes
*/
GstFlowReturn gst_dtls_connection_process(GstDtlsConnection *, gpointer ptr, gsize len, gsize *written, GError **err);
/*
* Will encode and send the given data.
*
* Sending with len == 0 will close the send side of the DTLS connection and
* no further data can be sent anymore in the future. This will also send the
* close_notify to the peer.
*
* Returns:
* - GST_FLOW_EOS if the send side of the DTLS connection was closed, i.e.
* we received an EOS before.
* - GST_FLOW_ERROR + err if an error happened
* - GST_FLOW_OK + written >= 0 if processing was successful
*/
GstFlowReturn gst_dtls_connection_send(GstDtlsConnection *, gconstpointer ptr, gsize len, gsize *written, GError **err);
G_END_DECLS
#endif /* gstdtlsconnection_h */