Open Enclave  0.13.0
host.h
Go to the documentation of this file.
1 // Copyright (c) Open Enclave SDK contributors.
2 // Licensed under the MIT License.
3 
10 #ifndef _OE_HOST_H
11 #define _OE_HOST_H
12 
13 #ifdef _OE_ENCLAVE_H
14 #error "enclave.h and host.h must not be included in the same compilation unit."
15 #endif
16 
17 #include <openenclave/bits/asym_keys.h>
18 #include <stdarg.h>
19 #include <stddef.h>
20 #include <stdint.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include "bits/defs.h"
25 #include "bits/eeid.h"
26 #include "bits/evidence.h"
27 #include "bits/result.h"
28 #include "bits/types.h"
29 #include "host_verify.h"
30 
31 OE_EXTERNC_BEGIN
32 
33 #ifndef _WIN32
34 #define _getpid getpid
35 #define sscanf_s sscanf
36 #define sprintf_s(buffer, size, format, argument) \
37  sprintf(buffer, format, argument)
38 #define strcat_s(destination, destination_size, source) \
39  strcat(destination, source)
40 #define strcpy_s(destination, destination_size, source) \
41  ; \
42  { \
43  (void)(destination_size); \
44  strcpy(destination, source); \
45  }
46 #define _strdup strdup
47 #define strncat_s(destination, destination_size, source, source_size) \
48  strncat(destination, source, source_size)
49 #define fopen_s(pfp, name, mode) *(pfp) = fopen((name), (mode))
50 #endif
51 
62 #define OE_ENCLAVE_FLAG_DEBUG 0x00000001u
63 
67 #define OE_ENCLAVE_FLAG_SIMULATE 0x00000002u
68 
77 #define OE_ENCLAVE_FLAG_SGX_KSS 0x00000004u
78 
79 #define OE_ENCLAVE_FLAG_RESERVED \
80  (~(OE_ENCLAVE_FLAG_DEBUG | OE_ENCLAVE_FLAG_SIMULATE))
81 
89 typedef void (*oe_ocall_func_t)(
90  const uint8_t* input_buffer,
91  size_t input_buffer_size,
92  uint8_t* output_buffer,
93  size_t output_buffer_size,
94  size_t* output_bytes_written);
95 
100 {
101  OE_ENCLAVE_SETTING_CONTEXT_SWITCHLESS = 0xdc73a628,
102 #ifdef OE_WITH_EXPERIMENTAL_EEID
103  OE_EXTENDED_ENCLAVE_INITIALIZATION_DATA = 0x976a8f66,
104 #endif
106 
111 {
124 
129 typedef struct _oe_enclave_setting
130 {
139  union {
141  context_switchless_setting;
142 #ifdef OE_WITH_EXPERIMENTAL_EEID
143  oe_eeid_t* eeid;
144 #endif
145  /* Add new setting types here. */
146  } u;
148 
152 typedef struct _oe_ecall_info_t
153 {
154  const char* name;
156 
196  const char* path,
197  oe_enclave_type_t type,
198  uint32_t flags,
199  const oe_enclave_setting_t* settings,
200  uint32_t setting_count,
201  const oe_ocall_func_t* ocall_table,
202  uint32_t ocall_count,
203  const oe_ecall_info_t* ecall_name_table,
204  uint32_t ecall_count,
205  oe_enclave_t** enclave);
206 
220 
221 #if (OE_API_VERSION < 2)
222 #error "Only OE_API_VERSION of 2 is supported"
223 #else
224 #define oe_get_report oe_get_report_v2
225 #endif
226 
249  oe_enclave_t* enclave,
250  uint32_t flags,
251  const void* opt_params,
252  size_t opt_params_size,
253  uint8_t** report_buffer,
254  size_t* report_buffer_size);
255 
261 void oe_free_report(uint8_t* report_buffer);
262 
263 #if (OE_API_VERSION < 2)
264 #error "Only OE_API_VERSION of 2 is supported"
265 #else
266 #define oe_get_target_info oe_get_target_info_v2
267 #endif
268 
290  const uint8_t* report,
291  size_t report_size,
292  void** target_info_buffer,
293  size_t* target_info_size);
294 
300 void oe_free_target_info(void* target_info_buffer);
301 
317  const uint8_t* report,
318  size_t report_size,
319  oe_report_t* parsed_report);
320 
341  oe_enclave_t* enclave,
342  const uint8_t* report,
343  size_t report_size,
344  oe_report_t* parsed_report);
345 
368  oe_enclave_t* enclave,
369  oe_seal_policy_t seal_policy,
370  const oe_asymmetric_key_params_t* key_params,
371  uint8_t** key_buffer,
372  size_t* key_buffer_size,
373  uint8_t** key_info,
374  size_t* key_info_size);
375 
394  oe_enclave_t* enclave,
395  const oe_asymmetric_key_params_t* key_params,
396  const uint8_t* key_info,
397  size_t key_info_size,
398  uint8_t** key_buffer,
399  size_t* key_buffer_size);
400 
410 void oe_free_key(
411  uint8_t* key_buffer,
412  size_t key_buffer_size,
413  uint8_t* key_info,
414  size_t key_info_size);
415 
416 OE_EXTERNC_END
417 
418 #endif /* _OE_HOST_H */
oe_result_t oe_get_public_key_by_policy(oe_enclave_t *enclave, oe_seal_policy_t seal_policy, const oe_asymmetric_key_params_t *key_params, uint8_t **key_buffer, size_t *key_buffer_size, uint8_t **key_info, size_t *key_info_size)
Returns a public key that is associated with the identity of the enclave and the specified policy...
enum _oe_seal_policy oe_seal_policy_t
This enumeration type defines the policy used to derive a seal key.
oe_result_t oe_get_public_key(oe_enclave_t *enclave, const oe_asymmetric_key_params_t *key_params, const uint8_t *key_info, size_t key_info_size, uint8_t **key_buffer, size_t *key_buffer_size)
Returns a public key that is associated with the identity of the enclave.
This file defines the types used by the OE SDK.
Structure to hold the parsed form of a report.
Definition: report.h:112
enum _oe_enclave_type oe_enclave_type_t
This enumeration defines values for the type parameter passed to oe_create_enclave().
size_t max_host_workers
The max number of worker threads for context-switchless ocalls.
Definition: host.h:117
oe_result_t oe_get_report_v2(oe_enclave_t *enclave, uint32_t flags, const void *opt_params, size_t opt_params_size, uint8_t **report_buffer, size_t *report_buffer_size)
Get a report signed by the enclave platform for use in attestation.
The setting for context-switchless calls.
Definition: host.h:110
This file defines structures and options for SGX evidence generation and verification.
oe_result_t oe_get_target_info_v2(const uint8_t *report, size_t report_size, void **target_info_buffer, size_t *target_info_size)
Extracts additional platform specific data from the report and writes it to target_info_buffer.
enum _oe_enclave_setting_type oe_enclave_setting_type_t
Types of settings passed into oe_create_enclave
_oe_enclave_setting_type
Types of settings passed into oe_create_enclave
Definition: host.h:99
This file defines Open Enclave return codes (results).
enum _oe_result oe_result_t
This enumeration type defines return codes for Open Enclave functions.
size_t max_enclave_workers
Context-switchless ecalls are not enabled yet.
Definition: host.h:122
struct _oe_enclave_setting_context_switchless oe_enclave_setting_context_switchless_t
The setting for context-switchless calls.
void oe_free_key(uint8_t *key_buffer, size_t key_buffer_size, uint8_t *key_info, size_t key_info_size)
Frees the given key and/or key info.
oe_enclave_setting_type_t setting_type
The type of the setting in u
Definition: host.h:134
struct _oe_ecall_info_t oe_ecall_info_t
Structure describing an ecall.
Structure describing an ecall.
Definition: host.h:152
void oe_free_report(uint8_t *report_buffer)
Frees a report buffer obtained from oe_get_report.
oe_result_t oe_parse_report(const uint8_t *report, size_t report_size, oe_report_t *parsed_report)
Parse an enclave report into a standard format for reading.
oe_result_t oe_verify_report(oe_enclave_t *enclave, const uint8_t *report, size_t report_size, oe_report_t *parsed_report)
Verify the integrity of the report and its signature.
void oe_free_target_info(void *target_info_buffer)
Frees a target info obtained from oe_get_target_info.
oe_result_t oe_terminate_enclave(oe_enclave_t *enclave)
Terminate an enclave and reclaims its resources.
void(* oe_ocall_func_t)(const uint8_t *input_buffer, size_t input_buffer_size, uint8_t *output_buffer, size_t output_buffer_size, size_t *output_bytes_written)
Type of each function in an ocall-table.
Definition: host.h:89
struct _oe_enclave oe_enclave_t
This is an opaque handle to an enclave returned by oe_create_enclave().
Definition: types.h:144
oe_result_t oe_create_enclave(const char *path, oe_enclave_type_t type, uint32_t flags, const oe_enclave_setting_t *settings, uint32_t setting_count, const oe_ocall_func_t *ocall_table, uint32_t ocall_count, const oe_ecall_info_t *ecall_name_table, uint32_t ecall_count, oe_enclave_t **enclave)
Create an enclave from an enclave image file.
struct _oe_enclave_setting oe_enclave_setting_t
The uniform structure type containing a specific type of enclave setting.
The uniform structure type containing a specific type of enclave setting.
Definition: host.h:129