edk.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_EDK_H
#define AWS_CRYPTOSDK_EDK_H
 
#include <aws/common/array_list.h>
#include <aws/common/byte_buf.h>
 
#include <aws/cryptosdk/exports.h>
 
/*
 * This public interface to the encrypted data key (EDK) objects is provided for
 * developers of CMMs and keyrings only. If you are a user of the AWS Encryption
 * SDK for C and you are not developing your own CMMs and/or keyrings, you do not
 * need to use it and you should not do so.
 */


struct aws_cryptosdk_edk {
    struct aws_byte_buf provider_id;
    struct aws_byte_buf provider_info;
    struct aws_byte_buf ciphertext;
};
 
#ifdef __cplusplus
extern "C" {
#endif

AWS_CRYPTOSDK_API
bool aws_cryptosdk_edk_is_valid(const struct aws_cryptosdk_edk *const edk);

AWS_CRYPTOSDK_API
bool aws_cryptosdk_edk_list_is_valid(const struct aws_array_list *edk_list);

AWS_CRYPTOSDK_API
bool aws_cryptosdk_empty_edk_list_is_valid(const struct aws_array_list *edk_list);

bool aws_cryptosdk_edk_list_elements_are_valid(const struct aws_array_list *edk_list);

AWS_CRYPTOSDK_API
void aws_cryptosdk_edk_clean_up(struct aws_cryptosdk_edk *edk);

AWS_CRYPTOSDK_API
int aws_cryptosdk_edk_list_init(struct aws_allocator *alloc, struct aws_array_list *edk_list);

AWS_CRYPTOSDK_API
void aws_cryptosdk_edk_list_clean_up(struct aws_array_list *edk_list);

AWS_CRYPTOSDK_API
void aws_cryptosdk_edk_list_clear(struct aws_array_list *edk_list);

AWS_CRYPTOSDK_API
int aws_cryptosdk_edk_init_clone(
    struct aws_allocator *alloc, struct aws_cryptosdk_edk *dest, const struct aws_cryptosdk_edk *src);

AWS_CRYPTOSDK_STATIC_INLINE bool aws_cryptosdk_edk_eq(
    const struct aws_cryptosdk_edk *a, const struct aws_cryptosdk_edk *b) {
    return aws_byte_buf_eq(&a->ciphertext, &b->ciphertext) && aws_byte_buf_eq(&a->provider_info, &b->provider_info) &&
           aws_byte_buf_eq(&a->provider_id, &b->provider_id);
}
 
#ifdef __cplusplus
}
#endif
  // doxygen group cmm_kr_lowlevel
 
#endif  // AWS_CRYPTOSDK_EDK_H