1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
// Copyright (C) 2017-2019 Baidu, Inc. All Rights Reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions // are met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above copyright // notice, this list of conditions and the following disclaimer in // the documentation and/or other materials provided with the // distribution. // * Neither the name of Baidu, Inc., nor the names of its // contributors may be used to endorse or promote products derived // from this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. //! # Trusted Key Exchange Library //! //! The library allow an ISV to exchange secrets between its server and its enclaves. They are used in //! concert with untrusted Key Exchange functions. //! #![no_std] extern crate sgx_types; use sgx_types::*; /// /// The rsgx_ra_init function creates a context for the remote attestation and key exchange process. /// /// # Description /// /// This is the first API user should call for a key exchange process. The context returned from this /// function is used as a handle for other APIs in the key exchange library. /// /// # Parameters /// /// **p_pub_key** /// /// The EC public key of the service provider based on the NIST P-256 elliptic curve. /// /// **b_pse** /// /// If true, platform service information is needed in message 3. The caller should make sure a PSE session /// has been established using rsgx_create_pse_session before attempting to establish a remote attestation /// and key exchange session involving platform service information. /// /// # Requirements /// /// Header: sgx_tkey_exchange.edl /// /// Library: libsgx_tkey_exchange.a /// /// # Return value /// /// The output context for the subsequent remote attestation and key exchange process, to be used in /// sgx_ra_get_msg1 and sgx_ra_proc_msg2. /// /// # Errors /// /// **SGX_ERROR_INVALID_PARAMETER** /// /// Indicates an error that the input parameters are invalid. /// /// **SGX_ERROR_OUT_OF_MEMORY** /// /// Not enough memory is available to complete this operation, or contexts reach the limits. /// /// **SGX_ERROR_AE_SESSION_INVALID** /// /// The session is invalid or ended by the server. /// /// **SGX_ERROR_UNEXPECTED** /// /// Indicates that an unexpected error occurred. /// pub fn rsgx_ra_init(p_pub_key: &sgx_ec256_public_t, b_pse: i32) -> SgxResult<sgx_ra_context_t> { let mut context: sgx_ra_context_t = 0; let ret = unsafe { sgx_ra_init(p_pub_key as * const sgx_ec256_public_t, b_pse, &mut context as * mut sgx_ra_context_t) }; match ret { sgx_status_t::SGX_SUCCESS => Ok(context), _ => Err(ret), } } /// /// The rsgx_ra_init_ex function creates a context for the remote attestation and key exchange process /// while it allows the use of a custom defined Key Derivation Function (KDF). /// /// # Description /// /// This is the first API user should call for a key exchange process. The context returned from this /// function is used as a handle for other APIs in the key exchange library. /// /// # Parameters /// /// **p_pub_key** /// /// The EC public key of the service provider based on the NIST P-256 elliptic curve. /// /// **b_pse** /// /// If true, platform service information is needed in message 3. The caller should make sure a PSE session /// has been established using rsgx_create_pse_session before attempting to establish a remote attestation /// and key exchange session involving platform service information. /// /// **derive_key_cb** /// /// This a pointer to a call back routine matching the funtion prototype of sgx_ra_derive_secret_keys_t. /// This function takes the Diffie-Hellman shared secret as input to allow the ISV enclave to generate /// their own derived shared keys (SMK, SK, MK and VK). /// /// # Requirements /// /// Header: sgx_tkey_exchange.edl /// /// Library: libsgx_tkey_exchange.a /// /// # Return value /// /// The output context for the subsequent remote attestation and key exchange process, to be used in /// sgx_ra_get_msg1 and sgx_ra_proc_msg2. /// /// # Errors /// /// **SGX_ERROR_INVALID_PARAMETER** /// /// Indicates an error that the input parameters are invalid. /// /// **SGX_ERROR_OUT_OF_MEMORY** /// /// Not enough memory is available to complete this operation, or contexts reach the limits. /// /// **SGX_ERROR_AE_SESSION_INVALID** /// /// The session is invalid or ended by the server. /// /// **SGX_ERROR_UNEXPECTED** /// /// Indicates that an unexpected error occurred. /// pub fn rsgx_ra_init_ex(p_pub_key: &sgx_ec256_public_t, b_pse: i32, derive_key_cb: sgx_ra_derive_secret_keys_t) -> SgxResult<sgx_ra_context_t> { let mut context: sgx_ra_context_t = 0; let ret = unsafe { sgx_ra_init_ex(p_pub_key as * const sgx_ec256_public_t, b_pse, derive_key_cb, &mut context as * mut sgx_ra_context_t) }; match ret { sgx_status_t::SGX_SUCCESS => Ok(context), _ => Err(ret), } } /// /// The sgx_ra_get_keys function is used to get the negotiated keys of a remote attestation and key exchange session. /// /// This function should only be called after the service provider accepts the remote attestation and key exchange /// protocol message 3 produced by sgx_ra_proc_msg2. /// /// # Description /// /// After a successful key exchange process, this API can be used in the enclave to get specific key associated /// with this remote attestation and key exchange session. /// /// # Parameters /// /// **context** /// /// Context returned by rsgx_ra_init. /// /// **keytype** /// /// The type of the keys, which can be SGX_RA_KEY_MK, SGX_RA_KEY_SK, or SGX_RA_VK. /// /// # Requirements /// /// Header: sgx_tkey_exchange.edl /// /// Library: libsgx_tkey_exchange.a /// /// # Return value /// /// The key returned. /// /// # Errors /// /// **SGX_ERROR_INVALID_PARAMETER** /// /// Indicates an error that the input parameters are invalid. /// /// **SGX_ERROR_INVALID_STATE** /// /// Indicates this API is invoked in incorrect order, it can be called only after a success session has been established. /// In other words, sgx_ra_proc_msg2 should have been called and no error returned. /// pub fn rsgx_ra_get_keys(context: sgx_ra_context_t, keytype: sgx_ra_key_type_t) -> SgxResult<sgx_ra_key_128_t> { let mut key = sgx_ra_key_128_t::default(); let ret = unsafe { sgx_ra_get_keys(context, keytype, &mut key as * mut sgx_ra_key_128_t) }; match ret { sgx_status_t::SGX_SUCCESS => Ok(key), _ => Err(ret), } } /// /// rsgx_ra_close release context created by rsgx_ra_init or rsgx_ra_init_ex. /// /// Call the rsgx_ra_close function to release the remote attestation and key exchange context after /// the process is done and the context isn’t needed anymore. /// /// # Description /// /// At the end of a key exchange process, the caller needs to use this API in an enclave to clear and /// free memory associated with this remote attestation session. /// /// # Parameters /// /// **context** /// /// Context returned by rsgx_ra_init. /// /// # Requirements /// /// Header: sgx_tkey_exchange.edl /// /// Library: libsgx_tkey_exchange.a /// /// # Errors /// /// **SGX_ERROR_INVALID_PARAMETER** /// /// Indicates an error that the input parameters are invalid. /// pub fn rsgx_ra_close(context: sgx_ra_context_t) -> SgxError { let ret = unsafe { sgx_ra_close(context) }; match ret { sgx_status_t::SGX_SUCCESS => Ok(()), _ => Err(ret), } }