| Index: include/srtp.h
|
| diff --git a/srtp/include/srtp.h b/include/srtp.h
|
| similarity index 62%
|
| rename from srtp/include/srtp.h
|
| rename to include/srtp.h
|
| index 89834b12011ab9f2a426a73ccff4bbc95068a95b..515582d5b1c7f3af50e55609bd33ef107c660e42 100644
|
| --- a/srtp/include/srtp.h
|
| +++ b/include/srtp.h
|
| @@ -46,30 +46,12 @@
|
| #ifndef SRTP_H
|
| #define SRTP_H
|
|
|
| +#include <stdint.h>
|
| +
|
| #ifdef __cplusplus
|
| extern "C" {
|
| #endif
|
|
|
| -#include <stdint.h>
|
| -#include "crypto.h"
|
| -#include "crypto_types.h"
|
| -#include "err.h"
|
| -
|
| -/*
|
| - * Compatibility shim for v1->v2 transition.
|
| - */
|
| -
|
| -#define srtp_crypto_policy_set_aes_cm_128_hmac_sha1_32 \
|
| - crypto_policy_set_aes_cm_128_hmac_sha1_32
|
| -#define srtp_crypto_policy_set_aes_cm_128_hmac_sha1_80 \
|
| - crypto_policy_set_aes_cm_128_hmac_sha1_80
|
| -#define srtp_crypto_policy_set_aes_gcm_128_16_auth \
|
| - crypto_policy_set_aes_gcm_128_16_auth
|
| -#define srtp_crypto_policy_set_aes_gcm_256_16_auth \
|
| - crypto_policy_set_aes_gcm_256_16_auth
|
| -
|
| -#define srtp_ssrc_type_t ssrc_type_t
|
| -
|
| /**
|
| * @defgroup SRTP Secure RTP
|
| *
|
| @@ -112,11 +94,184 @@ extern "C" {
|
| * as part of the IV formation logic applied to each RTP packet.
|
| */
|
| #define SRTP_AEAD_SALT_LEN 12
|
| -#define AES_128_GCM_KEYSIZE_WSALT SRTP_AEAD_SALT_LEN + 16
|
| -#define AES_192_GCM_KEYSIZE_WSALT SRTP_AEAD_SALT_LEN + 24
|
| -#define AES_256_GCM_KEYSIZE_WSALT SRTP_AEAD_SALT_LEN + 32
|
| +#define SRTP_AES_128_GCM_KEYSIZE_WSALT SRTP_AEAD_SALT_LEN + 16
|
| +#define SRTP_AES_192_GCM_KEYSIZE_WSALT SRTP_AEAD_SALT_LEN + 24
|
| +#define SRTP_AES_256_GCM_KEYSIZE_WSALT SRTP_AEAD_SALT_LEN + 32
|
| +
|
| +/*
|
| + * an srtp_hdr_t represents the srtp header
|
| + *
|
| + * in this implementation, an srtp_hdr_t is assumed to be 32-bit aligned
|
| + *
|
| + * (note that this definition follows that of RFC 1889 Appendix A, but
|
| + * is not identical)
|
| + */
|
| +
|
| +#ifndef WORDS_BIGENDIAN
|
| +
|
| +/*
|
| + * srtp_hdr_t represents an RTP or SRTP header. The bit-fields in
|
| + * this structure should be declared "unsigned int" instead of
|
| + * "unsigned char", but doing so causes the MS compiler to not
|
| + * fully pack the bit fields.
|
| + */
|
| +
|
| +typedef struct {
|
| + unsigned char cc:4; /* CSRC count */
|
| + unsigned char x:1; /* header extension flag */
|
| + unsigned char p:1; /* padding flag */
|
| + unsigned char version:2; /* protocol version */
|
| + unsigned char pt:7; /* payload type */
|
| + unsigned char m:1; /* marker bit */
|
| + uint16_t seq; /* sequence number */
|
| + uint32_t ts; /* timestamp */
|
| + uint32_t ssrc; /* synchronization source */
|
| +} srtp_hdr_t;
|
| +
|
| +#else /* BIG_ENDIAN */
|
| +
|
| +typedef struct {
|
| + unsigned char version:2; /* protocol version */
|
| + unsigned char p:1; /* padding flag */
|
| + unsigned char x:1; /* header extension flag */
|
| + unsigned char cc:4; /* CSRC count */
|
| + unsigned char m:1; /* marker bit */
|
| + unsigned char pt:7; /* payload type */
|
| + uint16_t seq; /* sequence number */
|
| + uint32_t ts; /* timestamp */
|
| + uint32_t ssrc; /* synchronization source */
|
| +} srtp_hdr_t;
|
| +
|
| +#endif
|
| +
|
| +typedef struct {
|
| + uint16_t profile_specific; /* profile-specific info */
|
| + uint16_t length; /* number of 32-bit words in extension */
|
| +} srtp_hdr_xtnd_t;
|
| +
|
| +
|
| +/*
|
| + * srtcp_hdr_t represents a secure rtcp header
|
| + *
|
| + * in this implementation, an srtcp header is assumed to be 32-bit
|
| + * alinged
|
| + */
|
| +
|
| +#ifndef WORDS_BIGENDIAN
|
| +
|
| +typedef struct {
|
| + unsigned char rc:5; /* reception report count */
|
| + unsigned char p:1; /* padding flag */
|
| + unsigned char version:2; /* protocol version */
|
| + unsigned char pt:8; /* payload type */
|
| + uint16_t len; /* length */
|
| + uint32_t ssrc; /* synchronization source */
|
| +} srtcp_hdr_t;
|
| +
|
| +typedef struct {
|
| + unsigned int index:31; /* srtcp packet index in network order! */
|
| + unsigned int e:1; /* encrypted? 1=yes */
|
| + /* optional mikey/etc go here */
|
| + /* and then the variable-length auth tag */
|
| +} srtcp_trailer_t;
|
| +
|
| +
|
| +#else /* BIG_ENDIAN */
|
| +
|
| +typedef struct {
|
| + unsigned char version:2; /* protocol version */
|
| + unsigned char p:1; /* padding flag */
|
| + unsigned char rc:5; /* reception report count */
|
| + unsigned char pt:8; /* payload type */
|
| + uint16_t len; /* length */
|
| + uint32_t ssrc; /* synchronization source */
|
| +} srtcp_hdr_t;
|
| +
|
| +typedef struct {
|
| + unsigned int version:2; /* protocol version */
|
| + unsigned int p:1; /* padding flag */
|
| + unsigned int count:5; /* varies by packet type */
|
| + unsigned int pt:8; /* payload type */
|
| + uint16_t length; /* len of uint32s of packet less header */
|
| +} rtcp_common_t;
|
| +
|
| +typedef struct {
|
| + unsigned int e:1; /* encrypted? 1=yes */
|
| + unsigned int index:31; /* srtcp packet index */
|
| + /* optional mikey/etc go here */
|
| + /* and then the variable-length auth tag */
|
| +} srtcp_trailer_t;
|
| +
|
| +#endif
|
| +
|
| +
|
|
|
| +/**
|
| + * @brief A srtp_cipher_type_id_t is an identifier for a particular cipher
|
| + * type.
|
| + *
|
| + * A srtp_cipher_type_id_t is an integer that represents a particular
|
| + * cipher type, e.g. the Advanced Encryption Standard (AES). A
|
| + * SRTP_NULL_CIPHER is avaliable; this cipher leaves the data unchanged,
|
| + * and can be selected to indicate that no encryption is to take
|
| + * place.
|
| + *
|
| + * @ingroup Ciphers
|
| + */
|
| +typedef uint32_t srtp_cipher_type_id_t;
|
|
|
| +/**
|
| + * @brief An srtp_auth_type_id_t is an identifier for a particular authentication
|
| + * function.
|
| + *
|
| + * An srtp_auth_type_id_t is an integer that represents a particular
|
| + * authentication function type, e.g. HMAC-SHA1. A SRTP_NULL_AUTH is
|
| + * avaliable; this authentication function performs no computation,
|
| + * and can be selected to indicate that no authentication is to take
|
| + * place.
|
| + *
|
| + * @ingroup Authentication
|
| + */
|
| +typedef uint32_t srtp_auth_type_id_t;
|
| +
|
| +/*
|
| + * @brief srtp_err_status_t defines error codes.
|
| + *
|
| + * The enumeration srtp_err_status_t defines error codes. Note that the
|
| + * value of srtp_err_status_ok is equal to zero, which can simplify error
|
| + * checking somewhat.
|
| + *
|
| + */
|
| +typedef enum {
|
| + srtp_err_status_ok = 0, /**< nothing to report */
|
| + srtp_err_status_fail = 1, /**< unspecified failure */
|
| + srtp_err_status_bad_param = 2, /**< unsupported parameter */
|
| + srtp_err_status_alloc_fail = 3, /**< couldn't allocate memory */
|
| + srtp_err_status_dealloc_fail = 4, /**< couldn't deallocate properly */
|
| + srtp_err_status_init_fail = 5, /**< couldn't initialize */
|
| + srtp_err_status_terminus = 6, /**< can't process as much data as requested */
|
| + srtp_err_status_auth_fail = 7, /**< authentication failure */
|
| + srtp_err_status_cipher_fail = 8, /**< cipher failure */
|
| + srtp_err_status_replay_fail = 9, /**< replay check failed (bad index) */
|
| + srtp_err_status_replay_old = 10, /**< replay check failed (index too old) */
|
| + srtp_err_status_algo_fail = 11, /**< algorithm failed test routine */
|
| + srtp_err_status_no_such_op = 12, /**< unsupported operation */
|
| + srtp_err_status_no_ctx = 13, /**< no appropriate context found */
|
| + srtp_err_status_cant_check = 14, /**< unable to perform desired validation */
|
| + srtp_err_status_key_expired = 15, /**< can't use key any more */
|
| + srtp_err_status_socket_err = 16, /**< error in use of socket */
|
| + srtp_err_status_signal_err = 17, /**< error in use POSIX signals */
|
| + srtp_err_status_nonce_bad = 18, /**< nonce check failed */
|
| + srtp_err_status_read_fail = 19, /**< couldn't read data */
|
| + srtp_err_status_write_fail = 20, /**< couldn't write data */
|
| + srtp_err_status_parse_err = 21, /**< error parsing data */
|
| + srtp_err_status_encode_err = 22, /**< error encoding data */
|
| + srtp_err_status_semaphore_err = 23,/**< error while using semaphores */
|
| + srtp_err_status_pfkey_err = 24 /**< error while using pfkey */
|
| +} srtp_err_status_t;
|
| +
|
| +typedef struct srtp_stream_ctx_t_ srtp_stream_ctx_t;
|
| +typedef struct srtp_ctx_t_ srtp_ctx_t;
|
|
|
| /*
|
| * nota bene: since libSRTP doesn't support the use of the MKI, the
|
| @@ -124,9 +279,9 @@ extern "C" {
|
| */
|
|
|
| /**
|
| - * @brief sec_serv_t describes a set of security services.
|
| + * @brief srtp_sec_serv_t describes a set of security services.
|
| *
|
| - * A sec_serv_t enumeration is used to describe the particular
|
| + * A srtp_sec_serv_t enumeration is used to describe the particular
|
| * security services that will be applied by a particular crypto
|
| * policy (or other mechanism).
|
| */
|
| @@ -136,38 +291,38 @@ typedef enum {
|
| sec_serv_conf = 1, /**< confidentiality */
|
| sec_serv_auth = 2, /**< authentication */
|
| sec_serv_conf_and_auth = 3 /**< confidentiality and authentication */
|
| -} sec_serv_t;
|
| +} srtp_sec_serv_t;
|
|
|
| /**
|
| - * @brief crypto_policy_t describes a particular crypto policy that
|
| + * @brief srtp_crypto_policy_t describes a particular crypto policy that
|
| * can be applied to an SRTP stream.
|
| *
|
| - * A crypto_policy_t describes a particular cryptographic policy that
|
| + * A srtp_crypto_policy_t describes a particular cryptographic policy that
|
| * can be applied to an SRTP or SRTCP stream. An SRTP session policy
|
| * consists of a list of these policies, one for each SRTP stream
|
| * in the session.
|
| */
|
|
|
| -typedef struct crypto_policy_t {
|
| - cipher_type_id_t cipher_type; /**< An integer representing
|
| - * the type of cipher. */
|
| +typedef struct srtp_crypto_policy_t {
|
| + srtp_cipher_type_id_t cipher_type; /**< An integer representing
|
| + * the type of cipher. */
|
| int cipher_key_len; /**< The length of the cipher key
|
| * in octets. */
|
| - auth_type_id_t auth_type; /**< An integer representing the
|
| - * authentication function. */
|
| + srtp_auth_type_id_t auth_type; /**< An integer representing the
|
| + * authentication function. */
|
| int auth_key_len; /**< The length of the authentication
|
| * function key in octets. */
|
| int auth_tag_len; /**< The length of the authentication
|
| * tag in octets. */
|
| - sec_serv_t sec_serv; /**< The flag indicating the security
|
| + srtp_sec_serv_t sec_serv; /**< The flag indicating the security
|
| * services to be applied. */
|
| -} crypto_policy_t;
|
| +} srtp_crypto_policy_t;
|
|
|
|
|
| /**
|
| - * @brief ssrc_type_t describes the type of an SSRC.
|
| + * @brief srtp_ssrc_type_t describes the type of an SSRC.
|
| *
|
| - * An ssrc_type_t enumeration is used to indicate a type of SSRC. See
|
| + * An srtp_ssrc_type_t enumeration is used to indicate a type of SSRC. See
|
| * @ref srtp_policy_t for more informataion.
|
| */
|
|
|
| @@ -180,12 +335,12 @@ typedef enum {
|
| ssrc_any_outbound = 3 /**< Indicates any outbound SSRC value
|
| (i.e. a value that is used in the
|
| function srtp_protect()) */
|
| -} ssrc_type_t;
|
| +} srtp_ssrc_type_t;
|
|
|
| /**
|
| - * @brief An ssrc_t represents a particular SSRC value, or a `wildcard' SSRC.
|
| + * @brief An srtp_ssrc_t represents a particular SSRC value, or a `wildcard' SSRC.
|
| *
|
| - * An ssrc_t represents a particular SSRC value (if its type is
|
| + * An srtp_ssrc_t represents a particular SSRC value (if its type is
|
| * ssrc_specific), or a wildcard SSRC value that will match all
|
| * outbound SSRCs (if its type is ssrc_any_outbound) or all inbound
|
| * SSRCs (if its type is ssrc_any_inbound).
|
| @@ -193,21 +348,21 @@ typedef enum {
|
| */
|
|
|
| typedef struct {
|
| - ssrc_type_t type; /**< The type of this particular SSRC */
|
| - unsigned int value; /**< The value of this SSRC, if it is not a wildcard */
|
| -} ssrc_t;
|
| + srtp_ssrc_type_t type; /**< The type of this particular SSRC */
|
| + unsigned int value; /**< The value of this SSRC, if it is not a wildcard */
|
| +} srtp_ssrc_t;
|
|
|
|
|
| /**
|
| * @brief points to an EKT policy
|
| */
|
| -typedef struct ekt_policy_ctx_t *ekt_policy_t;
|
| +typedef struct srtp_ekt_policy_ctx_t *srtp_ekt_policy_t;
|
|
|
|
|
| /**
|
| * @brief points to EKT stream data
|
| */
|
| -typedef struct ekt_stream_ctx_t *ekt_stream_t;
|
| +typedef struct srtp_ekt_stream_ctx_t *srtp_ekt_stream_t;
|
|
|
|
|
| /**
|
| @@ -238,16 +393,16 @@ typedef struct ekt_stream_ctx_t *ekt_stream_t;
|
| */
|
|
|
| typedef struct srtp_policy_t {
|
| - ssrc_t ssrc; /**< The SSRC value of stream, or the
|
| + srtp_ssrc_t ssrc; /**< The SSRC value of stream, or the
|
| * flags SSRC_ANY_INBOUND or
|
| * SSRC_ANY_OUTBOUND if key sharing
|
| * is used for this policy element.
|
| */
|
| - crypto_policy_t rtp; /**< SRTP crypto policy. */
|
| - crypto_policy_t rtcp; /**< SRTCP crypto policy. */
|
| + srtp_crypto_policy_t rtp; /**< SRTP crypto policy. */
|
| + srtp_crypto_policy_t rtcp; /**< SRTCP crypto policy. */
|
| unsigned char *key; /**< Pointer to the SRTP master key for
|
| * this stream. */
|
| - ekt_policy_t ekt; /**< Pointer to the EKT policy structure
|
| + srtp_ekt_policy_t ekt; /**< Pointer to the EKT policy structure
|
| * for this stream (if any) */
|
| unsigned long window_size; /**< The window size to use for replay
|
| * protection. */
|
| @@ -278,7 +433,7 @@ typedef struct srtp_policy_t {
|
| * streams, each of which originates with a different participant.
|
| */
|
|
|
| -typedef struct srtp_ctx_t *srtp_t;
|
| +typedef srtp_ctx_t *srtp_t;
|
|
|
|
|
| /**
|
| @@ -293,7 +448,7 @@ typedef struct srtp_ctx_t *srtp_t;
|
| * a set of streams.
|
| *
|
| */
|
| -typedef struct srtp_stream_ctx_t *srtp_stream_t;
|
| +typedef srtp_stream_ctx_t *srtp_stream_t;
|
|
|
|
|
|
|
| @@ -304,8 +459,7 @@ typedef struct srtp_stream_ctx_t *srtp_stream_t;
|
| * functions.
|
| */
|
|
|
| -err_status_t
|
| -srtp_init(void);
|
| +srtp_err_status_t srtp_init(void);
|
|
|
| /**
|
| * @brief srtp_shutdown() de-initializes the srtp library.
|
| @@ -313,8 +467,7 @@ srtp_init(void);
|
| * @warning No srtp functions may be called after calling this function.
|
| */
|
|
|
| -err_status_t
|
| -srtp_shutdown(void);
|
| +srtp_err_status_t srtp_shutdown(void);
|
|
|
| /**
|
| * @brief srtp_protect() is the Secure RTP sender-side packet processing
|
| @@ -322,7 +475,7 @@ srtp_shutdown(void);
|
| *
|
| * The function call srtp_protect(ctx, rtp_hdr, len_ptr) applies SRTP
|
| * protection to the RTP packet rtp_hdr (which has length *len_ptr) using
|
| - * the SRTP context ctx. If err_status_ok is returned, then rtp_hdr
|
| + * the SRTP context ctx. If srtp_err_status_ok is returned, then rtp_hdr
|
| * points to the resulting SRTP packet and *len_ptr is the number of
|
| * octets in that packet; otherwise, no assumptions should be made
|
| * about the value of either data elements.
|
| @@ -348,17 +501,16 @@ srtp_shutdown(void);
|
| *
|
| * @param len_ptr is a pointer to the length in octets of the complete
|
| * RTP packet (header and body) before the function call, and of the
|
| - * complete SRTP packet after the call, if err_status_ok was returned.
|
| + * complete SRTP packet after the call, if srtp_err_status_ok was returned.
|
| * Otherwise, the value of the data to which it points is undefined.
|
| *
|
| * @return
|
| - * - err_status_ok no problems
|
| - * - err_status_replay_fail rtp sequence number was non-increasing
|
| + * - srtp_err_status_ok no problems
|
| + * - srtp_err_status_replay_fail rtp sequence number was non-increasing
|
| * - @e other failure in cryptographic mechanisms
|
| */
|
|
|
| -err_status_t
|
| -srtp_protect(srtp_t ctx, void *rtp_hdr, int *len_ptr);
|
| +srtp_err_status_t srtp_protect(srtp_t ctx, void *rtp_hdr, int *len_ptr);
|
|
|
| /**
|
| * @brief srtp_unprotect() is the Secure RTP receiver-side packet
|
| @@ -367,7 +519,7 @@ srtp_protect(srtp_t ctx, void *rtp_hdr, int *len_ptr);
|
| * The function call srtp_unprotect(ctx, srtp_hdr, len_ptr) verifies
|
| * the Secure RTP protection of the SRTP packet pointed to by srtp_hdr
|
| * (which has length *len_ptr), using the SRTP context ctx. If
|
| - * err_status_ok is returned, then srtp_hdr points to the resulting
|
| + * srtp_err_status_ok is returned, then srtp_hdr points to the resulting
|
| * RTP packet and *len_ptr is the number of octets in that packet;
|
| * otherwise, no assumptions should be made about the value of either
|
| * data elements.
|
| @@ -383,34 +535,32 @@ srtp_protect(srtp_t ctx, void *rtp_hdr, int *len_ptr);
|
| *
|
| * @param srtp_hdr is a pointer to the header of the SRTP packet
|
| * (before the call). after the function returns, it points to the
|
| - * rtp packet if err_status_ok was returned; otherwise, the value of
|
| + * rtp packet if srtp_err_status_ok was returned; otherwise, the value of
|
| * the data to which it points is undefined.
|
| *
|
| * @param len_ptr is a pointer to the length in octets of the complete
|
| * srtp packet (header and body) before the function call, and of the
|
| - * complete rtp packet after the call, if err_status_ok was returned.
|
| + * complete rtp packet after the call, if srtp_err_status_ok was returned.
|
| * Otherwise, the value of the data to which it points is undefined.
|
| *
|
| * @return
|
| - * - err_status_ok if the RTP packet is valid.
|
| - * - err_status_auth_fail if the SRTP packet failed the message
|
| + * - srtp_err_status_ok if the RTP packet is valid.
|
| + * - srtp_err_status_auth_fail if the SRTP packet failed the message
|
| * authentication check.
|
| - * - err_status_replay_fail if the SRTP packet is a replay (e.g. packet has
|
| + * - srtp_err_status_replay_fail if the SRTP packet is a replay (e.g. packet has
|
| * already been processed and accepted).
|
| * - [other] if there has been an error in the cryptographic mechanisms.
|
| *
|
| */
|
|
|
| -err_status_t
|
| -srtp_unprotect(srtp_t ctx, void *srtp_hdr, int *len_ptr);
|
| +srtp_err_status_t srtp_unprotect(srtp_t ctx, void *srtp_hdr, int *len_ptr);
|
|
|
|
|
| /**
|
| * @brief srtp_create() allocates and initializes an SRTP session.
|
|
|
| - * The function call srtp_create(session, policy, key) allocates and
|
| - * initializes an SRTP session context, applying the given policy and
|
| - * key.
|
| + * The function call srtp_create(session, policy) allocates and
|
| + * initializes an SRTP session context, applying the given policy.
|
| *
|
| * @param session is a pointer to the SRTP session to which the policy is
|
| * to be added.
|
| @@ -423,13 +573,12 @@ srtp_unprotect(srtp_t ctx, void *srtp_hdr, int *len_ptr);
|
| * have its `next' field set to NULL.
|
| *
|
| * @return
|
| - * - err_status_ok if creation succeded.
|
| - * - err_status_alloc_fail if allocation failed.
|
| - * - err_status_init_fail if initialization failed.
|
| + * - srtp_err_status_ok if creation succeded.
|
| + * - srtp_err_status_alloc_fail if allocation failed.
|
| + * - srtp_err_status_init_fail if initialization failed.
|
| */
|
|
|
| -err_status_t
|
| -srtp_create(srtp_t *session, const srtp_policy_t *policy);
|
| +srtp_err_status_t srtp_create(srtp_t *session, const srtp_policy_t *policy);
|
|
|
|
|
| /**
|
| @@ -442,14 +591,12 @@ srtp_create(srtp_t *session, const srtp_policy_t *policy);
|
| * stream.
|
| *
|
| * @return values:
|
| - * - err_status_ok if stream creation succeded.
|
| - * - err_status_alloc_fail if stream allocation failed
|
| - * - err_status_init_fail if stream initialization failed.
|
| + * - srtp_err_status_ok if stream creation succeded.
|
| + * - srtp_err_status_alloc_fail if stream allocation failed
|
| + * - srtp_err_status_init_fail if stream initialization failed.
|
| */
|
|
|
| -err_status_t
|
| -srtp_add_stream(srtp_t session,
|
| - const srtp_policy_t *policy);
|
| +srtp_err_status_t srtp_add_stream(srtp_t session, const srtp_policy_t *policy);
|
|
|
|
|
| /**
|
| @@ -462,22 +609,73 @@ srtp_add_stream(srtp_t session,
|
| * @param session is the SRTP session from which the stream
|
| * will be removed.
|
| *
|
| - * @param ssrc is the SSRC value of the stream to be removed.
|
| + * @param ssrc is the SSRC value of the stream to be removed
|
| + * in network byte order.
|
| *
|
| * @warning Wildcard SSRC values cannot be removed from a
|
| * session.
|
| *
|
| * @return
|
| - * - err_status_ok if the stream deallocation succeded.
|
| + * - srtp_err_status_ok if the stream deallocation succeded.
|
| * - [other] otherwise.
|
| *
|
| */
|
|
|
| -err_status_t
|
| -srtp_remove_stream(srtp_t session, unsigned int ssrc);
|
| +srtp_err_status_t srtp_remove_stream(srtp_t session, unsigned int ssrc);
|
|
|
| /**
|
| - * @brief crypto_policy_set_rtp_default() sets a crypto policy
|
| + * @brief srtp_update() udpates all streams in the session.
|
| + *
|
| + * The function call srtp_update(session, policy) updates
|
| + * all the streams in the session applying the given policy
|
| + * and key. The exsisting ROC value of all streams will be
|
| + * preserved.
|
| + *
|
| + * @param session is the SRTP session that contains the streams
|
| + * to be updated.
|
| + *
|
| + * @param policy is the srtp_policy_t struct that describes the policy
|
| + * for the session. The struct may be a single element, or it may be
|
| + * the head of a list, in which case each element of the list is
|
| + * processed. The final element of the list @b must
|
| + * have its `next' field set to NULL.
|
| + *
|
| + * @return
|
| + * - srtp_err_status_ok if stream creation succeded.
|
| + * - srtp_err_status_alloc_fail if stream allocation failed
|
| + * - srtp_err_status_init_fail if stream initialization failed.
|
| + * - [other] otherwise.
|
| + *
|
| + */
|
| +
|
| +srtp_err_status_t srtp_update(srtp_t session, const srtp_policy_t *policy);
|
| +
|
| +/**
|
| + * @brief srtp_update_stream() udpates a SRTP stream.
|
| + *
|
| + * The function call srtp_update_stream(session, policy) updates
|
| + * the stream(s) in the session that match applying the given
|
| + * policy and key. The exsisting ROC value of all stream(s) will
|
| + * be preserved.
|
| + *
|
| + * @param session is the SRTP session that contains the streams
|
| + * to be updated.
|
| + *
|
| + * @param policy is the srtp_policy_t struct that describes the policy
|
| + * for the session.
|
| + *
|
| + * @return
|
| + * - srtp_err_status_ok if stream creation succeded.
|
| + * - srtp_err_status_alloc_fail if stream allocation failed
|
| + * - srtp_err_status_init_fail if stream initialization failed.
|
| + * - [other] otherwise.
|
| + *
|
| + */
|
| +
|
| +srtp_err_status_t srtp_update_stream(srtp_t session, const srtp_policy_t *policy);
|
| +
|
| +/**
|
| + * @brief srtp_crypto_policy_set_rtp_default() sets a crypto policy
|
| * structure to the SRTP default policy for RTP protection.
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| @@ -495,39 +693,37 @@ srtp_remove_stream(srtp_t session, unsigned int ssrc);
|
| *
|
| */
|
|
|
| -void
|
| -crypto_policy_set_rtp_default(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_rtp_default(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_rtcp_default() sets a crypto policy
|
| + * @brief srtp_crypto_policy_set_rtcp_default() sets a crypto policy
|
| * structure to the SRTP default policy for RTCP protection.
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_rtcp_default(&p) sets the
|
| - * crypto_policy_t at location p to the SRTP default policy for RTCP
|
| + * The function call srtp_crypto_policy_set_rtcp_default(&p) sets the
|
| + * srtp_crypto_policy_t at location p to the SRTP default policy for RTCP
|
| * protection, as defined in the specification. This function is a
|
| * convenience that helps to avoid dealing directly with the policy
|
| * data structure. You are encouraged to initialize policy elements
|
| * with this function call. Doing so may allow your code to be
|
| * forward compatible with later versions of libSRTP that include more
|
| - * elements in the crypto_policy_t datatype.
|
| + * elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return void.
|
| *
|
| */
|
|
|
| -void
|
| -crypto_policy_set_rtcp_default(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_rtcp_default(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_cm_128_hmac_sha1_80() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_cm_128_hmac_sha1_80() sets a crypto
|
| * policy structure to the SRTP default policy for RTP protection.
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function crypto_policy_set_aes_cm_128_hmac_sha1_80() is a
|
| - * synonym for crypto_policy_set_rtp_default(). It conforms to the
|
| + * The function srtp_crypto_policy_set_aes_cm_128_hmac_sha1_80() is a
|
| + * synonym for srtp_crypto_policy_set_rtp_default(). It conforms to the
|
| * naming convention used in RFC 4568 (SDP Security Descriptions for
|
| * Media Streams).
|
| *
|
| @@ -535,17 +731,17 @@ crypto_policy_set_rtcp_default(crypto_policy_t *p);
|
| *
|
| */
|
|
|
| -#define crypto_policy_set_aes_cm_128_hmac_sha1_80(p) crypto_policy_set_rtp_default(p)
|
| +#define srtp_crypto_policy_set_aes_cm_128_hmac_sha1_80(p) srtp_crypto_policy_set_rtp_default(p)
|
|
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_cm_128_hmac_sha1_32() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_cm_128_hmac_sha1_32() sets a crypto
|
| * policy structure to a short-authentication tag policy
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_cm_128_hmac_sha1_32(&p)
|
| - * sets the crypto_policy_t at location p to use policy
|
| + * The function call srtp_crypto_policy_set_aes_cm_128_hmac_sha1_32(&p)
|
| + * sets the srtp_crypto_policy_t at location p to use policy
|
| * AES_CM_128_HMAC_SHA1_32 as defined in RFC 4568.
|
| * This policy uses AES-128
|
| * Counter Mode encryption and HMAC-SHA1 authentication, with an
|
| @@ -558,7 +754,7 @@ crypto_policy_set_rtcp_default(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @warning This crypto policy is intended for use in SRTP, but not in
|
| * SRTCP. It is recommended that a policy that uses longer
|
| @@ -569,19 +765,18 @@ crypto_policy_set_rtcp_default(crypto_policy_t *p);
|
| *
|
| */
|
|
|
| -void
|
| -crypto_policy_set_aes_cm_128_hmac_sha1_32(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_cm_128_hmac_sha1_32(srtp_crypto_policy_t *p);
|
|
|
|
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_cm_128_null_auth() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_cm_128_null_auth() sets a crypto
|
| * policy structure to an encryption-only policy
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_cm_128_null_auth(&p) sets
|
| - * the crypto_policy_t at location p to use the SRTP default cipher
|
| + * The function call srtp_crypto_policy_set_aes_cm_128_null_auth(&p) sets
|
| + * the srtp_crypto_policy_t at location p to use the SRTP default cipher
|
| * (AES-128 Counter Mode), but to use no authentication method. This
|
| * policy is NOT RECOMMENDED unless it is unavoidable; see Section 7.5
|
| * of RFC 3711 (http://www.ietf.org/rfc/rfc3711.txt).
|
| @@ -590,7 +785,7 @@ crypto_policy_set_aes_cm_128_hmac_sha1_32(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @warning This policy is NOT RECOMMENDED for SRTP unless it is
|
| * unavoidable, and it is NOT RECOMMENDED at all for SRTCP; see
|
| @@ -600,18 +795,17 @@ crypto_policy_set_aes_cm_128_hmac_sha1_32(crypto_policy_t *p);
|
| *
|
| */
|
|
|
| -void
|
| -crypto_policy_set_aes_cm_128_null_auth(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_cm_128_null_auth(srtp_crypto_policy_t *p);
|
|
|
|
|
| /**
|
| - * @brief crypto_policy_set_null_cipher_hmac_sha1_80() sets a crypto
|
| + * @brief srtp_crypto_policy_set_null_cipher_hmac_sha1_80() sets a crypto
|
| * policy structure to an authentication-only policy
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_null_cipher_hmac_sha1_80(&p)
|
| - * sets the crypto_policy_t at location p to use HMAC-SHA1 with an 80
|
| + * The function call srtp_crypto_policy_set_null_cipher_hmac_sha1_80(&p)
|
| + * sets the srtp_crypto_policy_t at location p to use HMAC-SHA1 with an 80
|
| * bit authentication tag to provide message authentication, but to
|
| * use no encryption. This policy is NOT RECOMMENDED for SRTP unless
|
| * there is a requirement to forego encryption.
|
| @@ -620,7 +814,7 @@ crypto_policy_set_aes_cm_128_null_auth(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @warning This policy is NOT RECOMMENDED for SRTP unless there is a
|
| * requirement to forego encryption.
|
| @@ -628,20 +822,43 @@ crypto_policy_set_aes_cm_128_null_auth(crypto_policy_t *p);
|
| * @return void.
|
| *
|
| */
|
| +void srtp_crypto_policy_set_null_cipher_hmac_sha1_80(srtp_crypto_policy_t *p);
|
|
|
| -void
|
| -crypto_policy_set_null_cipher_hmac_sha1_80(crypto_policy_t *p);
|
| +/**
|
| + * @brief srtp_crypto_policy_set_null_cipher_hmac_null() sets a crypto
|
| + * policy structure to use no encryption or authentication.
|
| + *
|
| + * @param p is a pointer to the policy structure to be set
|
| + *
|
| + * The function call srtp_crypto_policy_set_null_cipher_hmac_null(&p)
|
| + * sets the srtp_crypto_policy_t at location p to use no encryption and
|
| + * no authentication. This policy should only be used for testing and
|
| + * troubleshootingl.
|
| + *
|
| + * This function is a convenience that helps to avoid dealing directly
|
| + * with the policy data structure. You are encouraged to initialize
|
| + * policy elements with this function call. Doing so may allow your
|
| + * code to be forward compatible with later versions of libSRTP that
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| + *
|
| + * @warning This policy is NOT RECOMMENDED for SRTP unless there is a
|
| + * requirement to forego encryption and authentication.
|
| + *
|
| + * @return void.
|
| + *
|
| + */
|
| +void srtp_crypto_policy_set_null_cipher_hmac_null(srtp_crypto_policy_t *p);
|
|
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_cm_256_hmac_sha1_80() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_cm_256_hmac_sha1_80() sets a crypto
|
| * policy structure to a encryption and authentication policy using AES-256
|
| * for RTP protection.
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_cm_256_hmac_sha1_80(&p)
|
| - * sets the crypto_policy_t at location p to use policy
|
| + * The function call srtp_crypto_policy_set_aes_cm_256_hmac_sha1_80(&p)
|
| + * sets the srtp_crypto_policy_t at location p to use policy
|
| * AES_CM_256_HMAC_SHA1_80 as defined in
|
| * draft-ietf-avt-srtp-big-aes-03.txt. This policy uses AES-256
|
| * Counter Mode encryption and HMAC-SHA1 authentication, with an 80 bit
|
| @@ -651,24 +868,24 @@ crypto_policy_set_null_cipher_hmac_sha1_80(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return void.
|
| *
|
| */
|
|
|
| -void crypto_policy_set_aes_cm_256_hmac_sha1_80(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_cm_256_hmac_sha1_80(srtp_crypto_policy_t *p);
|
|
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_cm_256_hmac_sha1_32() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_cm_256_hmac_sha1_32() sets a crypto
|
| * policy structure to a short-authentication tag policy using AES-256
|
| * encryption.
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_cm_256_hmac_sha1_32(&p)
|
| - * sets the crypto_policy_t at location p to use policy
|
| + * The function call srtp_crypto_policy_set_aes_cm_256_hmac_sha1_32(&p)
|
| + * sets the srtp_crypto_policy_t at location p to use policy
|
| * AES_CM_256_HMAC_SHA1_32 as defined in
|
| * draft-ietf-avt-srtp-big-aes-03.txt. This policy uses AES-256
|
| * Counter Mode encryption and HMAC-SHA1 authentication, with an
|
| @@ -681,7 +898,7 @@ void crypto_policy_set_aes_cm_256_hmac_sha1_80(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @warning This crypto policy is intended for use in SRTP, but not in
|
| * SRTCP. It is recommended that a policy that uses longer
|
| @@ -692,17 +909,16 @@ void crypto_policy_set_aes_cm_256_hmac_sha1_80(crypto_policy_t *p);
|
| *
|
| */
|
|
|
| -void
|
| -crypto_policy_set_aes_cm_256_hmac_sha1_32(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_cm_256_hmac_sha1_32(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_cm_256_null_auth() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_cm_256_null_auth() sets a crypto
|
| * policy structure to an encryption-only policy
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_cm_256_null_auth(&p) sets
|
| - * the crypto_policy_t at location p to use the SRTP default cipher
|
| + * The function call srtp_crypto_policy_set_aes_cm_256_null_auth(&p) sets
|
| + * the srtp_crypto_policy_t at location p to use the SRTP default cipher
|
| * (AES-256 Counter Mode), but to use no authentication method. This
|
| * policy is NOT RECOMMENDED unless it is unavoidable; see Section 7.5
|
| * of RFC 3711 (http://www.ietf.org/rfc/rfc3711.txt).
|
| @@ -711,7 +927,7 @@ crypto_policy_set_aes_cm_256_hmac_sha1_32(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @warning This policy is NOT RECOMMENDED for SRTP unless it is
|
| * unavoidable, and it is NOT RECOMMENDED at all for SRTCP; see
|
| @@ -720,17 +936,16 @@ crypto_policy_set_aes_cm_256_hmac_sha1_32(crypto_policy_t *p);
|
| * @return void.
|
| *
|
| */
|
| -void
|
| -crypto_policy_set_aes_cm_256_null_auth(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_cm_256_null_auth(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_gcm_128_8_auth() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_gcm_128_8_auth() sets a crypto
|
| * policy structure to an AEAD encryption policy.
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_gcm_128_8_auth(&p) sets
|
| - * the crypto_policy_t at location p to use the SRTP default cipher
|
| + * The function call srtp_crypto_policy_set_aes_gcm_128_8_auth(&p) sets
|
| + * the srtp_crypto_policy_t at location p to use the SRTP default cipher
|
| * (AES-128 Galois Counter Mode) with 8 octet auth tag. This
|
| * policy applies confidentiality and authentication to both the
|
| * RTP and RTCP packets.
|
| @@ -739,22 +954,21 @@ crypto_policy_set_aes_cm_256_null_auth(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return void.
|
| *
|
| */
|
| -void
|
| -crypto_policy_set_aes_gcm_128_8_auth(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_gcm_128_8_auth(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_gcm_256_8_auth() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_gcm_256_8_auth() sets a crypto
|
| * policy structure to an AEAD encryption policy
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_gcm_256_8_auth(&p) sets
|
| - * the crypto_policy_t at location p to use the SRTP default cipher
|
| + * The function call srtp_crypto_policy_set_aes_gcm_256_8_auth(&p) sets
|
| + * the srtp_crypto_policy_t at location p to use the SRTP default cipher
|
| * (AES-256 Galois Counter Mode) with 8 octet auth tag. This
|
| * policy applies confidentiality and authentication to both the
|
| * RTP and RTCP packets.
|
| @@ -763,22 +977,21 @@ crypto_policy_set_aes_gcm_128_8_auth(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return void.
|
| *
|
| */
|
| -void
|
| -crypto_policy_set_aes_gcm_256_8_auth(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_gcm_256_8_auth(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_gcm_128_8_only_auth() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_gcm_128_8_only_auth() sets a crypto
|
| * policy structure to an AEAD authentication-only policy
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_gcm_128_8_only_auth(&p) sets
|
| - * the crypto_policy_t at location p to use the SRTP default cipher
|
| + * The function call srtp_crypto_policy_set_aes_gcm_128_8_only_auth(&p) sets
|
| + * the srtp_crypto_policy_t at location p to use the SRTP default cipher
|
| * (AES-128 Galois Counter Mode) with 8 octet auth tag. This policy
|
| * applies confidentiality and authentication to the RTP packets,
|
| * but only authentication to the RTCP packets.
|
| @@ -787,22 +1000,21 @@ crypto_policy_set_aes_gcm_256_8_auth(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return void.
|
| *
|
| */
|
| -void
|
| -crypto_policy_set_aes_gcm_128_8_only_auth(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_gcm_128_8_only_auth(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_gcm_256_8_only_auth() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_gcm_256_8_only_auth() sets a crypto
|
| * policy structure to an AEAD authentication-only policy
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_gcm_256_8_only_auth(&p) sets
|
| - * the crypto_policy_t at location p to use the SRTP default cipher
|
| + * The function call srtp_crypto_policy_set_aes_gcm_256_8_only_auth(&p) sets
|
| + * the srtp_crypto_policy_t at location p to use the SRTP default cipher
|
| * (AES-256 Galois Counter Mode) with 8 octet auth tag. This policy
|
| * applies confidentiality and authentication to the RTP packets,
|
| * but only authentication to the RTCP packets.
|
| @@ -811,22 +1023,21 @@ crypto_policy_set_aes_gcm_128_8_only_auth(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return void.
|
| *
|
| */
|
| -void
|
| -crypto_policy_set_aes_gcm_256_8_only_auth(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_gcm_256_8_only_auth(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_gcm_128_16_auth() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_gcm_128_16_auth() sets a crypto
|
| * policy structure to an AEAD encryption policy.
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_gcm_128_16_auth(&p) sets
|
| - * the crypto_policy_t at location p to use the SRTP default cipher
|
| + * The function call srtp_crypto_policy_set_aes_gcm_128_16_auth(&p) sets
|
| + * the srtp_crypto_policy_t at location p to use the SRTP default cipher
|
| * (AES-128 Galois Counter Mode) with 16 octet auth tag. This
|
| * policy applies confidentiality and authentication to both the
|
| * RTP and RTCP packets.
|
| @@ -835,22 +1046,21 @@ crypto_policy_set_aes_gcm_256_8_only_auth(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return void.
|
| *
|
| */
|
| -void
|
| -crypto_policy_set_aes_gcm_128_16_auth(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_gcm_128_16_auth(srtp_crypto_policy_t *p);
|
|
|
| /**
|
| - * @brief crypto_policy_set_aes_gcm_256_16_auth() sets a crypto
|
| + * @brief srtp_crypto_policy_set_aes_gcm_256_16_auth() sets a crypto
|
| * policy structure to an AEAD encryption policy
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_aes_gcm_256_16_auth(&p) sets
|
| - * the crypto_policy_t at location p to use the SRTP default cipher
|
| + * The function call srtp_crypto_policy_set_aes_gcm_256_16_auth(&p) sets
|
| + * the srtp_crypto_policy_t at location p to use the SRTP default cipher
|
| * (AES-256 Galois Counter Mode) with 16 octet auth tag. This
|
| * policy applies confidentiality and authentication to both the
|
| * RTP and RTCP packets.
|
| @@ -859,13 +1069,12 @@ crypto_policy_set_aes_gcm_128_16_auth(crypto_policy_t *p);
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return void.
|
| *
|
| */
|
| -void
|
| -crypto_policy_set_aes_gcm_256_16_auth(crypto_policy_t *p);
|
| +void srtp_crypto_policy_set_aes_gcm_256_16_auth(srtp_crypto_policy_t *p);
|
|
|
|
|
| /**
|
| @@ -880,12 +1089,11 @@ crypto_policy_set_aes_gcm_256_16_auth(crypto_policy_t *p);
|
| * @param s is the srtp_t for the session to be deallocated.
|
| *
|
| * @return
|
| - * - err_status_ok if there no problems.
|
| - * - err_status_dealloc_fail a memory deallocation failure occured.
|
| + * - srtp_err_status_ok if there no problems.
|
| + * - srtp_err_status_dealloc_fail a memory deallocation failure occured.
|
| */
|
|
|
| -err_status_t
|
| -srtp_dealloc(srtp_t s);
|
| +srtp_err_status_t srtp_dealloc(srtp_t s);
|
|
|
|
|
| /*
|
| @@ -908,57 +1116,53 @@ typedef enum {
|
|
|
|
|
| /**
|
| - * @brief crypto_policy_set_from_profile_for_rtp() sets a crypto policy
|
| + * @brief srtp_crypto_policy_set_from_profile_for_rtp() sets a crypto policy
|
| * structure to the appropriate value for RTP based on an srtp_profile_t
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_rtp_default(&policy, profile)
|
| - * sets the crypto_policy_t at location policy to the policy for RTP
|
| + * The function call srtp_crypto_policy_set_rtp_default(&policy, profile)
|
| + * sets the srtp_crypto_policy_t at location policy to the policy for RTP
|
| * protection, as defined by the srtp_profile_t profile.
|
| *
|
| * This function is a convenience that helps to avoid dealing directly
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return values
|
| - * - err_status_ok no problems were encountered
|
| - * - err_status_bad_param the profile is not supported
|
| + * - srtp_err_status_ok no problems were encountered
|
| + * - srtp_err_status_bad_param the profile is not supported
|
| *
|
| */
|
| -err_status_t
|
| -crypto_policy_set_from_profile_for_rtp(crypto_policy_t *policy,
|
| - srtp_profile_t profile);
|
| +srtp_err_status_t srtp_crypto_policy_set_from_profile_for_rtp(srtp_crypto_policy_t *policy, srtp_profile_t profile);
|
|
|
|
|
|
|
|
|
| /**
|
| - * @brief crypto_policy_set_from_profile_for_rtcp() sets a crypto policy
|
| + * @brief srtp_crypto_policy_set_from_profile_for_rtcp() sets a crypto policy
|
| * structure to the appropriate value for RTCP based on an srtp_profile_t
|
| *
|
| * @param p is a pointer to the policy structure to be set
|
| *
|
| - * The function call crypto_policy_set_rtcp_default(&policy, profile)
|
| - * sets the crypto_policy_t at location policy to the policy for RTCP
|
| + * The function call srtp_crypto_policy_set_rtcp_default(&policy, profile)
|
| + * sets the srtp_crypto_policy_t at location policy to the policy for RTCP
|
| * protection, as defined by the srtp_profile_t profile.
|
| *
|
| * This function is a convenience that helps to avoid dealing directly
|
| * with the policy data structure. You are encouraged to initialize
|
| * policy elements with this function call. Doing so may allow your
|
| * code to be forward compatible with later versions of libSRTP that
|
| - * include more elements in the crypto_policy_t datatype.
|
| + * include more elements in the srtp_crypto_policy_t datatype.
|
| *
|
| * @return values
|
| - * - err_status_ok no problems were encountered
|
| - * - err_status_bad_param the profile is not supported
|
| + * - srtp_err_status_ok no problems were encountered
|
| + * - srtp_err_status_bad_param the profile is not supported
|
| *
|
| */
|
| -err_status_t
|
| -crypto_policy_set_from_profile_for_rtcp(crypto_policy_t *policy,
|
| - srtp_profile_t profile);
|
| +srtp_err_status_t srtp_crypto_policy_set_from_profile_for_rtcp(srtp_crypto_policy_t *policy, srtp_profile_t profile);
|
|
|
| /**
|
| * @brief returns the master key length for a given SRTP profile
|
| @@ -976,7 +1180,7 @@ srtp_profile_get_master_salt_length(srtp_profile_t profile);
|
| /**
|
| * @brief appends the salt to the key
|
| *
|
| - * The function call append_salt_to_key(k, klen, s, slen)
|
| + * The function call srtp_append_salt_to_key(k, klen, s, slen)
|
| * copies the string s to the location at klen bytes following
|
| * the location k.
|
| *
|
| @@ -986,8 +1190,8 @@ srtp_profile_get_master_salt_length(srtp_profile_t profile);
|
| */
|
|
|
| void
|
| -append_salt_to_key(unsigned char *key, unsigned int bytes_in_key,
|
| - unsigned char *salt, unsigned int bytes_in_salt);
|
| +srtp_append_salt_to_key(unsigned char *key, unsigned int bytes_in_key,
|
| + unsigned char *salt, unsigned int bytes_in_salt);
|
|
|
|
|
|
|
| @@ -1022,7 +1226,7 @@ append_salt_to_key(unsigned char *key, unsigned int bytes_in_key,
|
| *
|
| * The function call srtp_protect_rtcp(ctx, rtp_hdr, len_ptr) applies
|
| * SRTCP protection to the RTCP packet rtcp_hdr (which has length
|
| - * *len_ptr) using the SRTP session context ctx. If err_status_ok is
|
| + * *len_ptr) using the SRTP session context ctx. If srtp_err_status_ok is
|
| * returned, then rtp_hdr points to the resulting SRTCP packet and
|
| * *len_ptr is the number of octets in that packet; otherwise, no
|
| * assumptions should be made about the value of either data elements.
|
| @@ -1044,19 +1248,18 @@ append_salt_to_key(unsigned char *key, unsigned int bytes_in_key,
|
| *
|
| * @param pkt_octet_len is a pointer to the length in octets of the
|
| * complete RTCP packet (header and body) before the function call,
|
| - * and of the complete SRTCP packet after the call, if err_status_ok
|
| + * and of the complete SRTCP packet after the call, if srtp_err_status_ok
|
| * was returned. Otherwise, the value of the data to which it points
|
| * is undefined.
|
| *
|
| * @return
|
| - * - err_status_ok if there were no problems.
|
| + * - srtp_err_status_ok if there were no problems.
|
| * - [other] if there was a failure in
|
| * the cryptographic mechanisms.
|
| */
|
|
|
|
|
| -err_status_t
|
| -srtp_protect_rtcp(srtp_t ctx, void *rtcp_hdr, int *pkt_octet_len);
|
| +srtp_err_status_t srtp_protect_rtcp(srtp_t ctx, void *rtcp_hdr, int *pkt_octet_len);
|
|
|
| /**
|
| * @brief srtp_unprotect_rtcp() is the Secure RTCP receiver-side packet
|
| @@ -1065,7 +1268,7 @@ srtp_protect_rtcp(srtp_t ctx, void *rtcp_hdr, int *pkt_octet_len);
|
| * The function call srtp_unprotect_rtcp(ctx, srtp_hdr, len_ptr)
|
| * verifies the Secure RTCP protection of the SRTCP packet pointed to
|
| * by srtcp_hdr (which has length *len_ptr), using the SRTP session
|
| - * context ctx. If err_status_ok is returned, then srtcp_hdr points
|
| + * context ctx. If srtp_err_status_ok is returned, then srtcp_hdr points
|
| * to the resulting RTCP packet and *len_ptr is the number of octets
|
| * in that packet; otherwise, no assumptions should be made about the
|
| * value of either data elements.
|
| @@ -1078,27 +1281,26 @@ srtp_protect_rtcp(srtp_t ctx, void *rtcp_hdr, int *pkt_octet_len);
|
| *
|
| * @param srtcp_hdr is a pointer to the header of the SRTCP packet
|
| * (before the call). After the function returns, it points to the
|
| - * rtp packet if err_status_ok was returned; otherwise, the value of
|
| + * rtp packet if srtp_err_status_ok was returned; otherwise, the value of
|
| * the data to which it points is undefined.
|
| *
|
| * @param pkt_octet_len is a pointer to the length in octets of the
|
| * complete SRTCP packet (header and body) before the function call,
|
| - * and of the complete rtp packet after the call, if err_status_ok was
|
| + * and of the complete rtp packet after the call, if srtp_err_status_ok was
|
| * returned. Otherwise, the value of the data to which it points is
|
| * undefined.
|
| *
|
| * @return
|
| - * - err_status_ok if the RTCP packet is valid.
|
| - * - err_status_auth_fail if the SRTCP packet failed the message
|
| + * - srtp_err_status_ok if the RTCP packet is valid.
|
| + * - srtp_err_status_auth_fail if the SRTCP packet failed the message
|
| * authentication check.
|
| - * - err_status_replay_fail if the SRTCP packet is a replay (e.g. has
|
| + * - srtp_err_status_replay_fail if the SRTCP packet is a replay (e.g. has
|
| * already been processed and accepted).
|
| * - [other] if there has been an error in the cryptographic mechanisms.
|
| *
|
| */
|
|
|
| -err_status_t
|
| -srtp_unprotect_rtcp(srtp_t ctx, void *srtcp_hdr, int *pkt_octet_len);
|
| +srtp_err_status_t srtp_unprotect_rtcp(srtp_t ctx, void *srtcp_hdr, int *pkt_octet_len);
|
|
|
| /**
|
| * @}
|
| @@ -1190,7 +1392,7 @@ srtp_get_user_data(srtp_t ctx);
|
| * reached, an SRTP stream will enter an `expired' state in which no
|
| * more packets can be protected or unprotected. When this happens,
|
| * it is likely that you will want to either deallocate the stream
|
| - * (using srtp_stream_dealloc()), and possibly allocate a new one.
|
| + * (using srtp_remove_stream()), and possibly allocate a new one.
|
| *
|
| * When an SRTP stream expires, the other streams in the same session
|
| * are unaffected, unless key sharing is used by that stream. In the
|
| @@ -1252,8 +1454,7 @@ typedef void (srtp_event_handler_func_t)(srtp_event_data_t *data);
|
| * will be used by libSRTP to handle events.
|
| */
|
|
|
| -err_status_t
|
| -srtp_install_event_handler(srtp_event_handler_func_t func);
|
| +srtp_err_status_t srtp_install_event_handler(srtp_event_handler_func_t func);
|
|
|
| /**
|
| * @brief Returns the version string of the library.
|
| @@ -1268,6 +1469,23 @@ const char *srtp_get_version_string(void);
|
| unsigned int srtp_get_version(void);
|
|
|
| /**
|
| + * @brief srtp_set_debug_module(mod_name, v)
|
| + *
|
| + * sets dynamic debugging to the value v (0 for off, 1 for on) for the
|
| + * debug module with the name mod_name
|
| + *
|
| + * returns err_status_ok on success, err_status_fail otherwise
|
| + */
|
| +srtp_err_status_t srtp_set_debug_module(char *mod_name, int v);
|
| +
|
| +/**
|
| + * @brief srtp_list_debug_modules() outputs a list of debugging modules
|
| + *
|
| + */
|
| +srtp_err_status_t srtp_list_debug_modules(void);
|
| +
|
| +
|
| +/**
|
| * @}
|
| */
|
| /* in host order, so outside the #if */
|
|
|