tss-esapi 8.0.0-alpha

Rust-native wrapper around TSS 2.0 Enhanced System API
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

use crate::{tss2_esys::TPMA_SESSION, Error, Result, WrapperErrorKind};
use bitfield::bitfield;
use std::convert::TryFrom;

// SESSION ATTRIBUTES

bitfield! {
    /// Struct representing the session attributes.
    #[derive(Copy, Clone, Eq, PartialEq)]
    pub struct SessionAttributes(TPMA_SESSION);
    impl Debug;

    _, set_continue_session: 0;
    pub continue_session, _: 0;
    _, set_audit_exclusive: 1;
    pub audit_exclusive, _: 1;
    _, set_audit_reset: 2;
    pub audit_reset, _: 2;
    reserved, _: 4, 3; // Reserved 3,4 (Shall be clear)
    _, set_decrypt: 5;
    pub decrypt, _: 5;
    _, set_encrypt: 6;
    pub encrypt, _: 6;
    _, set_audit: 7;
    pub audit, _: 7;
}

impl SessionAttributes {
    /// Get a builder for the structure
    pub const fn builder() -> SessionAttributesBuilder {
        SessionAttributesBuilder::new()
    }

    /// Validates the session attributes
    pub fn validate(&self) -> Result<()> {
        if self.reserved() != 0 {
            return Err(Error::local_error(WrapperErrorKind::InvalidParam));
        }
        Ok(())
    }
}

impl TryFrom<TPMA_SESSION> for SessionAttributes {
    type Error = Error;

    fn try_from(tss_session_attributes: TPMA_SESSION) -> Result<SessionAttributes> {
        let result = SessionAttributes(tss_session_attributes);
        result.validate()?;
        Ok(result)
    }
}

impl TryFrom<SessionAttributes> for TPMA_SESSION {
    type Error = Error;

    fn try_from(session_attributes: SessionAttributes) -> Result<TPMA_SESSION> {
        session_attributes.validate()?;
        Ok(session_attributes.0)
    }
}

// SESSION ATTRIBUTES MASK

bitfield! {
    /// Struct representing the session attributes mask.
    #[derive(Copy, Clone, Eq, PartialEq)]
    pub struct SessionAttributesMask(TPMA_SESSION);
    impl Debug;

    _, use_continue_session: 0;
    _, use_audit_exclusive: 1;
    _, use_audit_reset: 2;
    reserved, _: 4, 3; // Reserved 3,4 (Shall be clear)
    _, use_decrypt: 5;
    _, use_encrypt: 6;
    _, use_audit: 7;
}

impl SessionAttributesMask {
    /// Get a builder for the structure
    pub const fn builder() -> SessionAttributesBuilder {
        SessionAttributesBuilder::new()
    }

    /// Validates the session attributes
    pub fn validate(&self) -> Result<()> {
        if self.reserved() != 0 {
            return Err(Error::local_error(WrapperErrorKind::InvalidParam));
        }
        Ok(())
    }
}

impl TryFrom<TPMA_SESSION> for SessionAttributesMask {
    type Error = Error;

    fn try_from(tpma_session: TPMA_SESSION) -> Result<SessionAttributesMask> {
        let result = SessionAttributesMask(tpma_session);
        result.validate()?;
        Ok(result)
    }
}

impl TryFrom<SessionAttributesMask> for TPMA_SESSION {
    type Error = Error;

    fn try_from(session_attributes_mask: SessionAttributesMask) -> Result<TPMA_SESSION> {
        session_attributes_mask.validate()?;
        Ok(session_attributes_mask.0)
    }
}

// SESSION ATTRIBUTES ITEMS BUILDER

/// A builder that is used to create
/// SessionAttributes and a corresponding
/// SessionAttributesMask.
#[derive(Debug, Copy, Clone)]
pub struct SessionAttributesBuilder {
    attributes: SessionAttributes,
    mask: SessionAttributesMask,
}

impl SessionAttributesBuilder {
    pub const fn new() -> SessionAttributesBuilder {
        SessionAttributesBuilder {
            attributes: SessionAttributes(0),
            mask: SessionAttributesMask(0),
        }
    }

    pub fn with_continue_session(mut self, set: bool) -> Self {
        self.attributes.set_continue_session(set);
        self.mask.use_continue_session(true);
        self
    }

    pub fn with_audit_exclusive(mut self, set: bool) -> Self {
        self.attributes.set_audit_exclusive(set);
        self.mask.use_audit_exclusive(true);
        self
    }

    pub fn with_audit_reset(mut self, set: bool) -> Self {
        self.attributes.set_audit_reset(set);
        self.mask.use_audit_reset(true);
        self
    }

    pub fn with_decrypt(mut self, set: bool) -> Self {
        self.attributes.set_decrypt(set);
        self.mask.use_decrypt(true);
        self
    }

    pub fn with_encrypt(mut self, set: bool) -> Self {
        self.attributes.set_encrypt(set);
        self.mask.use_encrypt(true);
        self
    }

    pub fn with_audit(mut self, set: bool) -> Self {
        self.attributes.set_audit(set);
        self.mask.use_audit(true);
        self
    }

    pub fn build(self) -> (SessionAttributes, SessionAttributesMask) {
        (self.attributes, self.mask)
    }
}

impl Default for SessionAttributesBuilder {
    fn default() -> Self {
        Self::new()
    }
}