seal.h

Go to the documentation of this file.

// Copyright (c) Open Enclave SDK contributors.
// Licensed under the MIT License.
 
#ifndef _OE_SEAL_H
#define _OE_SEAL_H
 
#include <openenclave/bits/evidence.h>
#include <openenclave/bits/result.h>
#include <openenclave/bits/types.h>
 
OE_EXTERNC_BEGIN
 
typedef struct _oe_seal_setting
{
    int type;      
    uint32_t size; 
    union
    {
        uint64_t q; 
        uint32_t d; 
        uint16_t w; 
        uint8_t b;  
        const void*
            p; 
    } value;
} oe_seal_setting_t;
 
/*
 * TEE agnostic seal settings supported by OE SDK
 */
enum oe_seal_setting_type_t
{
    OE_SEAL_SETTING_POLICY,
 
    OE_SEAL_SETTING_ADDITIONAL_CONTEXT,
 
    OE_SEAL_SETTING_IV,
 
    OE_SEAL_SETTING_MAX = 0x10000,
 
    OE_SEAL_SETTING_PLUGIN_DEFINED = OE_SEAL_SETTING_MAX / 2
};
 
#define __OE_SEAL_SET_POINTER(t, p, s) \
    {                                  \
        (t), s,                        \
        {                              \
            (uint64_t)(p)              \
        }                              \
    }
#define __OE_SEAL_SET_VALUE(t, v) __OE_SEAL_SET_POINTER(t, v, 0)
 
#define OE_SEAL_SET_POLICY(w) __OE_SEAL_SET_VALUE(OE_SEAL_SETTING_POLICY, w)
 
#define OE_SEAL_SET_CONTEXT(p, s) \
    __OE_SEAL_SET_POINTER(OE_SEAL_SETTING_ADDITIONAL_CONTEXT, p, s)
 
#define OE_SEAL_SET_IV(p, s) __OE_SEAL_SET_POINTER(OE_SEAL_SETTING_IV, p, s)
 
oe_result_t oe_seal(
    const oe_uuid_t* plugin_id,
    const oe_seal_setting_t* settings,
    size_t settings_count,
    const uint8_t* plaintext,
    size_t plaintext_size,
    const uint8_t* additional_data,
    size_t additional_data_size,
    uint8_t** blob,
    size_t* blob_size);
 
oe_result_t oe_unseal(
    const uint8_t* blob,
    size_t blob_size,
    const uint8_t* additional_data,
    size_t additional_data_size,
    uint8_t** plaintext,
    size_t* plaintext_size);
 
typedef struct _oe_seal_plugin_definition
{
    const oe_uuid_t id;
 
    oe_result_t (*seal)(
        const oe_seal_setting_t* settings,
        size_t settings_count,
        const uint8_t* plaintext,
        size_t plaintext_size,
        const uint8_t* additional_data,
        size_t additional_data_size,
        uint8_t** blob,
        size_t* blob_size);
 
    oe_result_t (*unseal)(
        const uint8_t* blob,
        size_t blob_size,
        const uint8_t* additional_data,
        size_t additional_data_size,
        uint8_t** plaintext,
        size_t* plaintext_size);
} oe_seal_plugin_definition_t;
 
oe_result_t oe_register_seal_plugin(
    const oe_seal_plugin_definition_t* plugin,
    bool make_default);
 
oe_result_t oe_unregister_seal_plugin(const oe_uuid_t* plugin_id);
 
OE_EXTERNC_END
 
#endif /* _OE_SEAL_H */