Skip to content

Commit c3fb7d6

Browse files
SuperhepperSuperhepper
committed
Renames the items in PcrSelectSize.
When the specification mentions the buffer in which pcr slots are stored it talks about octets. Our own api documentation regarding size_of_select is refering to octets as well so it make no sense that items in the enum had the suffix Byte or Bytes. Signed-off-by: Jesper Brynolf <[email protected]>
1 parent e44b389 commit c3fb7d6

File tree

9 files changed

+50
-50
lines changed

9 files changed

+50
-50
lines changed

‎tss-esapi/src/structures/pcr/select_size.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ use std::convert::TryFrom;
1212
#[derive(FromPrimitive, ToPrimitive, Debug, Copy, Clone, PartialEq, Eq)]
1313
#[repr(u8)]
1414
pub enum PcrSelectSize {
15-
OneByte = 1,
16-
TwoBytes = 2,
17-
ThreeBytes = 3,
18-
FourBytes = 4,
15+
OneOctet = 1,
16+
TwoOctets = 2,
17+
ThreeOctets = 3,
18+
FourOctets = 4,
1919
}
2020

2121
impl PcrSelectSize {
@@ -74,15 +74,15 @@ impl PcrSelectSize {
7474
}
7575
}
7676

77-
/// The default for PcrSelectSize is three bytes.
77+
/// The default for PcrSelectSize is three octets.
7878
/// A value for the sizeofSelect that works
7979
/// on most platforms.
8080
impl Default for PcrSelectSize {
8181
fn default() -> PcrSelectSize {
8282
match TPM2_PCR_SELECT_MAX {
83-
1 => PcrSelectSize::OneByte,
84-
2 => PcrSelectSize::TwoBytes,
85-
_ => PcrSelectSize::ThreeBytes,
83+
1 => PcrSelectSize::OneOctet,
84+
2 => PcrSelectSize::TwoOctets,
85+
_ => PcrSelectSize::ThreeOctets,
8686
}
8787
}
8888
}

‎tss-esapi/src/structures/pcr/slot_collection.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,10 +197,10 @@ impl PcrSlotCollection {
197197
/// pcr slots with regard to the PcrSelectSize
198198
const fn calculate_max_pcr_slots_value(pcr_select_size: PcrSelectSize) -> u32 {
199199
match pcr_select_size {
200-
PcrSelectSize::OneByte => 0x000000FF,
201-
PcrSelectSize::TwoBytes => 0x0000FFFF,
202-
PcrSelectSize::ThreeBytes => 0x00FFFFFF,
203-
PcrSelectSize::FourBytes => 0xFFFFFFFF,
200+
PcrSelectSize::OneOctet => 0x000000FF,
201+
PcrSelectSize::TwoOctets => 0x0000FFFF,
202+
PcrSelectSize::ThreeOctets => 0x00FFFFFF,
203+
PcrSelectSize::FourOctets => 0xFFFFFFFF,
204204
}
205205
}
206206
}

