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
// Copyright 2021 Contributors to the Parsec project.
// SPDX-License-Identifier: Apache-2.0
use crate::{
constants::CapabilityType,
interface_types::YesNo,
structures::{CapabilityData, PublicParameters},
tss2_esys::{Esys_GetCapability, Esys_TestParms},
Context, Result, ReturnCode,
};
use log::{error, warn};
use std::convert::TryFrom;
use std::ptr::null_mut;
impl Context {
/// Get current capability information about the TPM.
///
/// # Warning
/// - If [CapabilityType::AuthPolicies] is used but the version of the
/// tpm2-tss library used does not have the 'authPolicies' field
/// in the TPMU_CAPABILITIES defined then the call using this method
/// will fail.
///
/// - If [CapabilityType::Act] is used but the the version of the
/// tpm2-tss library used does not have the 'actData' field in the
/// TPMU_CAPABILITIES defined then the call using this method will fail.
///
/// # Example
///
/// ```rust
/// # use tss_esapi::{Context, TctiNameConf};
/// # // Create context
/// # let mut context =
/// # Context::new(
/// # TctiNameConf::from_environment_variable().expect("Failed to get TCTI"),
/// # ).expect("Failed to create Context");
/// #
/// use tss_esapi::constants::CapabilityType;
///
/// let (_capabilities, _more) = context
/// .get_capability(CapabilityType::Algorithms, 0, 80)
/// .expect("Failed to call get_capability");
/// ```
pub fn get_capability(
&mut self,
capability: CapabilityType,
property: u32,
property_count: u32,
) -> Result<(CapabilityData, bool)> {
let mut capability_data_ptr = null_mut();
let mut more_data = YesNo::No.into();
ReturnCode::ensure_success(
unsafe {
Esys_GetCapability(
self.mut_context(),
self.optional_session_1(),
self.optional_session_2(),
self.optional_session_3(),
capability.into(),
property,
property_count,
&mut more_data,
&mut capability_data_ptr,
)
},
|ret| {
error!("Error when getting capabilities: {:#010X}", ret);
},
)?;
Ok((
CapabilityData::try_from(Context::ffi_data_to_owned(capability_data_ptr))?,
YesNo::try_from(more_data)?.into(),
))
}
/// Test if the given parameters are supported by the TPM.
///
/// # Errors
/// * if any of the public parameters is not compatible with the TPM,
/// an `Err` containing the specific unmarshalling error will be returned.
pub fn test_parms(&mut self, public_parmeters: PublicParameters) -> Result<()> {
ReturnCode::ensure_success(
unsafe {
Esys_TestParms(
self.mut_context(),
self.optional_session_1(),
self.optional_session_2(),
self.optional_session_3(),
&public_parmeters.into(),
)
},
|ret| {
warn!(
"Parameters under test could not be unmarshalled: {:#010X}",
ret
);
},
)
}
}