tpm2_protocol/data/enum/
rc.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2// Copyright (c) 2025 Opinsys Oy
3// Copyright (c) 2024-2025 Jarkko Sakkinen
4
5use crate::{tpm_enum, TpmProtocolError};
6use core::{
7    convert::TryFrom,
8    fmt::{self, Debug, Display, Formatter},
9};
10
11pub const TPM_RC_VER1: u32 = 0x0100;
12pub const TPM_RC_FMT1: u32 = 0x0080;
13pub const TPM_RC_WARN: u32 = 0x0900;
14pub const TPM_RC_P_BIT: u32 = 1 << 6;
15pub const TPM_RC_N_SHIFT: u8 = 8;
16pub const TPM_RC_FMT1_ERROR_MASK: u32 = 0x003F;
17
18const MAX_HANDLE_INDEX: u8 = 7;
19const SESSION_INDEX_OFFSET: u8 = 8;
20
21#[derive(Debug, PartialEq, Eq, Copy, Clone)]
22pub enum TpmRcIndex {
23    Parameter(u8),
24    Handle(u8),
25    Session(u8),
26}
27
28impl Display for TpmRcIndex {
29    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
30        match self {
31            Self::Parameter(i) => write!(f, "parameter[{i}]"),
32            Self::Handle(i) => write!(f, "handle[{i}]"),
33            Self::Session(i) => write!(f, "session[{i}]"),
34        }
35    }
36}
37
38tpm_enum! {
39    #[derive(Debug, PartialEq, Eq, Copy, Clone)]
40    #[allow(clippy::upper_case_acronyms)]
41    pub enum TpmRcBase(u32) {
42        (Success, 0x0000, "TPM_RC_SUCCESS"),
43        (BadTag, 0x001E, "TPM_RC_BAD_TAG"),
44        (Initialize, TPM_RC_VER1, "TPM_RC_INITIALIZE"),
45        (Failure, TPM_RC_VER1 | 0x001, "TPM_RC_FAILURE"),
46        (Sequence, TPM_RC_VER1 | 0x003, "TPM_RC_SEQUENCE"),
47        (Private, TPM_RC_VER1 | 0x00B, "TPM_RC_PRIVATE"),
48        (Hmac, TPM_RC_VER1 | 0x019, "TPM_RC_HMAC"),
49        (Disabled, TPM_RC_VER1 | 0x020, "TPM_RC_DISABLED"),
50        (Exclusive, TPM_RC_VER1 | 0x021, "TPM_RC_EXCLUSIVE"),
51        (AuthType, TPM_RC_VER1 | 0x024, "TPM_RC_AUTH_TYPE"),
52        (AuthMissing, TPM_RC_VER1 | 0x025, "TPM_RC_AUTH_MISSING"),
53        (Policy, TPM_RC_VER1 | 0x026, "TPM_RC_POLICY"),
54        (Pcr, TPM_RC_VER1 | 0x027, "TPM_RC_PCR"),
55        (PcrChanged, TPM_RC_VER1 | 0x028, "TPM_RC_PCR_CHANGED"),
56        (Upgrade, TPM_RC_VER1 | 0x02D, "TPM_RC_UPGRADE"),
57        (TooManyContexts, TPM_RC_VER1 | 0x02E, "TPM_RC_TOO_MANY_CONTEXTS"),
58        (AuthUnavailable, TPM_RC_VER1 | 0x02F, "TPM_RC_AUTH_UNAVAILABLE"),
59        (Reboot, TPM_RC_VER1 | 0x030, "TPM_RC_REBOOT"),
60        (Unbalanced, TPM_RC_VER1 | 0x031, "TPM_RC_UNBALANCED"),
61        (CommandSize, TPM_RC_VER1 | 0x042, "TPM_RC_COMMAND_SIZE"),
62        (CommandCode, TPM_RC_VER1 | 0x043, "TPM_RC_COMMAND_CODE"),
63        (AuthSize, TPM_RC_VER1 | 0x044, "TPM_RC_AUTHSIZE"),
64        (AuthContext, TPM_RC_VER1 | 0x045, "TPM_RC_AUTH_CONTEXT"),
65        (NvRange, TPM_RC_VER1 | 0x046, "TPM_RC_NV_RANGE"),
66        (NvSize, TPM_RC_VER1 | 0x047, "TPM_RC_NV_SIZE"),
67        (NvLocked, TPM_RC_VER1 | 0x048, "TPM_RC_NV_LOCKED"),
68        (NvAuthorization, TPM_RC_VER1 | 0x049, "TPM_RC_NV_AUTHORIZATION"),
69        (NvUninitialized, TPM_RC_VER1 | 0x04A, "TPM_RC_NV_UNINITIALIZED"),
70        (NvSpace, TPM_RC_VER1 | 0x04B, "TPM_RC_NV_SPACE"),
71        (NvDefined, TPM_RC_VER1 | 0x04C, "TPM_RC_NV_DEFINED"),
72        (BadContext, TPM_RC_VER1 | 0x050, "TPM_RC_BAD_CONTEXT"),
73        (CpHash, TPM_RC_VER1 | 0x051, "TPM_RC_CPHASH"),
74        (Parent, TPM_RC_VER1 | 0x052, "TPM_RC_PARENT"),
75        (NeedsTest, TPM_RC_VER1 | 0x053, "TPM_RC_NEEDS_TEST"),
76        (NoResult, TPM_RC_VER1 | 0x054, "TPM_RC_NO_RESULT"),
77        (Sensitive, TPM_RC_VER1 | 0x055, "TPM_RC_SENSITIVE"),
78        (ReadOnly, TPM_RC_VER1 | 0x056, "TPM_RC_READ_ONLY"),
79        (Asymmetric, TPM_RC_FMT1 | 0x001, "TPM_RC_ASYMMETRIC"),
80        (Attributes, TPM_RC_FMT1 | 0x002, "TPM_RC_ATTRIBUTES"),
81        (Hash, TPM_RC_FMT1 | 0x003, "TPM_RC_HASH"),
82        (Value, TPM_RC_FMT1 | 0x004, "TPM_RC_VALUE"),
83        (Hierarchy, TPM_RC_FMT1 | 0x005, "TPM_RC_HIERARCHY"),
84        (KeySize, TPM_RC_FMT1 | 0x007, "TPM_RC_KEY_SIZE"),
85        (Mgf, TPM_RC_FMT1 | 0x008, "TPM_RC_MGF"),
86        (Mode, TPM_RC_FMT1 | 0x009, "TPM_RC_MODE"),
87        (Type, TPM_RC_FMT1 | 0x00A, "TPM_RC_TYPE"),
88        (Handle, TPM_RC_FMT1 | 0x00B, "TPM_RC_HANDLE"),
89        (Kdf, TPM_RC_FMT1 | 0x00C, "TPM_RC_KDF"),
90        (Range, TPM_RC_FMT1 | 0x00D, "TPM_RC_RANGE"),
91        (AuthFail, TPM_RC_FMT1 | 0x00E, "TPM_RC_AUTH_FAIL"),
92        (Nonce, TPM_RC_FMT1 | 0x00F, "TPM_RC_NONCE"),
93        (Pp, TPM_RC_FMT1 | 0x010, "TPM_RC_PP"),
94        (Scheme, TPM_RC_FMT1 | 0x012, "TPM_RC_SCHEME"),
95        (Size, TPM_RC_FMT1 | 0x015, "TPM_RC_SIZE"),
96        (Symmetric, TPM_RC_FMT1 | 0x016, "TPM_RC_SYMMETRIC"),
97        (Tag, TPM_RC_FMT1 | 0x017, "TPM_RC_TAG"),
98        (Selector, TPM_RC_FMT1 | 0x018, "TPM_RC_SELECTOR"),
99        (Insufficient, TPM_RC_FMT1 | 0x01A, "TPM_RC_INSUFFICIENT"),
100        (Signature, TPM_RC_FMT1 | 0x01B, "TPM_RC_SIGNATURE"),
101        (Key, TPM_RC_FMT1 | 0x01C, "TPM_RC_KEY"),
102        (PolicyFail, TPM_RC_FMT1 | 0x01D, "TPM_RC_POLICY_FAIL"),
103        (Integrity, TPM_RC_FMT1 | 0x01F, "TPM_RC_INTEGRITY"),
104        (Ticket, TPM_RC_FMT1 | 0x020, "TPM_RC_TICKET"),
105        (ReservedBits, TPM_RC_FMT1 | 0x021, "TPM_RC_RESERVED_BITS"),
106        (BadAuth, TPM_RC_FMT1 | 0x022, "TPM_RC_BAD_AUTH"),
107        (Expired, TPM_RC_FMT1 | 0x023, "TPM_RC_EXPIRED"),
108        (PolicyCc, TPM_RC_FMT1 | 0x024, "TPM_RC_POLICY_CC"),
109        (Binding, TPM_RC_FMT1 | 0x025, "TPM_RC_BINDING"),
110        (Curve, TPM_RC_FMT1 | 0x026, "TPM_RC_CURVE"),
111        (EccPoint, TPM_RC_FMT1 | 0x027, "TPM_RC_ECC_POINT"),
112        (FwLimited, TPM_RC_FMT1 | 0x028, "TPM_RC_FW_LIMITED"),
113        (SvnLimited, TPM_RC_FMT1 | 0x029, "TPM_RC_SVN_LIMITED"),
114        (Channel, TPM_RC_FMT1 | 0x030, "TPM_RC_CHANNEL"),
115        (ChannelKey, TPM_RC_FMT1 | 0x031, "TPM_RC_CHANNEL_KEY"),
116        (ContextGap, TPM_RC_WARN | 0x001, "TPM_RC_CONTEXT_GAP"),
117        (ObjectMemory, TPM_RC_WARN | 0x002, "TPM_RC_OBJECT_MEMORY"),
118        (SessionMemory, TPM_RC_WARN | 0x003, "TPM_RC_SESSION_MEMORY"),
119        (Memory, TPM_RC_WARN | 0x004, "TPM_RC_MEMORY"),
120        (SessionHandles, TPM_RC_WARN | 0x005, "TPM_RC_SESSION_HANDLES"),
121        (ObjectHandles, TPM_RC_WARN | 0x006, "TPM_RC_OBJECT_HANDLES"),
122        (Locality, TPM_RC_WARN | 0x007, "TPM_RC_LOCALITY"),
123        (Yielded, TPM_RC_WARN | 0x008, "TPM_RC_YIELDED"),
124        (Canceled, TPM_RC_WARN | 0x009, "TPM_RC_CANCELED"),
125        (Testing, TPM_RC_WARN | 0x00A, "TPM_RC_TESTING"),
126        (ReferenceH0, TPM_RC_WARN | 0x010, "TPM_RC_REFERENCE_H0"),
127        (ReferenceH1, TPM_RC_WARN | 0x011, "TPM_RC_REFERENCE_H1"),
128        (ReferenceH2, TPM_RC_WARN | 0x012, "TPM_RC_REFERENCE_H2"),
129        (ReferenceH3, TPM_RC_WARN | 0x013, "TPM_RC_REFERENCE_H3"),
130        (ReferenceH4, TPM_RC_WARN | 0x014, "TPM_RC_REFERENCE_H4"),
131        (ReferenceH5, TPM_RC_WARN | 0x015, "TPM_RC_REFERENCE_H5"),
132        (ReferenceH6, TPM_RC_WARN | 0x016, "TPM_RC_REFERENCE_H6"),
133        (ReferenceS0, TPM_RC_WARN | 0x018, "TPM_RC_REFERENCE_S0"),
134        (ReferenceS1, TPM_RC_WARN | 0x019, "TPM_RC_REFERENCE_S1"),
135        (ReferenceS2, TPM_RC_WARN | 0x01A, "TPM_RC_REFERENCE_S2"),
136        (ReferenceS3, TPM_RC_WARN | 0x01B, "TPM_RC_REFERENCE_S3"),
137        (ReferenceS4, TPM_RC_WARN | 0x01C, "TPM_RC_REFERENCE_S4"),
138        (ReferenceS5, TPM_RC_WARN | 0x01D, "TPM_RC_REFERENCE_S5"),
139        (ReferenceS6, TPM_RC_WARN | 0x01E, "TPM_RC_REFERENCE_S6"),
140        (NvRate, TPM_RC_WARN | 0x020, "TPM_RC_NV_RATE"),
141        (Lockout, TPM_RC_WARN | 0x021, "TPM_RC_LOCKOUT"),
142        (Retry, TPM_RC_WARN | 0x022, "TPM_RC_RETRY"),
143        (NvUnavailable, TPM_RC_WARN | 0x023, "TPM_RC_NV_UNAVAILABLE"),
144        (NotUsed, 0xFFFF_FFFF, "TPM_RC_NOT_USED"),
145    }
146}
147
148/// A TPM 2.0 response code with a Format 1 structure.
149#[derive(Debug, PartialEq, Eq, Copy, Clone)]
150pub struct TpmRcFmt1 {
151    pub base: TpmRcBase,
152    pub index: Option<TpmRcIndex>,
153}
154
155/// A TPM 2.0 response code.
156#[derive(Debug, PartialEq, Eq, Copy, Clone)]
157pub enum TpmRc {
158    Fmt0(TpmRcBase),
159    Fmt1(TpmRcFmt1),
160    Warn(TpmRcBase),
161}
162
163impl TpmRc {
164    /// Returns the raw `u32` value of the response code.
165    #[must_use]
166    pub fn value(self) -> u32 {
167        match self {
168            Self::Fmt0(base) | Self::Warn(base) => base as u32,
169            Self::Fmt1(fmt1) => {
170                let mut value = fmt1.base as u32;
171                if let Some(index) = fmt1.index {
172                    let (is_parameter, num) = match index {
173                        TpmRcIndex::Parameter(n) => (true, n),
174                        TpmRcIndex::Handle(n) => (false, n),
175                        TpmRcIndex::Session(n) => (false, n + SESSION_INDEX_OFFSET),
176                    };
177
178                    if is_parameter {
179                        value |= TPM_RC_P_BIT;
180                    }
181                    value |= u32::from(num) << TPM_RC_N_SHIFT;
182                }
183                value
184            }
185        }
186    }
187
188    /// Returns the underlying `TpmRcBase` for any `TpmRc` variant.
189    #[must_use]
190    pub fn base(&self) -> TpmRcBase {
191        match self {
192            TpmRc::Fmt0(base) | TpmRc::Warn(base) => *base,
193            TpmRc::Fmt1(fmt1) => fmt1.base,
194        }
195    }
196}
197
198impl crate::TpmSized for TpmRc {
199    const SIZE: usize = core::mem::size_of::<u32>();
200    fn len(&self) -> usize {
201        Self::SIZE
202    }
203}
204
205impl crate::TpmMarshal for TpmRc {
206    fn marshal(&self, writer: &mut crate::TpmWriter) -> crate::TpmResult<()> {
207        self.value().marshal(writer)
208    }
209}
210
211impl crate::TpmUnmarshal for TpmRc {
212    fn unmarshal(buf: &[u8]) -> crate::TpmResult<(Self, &[u8])> {
213        let (val, remainder) = u32::unmarshal(buf)?;
214        let rc = Self::try_from(val)?;
215        Ok((rc, remainder))
216    }
217}
218
219impl TryFrom<u32> for TpmRc {
220    type Error = TpmProtocolError;
221    fn try_from(value: u32) -> Result<Self, Self::Error> {
222        let base_code = if (value & TPM_RC_FMT1) != 0 {
223            TPM_RC_FMT1 | (value & TPM_RC_FMT1_ERROR_MASK)
224        } else {
225            value
226        };
227
228        let base = TpmRcBase::try_from(base_code)?;
229
230        if (value & TPM_RC_WARN) == TPM_RC_WARN {
231            Ok(Self::Warn(base))
232        } else if (value & TPM_RC_FMT1) != 0 {
233            let is_parameter = (value & TPM_RC_P_BIT) != 0;
234            let n = ((value >> TPM_RC_N_SHIFT) & 0b1111) as u8;
235
236            let index = match (is_parameter, n) {
237                (_, 0) => None,
238                (true, num) => Some(TpmRcIndex::Parameter(num)),
239                (false, num @ 1..=MAX_HANDLE_INDEX) => Some(TpmRcIndex::Handle(num)),
240                (false, num) => Some(TpmRcIndex::Session(num - SESSION_INDEX_OFFSET)),
241            };
242            Ok(Self::Fmt1(TpmRcFmt1 { base, index }))
243        } else {
244            Ok(Self::Fmt0(base))
245        }
246    }
247}
248
249impl From<TpmRcBase> for TpmRc {
250    fn from(base: TpmRcBase) -> Self {
251        Self::Fmt0(base)
252    }
253}
254
255impl Display for TpmRc {
256    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
257        match self {
258            Self::Fmt0(base) | Self::Warn(base) => write!(f, "{base}"),
259            Self::Fmt1(fmt1) => {
260                if let Some(index) = fmt1.index {
261                    write!(f, "[{}, {}]", fmt1.base, index)
262                } else {
263                    write!(f, "{}", fmt1.base)
264                }
265            }
266        }
267    }
268}
tpm2_protocol/data/enum/rc.rs

tpm2_protocol/data/enum/
rc.rs
