Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 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 | |
Yves Gerey | 3e70781 | 2018-11-28 15:47:49 | [diff] [blame] | 14 | #include <stddef.h> |
| 15 | #include <stdint.h> |
Jonas Olsson | a4d8737 | 2019-07-05 17:08:33 | [diff] [blame] | 16 | |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 17 | #include <vector> |
| 18 | |
Yves Gerey | 3e70781 | 2018-11-28 15:47:49 | [diff] [blame] | 19 | #include "api/array_view.h" |
Steve Anton | 10542f2 | 2019-01-11 17:11:00 | [diff] [blame] | 20 | #include "api/crypto/frame_decryptor_interface.h" |
| 21 | #include "api/media_types.h" |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 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. |
Tomas Gunnarsson | b3517fe | 2022-03-18 18:32:38 | [diff] [blame] | 29 | class FakeFrameDecryptor : public FrameDecryptorInterface { |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 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. |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 33 | explicit FakeFrameDecryptor(uint8_t fake_key = 0xAA, |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 34 | uint8_t expected_postfix_byte = 255); |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 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. |
Benjamin Wright | 2af5dcb | 2019-04-09 20:08:41 | [diff] [blame] | 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; |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 42 | // Always returns 1 less than the size of the encrypted frame. |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 43 | size_t GetMaxPlaintextByteSize(cricket::MediaType media_type, |
| 44 | size_t encrypted_frame_size) override; |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 45 | // Sets the fake key to use for encryption. |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 46 | void SetFakeKey(uint8_t fake_key); |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 47 | // Returns the fake key used for encryption. |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 48 | uint8_t GetFakeKey() const; |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 49 | // Set the Postfix byte that is expected in the encrypted payload. |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 50 | void SetExpectedPostfixByte(uint8_t expected_postfix_byte); |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 51 | // Returns the postfix byte that will be checked for in the encrypted payload. |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 52 | uint8_t GetExpectedPostfixByte() const; |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 53 | // If set to true will force all encryption to fail. |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 54 | void SetFailDecryption(bool fail_decryption); |
Benjamin Wright | 150a907 | 2018-10-26 22:43:06 | [diff] [blame] | 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 | }; |
Benjamin Wright | 84583f6 | 2018-10-04 21:22:34 | [diff] [blame] | 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_ |