Open Enclave  0.16.1
result.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_BITS_RESULT_H
11 #define _OE_BITS_RESULT_H
12 
13 #include "defs.h"
14 #include "types.h"
15 
16 OE_EXTERNC_BEGIN
17 
23 typedef enum _oe_result
24 {
25 
30 
35 
40 
47 
53 
59 
66 
71 
79 
85 
91 
96 
102 
108 
115 
121 
127 
133 
138 
143 
149 
155 
161 
167 
173 
179 
184 
189 
196 
203 
208 
213 
220 
226 
232 
238 
243 
249 
256 
261 
266 
271 
276 
281 
286 
291 
296 
301 
306 
311 
316 
321 
326 
331 
336 
341 
346 
351 
357 
363 
368 
374 
375  __OE_RESULT_MAX = OE_ENUM_MAX,
376 } oe_result_t;
390 const char* oe_result_str(oe_result_t result);
391 
392 OE_EXTERNC_END
393 
394 #endif /* _OE_BITS_RESULT_H */
OE_INVALID_UTC_DATE_TIME
@ OE_INVALID_UTC_DATE_TIME
The given UTC date-time string or structure is invalid.
Definition: result.h:255
oe_result_str
const char * oe_result_str(oe_result_t result)
Retrieve a string for a result code.
OE_CONTEXT_SWITCHLESS_OCALL_MISSED
@ OE_CONTEXT_SWITCHLESS_OCALL_MISSED
Failed to post a switchless call to host workers.
Definition: result.h:330
OE_BUFFER_TOO_SMALL
@ OE_BUFFER_TOO_SMALL
One or more output buffer function parameters is too small.
Definition: result.h:39
OE_INVALID_ISVSVN
@ OE_INVALID_ISVSVN
The given ISVSNV value is invalid.
Definition: result.h:166
OE_PUBLIC_KEY_NOT_FOUND
@ OE_PUBLIC_KEY_NOT_FOUND
The certificate does not contain a public key.
Definition: result.h:95
types.h
OE_QUOTE_LIBRARY_LOAD_ERROR
@ OE_QUOTE_LIBRARY_LOAD_ERROR
Failed to load the quote library used for quote generation and attestation.
Definition: result.h:373
OE_INVALID_PARAMETER
@ OE_INVALID_PARAMETER
One or more input function parameters is invalid.
Definition: result.h:46
OE_INVALID_REVOCATION_INFO
@ OE_INVALID_REVOCATION_INFO
The certificate revocation data for attesting the trusted computing base (TCB) is invalid for this en...
Definition: result.h:248
OE_UNEXPECTED
@ OE_UNEXPECTED
The function encountered an unexpected failure.
Definition: result.h:70
OE_MEMORY_LEAK
@ OE_MEMORY_LEAK
A memory leak was detected during enclave termination.
Definition: result.h:212
OE_SERVICE_UNAVAILABLE
@ OE_SERVICE_UNAVAILABLE
A software service is unavailable (such as the AESM service).
Definition: result.h:137
OE_QUOTE_PROVIDER_LOAD_ERROR
@ OE_QUOTE_PROVIDER_LOAD_ERROR
Failed to load the quote provider library used for quote generation and attestation.
Definition: result.h:237
OE_INTEGER_OVERFLOW
@ OE_INTEGER_OVERFLOW
The function encountered an overflow in an integer operation, which can occur in arithmetic operation...
Definition: result.h:90
OE_OVERLAPPED_COPY
@ OE_OVERLAPPED_COPY
The function prevented an attempt to perform an overlapped copy, where the source and destination buf...
Definition: result.h:107
OE_REENTRANT_ECALL
@ OE_REENTRANT_ECALL
The host attempted to perform a reentrant ECALL.
Definition: result.h:52
OE_BAD_ALIGNMENT
@ OE_BAD_ALIGNMENT
The data is improperly aligned for the given operation.
Definition: result.h:219
OE_INVALID_KEYNAME
@ OE_INVALID_KEYNAME
The given key name is invalid.
Definition: result.h:172
OE_VERIFY_REVOKED
@ OE_VERIFY_REVOKED
The certificate or signature has been revoked.
Definition: result.h:285
OE_QUOTE_PROVIDER_CALL_ERROR
@ OE_QUOTE_PROVIDER_CALL_ERROR
A call to the quote provider failed.
Definition: result.h:242
OE_OUT_OF_BOUNDS
@ OE_OUT_OF_BOUNDS
An integer index is outside the expected range.
Definition: result.h:101
OE_INVALID_SGX_SIGNING_KEY
@ OE_INVALID_SGX_SIGNING_KEY
The signing key provided cannot be used for SGX signing.
Definition: result.h:362
OE_ENCLAVE_ABORTING
@ OE_ENCLAVE_ABORTING
The operation cannot be completed because the enclave is aborting.
Definition: result.h:142
OE_INVALID_QE_IDENTITY_INFO
@ OE_INVALID_QE_IDENTITY_INFO
The QE identity data is invalid.
Definition: result.h:260
OE_INVALID_IMAGE
@ OE_INVALID_IMAGE
The binary image being loaded into the enclave could not be parsed.
Definition: result.h:367
OE_PLATFORM_ERROR
@ OE_PLATFORM_ERROR
The underlying platform or hardware returned an error.
Definition: result.h:154
OE_OUT_OF_THREADS
@ OE_OUT_OF_THREADS
The function is unable to bind the current host thread to an enclave thread.
Definition: result.h:65
OE_CRYPTO_ERROR
@ OE_CRYPTO_ERROR
An underlying crypto provider returned an error.
Definition: result.h:295
OE_TCB_LEVEL_INVALID
@ OE_TCB_LEVEL_INVALID
The level of the trusted computing base (TCB) is not up to date for report verification.
Definition: result.h:231
OE_INVALID_ENDORSEMENT
@ OE_INVALID_ENDORSEMENT
The quote verification collateral is invalid.
Definition: result.h:265
OE_IOCTL_FAILED
@ OE_IOCTL_FAILED
An IOCTL operation failed.
Definition: result.h:120
OE_VERIFY_CRL_EXPIRED
@ OE_VERIFY_CRL_EXPIRED
The CRL for a certificate has expired.
Definition: result.h:275
_oe_result
_oe_result
This enumeration type defines return codes for Open Enclave functions.
Definition: result.h:23
OE_THREAD_JOIN_ERROR
@ OE_THREAD_JOIN_ERROR
Thread join failed.
Definition: result.h:340
OE_QUOTE_VERIFICATION_ERROR
@ OE_QUOTE_VERIFICATION_ERROR
Quote verification error.
Definition: result.h:305
OE_READ_FAILED
@ OE_READ_FAILED
The function failed to read data from a device (such as a socket, or file).
Definition: result.h:132
QE_QUOTE_ENCLAVE_IDENTITY_PRODUCTID_MISMATCH
@ QE_QUOTE_ENCLAVE_IDENTITY_PRODUCTID_MISMATCH
Product id of the quoting enclave does not match expected value.
Definition: result.h:320
OE_BUSY
@ OE_BUSY
An operation cannot be performed beause the resource is busy.
Definition: result.h:195
OE_DEBUG_DOWNGRADE
@ OE_DEBUG_DOWNGRADE
Attempted to create a debug enclave with an enclave image that does not allow it.
Definition: result.h:178
OE_CONSTRAINT_FAILED
@ OE_CONSTRAINT_FAILED
The function detected a constraint failure.
Definition: result.h:114
OE_NOT_FOUND
@ OE_NOT_FOUND
The function failed to find a resource.
Definition: result.h:84
OE_FAILURE
@ OE_FAILURE
The function failed (without a more specific error code).
Definition: result.h:34
OE_REPORT_PARSE_ERROR
@ OE_REPORT_PARSE_ERROR
Failed to parse an enclave report.
Definition: result.h:183
OE_MISSING_CERTIFICATE_CHAIN
@ OE_MISSING_CERTIFICATE_CHAIN
The certificate chain is not available or missing.
Definition: result.h:188
OE_OK
@ OE_OK
The function was successful.
Definition: result.h:29
OE_QUOTE_ENCLAVE_IDENTITY_VERIFICATION_FAILED
@ OE_QUOTE_ENCLAVE_IDENTITY_VERIFICATION_FAILED
Quote enclave identity verification failed.
Definition: result.h:310
OE_THREAD_CREATE_ERROR
@ OE_THREAD_CREATE_ERROR
Thread creation failed.
Definition: result.h:335
OE_INVALID_CPUSVN
@ OE_INVALID_CPUSVN
The given CPUSVN value is invalid.
Definition: result.h:160
OE_JSON_INFO_PARSE_ERROR
@ OE_JSON_INFO_PARSE_ERROR
Failed to parse the trusted computing base (TCB) revocation data or the QE Identity data for the encl...
Definition: result.h:225
OE_OUT_OF_MEMORY
@ OE_OUT_OF_MEMORY
The function is out of memory.
Definition: result.h:58
OE_ENCLAVE_ABORTED
@ OE_ENCLAVE_ABORTED
The operation cannot be completed because the enclave has already aborted.
Definition: result.h:148
OE_INCORRECT_REPORT_SIZE
@ OE_INCORRECT_REPORT_SIZE
OE report size does not match the expected size.
Definition: result.h:300
OE_VERIFY_FAILED
@ OE_VERIFY_FAILED
A cryptographic verification failed.
Definition: result.h:78
OE_UNSUPPORTED_ENCLAVE_IMAGE
@ OE_UNSUPPORTED_ENCLAVE_IMAGE
The enclave image contains unsupported constructs.
Definition: result.h:270
OE_INVALID_SGX_CERTIFICATE_EXTENSIONS
@ OE_INVALID_SGX_CERTIFICATE_EXTENSIONS
The certificate does not contain the expected SGX extensions.
Definition: result.h:207
OE_NOT_OWNER
@ OE_NOT_OWNER
An operation cannot be performed because the requestor is not the owner of the resource.
Definition: result.h:202
OE_QUOTE_HASH_MISMATCH
@ OE_QUOTE_HASH_MISMATCH
The hash of claims section in the quote does not match the hash value held in the report_data field.
Definition: result.h:356
OE_VERIFY_CRL_MISSING
@ OE_VERIFY_CRL_MISSING
The CRL for a certificate could not be found.
Definition: result.h:280
OE_VERIFY_FAILED_AES_CMAC_MISMATCH
@ OE_VERIFY_FAILED_AES_CMAC_MISMATCH
AES CMAC of the report does not match the expected value.
Definition: result.h:325
oe_result_t
enum _oe_result oe_result_t
This enumeration type defines return codes for Open Enclave functions.
OE_UNSUPPORTED
@ OE_UNSUPPORTED
The given operation is unsupported, usually by a particular platform or environment.
Definition: result.h:126
OE_QUOTE_ENCLAVE_IDENTITY_UNIQUEID_MISMATCH
@ OE_QUOTE_ENCLAVE_IDENTITY_UNIQUEID_MISMATCH
Unique id of the quoting enclave does not match expected value.
Definition: result.h:315
OE_ALREADY_INITIALIZED
@ OE_ALREADY_INITIALIZED
The desired resource has already been initialized.
Definition: result.h:350
OE_VERIFY_FAILED_TO_FIND_VALIDITY_PERIOD
@ OE_VERIFY_FAILED_TO_FIND_VALIDITY_PERIOD
Could not find a valid validity period.
Definition: result.h:290
OE_ALREADY_EXISTS
@ OE_ALREADY_EXISTS
The desired resource already exists.
Definition: result.h:345