67 lines
2.3 KiB
C++
67 lines
2.3 KiB
C++
/*
|
|
* EncryptUtils.h
|
|
*
|
|
* This source file is part of the FoundationDB open source project
|
|
*
|
|
* Copyright 2013-2022 Apple Inc. and the FoundationDB project authors
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef ENCRYPT_UTILS_H
|
|
#define ENCRYPT_UTILS_H
|
|
#pragma once
|
|
|
|
#include <cstdint>
|
|
#include <limits>
|
|
|
|
#define ENCRYPT_INVALID_DOMAIN_ID 0
|
|
#define ENCRYPT_INVALID_CIPHER_KEY_ID 0
|
|
|
|
#define AUTH_TOKEN_SIZE 16
|
|
|
|
#define SYSTEM_KEYSPACE_ENCRYPT_DOMAIN_ID -1
|
|
#define ENCRYPT_HEADER_DOMAIN_ID -2
|
|
|
|
using EncryptCipherDomainId = int64_t;
|
|
using EncryptCipherBaseKeyId = uint64_t;
|
|
using EncryptCipherRandomSalt = uint64_t;
|
|
|
|
typedef enum {
|
|
ENCRYPT_CIPHER_MODE_NONE = 0,
|
|
ENCRYPT_CIPHER_MODE_AES_256_CTR = 1,
|
|
ENCRYPT_CIPHER_MODE_LAST = 2
|
|
} EncryptCipherMode;
|
|
|
|
static_assert(EncryptCipherMode::ENCRYPT_CIPHER_MODE_LAST <= std::numeric_limits<uint8_t>::max(),
|
|
"EncryptCipherMode value overflow");
|
|
|
|
// EncryptionHeader authentication modes
|
|
// 1. NONE - No 'authentication token' generation needed for EncryptionHeader i.e. no protection against header OR
|
|
// cipherText 'tampering' and/or bit rot/flip corruptions.
|
|
// 2. Single/Multi - Encyrption header would generate one or more 'authentication tokens' to protect the header against
|
|
// 'tempering' and/or bit rot/flip corruptions. Refer to BlobCipher.h for detailed usage recommendations.
|
|
// 3. LAST - Invalid mode, used for static asserts.
|
|
|
|
typedef enum {
|
|
ENCRYPT_HEADER_AUTH_TOKEN_MODE_NONE = 0,
|
|
ENCRYPT_HEADER_AUTH_TOKEN_MODE_SINGLE = 1,
|
|
ENCRYPT_HEADER_AUTH_TOKEN_MODE_MULTI = 2,
|
|
ENCRYPT_HEADER_AUTH_TOKEN_LAST = 3 // Always the last element
|
|
} EncryptAuthTokenMode;
|
|
|
|
static_assert(EncryptAuthTokenMode::ENCRYPT_HEADER_AUTH_TOKEN_LAST <= std::numeric_limits<uint8_t>::max(),
|
|
"EncryptHeaderAuthToken value overflow");
|
|
|
|
#endif
|