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 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
// Copyright (c) 2019, Arm Limited, All Rights Reserved // SPDX-License-Identifier: Apache-2.0 // // Licensed 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. #![deny( nonstandard_style, const_err, dead_code, improper_ctypes, legacy_directory_ownership, non_shorthand_field_patterns, no_mangle_generic_items, overflowing_literals, path_statements, patterns_in_fns_without_body, plugin_as_library, private_in_public, safe_extern_statics, unconditional_recursion, unused, unused_allocation, unused_comparisons, unused_parens, while_true, missing_debug_implementations, //TODO: activate this! //missing_docs, trivial_casts, trivial_numeric_casts, unused_extern_crates, unused_import_braces, unused_qualifications, unused_results, missing_copy_implementations )] //! # TSS 2.0 Rust Wrapper over Enhanced System API //! This crate exposes the functionality of the TCG Software Stack Enhanced System API to //! Rust developers, both directly through FFI bindings and through more Rust-tailored interfaces //! at varying levels of abstraction. //! At the moment, the abstracted functionality focuses on creating signing and encryption RSA //! keys, as well as signing and verifying signatures. //! Only platforms based on processors with a word size of at least 16 bits are supported. //! //! # Disclaimer //! //! The current version of the API does not offer any security or code safety guarantees as it has //! not been tested to a desired level of confidence. //! The implementation that is provided is suitable for exploratory testing and experimentation only. //! This test implementation does not offer any tangible security benefits and therefore is not //! suitable for use in production. //! Contributions from the developer community are welcome. Please refer to the contribution guidelines. //! //! # Code structure //! The modules comprising the crate expose the following functionalities: //! * lib/root module - exposes the `Context` structure, the most basic abstraction over the //! ESAPI, on top of which all other abstraction layers are implemented. //! * utils - exposes Rust-native versions and/or builders for (some of) the structures defined in //! the TSS 2.0 specification; it also offers convenience methods for generating very specific //! parameter structures for use in certain operations. //! * response_code - implements error code parsing for the formats defined in the TSS spec and //! exposes it along with wrapper-specific error types. //! * abstraction - intended to offer abstracted interfaces that focus on providing different //! kinds of user experience to the developers; at the moment the only implementation allows for a //! resource-handle-free coding experience by working soloely with object contexts. //! * tss2_esys - exposes raw FFI bindings to the Enhanced System API. //! * constants - exposes constants that were ported to Rust manually as bindgen does not support //! converting them yet. //! //! # Notes on code safety: //! * thread safety is ensured by the required mutability of the `Context` structure within the //! methods implemented on it; thus, in an otherwise safe app commands cannot be dispatched in //! parallel for the same context; whether multithreading with multiple context objects is possible //! depends on the TCTI used and this is the responsability of the crate client to establish. //! * the `unsafe` keyword is used to denote methods that could panic, crash or cause undefined //! behaviour. Whenever this is the case, the properties that need to be checked against //! parameters before passing them in will be stated in the documentation of the method. //! * `unsafe` blocks within this crate need to be documented through code comments if they //! are not covered by the points of trust described here. //! * the TSS2.0 library that this crate links to is trusted to return consistent values and to //! not crash or lead to undefined behaviour when presented with valid arguments. //! * the `Mbox` crate is trusted to perform operations safely on the pointers provided to it, if //! the pointers are trusted to be valid. //! * methods not marked `unsafe` are trusted to behave safely, potentially returning appropriate //! erorr messages when encountering any problems. //! * whenever `unwrap`, `expect`, `panic` or derivatives of these are used, they need to be //! thoroughly documented and justified - preferably `unwrap` and `expect` should *never* fail //! during normal operation. //! * these rules can be broken in test-only code and in tests. #![allow(dead_code)] #[allow( non_snake_case, non_camel_case_types, non_upper_case_globals, dead_code )] #[allow(clippy::all)] #[allow(clippy::unseparated_literal_suffix)] // There is an issue where long double become u128 in extern blocks. Check this issue: // https://github.com/rust-lang/rust-bindgen/issues/1549 #[allow(improper_ctypes, missing_debug_implementations, trivial_casts)] pub mod tss2_esys { #[cfg(not(feature = "docs"))] include!(concat!(env!("OUT_DIR"), "/tss2_esys_bindings.rs")); #[cfg(feature = "docs")] include!(concat!(env!("CARGO_MANIFEST_DIR"), "/doc_bindings.rs")); } pub mod abstraction; #[allow( non_snake_case, non_camel_case_types, non_upper_case_globals, dead_code )] #[allow(clippy::all)] pub mod constants; pub mod response_code; pub mod utils; pub use abstraction::transient::TransientObjectContext; use log::{error, info}; use mbox::MBox; use response_code::Result; use response_code::{Error, WrapperErrorKind as ErrorKind}; use std::collections::HashSet; use std::convert::{TryFrom, TryInto}; use std::ffi::CString; use std::ptr::{null, null_mut}; use tss2_esys::*; use utils::{Signature, TpmaSession, TpmsContext}; #[macro_use] macro_rules! wrap_buffer { ($buf:expr, $buf_type:ty, $buf_size:expr) => {{ if $buf.len() > $buf_size { return Err(Error::local_error(ErrorKind::WrongParamSize)); } let mut buffer = [0_u8; $buf_size]; buffer[..$buf.len()].clone_from_slice(&$buf[..$buf.len()]); let mut buf_struct: $buf_type = Default::default(); buf_struct.size = $buf.len().try_into().unwrap(); // should not fail since the length is checked above buf_struct.buffer = buffer; buf_struct }}; } /// Placeholder for passing empty session handles for a call to the TPM pub const NO_SESSIONS: (ESYS_TR, ESYS_TR, ESYS_TR) = (ESYS_TR_NONE, ESYS_TR_NONE, ESYS_TR_NONE); // Possible TCTI to use with the ESYS API. // TODO: add to each variant a structure for its configuration. Currently using the default // configuration. /// Placeholder TCTI types that can be used when initialising a `Context` to determine which /// interface will be used to communicate with the TPM. #[derive(Copy, Clone, Debug)] pub enum Tcti { Device, Mssim, Tabrmd, } const DEVICE: &str = "device"; const MSSIM: &str = "mssim"; const TABRMD: &str = "tabrmd"; use constants::*; /// Safe abstraction over an ESYS_CONTEXT. /// /// Serves as a low-level abstraction interface to the TPM, providing a thin wrapper around the /// `unsafe` FFI calls. It is meant for more advanced uses of the TSS where control over all /// parameters is necessary or important. /// /// The methods it exposes take the parameters advertised by the specification, with some of the /// parameters being passed as generated by `bindgen` and others in a more convenient/Rust-efficient /// way. /// /// The context also keeps track of all object allocated and deallocated through it and, before /// being dropped, will attempt to close all outstanding handles. However, care must be taken by /// the client to not exceed the maximum number of slots available from the RM. /// /// Code safety-wise, the methods should cover the two kinds of problems that might arise: /// * in terms of memory safety, all parameters passed down to the TSS are verified and the library /// stack is then trusted to provide back valid outputs /// * in terms of thread safety, all methods require a mutable reference to the context object, /// ensuring that no two threads can use the context at the same time for an operation (barring use /// of `unsafe` constructs on the client side) /// More testing and verification will be added to ensure this. /// /// For most methods, if the wrapped TSS call fails and returns a non-zero `TPM2_RC`, a /// corresponding `Tss2ResponseCode` will be created and returned as an `Error`. Wherever this is /// not the case or additional error types can be returned, the method definition should mention /// it. #[derive(Debug)] pub struct Context { /// Handle for the ESYS context object owned through an Mbox. /// Wrapping the handle in an optional Mbox is done to allow the `Context` to be closed properly when the `Context` structure is dropped. esys_context: Option<MBox<ESYS_CONTEXT>>, sessions: (ESYS_TR, ESYS_TR, ESYS_TR), /// TCTI context handle associated with the ESYS context. /// As with the ESYS context, an optional Mbox wrapper allows the context to be deallocated. tcti_context: Option<MBox<TSS2_TCTI_CONTEXT>>, /// A set of currently open object handles that should be flushed before closing the context. open_handles: HashSet<ESYS_TR>, } impl Context { /// Create a new ESYS context based on the desired TCTI /// /// # Safety /// * the client is responsible for ensuring that the context can be initialized safely, /// threading-wise /// /// # Errors /// * if either `Tss2_TctiLdr_Initiialize` or `Esys_Initialize` fail, a corresponding /// Tss2ResponseCode will be returned pub unsafe fn new(tcti: Tcti) -> Result<Self> { let mut esys_context = null_mut(); let mut tcti_context = null_mut(); let tcti_name_conf = match tcti { Tcti::Device => DEVICE, Tcti::Mssim => MSSIM, Tcti::Tabrmd => TABRMD, }; let tcti_name_conf = CString::new(tcti_name_conf).expect("Failed conversion to CString"); // should never panic let ret = Tss2_TctiLdr_Initialize(tcti_name_conf.as_ptr(), &mut tcti_context); let ret = Error::from_tss_rc(ret); if !ret.is_success() { error!("Error when creating a TCTI context: {}.", ret); return Err(ret); } let mut tcti_context = Some(MBox::from_raw(tcti_context)); let ret = Esys_Initialize( &mut esys_context, tcti_context.as_mut().unwrap().as_mut_ptr(), // will not panic as per how tcti_context is initialised null_mut(), ); let ret = Error::from_tss_rc(ret); if ret.is_success() { let esys_context = Some(MBox::from_raw(esys_context)); let mut context = Context { esys_context, sessions: NO_SESSIONS, tcti_context, open_handles: HashSet::new(), }; let session = context.start_auth_session( NO_SESSIONS, ESYS_TR_NONE, ESYS_TR_NONE, &[], TPM2_SE_HMAC, utils::TpmtSymDefBuilder::aes_256_cfb(), TPM2_ALG_SHA256, )?; let session_attr = TpmaSession::new() .with_flag(TPMA_SESSION_DECRYPT) .with_flag(TPMA_SESSION_ENCRYPT); context.set_session_attr(session, session_attr)?; context.sessions = (session, ESYS_TR_NONE, ESYS_TR_NONE); Ok(context) } else { error!("Error when creating a new context: {}.", ret); Err(ret) } } /// Start new authentication session and return the handle. /// /// The caller nonce is passed as a slice and converted by the method in a TSS digest /// structure. /// /// # Constraints /// * nonce must be at most 64 elements long /// /// # Errors /// * if the `nonce` is larger than allowed, a `WrongSizeParam` wrapper error is returned // TODO: Fix when compacting the arguments into a struct #[allow(clippy::too_many_arguments)] pub fn start_auth_session( &mut self, non_auth_sessions: (ESYS_TR, ESYS_TR, ESYS_TR), tpm_key: ESYS_TR, bind: ESYS_TR, nonce: &[u8], session_type: TPM2_SE, symmetric: TPMT_SYM_DEF, auth_hash: TPMI_ALG_HASH, ) -> Result<ESYS_TR> { let nonce_caller = wrap_buffer!(nonce, TPM2B_NONCE, 64); let mut sess = ESYS_TR_NONE; let ret = unsafe { Esys_StartAuthSession( self.mut_context(), tpm_key, bind, non_auth_sessions.0, non_auth_sessions.1, non_auth_sessions.2, if nonce.is_empty() { null() } else { &nonce_caller }, session_type, &symmetric, auth_hash, &mut sess, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let _ = self.open_handles.insert(sess); Ok(sess) } else { error!("Error when creating a session: {}.", ret); Err(ret) } } pub fn set_sessions(&mut self, session_handles: (ESYS_TR, ESYS_TR, ESYS_TR)) { self.sessions = session_handles; } pub fn sessions(&self) -> (ESYS_TR, ESYS_TR, ESYS_TR) { self.sessions } /// Create a primary key and return the handle. /// /// The authentication value, initial data, outside info and creation PCRs are passed as slices /// which are then converted by the method into TSS native structures. /// /// # Constraints /// * `outside_info` must be at most 64 elements long /// * `creation_pcrs` must be at most 16 elements long /// * `auth_value` must be at most 64 elements long /// * `initial_data` must be at most 256 elements long /// /// # Errors /// * if either of the slices is larger than the maximum size of the native objects, a /// `WrongParamSize` wrapper error is returned // TODO: Fix when compacting the arguments into a struct #[allow(clippy::too_many_arguments)] pub fn create_primary_key( &mut self, primary_handle: ESYS_TR, public: &TPM2B_PUBLIC, auth_value: &[u8], initial_data: &[u8], outside_info: &[u8], creation_pcrs: &[TPMS_PCR_SELECTION], ) -> Result<ESYS_TR> { let sensitive_create = TPM2B_SENSITIVE_CREATE { size: std::mem::size_of::<TPMS_SENSITIVE_CREATE>() .try_into() .unwrap(), // will not fail on targets of at least 16 bits sensitive: TPMS_SENSITIVE_CREATE { userAuth: wrap_buffer!(auth_value, TPM2B_AUTH, 64), data: wrap_buffer!(initial_data, TPM2B_SENSITIVE_DATA, 256), }, }; let outside_info = wrap_buffer!(outside_info, TPM2B_DATA, 64); if creation_pcrs.len() > 16 { return Err(Error::local_error(ErrorKind::WrongParamSize)); } let mut creation_pcrs_buffer = [Default::default(); 16]; creation_pcrs_buffer[..creation_pcrs.len()] .clone_from_slice(&creation_pcrs[..creation_pcrs.len()]); let creation_pcrs = TPML_PCR_SELECTION { count: creation_pcrs.len().try_into().unwrap(), // will not fail given the len checks above pcrSelections: creation_pcrs_buffer, }; let mut outpublic = null_mut(); let mut creation_data = null_mut(); let mut creation_hash = null_mut(); let mut creation_ticket = null_mut(); let mut prim_key_handle = ESYS_TR_NONE; let ret = unsafe { Esys_CreatePrimary( self.mut_context(), primary_handle, self.sessions.0, self.sessions.1, self.sessions.2, &sensitive_create, public, &outside_info, &creation_pcrs, &mut prim_key_handle, &mut outpublic, &mut creation_data, &mut creation_hash, &mut creation_ticket, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { unsafe { let _ = MBox::from_raw(outpublic); let _ = MBox::from_raw(creation_data); let _ = MBox::from_raw(creation_hash); let _ = MBox::from_raw(creation_ticket); } let _ = self.open_handles.insert(prim_key_handle); Ok(prim_key_handle) } else { error!("Error in creating primary key: {}.", ret); Err(ret) } } /// Create a key and return the handle. /// /// The authentication value, initial data, outside info and creation PCRs are passed as slices /// which are then converted by the method into TSS native structures. /// /// # Constraints /// * `outside_info` must be at most 64 elements long /// * `creation_pcrs` must be at most 16 elements long /// * `auth_value` must be at most 64 elements long /// * `initial_data` must be at most 256 elements long /// /// # Errors /// * if either of the slices is larger than the maximum size of the native objects, a /// `WrongParamSize` wrapper error is returned // TODO: Fix when compacting the arguments into a struct #[allow(clippy::too_many_arguments)] pub fn create_key( &mut self, parent_handle: ESYS_TR, public: &TPM2B_PUBLIC, auth_value: &[u8], initial_data: &[u8], outside_info: &[u8], creation_pcrs: &[TPMS_PCR_SELECTION], ) -> Result<(TPM2B_PRIVATE, TPM2B_PUBLIC)> { let sensitive_create = TPM2B_SENSITIVE_CREATE { size: std::mem::size_of::<TPMS_SENSITIVE_CREATE>() .try_into() .unwrap(), // will not fail on targets of at least 16 bits sensitive: TPMS_SENSITIVE_CREATE { userAuth: wrap_buffer!(auth_value, TPM2B_AUTH, 64), data: wrap_buffer!(initial_data, TPM2B_SENSITIVE_DATA, 256), }, }; let outside_info = wrap_buffer!(outside_info, TPM2B_DATA, 64); if creation_pcrs.len() > 16 { return Err(Error::local_error(ErrorKind::WrongParamSize)); } let mut creation_pcrs_buffer = [Default::default(); 16]; creation_pcrs_buffer[..creation_pcrs.len()] .clone_from_slice(&creation_pcrs[..creation_pcrs.len()]); let creation_pcrs = TPML_PCR_SELECTION { count: creation_pcrs.len().try_into().unwrap(), // will not fail given the len checks above pcrSelections: creation_pcrs_buffer, }; let mut outpublic = null_mut(); let mut outprivate = null_mut(); let mut creation_data = null_mut(); let mut digest = null_mut(); let mut creation = null_mut(); let ret = unsafe { Esys_Create( self.mut_context(), parent_handle, self.sessions.0, self.sessions.1, self.sessions.2, &sensitive_create, public, &outside_info, &creation_pcrs, &mut outprivate, &mut outpublic, &mut creation_data, &mut digest, &mut creation, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let outprivate = unsafe { MBox::from_raw(outprivate) }; let outpublic = unsafe { MBox::from_raw(outpublic) }; unsafe { let _ = MBox::from_raw(creation_data); let _ = MBox::from_raw(digest); let _ = MBox::from_raw(creation); } Ok((*outprivate, *outpublic)) } else { error!("Error in creating derived key: {}.", ret); Err(ret) } } /// Load a previously generated key back into the TPM and return its new handle. pub fn load( &mut self, parent_handle: ESYS_TR, private: TPM2B_PRIVATE, public: TPM2B_PUBLIC, ) -> Result<ESYS_TR> { let mut handle = ESYS_TR_NONE; let ret = unsafe { Esys_Load( self.mut_context(), parent_handle, self.sessions.0, self.sessions.1, self.sessions.2, &private, &public, &mut handle, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let _ = self.open_handles.insert(handle); Ok(handle) } else { error!("Error in loading: {}.", ret); Err(ret) } } /// Sign a digest with a key present in the TPM and return the signature. /// /// The digest is passed as a slice, converted by the method to a TSS digest structure. /// /// # Constraints /// * `digest` must be at most 64 elements long /// /// # Errors /// * if the digest provided is too long, a `WrongParamSize` wrapper error will be returned pub fn sign( &mut self, key_handle: ESYS_TR, digest: &[u8], scheme: TPMT_SIG_SCHEME, validation: &TPMT_TK_HASHCHECK, ) -> Result<Signature> { let mut signature = null_mut(); let digest = wrap_buffer!(digest, TPM2B_DIGEST, 64); let ret = unsafe { Esys_Sign( self.mut_context(), key_handle, self.sessions.0, self.sessions.1, self.sessions.2, &digest, &scheme, validation, &mut signature, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let signature = unsafe { MBox::from_raw(signature) }; Ok(unsafe { Signature::try_from(*signature)? }) } else { error!("Error in loading: {}.", ret); Err(ret) } } /// Verify if a signature was generated by signing a given digest with a key in the TPM. /// /// The digest is passed as a sliice and converted by the method to a TSS digest structure. /// /// # Constraints /// * `digest` must be at most 64 elements long /// /// # Errors /// * if the digest provided is too long, a `WrongParamSize` wrapper error will be returned pub fn verify_signature( &mut self, key_handle: ESYS_TR, digest: &[u8], signature: &TPMT_SIGNATURE, ) -> Result<TPMT_TK_VERIFIED> { let mut validation = null_mut(); let digest = wrap_buffer!(digest, TPM2B_DIGEST, 64); let ret = unsafe { Esys_VerifySignature( self.mut_context(), key_handle, self.sessions.0, self.sessions.1, self.sessions.2, &digest, signature, &mut validation, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let validation = unsafe { MBox::from_raw(validation) }; Ok(*validation) } else { error!("Error in loading: {}.", ret); Err(ret) } } /// Load an external key into the TPM and return its new handle. pub fn load_external( &mut self, private: &TPM2B_SENSITIVE, public: &TPM2B_PUBLIC, hierarchy: TPMI_RH_HIERARCHY, ) -> Result<ESYS_TR> { let mut key_handle = ESYS_TR_NONE; let ret = unsafe { Esys_LoadExternal( self.mut_context(), self.sessions.0, self.sessions.1, self.sessions.2, private, public, hierarchy, &mut key_handle, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let _ = self.open_handles.insert(key_handle); Ok(key_handle) } else { error!("Error in loading: {}.", ret); Err(ret) } } /// Load the public part of an external key and return its new handle. pub fn load_external_public( &mut self, public: &TPM2B_PUBLIC, hierarchy: TPMI_RH_HIERARCHY, ) -> Result<ESYS_TR> { let mut key_handle = ESYS_TR_NONE; let ret = unsafe { Esys_LoadExternal( self.mut_context(), self.sessions.0, self.sessions.1, self.sessions.2, null(), public, hierarchy, &mut key_handle, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let _ = self.open_handles.insert(key_handle); Ok(key_handle) } else { error!("Error in loading: {}.", ret); Err(ret) } } /// Read the public part of a key currently in the TPM and return it. pub fn read_public(&mut self, key_handle: ESYS_TR) -> Result<TPM2B_PUBLIC> { let mut public = null_mut(); let mut name = null_mut(); let mut qualified_name = null_mut(); let ret = unsafe { Esys_ReadPublic( self.mut_context(), key_handle, self.sessions.0, self.sessions.1, self.sessions.2, &mut public, &mut name, &mut qualified_name, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { unsafe { let _ = MBox::from_raw(name); let _ = MBox::from_raw(qualified_name); } let public = unsafe { MBox::<TPM2B_PUBLIC>::from_raw(public) }; Ok(*public) } else { error!("Error in loading: {}.", ret); Err(ret) } } /// Flush the context of an object from the TPM. pub fn flush_context(&mut self, handle: ESYS_TR) -> Result<()> { let ret = unsafe { Esys_FlushContext(self.mut_context(), handle) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let _ = self.open_handles.remove(&handle); Ok(()) } else { error!("Error in flushing context: {}.", ret); Err(ret) } } /// Save the context of an object from the TPM and return it. /// /// # Errors /// * if conversion from `TPMS_CONTEXT` to `TpmsContext` fails, a `WrongParamSize` error will /// be returned pub fn context_save(&mut self, handle: ESYS_TR) -> Result<TpmsContext> { let mut context = null_mut(); let ret = unsafe { Esys_ContextSave(self.mut_context(), handle, &mut context) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let context = unsafe { MBox::<TPMS_CONTEXT>::from_raw(context) }; Ok((*context).try_into()?) } else { error!("Error in saving context: {}.", ret); Err(ret) } } /// Load a previously saved context into the TPM and return the object handle. /// /// # Errors /// * if conversion from `TpmsContext` to the native `TPMS_CONTEXT` fails, a `WrongParamSize` /// error will be returned pub fn context_load(&mut self, context: TpmsContext) -> Result<ESYS_TR> { let mut handle = ESYS_TR_NONE; let ret = unsafe { Esys_ContextLoad( self.mut_context(), &TPMS_CONTEXT::try_from(context)?, &mut handle, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let _ = self.open_handles.insert(handle); Ok(handle) } else { error!("Error in loading context: {}.", ret); Err(ret) } } // TODO: Should we really keep `num_bytes` as `u16`? /// Get a number of random bytes from the TPM and return them. /// /// # Errors /// * if converting `num_bytes` to `u16` fails, a `WrongParamSize` will be returned pub fn get_random(&mut self, num_bytes: usize) -> Result<Vec<u8>> { let mut buffer = null_mut(); let ret = unsafe { Esys_GetRandom( self.mut_context(), self.sessions.0, self.sessions.1, self.sessions.2, num_bytes .try_into() .or_else(|_| Err(Error::local_error(ErrorKind::WrongParamSize)))?, &mut buffer, ) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { let buffer = unsafe { MBox::from_raw(buffer) }; let mut random = buffer.buffer.to_vec(); random.truncate(buffer.size.try_into().unwrap()); // should not panic given the TryInto above Ok(random) } else { error!("Error in flushing context: {}.", ret); Err(ret) } } /// Set the authentication value for a given object handle in the ESYS context. /// /// # Constraints /// * `auth_value` must be at most 64 elements long /// /// # Errors /// * if `auth_value` is larger than the limit, a `WrongParamSize` wrapper error is returned pub fn set_handle_auth(&mut self, handle: ESYS_TR, auth_value: &[u8]) -> Result<()> { let auth = wrap_buffer!(auth_value, TPM2B_AUTH, 64); let ret = unsafe { Esys_TR_SetAuth(self.mut_context(), handle, &auth) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { Ok(()) } else { Err(ret) } } /// Set the given attributes on a given session. pub fn set_session_attr(&mut self, handle: ESYS_TR, attrs: TpmaSession) -> Result<()> { let ret = unsafe { Esys_TRSess_SetAttributes(self.mut_context(), handle, attrs.flags(), attrs.mask()) }; let ret = Error::from_tss_rc(ret); if ret.is_success() { Ok(()) } else { Err(ret) } } /// Returns a mutable reference to the native ESYS context handle. fn mut_context(&mut self) -> *mut ESYS_CONTEXT { self.esys_context.as_mut().unwrap().as_mut_ptr() // will only fail if called from Drop after .take() } } impl Drop for Context { fn drop(&mut self) { info!("Closing context."); // Flush the open handles. self.open_handles.clone().iter().for_each(|handle| { info!("Flushing handle {}", *handle); if let Err(e) = self.flush_context(*handle) { error!("Error when dropping the context: {}.", e); } }); let esys_context = self.esys_context.take().unwrap(); // should not fail based on how the context is initialised/used let tcti_context = self.tcti_context.take().unwrap(); // should not fail based on how the context is initialised/used // Close the TCTI context. unsafe { Tss2_TctiLdr_Finalize(&mut tcti_context.into_raw()) }; // Close the context. unsafe { Esys_Finalize(&mut esys_context.into_raw()) }; info!("Context closed."); } }