xref: /aosp_15_r20/external/webrtc/api/test/fake_frame_decryptor.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1 /*
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_TEST_FAKE_FRAME_DECRYPTOR_H_
12 #define API_TEST_FAKE_FRAME_DECRYPTOR_H_
13 
14 #include <stddef.h>
15 #include <stdint.h>
16 
17 #include <vector>
18 
19 #include "api/array_view.h"
20 #include "api/crypto/frame_decryptor_interface.h"
21 #include "api/media_types.h"
22 
23 namespace webrtc {
24 
25 // The FakeFrameDecryptor is a TEST ONLY fake implementation of the
26 // FrameDecryptorInterface. It is constructed with a simple single digit key and
27 // a fixed postfix byte. This is just to validate that the core code works
28 // as expected.
29 class FakeFrameDecryptor : public FrameDecryptorInterface {
30  public:
31   // Provide a key (0,255) and some postfix byte (0,255) this should match the
32   // byte you expect from the FakeFrameEncryptor.
33   explicit FakeFrameDecryptor(uint8_t fake_key = 0xAA,
34                               uint8_t expected_postfix_byte = 255);
35   // Fake decryption that just xors the payload with the 1 byte key and checks
36   // the postfix byte. This will always fail if fail_decryption_ is set to true.
37   Result Decrypt(cricket::MediaType media_type,
38                  const std::vector<uint32_t>& csrcs,
39                  rtc::ArrayView<const uint8_t> additional_data,
40                  rtc::ArrayView<const uint8_t> encrypted_frame,
41                  rtc::ArrayView<uint8_t> frame) override;
42   // Always returns 1 less than the size of the encrypted frame.
43   size_t GetMaxPlaintextByteSize(cricket::MediaType media_type,
44                                  size_t encrypted_frame_size) override;
45   // Sets the fake key to use for encryption.
46   void SetFakeKey(uint8_t fake_key);
47   // Returns the fake key used for encryption.
48   uint8_t GetFakeKey() const;
49   // Set the Postfix byte that is expected in the encrypted payload.
50   void SetExpectedPostfixByte(uint8_t expected_postfix_byte);
51   // Returns the postfix byte that will be checked for in the encrypted payload.
52   uint8_t GetExpectedPostfixByte() const;
53   // If set to true will force all encryption to fail.
54   void SetFailDecryption(bool fail_decryption);
55   // Simple error codes for tests to validate against.
56   enum class FakeDecryptStatus : int {
57     OK = 0,
58     FORCED_FAILURE = 1,
59     INVALID_POSTFIX = 2
60   };
61 
62  private:
63   uint8_t fake_key_ = 0;
64   uint8_t expected_postfix_byte_ = 0;
65   bool fail_decryption_ = false;
66 };
67 
68 }  // namespace webrtc
69 
70 #endif  // API_TEST_FAKE_FRAME_DECRYPTOR_H_
71