pageant 0.2.1

Pageant SSH agent transport client.
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

use std::pin::Pin;

use log::debug;
use tokio::io::{AsyncRead, AsyncWrite};

use crate::Error;
#[cfg(all(windows, feature = "namedpipes"))]
use crate::namedpipes;
#[cfg(all(windows, feature = "wmmessage"))]
use crate::wmmessage;

/// Pageant transport stream (using one of the available transport implementations).
/// Implements [AsyncRead] and [AsyncWrite].
pub enum PageantStream {
    #[cfg(all(windows, feature = "wmmessage"))]
    WmMessage(wmmessage::PageantStream),
    #[cfg(all(windows, feature = "namedpipes"))]
    NamedPipes(namedpipes::PageantStream),
}

impl PageantStream {
    pub async fn new() -> Result<Self, Error> {
        let mut errors = vec![];
        // if compiled in, try the more modern named pipes approach first:
        #[cfg(all(windows, feature = "namedpipes"))]
        {
            match namedpipes::PageantStream::new().await {
                Ok(s) => {
                    return Ok(Self::NamedPipes(s));
                }
                Err(e) => {
                    debug!("Pageant NamedPipes connection failed: {e}");
                    errors.push(e);
                }
            }
        }

        #[cfg(all(windows, feature = "wmmessage"))]
        {
            match wmmessage::PageantStream::new().await {
                Ok(s) => {
                    return Ok(Self::WmMessage(s));
                }
                Err(e) => {
                    debug!("Pageant WM_Message connection failed: {e}");
                    errors.push(e);
                }
            }
        }

        if errors.len() == 1
            && let Some(err) = errors.pop()
        {
            Err(err)
        } else {
            Err(Error::Multiple(errors))
        }
    }
}

impl AsyncRead for PageantStream {
    fn poll_read(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buf: &mut tokio::io::ReadBuf<'_>,
    ) -> std::task::Poll<std::io::Result<()>> {
        match &mut *self {
            #[cfg(all(windows, feature = "wmmessage"))]
            Self::WmMessage(i) => wmmessage::PageantStream::poll_read(Pin::new(i), cx, buf),
            #[cfg(all(windows, feature = "namedpipes"))]
            Self::NamedPipes(i) => namedpipes::PageantStream::poll_read(Pin::new(i), cx, buf),
        }
    }
}

impl AsyncWrite for PageantStream {
    fn poll_write(
        mut self: Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buf: &[u8],
    ) -> std::task::Poll<Result<usize, std::io::Error>> {
        match &mut *self {
            #[cfg(all(windows, feature = "wmmessage"))]
            Self::WmMessage(i) => wmmessage::PageantStream::poll_write(Pin::new(i), cx, buf),
            #[cfg(all(windows, feature = "namedpipes"))]
            Self::NamedPipes(i) => namedpipes::PageantStream::poll_write(Pin::new(i), cx, buf),
        }
    }

    fn poll_flush(
        mut self: Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Result<(), std::io::Error>> {
        match &mut *self {
            #[cfg(all(windows, feature = "wmmessage"))]
            Self::WmMessage(i) => wmmessage::PageantStream::poll_flush(Pin::new(i), cx),
            #[cfg(all(windows, feature = "namedpipes"))]
            Self::NamedPipes(i) => namedpipes::PageantStream::poll_flush(Pin::new(i), cx),
        }
    }

    fn poll_shutdown(
        mut self: Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Result<(), std::io::Error>> {
        match &mut *self {
            #[cfg(all(windows, feature = "wmmessage"))]
            Self::WmMessage(i) => wmmessage::PageantStream::poll_shutdown(Pin::new(i), cx),
            #[cfg(all(windows, feature = "namedpipes"))]
            Self::NamedPipes(i) => namedpipes::PageantStream::poll_shutdown(Pin::new(i), cx),
        }
    }
}