sgx_trts.h 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. /*
  2. * Copyright (C) 2011-2018 Intel Corporation. All rights reserved.
  3. *
  4. * Redistribution and use in source and binary forms, with or without
  5. * modification, are permitted provided that the following conditions
  6. * are met:
  7. *
  8. * * Redistributions of source code must retain the above copyright
  9. * notice, this list of conditions and the following disclaimer.
  10. * * Redistributions in binary form must reproduce the above copyright
  11. * notice, this list of conditions and the following disclaimer in
  12. * the documentation and/or other materials provided with the
  13. * distribution.
  14. * * Neither the name of Intel Corporation nor the names of its
  15. * contributors may be used to endorse or promote products derived
  16. * from this software without specific prior written permission.
  17. *
  18. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29. *
  30. */
  31. #ifndef _SGX_TRTS_H_
  32. #define _SGX_TRTS_H_
  33. #include "sgx_error.h"
  34. #include "stddef.h"
  35. #include "sgx_defs.h"
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif
  39. /* sgx_is_within_enclave()
  40. * Parameters:
  41. * addr - the start address of the buffer
  42. * size - the size of the buffer
  43. * Return Value:
  44. * 1 - the buffer is strictly within the enclave
  45. * 0 - the whole buffer or part of the buffer is not within the enclave,
  46. * or the buffer is wrap around
  47. */
  48. int SGXAPI sgx_is_within_enclave(const void *addr, size_t size);
  49. /* sgx_is_outside_enclave()
  50. * Parameters:
  51. * addr - the start address of the buffer
  52. * size - the size of the buffer
  53. * Return Value:
  54. * 1 - the buffer is strictly outside the enclave
  55. * 0 - the whole buffer or part of the buffer is not outside the enclave,
  56. * or the buffer is wrap around
  57. */
  58. int SGXAPI sgx_is_outside_enclave(const void *addr, size_t size);
  59. /* sgx_is_enclave_crashed()
  60. * Return Value:
  61. * 1 - the enclave state is crashed.
  62. * 0 - the enclave state is not crashed.
  63. */
  64. int SGXAPI sgx_is_enclave_crashed(void);
  65. /* sgx_read_rand()
  66. * Parameters:
  67. * rand - the buffer to receive the random number
  68. * length_in_bytes - the number of bytes to read the random number
  69. * Return Value:
  70. * SGX_SUCCESS - success
  71. * SGX_ERROR_INVALID_PARAMETER - the parameter is invalid
  72. * SGX_ERROR_UNEXPECTED - HW failure of RDRAND instruction
  73. */
  74. sgx_status_t SGXAPI sgx_read_rand(unsigned char *rand, size_t length_in_bytes);
  75. #ifdef __cplusplus
  76. }
  77. #endif
  78. #endif