enclave_creator.h 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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: enclave_creator.h
  33. * Description: this header file defines the interface used by Enclave loader to create the Enclave
  34. *
  35. * The hardware, simulation and signing mode shall inherit from this class and
  36. * implement all the virtual functions
  37. */
  38. #ifndef _ENCLAVE_CREATOR_H
  39. #define _ENCLAVE_CREATOR_H
  40. #include "arch.h"
  41. #include "sgx_eid.h"
  42. #include "metadata.h"
  43. #include "sgx_error.h"
  44. #include "util.h"
  45. #include "launch_checker.h"
  46. #include "uncopyable.h"
  47. #include <string.h>
  48. #include "file.h"
  49. // this is the interface to both hardware, simulation and signing mode
  50. class EnclaveCreator : private Uncopyable
  51. {
  52. public:
  53. /*
  54. @quote the EPC reserved;
  55. @enclave_id identify the unique enclave;
  56. @start_addr is the linear address allocated for Enclave;
  57. */
  58. virtual int create_enclave(secs_t *secs, sgx_enclave_id_t *enclave_id, void **start_addr, bool ae = false) = 0;
  59. /*
  60. *@attr can be REMOVABLE
  61. */
  62. virtual int add_enclave_page(sgx_enclave_id_t enclave_id, void *source, uint64_t offset, const sec_info_t &sinfo, uint32_t attr) = 0;
  63. virtual int init_enclave(sgx_enclave_id_t enclave_id, enclave_css_t *enclave_css, SGXLaunchToken *lc, le_prd_css_file_t *prd_css_file = NULL) = 0;
  64. virtual int destroy_enclave(sgx_enclave_id_t enclave_id, uint64_t enclave_size = 0) = 0;
  65. virtual int initialize(sgx_enclave_id_t enclave_id) = 0;
  66. virtual bool use_se_hw() const = 0;
  67. virtual int get_misc_attr(sgx_misc_attribute_t *sgx_misc_attr, metadata_t *metadata, SGXLaunchToken * const lc, uint32_t flag) = 0;
  68. virtual bool get_plat_cap(sgx_misc_attribute_t *se_attr) = 0;
  69. #ifdef SE_1P5_VERTICAL
  70. virtual uint32_t handle_page_fault(uint64_t pf_address) { UNUSED(pf_address); return (uint32_t)SGX_ERROR_UNEXPECTED; }
  71. #endif
  72. // destructor
  73. virtual ~EnclaveCreator() {};
  74. };
  75. EnclaveCreator* get_enclave_creator(void);
  76. extern EnclaveCreator* g_enclave_creator;
  77. #endif