interprocess 2.4.0

Interprocess communication toolkit
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

use std::fmt::{self, Debug, Formatter};

impmod! {
    local_socket::peer_creds,
    PeerCreds as Inner,
    Pid,
}

/// Credentials of a connection peer.
///
/// The design of this type is inspired by [`std::fs::Metadata`].
///
/// The nature of the credentials is OS-specific and using some of them for making security
/// decisions may be subject to race conditions. Please make sure that the identifiers you use for
/// authenticating the peer cannot be invalidated and reused without administrative intervention.
///
/// ## Platform-specific behavior
/// Platforms can be divided by the set of credentials provided in this struct into the following
/// categories:
/// - Windows
/// - `ucred`-based
///   - Linux (including Android)
///   - OpenBSD
///   - Fuchsia
///   - Redox
/// - `xucred`-based
///   - FreeBSD
///   - DragonFly BSD
///   - Darwin (macOS, iOS, tvOS, watchOS)
/// - NetBSD
///
/// See the getter-level documentation for which credentials are available on which categories.
#[derive(Copy, Clone)]
pub struct PeerCreds(Inner);
impl Debug for PeerCreds {
    #[inline]
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { Debug::fmt(&self.0, f) }
}
impl From<Inner> for PeerCreds {
    #[inline(always)]
    fn from(v: Inner) -> Self { Self(v) }
}
impl PeerCreds {
    /// Returns the process ID of the peer.
    ///
    /// Please note that looking up security identifiers and other authentication data by process
    /// ID is subject to race conditions, assuming the peer process exiting and its PID being
    /// reused does not terminate the connection. This may happen if the peer's handle/FD for the
    /// connection gets leaked by mistake (perhaps by being inherited by a child process or sent
    /// via `SCM_RIGHTS`). It is not possible to cause this race in Interprocess, but
    /// adverse interactions with other libraries may require mitigating the race by performing
    /// multiple lookups.
    ///
    /// # Platform-specific behavior
    /// Available on:
    /// - Windows
    /// - `ucred`-based platforms
    /// - FreeBSD
    #[inline]
    pub fn pid(&self) -> Option<Pid> { self.0.pid() }

    /// Returns the effective user ID of the peer.
    ///
    /// # Platform-specific behavior
    /// Available on:
    /// - `ucred`-based platforms
    /// - `xucred`-based platforms
    /// - NetBSD
    #[cfg(any(doc, unix))]
    #[cfg_attr(feature = "doc_cfg", doc(cfg(unix)))]
    #[inline]
    pub fn euid(&self) -> Option<uid_t> { self.0.euid() }

    /// Returns the effective group ID of the peer.
    ///
    /// # Platform-specific behavior
    /// Available on:
    /// - `ucred`-based platforms
    /// - NetBSD
    #[cfg(any(doc, unix))]
    #[cfg_attr(feature = "doc_cfg", doc(cfg(unix)))]
    #[inline]
    pub fn egid(&self) -> Option<gid_t> { self.0.egid() }

    /// Returns a slice containing the supplementary group IDs of the peer.
    ///
    /// # Platform-specific behavior
    /// Available on:
    /// - `ucred`-based platforms
    #[cfg(any(doc, unix))]
    #[cfg_attr(feature = "doc_cfg", doc(cfg(unix)))]
    #[inline]
    pub fn groups(&self) -> Option<&[gid_t]> { self.0.groups() }
}

#[cfg(unix)]
use libc::{gid_t, uid_t};
#[cfg(not(unix))]
#[cfg_attr(not(doc), allow(unused_imports))]
use {u32 as uid_t, u32 as gid_t};