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
// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2025 Opinsys Oy
// Copyright (c) 2024-2025 Jarkko Sakkinen
#[macro_export]
macro_rules! integer {
($name:ident, $raw:ty, $bytes:expr) => {
#[derive(Default, Clone, Copy, PartialEq, Eq, Hash)]
#[repr(transparent)]
pub struct $name([u8; $bytes]);
impl $name {
#[must_use]
pub const fn new(value: $raw) -> Self {
Self(value.to_be_bytes())
}
#[must_use]
pub const fn value(self) -> $raw {
<$raw>::from_be_bytes(self.0)
}
#[must_use]
pub const fn get(&self) -> $raw {
<$raw>::from_be_bytes(self.0)
}
pub const fn set(&mut self, value: $raw) {
self.0 = value.to_be_bytes();
}
#[must_use]
pub const fn as_bytes(&self) -> &[u8; $bytes] {
&self.0
}
#[must_use]
pub fn as_bytes_mut(&mut self) -> &mut [u8; $bytes] {
&mut self.0
}
#[must_use]
pub fn to_be_bytes(self) -> [u8; $bytes] {
self.0
}
#[must_use]
pub const fn from_be_bytes(bytes: [u8; $bytes]) -> Self {
Self(bytes)
}
/// Casts a byte slice into a TPM integer wire view.
///
/// # Errors
///
/// Returns [`UnexpectedEnd`](crate::TpmProtocolError::UnexpectedEnd) when
/// `buf` is smaller than this integer's wire size.
/// Returns [`TrailingData`](crate::TpmProtocolError::TrailingData) when
/// `buf` is larger than this integer's wire size.
pub fn cast(buf: &[u8]) -> $crate::TpmResult<&Self> {
let _ = $crate::TpmWireBytes::<$bytes>::cast(buf)?;
// SAFETY: `TpmWireBytes::<$bytes>::cast` validated the exact
// byte length required by this transparent integer view.
Ok(unsafe { Self::cast_unchecked(buf) })
}
/// Casts a byte slice into a TPM integer wire view without validation.
///
/// # Safety
///
/// The caller must ensure that `buf.len()` equals this integer's
/// wire size and that any containing protocol structure has been
/// validated as needed.
#[must_use]
pub unsafe fn cast_unchecked(buf: &[u8]) -> &Self {
let ptr = buf.as_ptr().cast::<Self>();
// SAFETY: `$name` is `repr(transparent)` over `[u8; $bytes]`.
// The caller guarantees exact size.
unsafe { &*ptr }
}
/// Casts a mutable byte slice into a mutable TPM integer wire view.
///
/// # Errors
///
/// Returns [`UnexpectedEnd`](crate::TpmProtocolError::UnexpectedEnd) when
/// `buf` is smaller than this integer's wire size.
/// Returns [`TrailingData`](crate::TpmProtocolError::TrailingData) when
/// `buf` is larger than this integer's wire size.
pub fn cast_mut(buf: &mut [u8]) -> $crate::TpmResult<&mut Self> {
let _ = $crate::TpmWireBytes::<$bytes>::cast_mut(buf)?;
// SAFETY: `TpmWireBytes::<$bytes>::cast_mut` validated the exact
// byte length required by this transparent integer view.
Ok(unsafe { Self::cast_mut_unchecked(buf) })
}
/// Casts a mutable byte slice into a mutable TPM integer wire view without validation.
///
/// # Safety
///
/// The caller must ensure that `buf.len()` equals this integer's
/// wire size and that any containing protocol structure has been
/// validated as needed. The returned reference inherits the
/// exclusive access represented by `buf`.
#[must_use]
pub unsafe fn cast_mut_unchecked(buf: &mut [u8]) -> &mut Self {
let ptr = buf.as_mut_ptr().cast::<Self>();
// SAFETY: `$name` is `repr(transparent)` over `[u8; $bytes]`.
// The caller guarantees exact size.
unsafe { &mut *ptr }
}
}
impl core::fmt::Debug for $name {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
f.debug_tuple(stringify!($name)).field(&self.get()).finish()
}
}
impl core::cmp::PartialOrd for $name {
fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl core::cmp::Ord for $name {
fn cmp(&self, other: &Self) -> core::cmp::Ordering {
self.get().cmp(&other.get())
}
}
impl From<$raw> for $name {
fn from(value: $raw) -> Self {
Self::new(value)
}
}
impl From<$name> for $raw {
fn from(value: $name) -> $raw {
value.value()
}
}
impl core::fmt::Display for $name {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
core::fmt::Display::fmt(&self.get(), f)
}
}
impl core::fmt::LowerHex for $name {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
core::fmt::LowerHex::fmt(&self.get(), f)
}
}
impl core::fmt::UpperHex for $name {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
core::fmt::UpperHex::fmt(&self.get(), f)
}
}
impl $crate::TpmSized for $name {
const SIZE: usize = $bytes;
fn len(&self) -> usize {
Self::SIZE
}
}
impl $crate::TpmMarshal for $name {
fn marshal(&self, writer: &mut $crate::TpmWriter) -> $crate::TpmResult<()> {
writer.write_bytes(self.as_bytes())
}
}
impl $crate::TpmUnmarshal for $name {
fn unmarshal(buf: &[u8]) -> $crate::TpmResult<(Self, &[u8])> {
let size = core::mem::size_of::<$raw>();
let bytes = buf
.get(..size)
.ok_or($crate::TpmProtocolError::UnexpectedEnd)?;
let array = bytes
.try_into()
.map_err(|_| $crate::TpmProtocolError::UnexpectedEnd)?;
let val = Self::from_be_bytes(array);
Ok((val, &buf[size..]))
}
}
impl $crate::TpmCast for $name {
fn cast(buf: &[u8]) -> $crate::TpmResult<&Self> {
Self::cast(buf)
}
unsafe fn cast_unchecked(buf: &[u8]) -> &Self {
// SAFETY: The caller upholds the unchecked cast contract for `$name`.
unsafe { Self::cast_unchecked(buf) }
}
}
impl $crate::TpmCastMut for $name {
fn cast_mut(buf: &mut [u8]) -> $crate::TpmResult<&mut Self> {
Self::cast_mut(buf)
}
unsafe fn cast_mut_unchecked(buf: &mut [u8]) -> &mut Self {
// SAFETY: The caller upholds the unchecked mutable cast contract for `$name`.
unsafe { Self::cast_mut_unchecked(buf) }
}
}
impl TryFrom<usize> for $name
where
$raw: TryFrom<usize>,
{
type Error = <$raw as TryFrom<usize>>::Error;
fn try_from(value: usize) -> Result<Self, Self::Error> {
<$raw>::try_from(value).map(Self::new)
}
}
};
}