/usr/include/pjmedia/transport_srtp.h is in libpjproject-dev 2.7.2~dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 | /* $Id: transport_srtp.h 5621 2017-07-05 05:37:24Z nanang $ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
*
* 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 2 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJMEDIA_TRANSPORT_SRTP_H__
#define __PJMEDIA_TRANSPORT_SRTP_H__
/**
* @file transport_srtp.h
* @brief Secure RTP (SRTP) transport.
*/
#include <pjmedia/transport.h>
/**
* @defgroup PJMEDIA_TRANSPORT_SRTP Secure RTP (SRTP) Media Transport
* @ingroup PJMEDIA_TRANSPORT
* @brief Media transport adapter to add SRTP feature to existing transports
* @{
*
* This module implements SRTP as described by RFC 3711, using RFC 4568 as
* key exchange method. It implements \ref PJMEDIA_TRANSPORT to integrate
* with the rest of PJMEDIA framework.
*
* As we know, media transport is separated from the stream object (which
* does the encoding/decoding of PCM frames, (de)packetization of RTP/RTCP
* packets, and de-jitter buffering). The connection between stream and media
* transport is established when the stream is created (we need to specify
* media transport during stream creation), and the interconnection can be
* depicted from the diagram below:
*
\image html media-transport.PNG
* I think the diagram above is self-explanatory.
*
* SRTP functionality is implemented as some kind of "adapter", which is
* plugged between the stream and the actual media transport that does
* sending/receiving RTP/RTCP packets. When SRTP is used, the interconnection
* between stream and transport is like the diagram below:
*
\image html media-srtp-transport.PNG
* So to stream, the SRTP transport behaves as if it is a media transport
* (because it is a media transport), and to the media transport it behaves
* as if it is a stream. The SRTP object then forwards RTP packets back and
* forth between stream and the actual transport, encrypting/decrypting
* the RTP/RTCP packets as necessary.
*
* The neat thing about this design is the SRTP "adapter" then can be used
* to encrypt any kind of media transports. We currently have UDP and ICE
* media transports that can benefit SRTP, and we could add SRTP to any
* media transports that will be added in the future.
*/
PJ_BEGIN_DECL
/**
* Crypto option.
*/
typedef enum pjmedia_srtp_crypto_option
{
/** When this flag is specified, encryption will be disabled. */
PJMEDIA_SRTP_NO_ENCRYPTION = 1,
/** When this flag is specified, authentication will be disabled. */
PJMEDIA_SRTP_NO_AUTHENTICATION = 2
} pjmedia_srtp_crypto_option;
/**
* This structure describes an individual crypto setting.
*/
typedef struct pjmedia_srtp_crypto
{
/** Optional key. If empty, a random key will be autogenerated. */
pj_str_t key;
/** Crypto name. */
pj_str_t name;
/** Flags, bitmask from #pjmedia_srtp_crypto_option */
unsigned flags;
} pjmedia_srtp_crypto;
/**
* This enumeration specifies the behavior of the SRTP transport regarding
* media security offer and answer.
*/
typedef enum pjmedia_srtp_use
{
/**
* When this flag is specified, SRTP will be disabled, and the transport
* will reject RTP/SAVP offer.
*/
PJMEDIA_SRTP_DISABLED,
/**
* When this flag is specified, SRTP will be advertised as optional and
* incoming SRTP offer will be accepted.
*/
PJMEDIA_SRTP_OPTIONAL,
/**
* When this flag is specified, the transport will require that RTP/SAVP
* media shall be used.
*/
PJMEDIA_SRTP_MANDATORY
} pjmedia_srtp_use;
/**
* This enumeration specifies SRTP keying methods.
*/
typedef enum pjmedia_srtp_keying_method
{
/**
* Session Description (SDES).
*/
PJMEDIA_SRTP_KEYING_SDES,
/**
* DTLS-SRTP.
*/
PJMEDIA_SRTP_KEYING_DTLS_SRTP,
/**
* Number of keying method.
*/
PJMEDIA_SRTP_KEYINGS_COUNT
} pjmedia_srtp_keying_method;
/**
* Structure containing callbacks to receive SRTP notifications.
*/
typedef struct pjmedia_srtp_cb
{
/**
* This callback will be called when SRTP negotiation completes. This
* callback will be invoked when the negotiation is done outside of
* the SDP signalling, such as in DTLS-SRTP.
*
* @param tp PJMEDIA SRTP transport.
* @param status Operation status.
*/
void (*on_srtp_nego_complete)(pjmedia_transport *tp,
pj_status_t status);
} pjmedia_srtp_cb;
/**
* Settings to be given when creating SRTP transport. Application should call
* #pjmedia_srtp_setting_default() to initialize this structure with its
* default values.
*/
typedef struct pjmedia_srtp_setting
{
/**
* Specify the usage policy. Default is PJMEDIA_SRTP_OPTIONAL.
*/
pjmedia_srtp_use use;
/**
* Specify whether the SRTP transport should close the member transport
* when it is destroyed. Default: PJ_TRUE.
*/
pj_bool_t close_member_tp;
/**
* Specify the number of crypto suite settings.
*/
unsigned crypto_count;
/**
* Specify individual crypto suite setting.
* Notes for DTLS-SRTP keying:
* - Currently only supports these cryptos: AES_CM_128_HMAC_SHA1_80,
* AES_CM_128_HMAC_SHA1_32, AEAD_AES_256_GCM, and AEAD_AES_128_GCM.
* - SRTP key is not configurable.
*/
pjmedia_srtp_crypto crypto[PJMEDIA_SRTP_MAX_CRYPTOS];
/**
* Specify the number of enabled keying methods.
* Default is PJMEDIA_SRTP_MAX_KEYINGS (all enabled).
*/
unsigned keying_count;
/**
* Specify enabled keying methods and its priority order. Keying method
* with higher priority will be given earlier chance to process the SDP,
* for example as currently only one keying is supported in the SDP offer,
* keying with first priority will be likely used in the SDP offer.
*
* Default is that all supported keying methods (i.e: currently SDES and
* DTLS-SRTP) will be enabled and with priority order: SDES, DTLS-SRTP.
*/
pjmedia_srtp_keying_method keying[PJMEDIA_SRTP_KEYINGS_COUNT];
/**
* Specify SRTP callback.
*/
pjmedia_srtp_cb cb;
/**
* Specify SRTP transport user data.
*/
void *user_data;
} pjmedia_srtp_setting;
/**
* This structure specifies SRTP transport specific info. This will fit
* into \a buffer field of pjmedia_transport_specific_info.
*/
typedef struct pjmedia_srtp_info
{
/**
* Specify whether the SRTP transport is active for SRTP session.
*/
pj_bool_t active;
/**
* Specify the policy used by the SRTP session for receive direction.
*/
pjmedia_srtp_crypto rx_policy;
/**
* Specify the policy used by the SRTP session for transmit direction.
*/
pjmedia_srtp_crypto tx_policy;
/**
* Specify the usage policy.
*/
pjmedia_srtp_use use;
/**
* Specify the peer's usage policy.
*/
pjmedia_srtp_use peer_use;
} pjmedia_srtp_info;
/**
* This structure specifies DTLS-SRTP negotiation parameters.
*/
typedef struct pjmedia_srtp_dtls_nego_param
{
/**
* Fingerprint of remote certificate, should be formatted as
* "SHA-256/1 XX:XX:XX...". If this is not set, fingerprint verification
* will not be performed.
*/
pj_str_t rem_fingerprint;
/**
* Remote address and port.
*/
pj_sockaddr rem_addr;
/**
* Remote RTCP address and port.
*/
pj_sockaddr rem_rtcp;
/**
* Set to PJ_TRUE if our role is active. Active role will initiates
* the DTLS negotiation. Passive role will wait for incoming DTLS
* negotiation packet.
*/
pj_bool_t is_role_active;
} pjmedia_srtp_dtls_nego_param;
/**
* Initialize SRTP library. This function should be called before
* any SRTP functions, however calling #pjmedia_transport_srtp_create()
* will also invoke this function. This function will also register SRTP
* library deinitialization to #pj_atexit(), so the deinitialization
* of SRTP library will be performed automatically by PJLIB destructor.
*
* @param endpt The media endpoint instance.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_srtp_init_lib(pjmedia_endpt *endpt);
/**
* Initialize SRTP setting with its default values.
*
* @param opt SRTP setting to be initialized.
*/
PJ_DECL(void) pjmedia_srtp_setting_default(pjmedia_srtp_setting *opt);
/**
* Create an SRTP media transport.
*
* @param endpt The media endpoint instance.
* @param tp The actual media transport to send and receive
* RTP/RTCP packets. This media transport will be
* kept as member transport of this SRTP instance.
* @param opt Optional settings. If NULL is given, default
* settings will be used.
* @param p_tp Pointer to receive the transport SRTP instance.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_transport_srtp_create(
pjmedia_endpt *endpt,
pjmedia_transport *tp,
const pjmedia_srtp_setting *opt,
pjmedia_transport **p_tp);
/**
* Get fingerprint of local DTLS-SRTP certificate.
*
* @param srtp The SRTP transport.
* @param hash Fingerprint hash algorithm, currently valid values are
* "SHA-256" and "SHA-1".
* @param buf Buffer for fingerprint output. The output will be
* formatted as "SHA-256/1 XX:XX:XX..." and null terminated.
* @param len On input, the size of the buffer.
* On output, the length of the fingerprint.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_transport_srtp_dtls_get_fingerprint(
pjmedia_transport *srtp,
const char *hash,
char *buf, pj_size_t *len);
/**
* Manually start DTLS-SRTP negotiation with the given parameters. Application
* only needs to call this function when the SRTP transport is used without
* SDP offer/answer. When SDP offer/answer framework is used, the DTLS-SRTP
* negotiation will be handled by pjmedia_transport_media_create(),
* pjmedia_transport_media_start(), pjmedia_transport_media_encode_sdp(), and
* pjmedia_transport_media_stop().
*
* When the negotiation completes, application will be notified via SRTP
* callback on_srtp_nego_complete(), if set. If the negotiation is successful,
* SRTP will be automatically started.
*
* Note that if the SRTP member transport is an ICE transport, application
* should only call this function after ICE negotiation is completed
* successfully.
*
* @param srtp The SRTP transport.
* @param param DTLS-SRTP nego parameter.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_transport_srtp_dtls_start_nego(
pjmedia_transport *srtp,
const pjmedia_srtp_dtls_nego_param *param);
/**
* Manually start SRTP session with the given parameters. Application only
* needs to call this function when the SRTP transport is used without SDP
* offer/answer. When SDP offer/answer framework is used, the SRTP transport
* will be started/stopped by #pjmedia_transport_media_start() and
* #pjmedia_transport_media_stop() respectively.
*
* Please note that even if an RTP stream is only one direction, application
* will still need to provide both crypto suites, because it is needed by
* RTCP.
* If application specifies the crypto keys, the keys for transmit and receive
* direction MUST be different.
*
* @param srtp The SRTP transport.
* @param tx Crypto suite setting for transmit direction.
* @param rx Crypto suite setting for receive direction.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_transport_srtp_start(
pjmedia_transport *srtp,
const pjmedia_srtp_crypto *tx,
const pjmedia_srtp_crypto *rx);
/**
* Stop SRTP session.
*
* @param srtp The SRTP media transport.
*
* @return PJ_SUCCESS on success.
*
* @see #pjmedia_transport_srtp_start()
*/
PJ_DECL(pj_status_t) pjmedia_transport_srtp_stop(pjmedia_transport *srtp);
/**
* This is a utility function to decrypt SRTP packet using SRTP transport.
* This function is not part of SRTP transport's API, but it can be used
* to decrypt SRTP packets from non-network (for example, from a saved file)
* without having to use the transport framework. See pcaputil.c in the
* samples collection on how to use this function.
*
* @param tp The SRTP transport.
* @param is_rtp Set to non-zero if the packet is SRTP, otherwise set
* to zero if the packet is SRTCP.
* @param pkt On input, it contains SRTP or SRTCP packet. On
* output, it contains the decrypted RTP/RTCP packet.
* @param pkt_len On input, specify the length of the buffer. On
* output, it will be filled with the actual length
* of decrypted packet.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_transport_srtp_decrypt_pkt(pjmedia_transport *tp,
pj_bool_t is_rtp,
void *pkt,
int *pkt_len);
/**
* Query member transport of SRTP.
*
* @param srtp The SRTP media transport.
*
* @return member media transport.
*/
PJ_DECL(pjmedia_transport*) pjmedia_transport_srtp_get_member(
pjmedia_transport *srtp);
PJ_END_DECL
/**
* @}
*/
#endif /* __PJMEDIA_TRANSPORT_SRTP_H__ */
|