‎tss-esapi/tests/integration_tests/structures_tests/lists_tests/pcr_selection_list_builder_tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ fn test_conversion_of_data_with_invalid_pcr_select_bit_flags() {
147147

148148
assert_eq!(
149149
pcr_selection_list.get_selections()[0].size_of_select(),
150-
PcrSelectSize::ThreeBytes,
150+
PcrSelectSize::ThreeOctets,
151151
"PcrSelection in index 0, in the converted pcr selection list, contained an unexpected 'size of select' value",
152152
);
153153

‎tss-esapi/tests/integration_tests/structures_tests/lists_tests/pcr_selection_list_tests.rs

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use tss_esapi::{
1212
fn from_tpml_retains_order() {
1313
let selection_1 = PcrSelection::create(
1414
HashingAlgorithm::Sha256,
15-
PcrSelectSize::ThreeBytes,
15+
PcrSelectSize::ThreeOctets,
1616
&[PcrSlot::Slot10],
1717
)
1818
.expect("Failed to create PcrSelection 1");
@@ -21,7 +21,7 @@ fn from_tpml_retains_order() {
2121

2222
let selection_2 = PcrSelection::create(
2323
HashingAlgorithm::Sha256,
24-
PcrSelectSize::ThreeBytes,
24+
PcrSelectSize::ThreeOctets,
2525
&[PcrSlot::Slot11],
2626
)
2727
.expect("Failed to create PcrSelection 2");
@@ -30,7 +30,7 @@ fn from_tpml_retains_order() {
3030

3131
let selection_3 = PcrSelection::create(
3232
HashingAlgorithm::Sha1,
33-
PcrSelectSize::ThreeBytes,
33+
PcrSelectSize::ThreeOctets,
3434
&[PcrSlot::Slot16],
3535
)
3636
.expect("Failed to create PcrSelection 3");
@@ -39,7 +39,7 @@ fn from_tpml_retains_order() {
3939

4040
let selection_4 = PcrSelection::create(
4141
HashingAlgorithm::Sha1,
42-
PcrSelectSize::ThreeBytes,
42+
PcrSelectSize::ThreeOctets,
4343
&[PcrSlot::Slot2],
4444
)
4545
.expect("Failed to create PcrSelection 4");
@@ -101,7 +101,7 @@ fn from_tpml_retains_order() {
101101
fn test_subtract() {
102102
let pcr_selection_1 = PcrSelection::create(
103103
HashingAlgorithm::Sha256,
104-
PcrSelectSize::ThreeBytes,
104+
PcrSelectSize::ThreeOctets,
105105
&[PcrSlot::Slot10],
106106
)
107107
.expect("Failed to create PcrSelection 1");
@@ -110,7 +110,7 @@ fn test_subtract() {
110110

111111
let pcr_selection_2 = PcrSelection::create(
112112
HashingAlgorithm::Sha256,
113-
PcrSelectSize::ThreeBytes,
113+
PcrSelectSize::ThreeOctets,
114114
&[PcrSlot::Slot11],
115115
)
116116
.expect("Failed to create PcrSelection 2");
@@ -120,7 +120,7 @@ fn test_subtract() {
120120
let tpms_pcr_selection_3 = TPMS_PCR_SELECTION::try_from(
121121
PcrSelection::create(
122122
HashingAlgorithm::Sha1,
123-
PcrSelectSize::ThreeBytes,
123+
PcrSelectSize::ThreeOctets,
124124
&[PcrSlot::Slot16],
125125
)
126126
.expect("Failed to create PcrSelection 3"),
@@ -130,7 +130,7 @@ fn test_subtract() {
130130
let tpms_pcr_selection_4 = TPMS_PCR_SELECTION::try_from(
131131
PcrSelection::create(
132132
HashingAlgorithm::Sha1,
133-
PcrSelectSize::ThreeBytes,
133+
PcrSelectSize::ThreeOctets,
134134
&[PcrSlot::Slot2],
135135
)
136136
.expect("Failed to create PcrSelection 4"),
@@ -207,7 +207,7 @@ fn test_subtract_overlapping_without_remaining() {
207207
let tpms_pcr_selection_1 = TPMS_PCR_SELECTION::try_from(
208208
PcrSelection::create(
209209
HashingAlgorithm::Sha256,
210-
PcrSelectSize::ThreeBytes,
210+
PcrSelectSize::ThreeOctets,
211211
&[PcrSlot::Slot10],
212212
)
213213
.expect("Failed to create PcrSelection 1"),
@@ -216,7 +216,7 @@ fn test_subtract_overlapping_without_remaining() {
216216
let tpms_pcr_selection_2 = TPMS_PCR_SELECTION::try_from(
217217
PcrSelection::create(
218218
HashingAlgorithm::Sha256,
219-
PcrSelectSize::ThreeBytes,
219+
PcrSelectSize::ThreeOctets,
220220
&[PcrSlot::Slot11],
221221
)
222222
.expect("Failed to create PcrSelection 2"),
@@ -226,7 +226,7 @@ fn test_subtract_overlapping_without_remaining() {
226226
let tpms_pcr_selection_3 = TPMS_PCR_SELECTION::try_from(
227227
PcrSelection::create(
228228
HashingAlgorithm::Sha256,
229-
PcrSelectSize::ThreeBytes,
229+
PcrSelectSize::ThreeOctets,
230230
&[PcrSlot::Slot10, PcrSlot::Slot11],
231231
)
232232
.expect("Failed to create PcrSelection 3"),
@@ -295,7 +295,7 @@ fn test_subtract_overlapping_with_remaining() {
295295
let tpms_pcr_selection_1 = TPMS_PCR_SELECTION::try_from(
296296
PcrSelection::create(
297297
HashingAlgorithm::Sha256,
298-
PcrSelectSize::ThreeBytes,
298+
PcrSelectSize::ThreeOctets,
299299
&[PcrSlot::Slot10],
300300
)
301301
.expect("Failed to create PcrSelection 1"),
@@ -305,7 +305,7 @@ fn test_subtract_overlapping_with_remaining() {
305305
let tpms_pcr_selection_2 = TPMS_PCR_SELECTION::try_from(
306306
PcrSelection::create(
307307
HashingAlgorithm::Sha256,
308-
PcrSelectSize::ThreeBytes,
308+
PcrSelectSize::ThreeOctets,
309309
&[PcrSlot::Slot11],
310310
)
311311
.expect("Failed to create PcrSelection 2"),
@@ -314,7 +314,7 @@ fn test_subtract_overlapping_with_remaining() {
314314

315315
let expected = PcrSelection::create(
316316
HashingAlgorithm::Sha256,
317-
PcrSelectSize::ThreeBytes,
317+
PcrSelectSize::ThreeOctets,
318318
&[PcrSlot::Slot12],
319319
)
320320
.expect("Failed to create PcrSelection 'expected'");
@@ -324,7 +324,7 @@ fn test_subtract_overlapping_with_remaining() {
324324
let tpms_pcr_selection_4 = TPMS_PCR_SELECTION::try_from(
325325
PcrSelection::create(
326326
HashingAlgorithm::Sha256,
327-
PcrSelectSize::ThreeBytes,
327+
PcrSelectSize::ThreeOctets,
328328
&[PcrSlot::Slot10, PcrSlot::Slot11],
329329
)
330330
.expect("Failed to create PcrSelection 4"),
@@ -396,7 +396,7 @@ fn test_subtract_overlapping_with_remaining() {
396396
fn test_invalid_subtraction() {
397397
let pcr_selection_1 = PcrSelection::create(
398398
HashingAlgorithm::Sha256,
399-
PcrSelectSize::ThreeBytes,
399+
PcrSelectSize::ThreeOctets,
400400
&[PcrSlot::Slot10],
401401
)
402402
.expect("Failed to create PcrSelection 1");
@@ -405,7 +405,7 @@ fn test_invalid_subtraction() {
405405

406406
let pcr_selection_2 = PcrSelection::create(
407407
HashingAlgorithm::Sha256,
408-
PcrSelectSize::ThreeBytes,
408+
PcrSelectSize::ThreeOctets,
409409
&[PcrSlot::Slot11],
410410
)
411411
.expect("Failed to create PcrSelection 2");
@@ -415,7 +415,7 @@ fn test_invalid_subtraction() {
415415
let tpms_pcr_selection_3 = TPMS_PCR_SELECTION::try_from(
416416
PcrSelection::create(
417417
HashingAlgorithm::Sha1,
418-
PcrSelectSize::ThreeBytes,
418+
PcrSelectSize::ThreeOctets,
419419
&[PcrSlot::Slot16],
420420
)
421421
.expect("Failed to create PcrSelection 3"),
@@ -424,7 +424,7 @@ fn test_invalid_subtraction() {
424424
let tpms_pcr_selection_4 = TPMS_PCR_SELECTION::try_from(
425425
PcrSelection::create(
426426
HashingAlgorithm::Sha1,
427-
PcrSelectSize::ThreeBytes,
427+
PcrSelectSize::ThreeOctets,
428428
&[PcrSlot::Slot2],
429429
)
430430
.expect("Failed to create PcrSelection 4"),

‎tss-esapi/tests/integration_tests/structures_tests/lists_tests/tagged_pcr_property_list_tests.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ fn test_valid_conversions() {
1313
let expected_tagged_pcr_properties = vec![
1414
TaggedPcrSelect::create(
1515
PcrPropertyTag::Auth,
16-
PcrSelectSize::ThreeBytes,
16+
PcrSelectSize::ThreeOctets,
1717
&[PcrSlot::Slot1, PcrSlot::Slot8, PcrSlot::Slot17],
1818
)
1919
.expect("Failed to create TaggedPcrSelect 1"),
2020
TaggedPcrSelect::create(
2121
PcrPropertyTag::DrtmReset,
22-
PcrSelectSize::TwoBytes,
22+
PcrSelectSize::TwoOctets,
2323
&[PcrSlot::Slot2, PcrSlot::Slot9],
2424
)
2525
.expect("Failed to create TaggedPcrSelect 2"),
2626
TaggedPcrSelect::create(
2727
PcrPropertyTag::ExtendL0,
28-
PcrSelectSize::OneByte,
28+
PcrSelectSize::OneOctet,
2929
&[
3030
PcrSlot::Slot4,
3131
PcrSlot::Slot5,

‎tss-esapi/tests/integration_tests/structures_tests/pcr_tests/pcr_select_size_tests.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ macro_rules! test_valid_conversions {
9393

9494
#[test]
9595
fn test_valid_conversions() {
96-
test_valid_conversions!(PcrSelectSize::OneByte, 1);
97-
test_valid_conversions!(PcrSelectSize::TwoBytes, 2);
98-
test_valid_conversions!(PcrSelectSize::ThreeBytes, 3);
99-
test_valid_conversions!(PcrSelectSize::FourBytes, 4);
96+
test_valid_conversions!(PcrSelectSize::OneOctet, 1);
97+
test_valid_conversions!(PcrSelectSize::TwoOctets, 2);
98+
test_valid_conversions!(PcrSelectSize::ThreeOctets, 3);
99+
test_valid_conversions!(PcrSelectSize::FourOctets, 4);
100100
}
101101

102102
#[test]
@@ -116,7 +116,7 @@ fn test_default() {
116116
// The default valuen should be the value that
117117
// works on most platforms i.e. three octets.
118118
assert_eq!(
119-
PcrSelectSize::ThreeBytes,
119+
PcrSelectSize::ThreeOctets,
120120
PcrSelectSize::default(),
121121
"PcrSelectSize did not have the expected default value",
122122
);

‎tss-esapi/tests/integration_tests/structures_tests/pcr_tests/pcr_select_tests.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use tss_esapi::{
99
#[test]
1010
fn test_conversion_to_tss_pcr_select() {
1111
let actual = TPMS_PCR_SELECT::try_from(
12-
PcrSelect::create(PcrSelectSize::TwoBytes, &[PcrSlot::Slot0, PcrSlot::Slot8])
12+
PcrSelect::create(PcrSelectSize::TwoOctets, &[PcrSlot::Slot0, PcrSlot::Slot8])
1313
.expect("Failed to create PcrSelect"),
1414
)
1515
.expect("Failed to convert PcrSelect into TPMS_PCR_SELECT");
@@ -31,7 +31,7 @@ fn test_size_of_select_handling() {
3131
// Size of select is 3 so no values set in the fourth
3232
// octet should be present.
3333
let expected = PcrSelect::create(
34-
PcrSelectSize::ThreeBytes,
34+
PcrSelectSize::ThreeOctets,
3535
&[
3636
PcrSlot::Slot1,
3737
PcrSlot::Slot8,
@@ -51,7 +51,7 @@ fn test_conversion_from_tss_pcr_select() {
5151
})
5252
.unwrap();
5353
let expected = PcrSelect::create(
54-
PcrSelectSize::ThreeBytes,
54+
PcrSelectSize::ThreeOctets,
5555
&[
5656
PcrSlot::Slot1,
5757
PcrSlot::Slot8,

‎tss-esapi/tests/integration_tests/structures_tests/pcr_tests/pcr_selection_tests.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ fn test_conversion_to_tss_pcr_selection() {
1313
let actual = TPMS_PCR_SELECTION::try_from(
1414
PcrSelection::create(
1515
HashingAlgorithm::Sha512,
16-
PcrSelectSize::ThreeBytes,
16+
PcrSelectSize::ThreeOctets,
1717
&[PcrSlot::Slot3, PcrSlot::Slot9, PcrSlot::Slot23],
1818
)
1919
.expect("Failed to create pcr selection"),
@@ -39,7 +39,7 @@ fn test_conversion_from_tss_pcr_selection() {
3939
.unwrap();
4040
let expected = PcrSelection::create(
4141
HashingAlgorithm::Sha256,
42-
PcrSelectSize::TwoBytes,
42+
PcrSelectSize::TwoOctets,
4343
&[PcrSlot::Slot4, PcrSlot::Slot15],
4444
)
4545
.expect("Failed to create pcr selection");
@@ -60,7 +60,7 @@ fn test_size_of_select_handling() {
6060

6161
let expected = PcrSelection::create(
6262
HashingAlgorithm::Sha256,
63-
PcrSelectSize::TwoBytes,
63+
PcrSelectSize::TwoOctets,
6464
&[PcrSlot::Slot4, PcrSlot::Slot15],
6565
)
6666
.expect("Failed to create PcrSelection");
@@ -71,14 +71,14 @@ fn test_size_of_select_handling() {
7171
fn test_subtract() {
7272
let mut pcr_select_1 = PcrSelection::create(
7373
HashingAlgorithm::Sha256,
74-
PcrSelectSize::TwoBytes,
74+
PcrSelectSize::TwoOctets,
7575
&[PcrSlot::Slot4, PcrSlot::Slot15],
7676
)
7777
.expect("Failed to create PcrSelect pcr_select_1");
7878

7979
let pcr_select_2 = PcrSelection::create(
8080
HashingAlgorithm::Sha256,
81-
PcrSelectSize::TwoBytes,
81+
PcrSelectSize::TwoOctets,
8282
&[PcrSlot::Slot4],
8383
)
8484
.expect("Failed to create PcrSelect pcr_select_2");
@@ -95,7 +95,7 @@ fn test_subtract() {
9595

9696
assert_eq!(
9797
pcr_select_1.size_of_select(),
98-
PcrSelectSize::TwoBytes,
98+
PcrSelectSize::TwoOctets,
9999
"The pcr_select_1 did not have the expected size of select after subtract"
100100
);
101101

‎tss-esapi/tests/integration_tests/structures_tests/tagged_pcr_select_tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use tss_esapi::{
1010
#[test]
1111
fn test_conversions() {
1212
let expected_pcr_property_tag = PcrPropertyTag::ExtendL0;
13-
let expected_size_of_select = PcrSelectSize::ThreeBytes;
13+
let expected_size_of_select = PcrSelectSize::ThreeOctets;
1414
let expected_pcr_slots = vec![
1515
PcrSlot::Slot1,
1616
PcrSlot::Slot8,

0 commit comments

Comments
 (0)