keyring_trace.h

Go to the documentation of this file.

/*
 * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use
 * this file except in compliance with the License. A copy of the License is
 * located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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 AWS_CRYPTOSDK_KEYRING_TRACE_H
#define AWS_CRYPTOSDK_KEYRING_TRACE_H
 
#include <aws/common/array_list.h>
#include <aws/common/string.h>
#include <aws/cryptosdk/exports.h>

struct aws_cryptosdk_keyring_trace_record {
    struct aws_string *wrapping_key_namespace;
    struct aws_string *wrapping_key_name;
    uint32_t flags;
};

#define AWS_CRYPTOSDK_WRAPPING_KEY_GENERATED_DATA_KEY 1

#define AWS_CRYPTOSDK_WRAPPING_KEY_ENCRYPTED_DATA_KEY (1 << 1)

#define AWS_CRYPTOSDK_WRAPPING_KEY_DECRYPTED_DATA_KEY (1 << 2)

#define AWS_CRYPTOSDK_WRAPPING_KEY_SIGNED_ENC_CTX (1 << 3)

#define AWS_CRYPTOSDK_WRAPPING_KEY_VERIFIED_ENC_CTX (1 << 4)
 
#ifdef __cplusplus
extern "C" {
#endif

AWS_CRYPTOSDK_API
bool aws_cryptosdk_keyring_trace_record_is_valid(struct aws_cryptosdk_keyring_trace_record *record);

AWS_CRYPTOSDK_API
bool aws_cryptosdk_keyring_trace_is_valid(const struct aws_array_list *trace);

AWS_CRYPTOSDK_API
int aws_cryptosdk_keyring_trace_add_record(
    struct aws_allocator *alloc,
    struct aws_array_list *trace,
    const struct aws_string *wrapping_key_namespace,
    const struct aws_string *wrapping_key_name,
    uint32_t flags);

AWS_CRYPTOSDK_API
int aws_cryptosdk_keyring_trace_add_record_c_str(
    struct aws_allocator *alloc,
    struct aws_array_list *trace,
    const char *wrapping_key_namespace,
    const char *wrapping_key_name,
    uint32_t flags);

AWS_CRYPTOSDK_API
int aws_cryptosdk_keyring_trace_add_record_buf(
    struct aws_allocator *alloc,
    struct aws_array_list *trace,
    const struct aws_byte_buf *wrapping_key_namespace,
    const struct aws_byte_buf *wrapping_key_name,
    uint32_t flags);

AWS_CRYPTOSDK_API
int aws_cryptosdk_keyring_trace_init(struct aws_allocator *alloc, struct aws_array_list *trace);

AWS_CRYPTOSDK_API
void aws_cryptosdk_keyring_trace_clean_up(struct aws_array_list *trace);

AWS_CRYPTOSDK_API
void aws_cryptosdk_keyring_trace_clear(struct aws_array_list *trace);
 
#ifdef __cplusplus
}
#endif
 
#endif  // AWS_CRYPTOSDK_KEYRING_TRACE_H