sgx_utils.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. /*
  2. * Copyright (C) 2011-2017 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. /**
  32. * File: sgx_utils.h
  33. * Description:
  34. * Trusted library for SGX instructions
  35. */
  36. #ifndef _SGX_UTILS_H_
  37. #define _SGX_UTILS_H_
  38. #include "sgx.h"
  39. #include "sgx_defs.h"
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. /*sgx_create_report
  44. * Purpose: Create a cryptographic report of the enclave using the input information if any.
  45. *
  46. * Parameters:
  47. * target_info - [IN] pointer to the information of the target enclave.
  48. * report_data - [IN] pointer to a set of data used for communication between the enclaves.
  49. * report - [OUT] pointer to the cryptographic report of the enclave
  50. *
  51. * Return value:
  52. * sgx_status_t - SGX_SUCCESS or failure as defined in sgx_error.h.
  53. */
  54. sgx_status_t SGXAPI sgx_create_report(const sgx_target_info_t *target_info, const sgx_report_data_t *report_data, sgx_report_t *report);
  55. /* sgx_verify_report
  56. * Purpose: Software verification for the input report
  57. *
  58. * Paramters:
  59. * report - [IN] ponter to the cryptographic report to be verified.
  60. *
  61. * Return value:
  62. * sgx_status_t - SGX_SUCCESS or failure as defined in sgx_error.h.
  63. */
  64. sgx_status_t SGXAPI sgx_verify_report(const sgx_report_t *report);
  65. /*sgx_get_key
  66. * Purpose: Generate a 128-bit secret key with the input information.
  67. *
  68. * Parameters:
  69. * key_request - [IN] pointer to the sgx_key_request_t object used for selecting the appropriate key.
  70. * key - [OUT] Pointer to the buffer that receives the cryptographic key output.
  71. *
  72. * Return value:
  73. * sgx_status_t - SGX_SUCCESS or failure as defined in sgx_error.h.
  74. */
  75. sgx_status_t SGXAPI sgx_get_key(const sgx_key_request_t *key_request, sgx_key_128bit_t *key);
  76. #ifdef __cplusplus
  77. }
  78. #endif
  79. #endif