/*
|
* Copyright (c) 2010-2019 Belledonne Communications SARL.
|
*
|
* This file is part of mediastreamer2.
|
*
|
* This program is free software: you can redistribute it and/or modify
|
* it under the terms of the GNU General Public License as published by
|
* the Free Software Foundation, either version 3 of the License, or
|
* (at your option) any later version.
|
*
|
* This program is distributed in the hope that it will be useful,
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
* GNU General Public License for more details.
|
*
|
* You should have received a copy of the GNU General Public License
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
*/
|
|
#ifndef ms_srtp_h
|
#define ms_srtp_h
|
|
#include <ortp/rtpsession.h>
|
#include "mediastreamer2/mscommon.h"
|
|
#ifdef __cplusplus
|
extern "C"{
|
#endif
|
/* defined in mediastream.h */
|
#ifndef MS_MEDIA_STREAM_SESSIONS_DEFINED
|
typedef struct _MSMediaStreamSessions MSMediaStreamSessions;
|
#define MS_MEDIA_STREAM_SESSIONS_DEFINED 1
|
#endif
|
|
/*
|
* Crypto suite used configure encrypted stream*/
|
typedef enum _MSCryptoSuite{
|
MS_CRYPTO_SUITE_INVALID=0,
|
MS_AES_128_SHA1_80,
|
MS_AES_128_SHA1_32,
|
MS_AES_128_NO_AUTH,
|
MS_NO_CIPHER_SHA1_80,
|
MS_AES_256_SHA1_80,
|
MS_AES_CM_256_SHA1_80,
|
MS_AES_256_SHA1_32
|
} MSCryptoSuite;
|
|
typedef struct _MSCryptoSuiteNameParams{
|
const char *name;
|
const char *params;
|
}MSCryptoSuiteNameParams;
|
|
MS2_PUBLIC MSCryptoSuite ms_crypto_suite_build_from_name_params(const MSCryptoSuiteNameParams *nameparams);
|
MS2_PUBLIC int ms_crypto_suite_to_name_params(MSCryptoSuite cs, MSCryptoSuiteNameParams *nameparams);
|
|
|
/* defined in srtp.h*/
|
typedef struct _MSSrtpCtx MSSrtpCtx;
|
|
typedef enum {
|
MSSRTP_RTP_STREAM,
|
MSSRTP_RTCP_STREAM,
|
MSSRTP_ALL_STREAMS
|
} MSSrtpStreamType;
|
/**
|
* return humanly readable string
|
* @param[in] type
|
* @return
|
*
|
* */
|
MS2_PUBLIC const char * ms_srtp_stream_type_to_string(const MSSrtpStreamType type);
|
/**
|
* Check if SRTP is supported
|
* @return true if SRTP is supported
|
*/
|
MS2_PUBLIC bool_t ms_srtp_supported(void);
|
|
/**
|
* Set encryption requirements.
|
* srtp session might be created/deleted depending on requirement parameter and already set keys
|
* @param[in/out] sessions The sessions associated to the current media stream
|
* @param[in] yesno If yes, any incoming/outgoing rtp packets are silently discarded.
|
* until keys are provided using functions #media_stream_set_srtp_recv_key_b64 or #media_stream_set_srtp_recv_key
|
* @return 0 on success, error code otherwise
|
*/
|
|
MS2_PUBLIC int ms_media_stream_sessions_set_encryption_mandatory(MSMediaStreamSessions *sessions, bool_t yesno);
|
|
/**
|
* Get encryption requirements.
|
* @param[in/out] sessions The sessions associated to the current media stream
|
* @return TRUE if only encrypted rtp packet shall be sent/received
|
*/
|
|
MS2_PUBLIC bool_t ms_media_stream_sessions_get_encryption_mandatory(const MSMediaStreamSessions *sessions);
|
|
/**
|
* Set srtp receiver key for the given media stream.
|
* If no srtp session exists on the stream it is created, if it already exists srtp policy is created/modified for the receiver side of the stream.
|
*
|
* @param[in/out] sessions The sessions associated to the current media stream
|
* @param[in] suite The srtp crypto suite to use
|
* @param[in] key Srtp master key and master salt in a base 64 NULL terminated string
|
* @return 0 on success, error code otherwise
|
*/
|
MS2_PUBLIC int ms_media_stream_sessions_set_srtp_recv_key_b64(MSMediaStreamSessions *sessions, MSCryptoSuite suite, const char* key);
|
|
/**
|
* Set srtp receiver key for the given media stream.
|
* If no srtp session exists on the stream it is created, if it already exists srtp policy is created/modified for the receiver side of the stream.
|
*
|
* @param[in/out] sessions The sessions associated to the current media stream
|
* @param[in] suite The srtp crypto suite to use
|
* @param[in] key Srtp master key and master salt
|
* @param[in] key_length key buffer length
|
* @param[in] stream_type Srtp suite is applied to RTP stream, RTCP stream or both
|
* @return 0 on success, error code otherwise
|
*/
|
MS2_PUBLIC int ms_media_stream_sessions_set_srtp_recv_key(MSMediaStreamSessions *sessions, MSCryptoSuite suite, const char* key, size_t key_length, MSSrtpStreamType stream_type);
|
|
/**
|
* Set srtp sender key for the given media stream.
|
* If no srtp session exists on the stream it is created, if it already exists srtp policy is created/modified for the sender side of the stream.
|
*
|
* @param[in/out] sessions The sessions associated to the current media stream
|
* @param[in] suite The srtp crypto suite to use
|
* @param[in] key Srtp master key and master salt in a base 64 NULL terminated string
|
* @return 0 on success, error code otherwise
|
*/
|
MS2_PUBLIC int ms_media_stream_sessions_set_srtp_send_key_b64(MSMediaStreamSessions *sessions, MSCryptoSuite suite, const char* key);
|
|
/**
|
* Set srtp sender key for the given media stream.
|
* If no srtp session exists on the stream it is created, if it already exists srtp policy is created/modified for the sender side of the stream.
|
*
|
* @param[in/out] stream The mediastream to operate on
|
* @param[in] suite The srtp crypto suite to use
|
* @param[in] key Srtp master key and master salt
|
* @param[in] key_length key buffer length
|
* @param[in] stream_type Srtp suite is applied to RTP stream, RTCP stream or both
|
* @return 0 on success, error code otherwise
|
*/
|
MS2_PUBLIC int ms_media_stream_sessions_set_srtp_send_key(MSMediaStreamSessions *sessions, MSCryptoSuite suite, const char* key, size_t key_length, MSSrtpStreamType stream_type);
|
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
#endif /* ms_srtp_h */
|
