mirror of
https://github.com/aykhans/AzSuicideDataVisualization.git
synced 2025-04-22 10:28:02 +00:00
95 lines
4.0 KiB
C++
95 lines
4.0 KiB
C++
// Licensed to the Apache Software Foundation (ASF) under one
|
|
// or more contributor license agreements. See the NOTICE file
|
|
// distributed with this work for additional information
|
|
// regarding copyright ownership. The ASF licenses this file
|
|
// to you 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.
|
|
|
|
#pragma once
|
|
|
|
#include <string>
|
|
|
|
#include "arrow/util/variant.h"
|
|
|
|
#include "parquet/encryption/key_material.h"
|
|
#include "parquet/exception.h"
|
|
#include "parquet/platform.h"
|
|
|
|
namespace parquet {
|
|
namespace encryption {
|
|
|
|
// Parquet encryption specification defines "key metadata" as an arbitrary byte array,
|
|
// generated by file writers for each encryption key, and passed to the low level API for
|
|
// storage in the file footer. The "key metadata" field is made available to file readers
|
|
// to enable recovery of the key. This interface can be utilized for implementation
|
|
// of any key management scheme.
|
|
//
|
|
// The keytools package (PARQUET-1373) implements one approach, of many possible, to key
|
|
// management and to generation of the "key metadata" fields. This approach, based on the
|
|
// "envelope encryption" pattern, allows integration with KMS servers. It keeps the actual
|
|
// material, required to recover a key, in a "key material" object (see the KeyMaterial
|
|
// class for details). This class is implemented to support version 1 of the parquet key
|
|
// management tools specification.
|
|
//
|
|
// KeyMetadata writes (and reads) the "key metadata" field as a flat json object,
|
|
// with the following fields:
|
|
// 1. "keyMaterialType" - a String, with the type of key material.
|
|
// 2. "internalStorage" - a boolean. If true, means that "key material" is kept inside the
|
|
// "key metadata" field. If false, "key material" is kept externally (outside Parquet
|
|
// files) - in this case, "key metadata" keeps a reference to the external "key material".
|
|
// 3. "keyReference" - a String, with the reference to the external "key material".
|
|
// Written only if internalStorage is false.
|
|
//
|
|
// If internalStorage is true, "key material" is a part of "key metadata", and the json
|
|
// keeps additional fields, described in the KeyMaterial class.
|
|
class PARQUET_EXPORT KeyMetadata {
|
|
public:
|
|
static constexpr const char kKeyMaterialInternalStorageField[] = "internalStorage";
|
|
static constexpr const char kKeyReferenceField[] = "keyReference";
|
|
|
|
/// key_metadata_bytes is the key metadata field stored in the parquet file,
|
|
/// in the serialized json object format.
|
|
static KeyMetadata Parse(const std::string& key_metadata_bytes);
|
|
|
|
static std::string CreateSerializedForExternalMaterial(
|
|
const std::string& key_reference);
|
|
|
|
bool key_material_stored_internally() const { return is_internal_storage_; }
|
|
|
|
const KeyMaterial& key_material() const {
|
|
if (!is_internal_storage_) {
|
|
throw ParquetException("key material is stored externally.");
|
|
}
|
|
return ::arrow::util::get<KeyMaterial>(key_material_or_reference_);
|
|
}
|
|
|
|
const std::string& key_reference() const {
|
|
if (is_internal_storage_) {
|
|
throw ParquetException("key material is stored internally.");
|
|
}
|
|
return ::arrow::util::get<std::string>(key_material_or_reference_);
|
|
}
|
|
|
|
private:
|
|
explicit KeyMetadata(const KeyMaterial& key_material);
|
|
explicit KeyMetadata(const std::string& key_reference);
|
|
|
|
bool is_internal_storage_;
|
|
/// If is_internal_storage_ is true, KeyMaterial is set,
|
|
/// else a string referencing to an outside "key material" is set.
|
|
::arrow::util::Variant<KeyMaterial, std::string> key_material_or_reference_;
|
|
};
|
|
|
|
} // namespace encryption
|
|
} // namespace parquet
|