keyutils_raw/
types.rs

1// Copyright (c) 2018, Ben Boeckel
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without modification,
5// are permitted provided that the following conditions are met:
6//
7//     * Redistributions of source code must retain the above copyright notice,
8//       this list of conditions and the following disclaimer.
9//     * Redistributions in binary form must reproduce the above copyright notice,
10//       this list of conditions and the following disclaimer in the documentation
11//       and/or other materials provided with the distribution.
12//     * Neither the name of this project nor the names of its contributors
13//       may be used to endorse or promote products derived from this software
14//       without specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27use std::convert::TryFrom;
28use std::num::NonZeroI32;
29
30/// Alias for the key_serial_t kernel type, representing a keyring (or key).
31pub type KeyringSerial = NonZeroI32;
32
33/// Alias for the key_perm_t kernel type, representing a keyring's (or key's)
34/// permission bits.
35///
36/// See `Permission`.
37pub type KeyPermissions = u32;
38
39pub type TimeoutSeconds = libc::c_uint;
40
41/// An enumeration for the keyrings which may be set as the default.
42///
43/// Keys which are implicitly required via syscalls and other operations are
44/// placed in the default keyring.
45#[derive(Debug, PartialEq, Eq)]
46// #[non_exhaustive]
47pub enum DefaultKeyring {
48    /// Do not change the default keyring.
49    ///
50    /// This may be used to get the current default keyring.
51    NoChange = -1,
52    /// Set the thread-specific keyring as the default.
53    ThreadKeyring = 1,
54    /// Set the process-specific keyring as the default.
55    ProcessKeyring = 2,
56    /// Set the session-specific keyring as the default.
57    SessionKeyring = 3,
58    /// Set the user-specific keyring as the default.
59    UserKeyring = 4,
60    /// Set the user session-specific keyring as the default.
61    UserSessionKeyring = 5,
62    /// Set the user session-specific keyring as the default.
63    GroupKeyring = 6,
64    /// Set the default keyring to the default logic.
65    ///
66    /// Keys will be placed in the first available keyring of:
67    ///
68    ///   - thread-specific
69    ///   - process-specific
70    ///   - session-specific
71    ///   - user-specific
72    DefaultKeyring = 0,
73}
74
75#[derive(Debug, PartialEq, Eq)]
76pub struct UnknownDefault(pub libc::c_long);
77
78impl TryFrom<libc::c_long> for DefaultKeyring {
79    type Error = UnknownDefault;
80    fn try_from(id: libc::c_long) -> Result<DefaultKeyring, UnknownDefault> {
81        use self::DefaultKeyring::*;
82        match id {
83            x if x == NoChange as libc::c_long => Ok(NoChange),
84            x if x == ThreadKeyring as libc::c_long => Ok(ThreadKeyring),
85            x if x == ProcessKeyring as libc::c_long => Ok(ProcessKeyring),
86            x if x == SessionKeyring as libc::c_long => Ok(SessionKeyring),
87            x if x == UserKeyring as libc::c_long => Ok(UserKeyring),
88            x if x == UserSessionKeyring as libc::c_long => Ok(UserSessionKeyring),
89            x if x == GroupKeyring as libc::c_long => Ok(GroupKeyring),
90            x if x == DefaultKeyring as libc::c_long => Ok(DefaultKeyring),
91            x => Err(UnknownDefault(x)),
92        }
93    }
94}
keyutils_raw/types.rs

keyutils_raw/
types.rs
