d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
133 lines
5.9 KiB
C++
133 lines
5.9 KiB
C++
/**************************************************************************/
|
|
/* crypto.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef CRYPTO_H
|
|
#define CRYPTO_H
|
|
|
|
#include "core/crypto/hashing_context.h"
|
|
#include "core/io/resource.h"
|
|
#include "core/io/resource_loader.h"
|
|
#include "core/io/resource_saver.h"
|
|
#include "core/object/ref_counted.h"
|
|
|
|
class CryptoKey : public Resource {
|
|
GDCLASS(CryptoKey, Resource);
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
static CryptoKey *(*_create)();
|
|
|
|
public:
|
|
static CryptoKey *create();
|
|
virtual Error load(String p_path, bool p_public_only = false) = 0;
|
|
virtual Error save(String p_path, bool p_public_only = false) = 0;
|
|
virtual String save_to_string(bool p_public_only = false) = 0;
|
|
virtual Error load_from_string(String p_string_key, bool p_public_only = false) = 0;
|
|
virtual bool is_public_only() const = 0;
|
|
};
|
|
|
|
class X509Certificate : public Resource {
|
|
GDCLASS(X509Certificate, Resource);
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
static X509Certificate *(*_create)();
|
|
|
|
public:
|
|
static X509Certificate *create();
|
|
virtual Error load(String p_path) = 0;
|
|
virtual Error load_from_memory(const uint8_t *p_buffer, int p_len) = 0;
|
|
virtual Error save(String p_path) = 0;
|
|
};
|
|
|
|
class HMACContext : public RefCounted {
|
|
GDCLASS(HMACContext, RefCounted);
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
static HMACContext *(*_create)();
|
|
|
|
public:
|
|
static HMACContext *create();
|
|
|
|
virtual Error start(HashingContext::HashType p_hash_type, PackedByteArray p_key) = 0;
|
|
virtual Error update(PackedByteArray p_data) = 0;
|
|
virtual PackedByteArray finish() = 0;
|
|
|
|
HMACContext() {}
|
|
virtual ~HMACContext() {}
|
|
};
|
|
|
|
class Crypto : public RefCounted {
|
|
GDCLASS(Crypto, RefCounted);
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
static Crypto *(*_create)();
|
|
static void (*_load_default_certificates)(String p_path);
|
|
|
|
public:
|
|
static Crypto *create();
|
|
static void load_default_certificates(String p_path);
|
|
|
|
virtual PackedByteArray generate_random_bytes(int p_bytes) = 0;
|
|
virtual Ref<CryptoKey> generate_rsa(int p_bytes) = 0;
|
|
virtual Ref<X509Certificate> generate_self_signed_certificate(Ref<CryptoKey> p_key, String p_issuer_name, String p_not_before, String p_not_after) = 0;
|
|
|
|
virtual Vector<uint8_t> sign(HashingContext::HashType p_hash_type, Vector<uint8_t> p_hash, Ref<CryptoKey> p_key) = 0;
|
|
virtual bool verify(HashingContext::HashType p_hash_type, Vector<uint8_t> p_hash, Vector<uint8_t> p_signature, Ref<CryptoKey> p_key) = 0;
|
|
virtual Vector<uint8_t> encrypt(Ref<CryptoKey> p_key, Vector<uint8_t> p_plaintext) = 0;
|
|
virtual Vector<uint8_t> decrypt(Ref<CryptoKey> p_key, Vector<uint8_t> p_ciphertext) = 0;
|
|
|
|
PackedByteArray hmac_digest(HashingContext::HashType p_hash_type, PackedByteArray p_key, PackedByteArray p_msg);
|
|
|
|
// Compares two PackedByteArrays for equality without leaking timing information in order to prevent timing attacks.
|
|
// @see: https://paragonie.com/blog/2015/11/preventing-timing-attacks-on-string-comparison-with-double-hmac-strategy
|
|
bool constant_time_compare(PackedByteArray p_trusted, PackedByteArray p_received);
|
|
|
|
Crypto() {}
|
|
};
|
|
|
|
class ResourceFormatLoaderCrypto : public ResourceFormatLoader {
|
|
public:
|
|
virtual Ref<Resource> load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr, CacheMode p_cache_mode = CACHE_MODE_REUSE);
|
|
virtual void get_recognized_extensions(List<String> *p_extensions) const;
|
|
virtual bool handles_type(const String &p_type) const;
|
|
virtual String get_resource_type(const String &p_path) const;
|
|
};
|
|
|
|
class ResourceFormatSaverCrypto : public ResourceFormatSaver {
|
|
public:
|
|
virtual Error save(const Ref<Resource> &p_resource, const String &p_path, uint32_t p_flags = 0);
|
|
virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const;
|
|
virtual bool recognize(const Ref<Resource> &p_resource) const;
|
|
};
|
|
|
|
#endif // CRYPTO_H
|