firehazard 0.0.0-2022-09-10

Unopinionated low level API bindings focused on soundness, safety, and stronger types over raw FFI.
Documentation 
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

use crate::*;

use winapi::shared::guiddef::GUID;
use winapi::shared::minwindef::FALSE;
use winapi::shared::winerror::*;
use winapi::um::securitybaseapi::*;
use winapi::um::winnt::ACL;

use core::ptr::null_mut;

/// `WORD` sizes etc. limit the size to `0xFFFF`.
/// However, InitializeAcl will fail with `0xFFFF`, since the end isn't DWORD aligned.
/// Instead, specify `0xFFFC` which *is* DWORD aligned.
macro_rules! max_acl_bytes { () => { 0xFFFC } }



pub struct Builder {
    u: U,
}

#[repr(C)] union U {
    bytes:  [u8; max_acl_bytes!()], // max acl is 64 KiB
    acl:    ACL,
}

impl<'a> From<&'a mut Builder> for acl::Ptr<'a> { fn from(b: &'a mut Builder) -> Self { b.as_acl_ptr() } }

impl Builder {
    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-initializeacl)\]
    /// InitializeAcl
    pub fn new(revision: acl::Revision) -> Self {
        let mut b = Self { u: U { bytes: [0; max_acl_bytes!()] } };
        assert!(FALSE != unsafe { InitializeAcl(&mut b.u.acl, max_acl_bytes!(), revision.into()) }, "GetLastError()=={:?}", Error::get_last());
        b
    }

    fn as_winapi(&mut self) -> *mut ACL { unsafe { &mut self.u.acl } }
    fn as_winapi_const(&self) -> *mut ACL { unsafe { &self.u.acl as *const _ as *mut _ } }
    pub fn as_acl_ptr(&self) -> acl::Ptr { unsafe { acl::Ptr::from_raw_unchecked(&self.u.acl as *const _ as *mut _) } }
    #[allow(dead_code)] pub(crate) fn as_bytes(&self) -> &[u8] { let len = usize::from32(self.as_acl_ptr().get_acl_size_information().AclBytesInUse); unsafe { &self.u.bytes[..len] } }


    pub fn finish(&mut self) -> Result<&mut Self, Error> {
        // TODO: eliminate the need for this by only temporarilly growing AclSize immediately before add_*_ace and then shrinking it afterwards?
        let size = self.as_acl_ptr().get_acl_size_information().AclBytesInUse;
        let size = u16::try_from(size).map_err(|_| Error(ERROR_ALLOTTED_SPACE_EXCEEDED))?;
        self.u.acl.AclSize = size;
        Ok(self)
    }

    // https://docs.microsoft.com/en-us/windows/win32/secauthz/authorization-functions

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addaccessallowedace)\]
    /// `AddAccessAllowedAce`
    pub fn add_access_allowed_ace<'acl, 'sid>(&'acl mut self,
        ace_revision:   acl::Revision,
        access_mask:    token::AccessRights,
        sid:            impl Into<sid::Ptr<'sid>>,
    ) -> Result<&'acl mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { AddAccessAllowedAce(self.as_winapi(), ace_revision.into(), access_mask.into(), sid.into().as_psid()) })?;
        Ok(self)
    }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addaccessallowedaceex)\]
    /// `AddAccessAllowedAceEx`
    pub fn add_access_allowed_ace_ex<'acl, 'sid>(&'acl mut self,
        ace_revision:   acl::Revision,
        ace_flags:      ace::Flags,
        access_mask:    token::AccessRights,
        sid:            impl Into<sid::Ptr<'sid>>,
    ) -> Result<&'acl mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { AddAccessAllowedAceEx(self.as_winapi(), ace_revision.into(), ace_flags.into(), access_mask.into(), sid.into().as_psid()) })?;
        Ok(self)
    }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addaccessallowedobjectace)\]
    /// `AddAccessAllowedObjectAce`
    pub fn add_access_allowed_object_ace<'acl, 'sid>(&'acl mut self,
        ace_revision:               acl::Revision,
        ace_flags:                  ace::Flags,
        access_mask:                token::AccessRights,
        object_type_guid:           impl Into<Option<GUID>>,
        inherited_object_type_guid: impl Into<Option<GUID>>,
        sid:                        impl Into<sid::Ptr<'sid>>,
    ) -> Result<&'acl mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { AddAccessAllowedObjectAce(
            self.as_winapi(),
            ace_revision.into(),
            ace_flags.into(),
            access_mask.into(),
            object_type_guid.into().as_mut().map_or(null_mut(), |g| g),
            inherited_object_type_guid.into().as_mut().map_or(null_mut(), |g| g),
            sid.into().as_psid()
        )})?;
        Ok(self)
    }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addaccessdeniedace)\]
    /// `AddAccessDeniedAce`
    pub fn add_access_denied_ace<'acl, 'sid>(&'acl mut self,
        ace_revision:   acl::Revision,
        access_mask:    token::AccessRights,
        sid:            impl Into<sid::Ptr<'sid>>,
    ) -> Result<&'acl mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { AddAccessDeniedAce(self.as_winapi(), ace_revision.into(), access_mask.into(), sid.into().as_psid()) })?;
        Ok(self)
    }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addaccessdeniedaceex)\]
    /// `AddAccessDeniedAceEx`
    pub fn add_access_denied_ace_ex<'acl, 'sid>(&'acl mut self,
        ace_revision:   acl::Revision,
        ace_flags:      ace::Flags,
        access_mask:    token::AccessRights,
        sid:            impl Into<sid::Ptr<'sid>>,
    ) -> Result<&'acl mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { AddAccessDeniedAceEx(self.as_winapi(), ace_revision.into(), ace_flags.into(), access_mask.into(), sid.into().as_psid()) })?;
        Ok(self)
    }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addaccessdeniedobjectace)\]
    /// `AddAccessDeniedObjectAce`
    pub fn add_access_denied_object_ace<'acl, 'sid>(&'acl mut self,
        ace_revision:               acl::Revision,
        ace_flags:                  ace::Flags,
        access_mask:                token::AccessRights,
        object_type_guid:           impl Into<Option<GUID>>,
        inherited_object_type_guid: impl Into<Option<GUID>>,
        sid:                        impl Into<sid::Ptr<'sid>>,
    ) -> Result<&'acl mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { AddAccessDeniedObjectAce(
            self.as_winapi(),
            ace_revision.into(),
            ace_flags.into(),
            access_mask.into(),
            object_type_guid.into().as_mut().map_or(null_mut(), |g| g),
            inherited_object_type_guid.into().as_mut().map_or(null_mut(), |g| g),
            sid.into().as_psid()
        )})?;
        Ok(self)
    }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addace)\]
    /// `AddAce` an entire Acl
    pub fn add_acl(&mut self, ace_revision: acl::Revision, starting_ace_index: u32, acl: acl::Ptr) -> Result<&mut Self, Error> {
        if acl.as_pacl().is_null() { return Err(Error(ERROR_INVALID_PARAMETER)); }
        let size : u16 = acl.aces().map(|a| a.header().size).sum();
        let ptr = acl.aces().as_ptr().cast();
        Error::get_last_if(FALSE == unsafe { AddAce(self.as_winapi(), ace_revision.into(), starting_ace_index, ptr, size.into()) })?;
        Ok(self)
    }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addauditaccessobjectace)\]
    /// `AddAuditAccessObjectAce`
    pub fn add_audit_access_object_ace<'acl, 'sid>(&'acl mut self,
        ace_revision:               acl::Revision,
        ace_flags:                  ace::Flags,
        access_mask:                token::AccessRights,
        object_type_guid:           impl Into<Option<GUID>>,
        inherited_object_type_guid: impl Into<Option<GUID>>,
        sid:                        impl Into<sid::Ptr<'sid>>,
        audit_success:              bool,
        audit_failure:              bool,
    ) -> Result<&'acl mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { AddAuditAccessObjectAce(
            self.as_winapi(),
            ace_revision.into(),
            ace_flags.into(),
            access_mask.into(),
            object_type_guid.into().as_mut().map_or(null_mut(), |g| g),
            inherited_object_type_guid.into().as_mut().map_or(null_mut(), |g| g),
            sid.into().as_psid(),
            audit_success.into(),
            audit_failure.into(),
        )})?;
        Ok(self)
    }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addmandatoryace)\]
    /// `AddMandatoryAce`
    pub fn add_mandatory_ace<'acl, 'sid>(&'acl mut self,
        ace_revision:       acl::Revision,
        ace_flags:          ace::Flags,
        mandatory_policy:   u32, // TODO: strengthen type to limit to SYSTEM_MANDATORY_LABEL_*
        sid:                impl Into<sid::Ptr<'sid>>,
    ) -> Result<&'acl mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { AddMandatoryAce(self.as_winapi(), ace_revision.into(), ace_flags.into(), mandatory_policy.into(), sid.into().as_psid()) })?;
        Ok(self)
    }

    // TODO: https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addresourceattributeace
    // TODO: https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-addscopedpolicyidace

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-deleteace)\]
    /// `DeleteAce`
    pub fn delete_ace(&mut self, ace_index: u32) -> Result<&mut Self, Error> {
        Error::get_last_if(FALSE == unsafe { DeleteAce(self.as_winapi(), ace_index) })?;
        Ok(self)
    }

    // https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-findfirstfreeace

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-getace)\]
    /// `GetAce`
    pub fn get_ace(&self, ace_index: u32) -> Result<ace::Ptr, Error> {
        let mut ace = null_mut();
        Error::get_last_if(FALSE == unsafe { GetAce(self.as_winapi_const(), ace_index, &mut ace) })?;
        unsafe { ace::Ptr::from_raw(ace.cast()) }.ok_or(Error(ERROR_INVALID_HANDLE))
    }

    // https://docs.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-setaclinformation
}