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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
// Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License.. //! //! Provides APIs to authenticate and verify the input data with AES-GMAC. //! use sgx_types::*; use sgx_types::marker::ContiguousMemory; use crate::internal::*; use core::mem; use core::marker::PhantomData; use alloc::slice; use alloc::boxed::Box; /// The structure about sealed data, for authenticate and verify. pub struct SgxMacAadata<'a, T: 'a + ?Sized> { inner: SgxInternalSealedData, marker: PhantomData<&'a T>, } impl<'a, T: 'a + ?Sized> Default for SgxMacAadata<'a, T> { fn default() -> SgxMacAadata<'a, T> { SgxMacAadata { inner: SgxInternalSealedData::new(), marker: PhantomData, } } } impl<'a, T: 'a + Clone + ?Sized> Clone for SgxMacAadata<'a, T> { fn clone(&self) -> SgxMacAadata<'a, T> { SgxMacAadata { inner: self.inner.clone(), marker: PhantomData, } } } impl<'a, T: 'a + Copy + ContiguousMemory> SgxMacAadata<'a, T> { /// /// This function is used to authenticate the input data with AES-GMAC. /// /// # Descryption /// /// The mac_aadata function retrieves a key unique to the enclave and /// uses that key to generate the authentication tag based on the input data buffer. This function can be utilized to provide authentication assurance for additional data (of practically unlimited length per invocation) that is not /// encrypted. The data origin authentication can be demonstrated on future /// instantiations of the enclave using the MAC stored into the data blob. /// Use `calc_raw_sealed_data_size` to calculate the number of bytes to /// allocate for the SgxMacAadata structure. The input sealed data buffer /// must be allocated within the enclave /// /// # Requirements /// /// Library: libsgx_tservice.a or libsgx_tservice_sim.a (simulation) /// /// # Parameters /// /// **additional_text** /// /// Pointer to the plain text to provide authentication for. /// /// # Return value /// /// The sealed data in SgxMacAadata. /// /// # Errors /// /// **SGX_ERROR_INVALID_PARAMETER** /// /// Indicates an error if the parameters do not meet any of the following conditions: /// /// * additional_text buffer can be within or outside the enclave, but cannot cross the enclave boundary. /// * encrypt_text must be non-zero. /// * encrypt_text buffer must be within the enclave. /// /// **SGX_ERROR_OUT_OF_MEMORY** /// /// The enclave is out of memory. /// /// **SGX_ERROR_UNEXPECTED** /// /// Indicates a crypto library failure or the RDRAND instruction fails to generate a /// random number. /// pub fn mac_aadata(additional_text: &T) -> SgxResult<Self> { let size = mem::size_of::<T>(); if size == 0 { return Err(sgx_status_t::SGX_ERROR_INVALID_PARAMETER); } let aad_slice: &[u8] = unsafe { slice::from_raw_parts(additional_text as *const _ as *const u8, mem::size_of_val(additional_text)) }; let result = SgxInternalSealedData::mac_aadata(aad_slice); result.map(|x| SgxMacAadata {inner: x, marker: PhantomData}) } /// /// This function is used to authenticate the input data with AES-GMAC. This is /// the expert mode version of the function mac_aadata. /// /// # Descryption /// /// The mac_aadata_ex is an extended version of mac_aadata. It /// provides parameters for you to identify how to derive the sealing key (key /// policy and attributes_mask). Typical callers of the seal library should be /// able to use mac_aadata and the default values provided for key_policy (MR_SIGNER) and an attribute mask which includes the RESERVED, /// INITED and DEBUG bits. Before you use this function, you should have a clear /// understanding of the impact of using a policy and/or attribute_mask that /// is different from that in mac_aadata. /// # Requirements /// /// Library: libsgx_tservice.a or libsgx_tservice_sim.a (simulation) /// /// # Parameters /// /// **key_policy** /// /// Specifies the policy to use in the key derivation. Function sgx_seal_data uses the MRSIGNER policy. /// /// Key policy name | Value | Description /// ---|---|--- /// KEYPOLICY_MRENCLAVE | 0x0001 | -Derive key using the enclave??s ENCLAVE measurement register /// KEYPOLICY_MRSIGNER |0x0002 | -Derive key using the enclave??s SIGNER measurement register /// /// **attribute_mask** /// /// Identifies which platform/enclave attributes to use in the key derivation. See /// the definition of sgx_attributes_t to determine which attributes will be /// checked. Function sgx_seal_data uses flags=0xfffffffffffffff3,?xfrm=0. /// /// **misc_mask** /// /// The misc mask bits for the enclave. Reserved for future function extension. /// /// **additional_text** /// /// Pointer to the additional Message Authentication Code (MAC) data. /// This additional data is optional and no data is necessary. /// /// # Return value /// /// The sealed data in SgxSealedData. /// /// # Errors /// /// **SGX_ERROR_INVALID_PARAMETER** /// /// Indicates an error if the parameters do not meet any of the following conditions: /// /// * additional_text buffer can be within or outside the enclave, but cannot cross the enclave boundary. /// * encrypt_text must be non-zero. /// * encrypt_text buffer must be within the enclave. /// /// **SGX_ERROR_OUT_OF_MEMORY** /// /// The enclave is out of memory. /// /// **SGX_ERROR_UNEXPECTED** /// /// Indicates a crypto library failure or the RDRAND instruction fails to generate a /// random number. /// pub fn mac_aadata_ex(key_policy: u16, attribute_mask: sgx_attributes_t, misc_mask: sgx_misc_select_t, additional_text: &T) -> SgxResult<Self> { let size = mem::size_of::<T>(); if size == 0 { return Err(sgx_status_t::SGX_ERROR_INVALID_PARAMETER); } let aad_slice: &[u8] = unsafe { slice::from_raw_parts(additional_text as *const _ as *const u8, mem::size_of_val(additional_text)) }; let result = SgxInternalSealedData::mac_aadata_ex(key_policy, attribute_mask, misc_mask, aad_slice); result.map(|x| SgxMacAadata {inner: x, marker: PhantomData}) } /// /// This function is used to verify the authenticity of the input sealed data structure using AES-GMAC. This function verifies the MAC generated with sgx_mac_aadata or sgx_mac_aadata_ex. /// /// # Descryption /// /// The sgx_unmac_aadata function verifies the tag with AES-GMAC. Use this /// function to demonstrate the authenticity of data that was preserved by an /// earlier instantiation of this enclave. /// /// # Requirements /// /// Library: libsgx_tservice.a or libsgx_tservice_sim.a (simulation) /// /// # Return value /// /// The pointer of the additional data. /// /// # Errors /// /// **SGX_ERROR_INVALID_PARAMETER** /// /// The size of T may be zero. /// /// **SGX_ERROR_INVALID_CPUSVN** /// /// The CPUSVN in the data blob is beyond the CPUSVN value of the platform. /// /// **SGX_ERROR_INVALID_ISVSVN** /// /// The ISVSVN in the data blob is greater than the ISVSVN value of the enclave. /// /// **SGX_ERROR_MAC_MISMATCH** /// /// The tag verification fails. The error may be caused by a platform update, software update, or corruption of the sealed_data_t structure. /// /// **SGX_ERROR_OUT_OF_MEMORY** /// /// The enclave is out of memory. /// /// **SGX_ERROR_UNEXPECTED** /// /// Indicates a crypto library failure or the RDRAND instruction fails to generate a /// random number. /// pub fn unmac_aadata(&self) -> SgxResult<Box<T>> { let size = mem::size_of::<T>(); if size == 0 { return Err(sgx_status_t::SGX_ERROR_INVALID_PARAMETER); } let aad_len = self.get_add_mac_txt_len() as usize; if size != aad_len { return Err(sgx_status_t::SGX_ERROR_MAC_MISMATCH); } self.inner.unmac_aadata().map(|x| { let ptr = Box::into_raw(x.additional); unsafe{Box::from_raw(ptr as *mut T)} }) } /// /// Convert a pointer of sgx_sealed_data_t buffer to SgxMacAadata. /// pub unsafe fn from_raw_sealed_data_t(p: *mut sgx_sealed_data_t, len: u32) -> Option<Self> { let size = mem::size_of::<T>(); if size == 0 { return None; } let opt = SgxInternalSealedData::from_raw_sealed_data_t(p, len); opt.map(|x| SgxMacAadata{inner: x, marker: PhantomData}) } /// /// Convert SgxMacAadata to the pointer of sgx_sealed_data_t. /// /// # Parameters /// /// **p** /// /// The pointer of sgx_sealed_data_t to save the data in SgxMacAadata. /// /// **len** /// /// The size of the pointer of sgx_sealed_data_t. /// /// # Error /// /// **Some(*mut sgx_sealed_data_t)** /// /// Indicates the conversion is successfully. The return value is the pointer of sgx_sealed_data_t. /// /// **None** /// /// May be the parameter p and len is not avaliable. /// pub unsafe fn to_raw_sealed_data_t(&self, p: *mut sgx_sealed_data_t, len: u32) -> Option<*mut sgx_sealed_data_t> { self.inner.to_raw_sealed_data_t(p, len) } } impl<'a, T: 'a + Copy + ContiguousMemory> SgxMacAadata<'a, [T]> { /// /// This function is used to authenticate the input data with AES-GMAC. /// pub fn mac_aadata(additional_text: &[T]) -> SgxResult<Self> { let size = mem::size_of::<T>(); let len = mem::size_of_val(additional_text); if size == 0 || len == 0 { return Err(sgx_status_t::SGX_ERROR_INVALID_PARAMETER); } let aad_slice: &[u8] = unsafe { slice::from_raw_parts(additional_text.as_ptr() as *const u8, len) }; let result = SgxInternalSealedData::mac_aadata(aad_slice); result.map(|x| SgxMacAadata {inner: x, marker: PhantomData}) } /// /// This function is used to authenticate the input data with AES-GMAC. This is /// the expert mode version of the function mac_aadata. /// pub fn mac_aadata_ex(key_policy: u16, attribute_mask: sgx_attributes_t, misc_mask: sgx_misc_select_t, additional_text: &[T]) -> SgxResult<Self> { let size = mem::size_of::<T>(); let len = mem::size_of_val(additional_text); if size == 0 || len == 0 { return Err(sgx_status_t::SGX_ERROR_INVALID_PARAMETER); } let aad_slice: &[u8] = unsafe { slice::from_raw_parts(additional_text.as_ptr() as *const u8, len) }; let result = SgxInternalSealedData::mac_aadata_ex(key_policy, attribute_mask, misc_mask, aad_slice); result.map(|x| SgxMacAadata {inner: x, marker: PhantomData}) } /// /// This function is used to verify the authenticity of the input sealed data structure using AES-GMAC. This function verifies the MAC generated with sgx_mac_aadataorsgx_mac_aadata_ex. /// pub fn unmac_aadata(&self) -> SgxResult<Box<[T]>> { let size = mem::size_of::<T>(); if size == 0 { return Err(sgx_status_t::SGX_ERROR_INVALID_PARAMETER); } let aad_len = self.get_add_mac_txt_len() as usize; if size > aad_len { return Err(sgx_status_t::SGX_ERROR_MAC_MISMATCH); } if (aad_len % size) != 0 { return Err(sgx_status_t::SGX_ERROR_MAC_MISMATCH); } self.inner.unmac_aadata().map(|x| { let ptr = Box::into_raw(x.additional); unsafe { let slice = slice::from_raw_parts_mut(ptr as *mut T, aad_len/size); Box::from_raw(slice as *mut [T]) } }) } /// /// Convert a pointer of sgx_sealed_data_t buffer to SgxMacAadata. /// pub unsafe fn from_raw_sealed_data_t(p: *mut sgx_sealed_data_t, len: u32) -> Option<Self> { let size = mem::size_of::<T>(); if size == 0 { return None; } let opt = SgxInternalSealedData::from_raw_sealed_data_t(p, len); opt.map(|x| SgxMacAadata{inner: x, marker: PhantomData}) } /// /// Convert SgxMacAadata to the pointer of sgx_sealed_data_t. /// /// # Parameters /// /// **p** /// /// The pointer of sgx_sealed_data_t to save the data in SgxMacAadata. /// /// **len** /// /// The size of the pointer of sgx_sealed_data_t. /// /// # Error /// /// **Some(*mut sgx_sealed_data_t)** /// /// Indicates the conversion is successfully. The return value is the pointer of sgx_sealed_data_t. /// /// **None** /// /// May be the parameter p and len is not avaliable. /// pub unsafe fn to_raw_sealed_data_t(&self, p: *mut sgx_sealed_data_t, len: u32) -> Option<*mut sgx_sealed_data_t> { self.inner.to_raw_sealed_data_t(p, len) } } impl<'a, T: 'a + ?Sized> SgxMacAadata<'a, T> { /// /// Create a SgxMacAadata with default values. /// pub fn new() -> Self { SgxMacAadata::default() } /// /// Get the size of payload in SgxMacAadata. /// pub fn get_payload_size(&self) -> u32 { self.inner.get_payload_size() } /// /// Get a slice of payload in SgxMacAadata. /// pub fn get_payload_tag(&self) -> &[u8; SGX_SEAL_TAG_SIZE] { self.inner.get_payload_tag() } /// /// Get the pointer of sgx_key_request_t in SgxMacAadata. /// pub fn get_key_request(&self) -> &sgx_key_request_t { self.inner.get_key_request() } /// /// Get a slice of additional text in SgxMacAadata. /// pub fn get_additional_txt(&self) -> &[u8] { self.inner.get_additional_txt() } /// /// Calculate the size of the sealed data in SgxMacAadata. /// pub fn calc_raw_sealed_data_size(add_mac_txt_size: u32, encrypt_txt_size: u32) -> u32 { SgxInternalSealedData::calc_raw_sealed_data_size(add_mac_txt_size, encrypt_txt_size) } /// /// Get the size of the additional mactext in SgxMacAadata. /// pub fn get_add_mac_txt_len(&self) -> u32 { self.inner.get_add_mac_txt_len() } }