thrussh 0.40.5

A client and server SSH library.
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
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

// Copyright 2016 Pierre-Étienne Meunier
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
use crate::{cipher, key, mac, msg};
use byteorder::{BigEndian, ByteOrder};

use crate::session::Exchange;
use cryptovec::CryptoVec;
use rand::RngCore;
use sodium;
use std::cell::RefCell;
use thrussh_keys::encoding::Encoding;

#[doc(hidden)]
pub struct Algorithm {
    local_secret: Option<sodium::scalarmult::Scalar>,
    shared_secret: Option<sodium::scalarmult::GroupElement>,
}

impl std::fmt::Debug for Algorithm {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(
            f,
            "Algorithm {{ local_secret: [hidden], shared_secret: [hidden] }}",
        )
    }
}

#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub struct Name(&'static str);
impl AsRef<str> for Name {
    fn as_ref(&self) -> &str {
        self.0
    }
}
pub const CURVE25519: Name = Name("curve25519-sha256@libssh.org");
pub const STRICT_C: Name = Name("kex-strict-c-v00@openssh.com");
pub const STRICT_S: Name = Name("kex-strict-s-v00@openssh.com");
pub const CLIENT_SUPPORTS_EXT: Name = Name("ext-info-c");
pub const SERVER_SUPPORTS_EXT: Name = Name("ext-info-s");

thread_local! {
    static KEY_BUF: RefCell<CryptoVec> = RefCell::new(CryptoVec::new());
    static IV_BUF: RefCell<CryptoVec> = RefCell::new(CryptoVec::new());
    static BUFFER: RefCell<CryptoVec> = RefCell::new(CryptoVec::new());
    static MAC_BUF: RefCell<CryptoVec> = RefCell::new(CryptoVec::new());
}

// We used to support curve "NIST P-256" here, but the security of
// that curve is controversial, see
// http://safecurves.cr.yp.to/rigid.html

impl Algorithm {
    #[doc(hidden)]
    pub fn server_dh(
        _name: Name,
        exchange: &mut Exchange,
        payload: &[u8],
    ) -> Result<Algorithm, crate::Error> {
        debug!("server_dh");

        assert_eq!(payload[0], msg::KEX_ECDH_INIT);
        let mut client_pubkey = GroupElement([0; 32]);
        {
            let pubkey_len = BigEndian::read_u32(&payload[1..]) as usize;
            client_pubkey
                .0
                .clone_from_slice(&payload[5..(5 + pubkey_len)])
        };
        debug!("client_pubkey: {:?}", client_pubkey);
        use sodium::scalarmult::*;
        let mut server_secret = Scalar([0; 32]);
        rand::rng().fill_bytes(&mut server_secret.0);
        let server_pubkey = scalarmult_base(&server_secret);

        // fill exchange.
        exchange.server_ephemeral.clear();
        exchange.server_ephemeral.extend(&server_pubkey.0);
        let shared = scalarmult(&server_secret, &client_pubkey);
        Ok(Algorithm {
            local_secret: None,
            shared_secret: Some(shared),
        })
    }

    #[doc(hidden)]
    pub fn client_dh(
        _name: Name,
        client_ephemeral: &mut CryptoVec,
        buf: &mut CryptoVec,
    ) -> Result<Algorithm, crate::Error> {
        use sodium::scalarmult::*;
        let mut client_secret = Scalar([0; 32]);
        rand::rng().fill_bytes(&mut client_secret.0);
        let client_pubkey = scalarmult_base(&client_secret);

        // fill exchange.
        client_ephemeral.clear();
        client_ephemeral.extend(&client_pubkey.0);

        buf.push(msg::KEX_ECDH_INIT);
        buf.extend_ssh_string(&client_pubkey.0);

        Ok(Algorithm {
            local_secret: Some(client_secret),
            shared_secret: None,
        })
    }

    pub fn compute_shared_secret(&mut self, remote_pubkey_: &[u8]) -> Result<(), crate::Error> {
        let local_secret = std::mem::replace(&mut self.local_secret, None).unwrap();

        use sodium::scalarmult::*;
        let mut remote_pubkey = GroupElement([0; 32]);
        remote_pubkey.0.clone_from_slice(remote_pubkey_);
        let shared = scalarmult(&local_secret, &remote_pubkey);
        self.shared_secret = Some(shared);
        Ok(())
    }

    pub fn compute_exchange_hash<K: key::PubKey>(
        &self,
        key: &K,
        exchange: &Exchange,
        buffer: &mut CryptoVec,
    ) -> Result<crate::Sha256Hash, crate::Error> {
        // Computing the exchange hash, see page 7 of RFC 5656.
        buffer.clear();
        buffer.extend_ssh_string(&exchange.client_id);
        buffer.extend_ssh_string(&exchange.server_id);
        buffer.extend_ssh_string(&exchange.client_kex_init);
        buffer.extend_ssh_string(&exchange.server_kex_init);

        key.push_to(buffer);
        buffer.extend_ssh_string(&exchange.client_ephemeral);
        buffer.extend_ssh_string(&exchange.server_ephemeral);

        if let Some(ref shared) = self.shared_secret {
            buffer.extend_ssh_mpint(&shared.0);
        }

        use sha2::Digest;
        let mut hasher = sha2::Sha256::new();
        hasher.update(&buffer);
        Ok(hasher.finalize())
    }

