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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
use bstr::{BStr, BString};
use std::{
io::{self, Write},
process::{Command, Stdio},
};
use quick_error::quick_error;
pub type Result = std::result::Result<Option<Outcome>, Error>;
quick_error! {
#[derive(Debug)]
#[allow(missing_docs)]
pub enum Error {
Io(err: io::Error) {
display("An IO error occurred while communicating to the credentials helper")
from()
source(err)
}
KeyNotFound(name: String) {
display("Could not find '{}' in output of git credentials helper", name)
}
CredentialsHelperFailed(code: Option<i32>) {
display("Credentials helper program failed with status code {:?}", code)
}
}
}
#[derive(Clone, Debug)]
pub enum Action<'a> {
Fill(&'a BStr),
Approve(BString),
Reject(BString),
}
impl<'a> Action<'a> {
fn is_fill(&self) -> bool {
matches!(self, Action::Fill(_))
}
fn as_str(&self) -> &str {
match self {
Action::Approve(_) => "approve",
Action::Fill(_) => "fill",
Action::Reject(_) => "reject",
}
}
}
#[derive(Clone, Debug)]
pub struct NextAction {
previous_output: BString,
}
impl NextAction {
pub fn approve(self) -> Action<'static> {
Action::Approve(self.previous_output)
}
pub fn reject(self) -> Action<'static> {
Action::Reject(self.previous_output)
}
}
pub struct Outcome {
pub identity: git_sec::identity::Account,
pub next: NextAction,
}
pub fn action(action: Action<'_>) -> Result {
let mut cmd = Command::new(cfg!(windows).then(|| "git.exe").unwrap_or("git"));
cmd.arg("credential")
.arg(action.as_str())
.stdin(Stdio::piped())
.stdout(if action.is_fill() {
Stdio::piped()
} else {
Stdio::null()
});
let mut child = cmd.spawn()?;
let mut stdin = child.stdin.take().expect("stdin to be configured");
match action {
Action::Fill(url) => encode_message(url, stdin)?,
Action::Approve(last) | Action::Reject(last) => {
stdin.write_all(&last)?;
stdin.write_all(&[b'\n'])?
}
}
let output = child.wait_with_output()?;
if !output.status.success() {
return Err(Error::CredentialsHelperFailed(output.status.code()));
}
let stdout = output.stdout;
if stdout.is_empty() {
Ok(None)
} else {
let kvs = decode_message(stdout.as_slice())?;
let find = |name: &str| {
kvs.iter()
.find(|(k, _)| k == name)
.ok_or_else(|| Error::KeyNotFound(name.into()))
.map(|(_, n)| n.to_owned())
};
Ok(Some(Outcome {
identity: git_sec::identity::Account {
username: find("username")?,
password: find("password")?,
},
next: NextAction {
previous_output: stdout.into(),
},
}))
}
}
pub fn encode_message(url: &BStr, mut out: impl io::Write) -> io::Result<()> {
validate(url)?;
writeln!(out, "url={}\n", url)
}
fn validate(url: &BStr) -> io::Result<()> {
if url.contains(&0) || url.contains(&b'\n') {
return Err(io::Error::new(
io::ErrorKind::Other,
"token to encode must not contain newlines or null bytes",
));
}
Ok(())
}
pub fn decode_message(mut input: impl io::Read) -> io::Result<Vec<(String, String)>> {
let mut buf = String::new();
input.read_to_string(&mut buf)?;
buf.lines()
.take_while(|l| !l.is_empty())
.map(|l| {
let mut iter = l.splitn(2, '=').map(|s| s.to_owned());
match (iter.next(), iter.next()) {
(Some(key), Some(value)) => validate(key.as_str().into())
.and_then(|_| validate(value.as_str().into()))
.map(|_| (key, value)),
_ => Err(io::Error::new(
io::ErrorKind::Other,
"Invalid format, expecting key=value",
)),
}
})
.collect::<io::Result<Vec<_>>>()
}
#[cfg(test)]
mod tests {
use super::*;
type Result = std::result::Result<(), Box<dyn std::error::Error>>;
mod encode_message {
use bstr::ByteSlice;
use super::*;
#[test]
fn from_url() -> super::Result {
let mut out = Vec::new();
encode_message("https://github.com/byron/gitoxide".into(), &mut out)?;
assert_eq!(out.as_bstr(), b"url=https://github.com/byron/gitoxide\n\n".as_bstr());
Ok(())
}
mod invalid {
use std::io;
use super::*;
#[test]
fn contains_null() {
assert_eq!(
encode_message("https://foo\u{0}".into(), Vec::new())
.err()
.map(|e| e.kind()),
Some(io::ErrorKind::Other)
);
}
#[test]
fn contains_newline() {
assert_eq!(
encode_message("https://foo\n".into(), Vec::new())
.err()
.map(|e| e.kind()),
Some(io::ErrorKind::Other)
);
}
}
}
mod decode_message {
use super::*;
#[test]
fn typical_response() -> super::Result {
assert_eq!(
decode_message(
"protocol=https
host=example.com
username=bob
password=secr3t\n\n
this=is-skipped-past-empty-line"
.as_bytes()
)?,
vec![
("protocol", "https"),
("host", "example.com"),
("username", "bob"),
("password", "secr3t")
]
.iter()
.map(|(k, v)| (k.to_string(), v.to_string()))
.collect::<Vec<_>>()
);
Ok(())
}
}
}