blob: 1c49b511f7b942f18dc6ca8be42278efc08d6e1f [file] [log] [blame]
Benjamin Wrightea086912018-08-29 13:06:15 -07001/*
2 * Copyright 2018 The WebRTC project authors. All Rights Reserved.
3 *
4 * 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.
9 */
10
11#ifndef API_CRYPTO_FRAMEDECRYPTORINTERFACE_H_
12#define API_CRYPTO_FRAMEDECRYPTORINTERFACE_H_
13
14#include "api/array_view.h"
15#include "api/mediatypes.h"
16#include "rtc_base/refcount.h"
17
18namespace webrtc {
19
20// FrameDecryptorInterface allows users to provide a custom decryption
21// implementation for all incoming audio and video frames. The user must also
22// provide a FrameEncryptorInterface to be able to encrypt the frames being
23// sent out of the device. Note this is an additional layer of encyrption in
24// addition to the standard SRTP mechanism and is not intended to be used
25// without it. You may assume that this interface will have the same lifetime
26// as the RTPReceiver it is attached to. It must only be attached to one
27// RTPReceiver.
Benjamin Wright88e3e3f2018-09-06 13:20:14 -070028// Note: This interface is not ready for production use.
Benjamin Wrightea086912018-08-29 13:06:15 -070029class FrameDecryptorInterface : public rtc::RefCountInterface {
30 public:
Benjamin Wrightd81ac952018-08-29 17:02:10 -070031 ~FrameDecryptorInterface() override {}
Benjamin Wrightea086912018-08-29 13:06:15 -070032
33 // Attempts to decrypt the encrypted frame. You may assume the frame size will
34 // be allocated to the size returned from GetOutputSize. You may assume that
35 // the frames are in order if SRTP is enabled. The stream is not provided here
36 // and it is up to the implementor to transport this information to the
Benjamin Wright88e3e3f2018-09-06 13:20:14 -070037 // receiver if they care about it. You must set bytes_written to how many
38 // bytes you wrote to in the frame buffer. 0 must be returned if successful
39 // all other numbers can be selected by the implementer to represent error
40 // codes.
41 virtual int Decrypt(cricket::MediaType media_type,
42 rtc::ArrayView<const uint8_t> encrypted_frame,
43 rtc::ArrayView<uint8_t> frame,
44 size_t* bytes_written) = 0;
Benjamin Wrightea086912018-08-29 13:06:15 -070045
46 // Returns the total required length in bytes for the output of the
Benjamin Wright88e3e3f2018-09-06 13:20:14 -070047 // decryption. This can be larger than the actual number of bytes you need but
48 // must never be smaller as it informs the size of the frame buffer.
49 virtual size_t GetMaxPlaintextByteSize(cricket::MediaType media_type,
50 size_t encrypted_frame_size) = 0;
Benjamin Wrightea086912018-08-29 13:06:15 -070051};
52
53} // namespace webrtc
54
55#endif // API_CRYPTO_FRAMEDECRYPTORINTERFACE_H_