1/**************************************************************************/
2/* file_access_encrypted.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef FILE_ACCESS_ENCRYPTED_H
32#define FILE_ACCESS_ENCRYPTED_H
33
34#include "core/io/file_access.h"
35
36#define ENCRYPTED_HEADER_MAGIC 0x43454447
37
38class FileAccessEncrypted : public FileAccess {
39public:
40 enum Mode {
41 MODE_READ,
42 MODE_WRITE_AES256,
43 MODE_MAX
44 };
45
46private:
47 Vector<uint8_t> key;
48 bool writing = false;
49 Ref<FileAccess> file;
50 uint64_t base = 0;
51 uint64_t length = 0;
52 Vector<uint8_t> data;
53 mutable uint64_t pos = 0;
54 mutable bool eofed = false;
55 bool use_magic = true;
56
57 void _close();
58
59public:
60 Error open_and_parse(Ref<FileAccess> p_base, const Vector<uint8_t> &p_key, Mode p_mode, bool p_with_magic = true);
61 Error open_and_parse_password(Ref<FileAccess> p_base, const String &p_key, Mode p_mode);
62
63 virtual Error open_internal(const String &p_path, int p_mode_flags) override; ///< open a file
64 virtual bool is_open() const override; ///< true when file is open
65
66 virtual String get_path() const override; /// returns the path for the current open file
67 virtual String get_path_absolute() const override; /// returns the absolute path for the current open file
68
69 virtual void seek(uint64_t p_position) override; ///< seek to a given position
70 virtual void seek_end(int64_t p_position = 0) override; ///< seek from the end of file
71 virtual uint64_t get_position() const override; ///< get position in the file
72 virtual uint64_t get_length() const override; ///< get size of the file
73
74 virtual bool eof_reached() const override; ///< reading passed EOF
75
76 virtual uint8_t get_8() const override; ///< get a byte
77 virtual uint64_t get_buffer(uint8_t *p_dst, uint64_t p_length) const override;
78
79 virtual Error get_error() const override; ///< get last error
80
81 virtual void flush() override;
82 virtual void store_8(uint8_t p_dest) override; ///< store a byte
83 virtual void store_buffer(const uint8_t *p_src, uint64_t p_length) override; ///< store an array of bytes
84
85 virtual bool file_exists(const String &p_name) override; ///< return true if a file exists
86
87 virtual uint64_t _get_modified_time(const String &p_file) override;
88 virtual BitField<FileAccess::UnixPermissionFlags> _get_unix_permissions(const String &p_file) override;
89 virtual Error _set_unix_permissions(const String &p_file, BitField<FileAccess::UnixPermissionFlags> p_permissions) override;
90
91 virtual bool _get_hidden_attribute(const String &p_file) override;
92 virtual Error _set_hidden_attribute(const String &p_file, bool p_hidden) override;
93 virtual bool _get_read_only_attribute(const String &p_file) override;
94 virtual Error _set_read_only_attribute(const String &p_file, bool p_ro) override;
95
96 virtual void close() override;
97
98 FileAccessEncrypted() {}
99 ~FileAccessEncrypted();
100};
101
102#endif // FILE_ACCESS_ENCRYPTED_H
103