blob: 3319beaed4d1a2511583558c6789ac2875829f0c [file] [log] [blame]
henrike@webrtc.orga7b98182014-02-21 15:51:43 +00001/*
kjellander65c7f672016-02-12 00:05:01 -08002 * Copyright 2014 The WebRTC project authors. All Rights Reserved.
henrike@webrtc.orga7b98182014-02-21 15:51:43 +00003 *
kjellander65c7f672016-02-12 00:05:01 -08004 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
henrike@webrtc.orga7b98182014-02-21 15:51:43 +00009 */
10
Steve Anton10542f22019-01-11 09:11:00 -080011#ifndef PC_EXTERNAL_HMAC_H_
12#define PC_EXTERNAL_HMAC_H_
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000013
14// External libsrtp HMAC auth module which implements methods defined in
15// auth_type_t.
16// The default auth module will be replaced only when the ENABLE_EXTERNAL_AUTH
17// flag is enabled. This allows us to access to authentication keys,
18// as the default auth implementation doesn't provide access and avoids
19// hashing each packet twice.
20
21// How will libsrtp select this module?
22// Libsrtp defines authentication function types identified by an unsigned
mattdr8cab52d2016-10-10 15:33:37 -070023// integer, e.g. SRTP_HMAC_SHA1 is 3. Using authentication ids, the
24// application can plug any desired authentication modules into libsrtp.
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000025// libsrtp also provides a mechanism to select different auth functions for
26// individual streams. This can be done by setting the right value in
27// the auth_type of srtp_policy_t. The application must first register auth
28// functions and the corresponding authentication id using
29// crypto_kernel_replace_auth_type function.
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000030
pbosc7c26a02017-01-02 08:42:32 -080031#include <stdint.h>
32
mattdr51f29192016-09-28 14:08:46 -070033#include "third_party/libsrtp/crypto/include/auth.h"
Yves Gerey3e707812018-11-28 16:47:49 +010034#include "third_party/libsrtp/crypto/include/crypto_types.h"
35#include "third_party/libsrtp/include/srtp.h"
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000036
mattdr8cab52d2016-10-10 15:33:37 -070037#define EXTERNAL_HMAC_SHA1 SRTP_HMAC_SHA1 + 1
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000038#define HMAC_KEY_LENGTH 20
39
40// The HMAC context structure used to store authentication keys.
41// The pointer to the key will be allocated in the external_hmac_init function.
42// This pointer is owned by srtp_t in a template context.
43typedef struct {
Peter Boström0c4e06b2015-10-07 12:23:21 +020044 uint8_t key[HMAC_KEY_LENGTH];
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000045 int key_length;
pbos@webrtc.orga9cf0792014-12-18 09:12:21 +000046} ExternalHmacContext;
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000047
mattdr8cab52d2016-10-10 15:33:37 -070048srtp_err_status_t external_hmac_alloc(srtp_auth_t** a,
49 int key_len,
50 int out_len);
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000051
mattdr8cab52d2016-10-10 15:33:37 -070052srtp_err_status_t external_hmac_dealloc(srtp_auth_t* a);
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000053
Vlad Tsyrkleviche8e8ad82017-12-06 18:38:22 -080054srtp_err_status_t external_hmac_init(void* state,
mattdr8cab52d2016-10-10 15:33:37 -070055 const uint8_t* key,
56 int key_len);
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000057
Vlad Tsyrkleviche8e8ad82017-12-06 18:38:22 -080058srtp_err_status_t external_hmac_start(void* state);
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000059
Vlad Tsyrkleviche8e8ad82017-12-06 18:38:22 -080060srtp_err_status_t external_hmac_update(void* state,
mattdr8cab52d2016-10-10 15:33:37 -070061 const uint8_t* message,
62 int msg_octets);
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000063
Vlad Tsyrkleviche8e8ad82017-12-06 18:38:22 -080064srtp_err_status_t external_hmac_compute(void* state,
65 const uint8_t* message,
mattdr8cab52d2016-10-10 15:33:37 -070066 int msg_octets,
67 int tag_len,
68 uint8_t* result);
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000069
mattdr8cab52d2016-10-10 15:33:37 -070070srtp_err_status_t external_crypto_init();
henrike@webrtc.orga7b98182014-02-21 15:51:43 +000071
Steve Anton10542f22019-01-11 09:11:00 -080072#endif // PC_EXTERNAL_HMAC_H_