    pub fn compute_keys(
        &self,
        session_id: &crate::Sha256Hash,
        exchange_hash: &crate::Sha256Hash,
        cipher: cipher::Name,
        mac: mac::Name,
        is_server: bool,
    ) -> Result<super::cipher::CipherPair, crate::Error> {
        let cipher = match cipher {
            super::cipher::chacha20poly1305::NAME => &super::cipher::chacha20poly1305::CIPHER,
            #[cfg(feature = "openssl")]
            super::cipher::aes256_gcm::NAME => &super::cipher::aes256_gcm::CIPHER,
            #[cfg(feature = "openssl")]
            super::cipher::aes256_ctr::NAME => &super::cipher::aes256_ctr::CIPHER,
            _ => unreachable!(),
        };

        let mac = match mac {
            super::mac::hmac_sha256::NAME => Some(&super::mac::hmac_sha256::MAC),
            super::mac::Name("none") => None,
            _ => unreachable!(),
        };

        // https://tools.ietf.org/html/rfc4253#section-7.2
        BUFFER.with(|buffer| {
            KEY_BUF.with(|key| {
                IV_BUF.with(|iv| {
                    MAC_BUF.with(|mac_buf| {
                        let compute_key =
                            |c, key: &mut CryptoVec, len| -> Result<(), crate::Error> {
                                let mut buffer = buffer.borrow_mut();
                                buffer.clear();
                                key.clear();

                                if let Some(ref shared) = self.shared_secret {
                                    buffer.extend_ssh_mpint(&shared.0);
                                }

                                buffer.extend(exchange_hash.as_ref());
                                buffer.push(c);
                                buffer.extend(session_id.as_ref());
                                let hash = {
                                    use sha2::Digest;
                                    let mut hasher = sha2::Sha256::new();
                                    hasher.update(&buffer[..]);
                                    hasher.finalize()
                                };
                                key.extend(hash.as_ref());

                                while key.len() < len {
                                    // extend.
                                    buffer.clear();
                                    if let Some(ref shared) = self.shared_secret {
                                        buffer.extend_ssh_mpint(&shared.0);
                                    }
                                    buffer.extend(exchange_hash.as_ref());
                                    buffer.extend(key);
                                    let hash = {
                                        use sha2::Digest;
                                        let mut hasher = sha2::Sha256::new();
                                        hasher.update(&buffer[..]);
                                        hasher.finalize()
                                    };
                                    key.extend(&hash.as_ref());
                                }
                                key.resize(len);
                                Ok(())
                            };

                        let (
                            local_to_remote,
                            local_to_remote_iv,
                            local_to_remote_mac,
                            remote_to_local,
                            remote_to_local_iv,
                            remote_to_local_mac,
                        ) = if is_server {
                            (b'D', b'B', b'F', b'C', b'A', b'E')
                        } else {
                            (b'C', b'A', b'E', b'D', b'B', b'F')
                        };

                        let mut key = key.borrow_mut();
                        compute_key(local_to_remote, &mut key, cipher.key_len)?;
                        let mut iv = iv.borrow_mut();
                        if cipher.iv_len > 0 {
                            compute_key(local_to_remote_iv, &mut iv, cipher.iv_len)?;
                        }

                        let local_to_remote_mac = if let Some(mac) = mac {
                            let mut mac_buf = mac_buf.borrow_mut();
                            compute_key(local_to_remote_mac, &mut mac_buf, mac.key_len)?;
                            (mac.make_key)(&mac_buf)
                        } else {
                            mac::MacKey::None
                        };

                        let local_to_remote =
                            (cipher.make_sealing_cipher)(&key, &iv, local_to_remote_mac);

                        compute_key(remote_to_local, &mut key, cipher.key_len)?;
                        if cipher.iv_len > 0 {
                            compute_key(remote_to_local_iv, &mut iv, cipher.iv_len)?;
                        }
                        let remote_to_local_mac = if let Some(mac) = mac {
                            let mut mac_buf = mac_buf.borrow_mut();
                            compute_key(remote_to_local_mac, &mut mac_buf, mac.key_len)?;
                            (mac.make_key)(&mac_buf)
                        } else {
                            mac::MacKey::None
                        };
                        let remote_to_local =
                            (cipher.make_opening_cipher)(&key, &iv, remote_to_local_mac);

                        Ok(super::cipher::CipherPair {
                            local_to_remote: local_to_remote,
                            remote_to_local: remote_to_local,
                        })
                    })
                })
            })
        })
    }
}