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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
#![allow(dead_code)]
use super::{RelayHandshakeError, RelayHandshakeResult};
use crate::util::ct;
use crate::{Error, Result};
use tor_bytes::{Reader, Writeable, Writer};
use tor_llcrypto::d::{Sha3_256, Shake256};
use tor_llcrypto::pk::{curve25519, ed25519::Ed25519Identity};
use tor_llcrypto::util::rand_compat::RngCompatExt;
use cipher::{KeyIvInit, StreamCipher};
use generic_array::GenericArray;
use rand_core::{CryptoRng, RngCore};
use subtle::{Choice, ConstantTimeEq};
use tor_llcrypto::cipher::aes::Aes256Ctr;
use zeroize::Zeroizing;
const ENC_KEY_LEN: usize = 32;
const MAC_KEY_LEN: usize = 32;
const PUB_KEY_LEN: usize = 32;
const DIGEST_LEN: usize = 32;
const MAC_LEN: usize = 32;
const ID_LEN: usize = 32;
type DigestVal = [u8; DIGEST_LEN];
type MacVal = [u8; MAC_LEN];
type EncKey = [u8; ENC_KEY_LEN];
type MacKey = [u8; MAC_KEY_LEN];
struct Encap<'a>(&'a [u8]);
impl<'a> Writeable for Encap<'a> {
fn write_onto<B: Writer + ?Sized>(&self, b: &mut B) {
b.write_u64(self.0.len() as u64);
b.write(self.0);
}
}
impl<'a> Encap<'a> {
fn len(&self) -> usize {
self.0.len()
}
fn data(&self) -> &'a [u8] {
self.0
}
}
macro_rules! define_tweaks {
{
$(#[$pid_meta:meta])*
PROTOID = $protoid:expr;
$( $(#[$meta:meta])* $name:ident <= $suffix:expr ; )*
} => {
$(#[$pid_meta])*
const PROTOID: &'static [u8] = $protoid.as_bytes();
$(
$(#[$meta])*
const $name : Encap<'static> =
Encap(concat!($protoid, ":", $suffix).as_bytes());
)*
}
}
define_tweaks! {
PROTOID = "ntor3-curve25519-sha3_256-1";
T_MSGMAC <= "msg_mac";
T_MSGKDF <= "kdf_phase1";
T_KEY_SEED <= "key_seed";
T_VERIFY <= "verify";
T_FINAL <= "kdf_final";
T_AUTH <= "auth_final";
}
fn hash(t: &Encap<'_>, data: &[u8]) -> DigestVal {
use digest::Digest;
let mut d = Sha3_256::new();
d.update((t.len() as u64).to_be_bytes());
d.update(t.data());
d.update(data);
d.finalize().into()
}
fn encrypt(key: &EncKey, m: &[u8]) -> Vec<u8> {
let mut d = m.to_vec();
let zero_iv = GenericArray::default();
let mut cipher = Aes256Ctr::new(key.into(), &zero_iv);
cipher.apply_keystream(&mut d);
d
}
fn decrypt(key: &EncKey, m: &[u8]) -> Vec<u8> {
encrypt(key, m)
}
struct DigestWriter<U>(U);
impl<U: digest::Update> tor_bytes::Writer for DigestWriter<U> {
fn write_all(&mut self, bytes: &[u8]) {
self.0.update(bytes);
}
}
impl<U> DigestWriter<U> {
fn take(self) -> U {
self.0
}
}
fn h_key_seed(d: &[u8]) -> DigestVal {
hash(&T_KEY_SEED, d)
}
fn h_verify(d: &[u8]) -> DigestVal {
hash(&T_VERIFY, d)
}
fn kdf_msgkdf(
xb: &curve25519::SharedSecret,
relay_public: &NtorV3PublicKey,
client_public: &curve25519::PublicKey,
verification: &[u8],
) -> (Zeroizing<EncKey>, DigestWriter<Sha3_256>) {
use digest::{ExtendableOutput, XofReader};
let mut msg_kdf = DigestWriter(Shake256::default());
msg_kdf.write(&T_MSGKDF);
msg_kdf.write(xb);
msg_kdf.write(&relay_public.id);
msg_kdf.write(client_public);
msg_kdf.write(&relay_public.pk);
msg_kdf.write(PROTOID);
msg_kdf.write(&Encap(verification));
let mut r = msg_kdf.take().finalize_xof();
let mut enc_key = Zeroizing::new([0; ENC_KEY_LEN]);
let mut mac_key = Zeroizing::new([0; MAC_KEY_LEN]);
r.read(&mut enc_key[..]);
r.read(&mut mac_key[..]);
let mut mac = DigestWriter(Sha3_256::default());
{
mac.write(&T_MSGMAC);
mac.write(&Encap(&mac_key[..]));
mac.write(&relay_public.id);
mac.write(&relay_public.pk);
mac.write(client_public);
}
(enc_key, mac)
}
#[derive(Clone, Debug)]
pub(crate) struct NtorV3PublicKey {
id: Ed25519Identity,
pk: curve25519::PublicKey,
}
pub(crate) struct NtorV3SecretKey {
pk: NtorV3PublicKey,
sk: curve25519::StaticSecret,
}
impl NtorV3SecretKey {
fn matches(&self, id: Ed25519Identity, pk: curve25519::PublicKey) -> Choice {
id.as_bytes().ct_eq(self.pk.id.as_bytes()) & pk.as_bytes().ct_eq(self.pk.pk.as_bytes())
}
}
pub(crate) struct NtorV3HandshakeState {
relay_public: NtorV3PublicKey,
my_sk: curve25519::StaticSecret,
my_public: curve25519::PublicKey,
shared_secret: curve25519::SharedSecret,
msg_mac: MacVal,
}
fn client_handshake_ntor_v3<R: RngCore + CryptoRng>(
rng: &mut R,
relay_public: &NtorV3PublicKey,
client_msg: &[u8],
verification: &[u8],
) -> (NtorV3HandshakeState, Vec<u8>) {
let my_sk = curve25519::StaticSecret::new(rng.rng_compat());
client_handshake_ntor_v3_no_keygen(relay_public, client_msg, verification, my_sk)
}
fn client_handshake_ntor_v3_no_keygen(
relay_public: &NtorV3PublicKey,
client_msg: &[u8],
verification: &[u8],
my_sk: curve25519::StaticSecret,
) -> (NtorV3HandshakeState, Vec<u8>) {
let my_public = curve25519::PublicKey::from(&my_sk);
let bx = my_sk.diffie_hellman(&relay_public.pk);
let (enc_key, mut mac) = kdf_msgkdf(&bx, relay_public, &my_public, verification);
let encrypted_msg = encrypt(&enc_key, client_msg);
let msg_mac: DigestVal = {
use digest::Digest;
mac.write(&encrypted_msg);
mac.take().finalize().into()
};
let mut message = Vec::new();
message.write(&relay_public.id);
message.write(&relay_public.pk);
message.write(&my_public);
message.write(&encrypted_msg);
message.write(&msg_mac);
let state = NtorV3HandshakeState {
relay_public: relay_public.clone(),
my_sk,
my_public,
shared_secret: bx,
msg_mac,
};
(state, message)
}
pub(crate) trait MsgReply {
fn reply(&mut self, msg: &[u8]) -> Option<Vec<u8>>;
}
fn server_handshake_ntor_v3<RNG: CryptoRng + RngCore, REPLY: MsgReply>(
rng: &mut RNG,
reply_fn: &mut REPLY,
message: &[u8],
keys: &[NtorV3SecretKey],
verification: &[u8],
) -> RelayHandshakeResult<(Vec<u8>, impl digest::XofReader)> {
let secret_key_y = curve25519::StaticSecret::new(rng.rng_compat());
server_handshake_ntor_v3_no_keygen(reply_fn, &secret_key_y, message, keys, verification)
}
fn server_handshake_ntor_v3_no_keygen<REPLY: MsgReply>(
reply_fn: &mut REPLY,
secret_key_y: &curve25519::StaticSecret,
message: &[u8],
keys: &[NtorV3SecretKey],
verification: &[u8],
) -> RelayHandshakeResult<(Vec<u8>, impl digest::XofReader)> {
let mut r = Reader::from_slice(message);
let id: Ed25519Identity = r.extract()?;
let requested_pk: curve25519::PublicKey = r.extract()?;
let client_pk: curve25519::PublicKey = r.extract()?;
let client_msg = if let Some(msg_len) = r.remaining().checked_sub(MAC_LEN) {
r.take(msg_len)?
} else {
return Err(tor_bytes::Error::Truncated.into());
};
let msg_mac: MacVal = r.extract()?;
r.should_be_exhausted()?;
let keypair = ct::lookup(keys, |key| key.matches(id, requested_pk));
let keypair = match keypair {
Some(k) => k,
None => return Err(RelayHandshakeError::MissingKey),
};
let xb = keypair.sk.diffie_hellman(&client_pk);
let (enc_key, mut mac) = kdf_msgkdf(&xb, &keypair.pk, &client_pk, verification);
let computed_mac: DigestVal = {
use digest::Digest;
mac.write(client_msg);
mac.take().finalize().into()
};
let y_pk: curve25519::PublicKey = (secret_key_y).into();
let xy = secret_key_y.diffie_hellman(&client_pk);
let mut okay = computed_mac.ct_eq(&msg_mac)
& ct::bool_to_choice(xy.was_contributory())
& ct::bool_to_choice(xb.was_contributory());
let plaintext_msg = decrypt(&enc_key, client_msg);
let reply = reply_fn.reply(&plaintext_msg);
okay &= ct::bool_to_choice(reply.is_some());
let reply = reply.unwrap_or_default();
let secret_input = {
let mut si = Zeroizing::new(Vec::new());
si.write(&xy);
si.write(&xb);
si.write(&keypair.pk.id);
si.write(&keypair.pk.pk);
si.write(&client_pk);
si.write(&y_pk);
si.write(PROTOID);
si.write(&Encap(verification));
si
};
let ntor_key_seed = h_key_seed(&secret_input);
let verify = h_verify(&secret_input);
let (enc_key, keystream) = {
use digest::{ExtendableOutput, XofReader};
let mut xof = DigestWriter(Shake256::default());
xof.write(&T_FINAL);
xof.write(&ntor_key_seed);
let mut r = xof.take().finalize_xof();
let mut enc_key = Zeroizing::new([0_u8; ENC_KEY_LEN]);
r.read(&mut enc_key[..]);
(enc_key, r)
};
let encrypted_reply = encrypt(&enc_key, &reply);
let auth: DigestVal = {
use digest::Digest;
let mut auth = DigestWriter(Sha3_256::default());
auth.write(&T_AUTH);
auth.write(&verify);
auth.write(&keypair.pk.id);
auth.write(&keypair.pk.pk);
auth.write(&y_pk);
auth.write(&client_pk);
auth.write(&msg_mac);
auth.write(&Encap(&encrypted_reply));
auth.write(PROTOID);
auth.write(&b"Server"[..]);
auth.take().finalize().into()
};
let reply = {
let mut reply = Vec::new();
reply.write(&y_pk);
reply.write(&auth);
reply.write(&encrypted_reply);
reply
};
if okay.into() {
Ok((reply, keystream))
} else {
Err(RelayHandshakeError::BadHandshake)
}
}
fn client_handshake_ntor_v3_part2(
state: &NtorV3HandshakeState,
relay_handshake: &[u8],
verification: &[u8],
) -> Result<(Vec<u8>, impl digest::XofReader)> {
let mut reader = Reader::from_slice(relay_handshake);
let y_pk: curve25519::PublicKey = reader.extract()?;
let auth: DigestVal = reader.extract()?;
let encrypted_msg = reader.into_rest();
let yx = state.my_sk.diffie_hellman(&y_pk);
let secret_input = {
let mut si = Zeroizing::new(Vec::new());
si.write(&yx);
si.write(&state.shared_secret);
si.write(&state.relay_public.id);
si.write(&state.relay_public.pk);
si.write(&state.my_public);
si.write(&y_pk);
si.write(PROTOID);
si.write(&Encap(verification));
si
};
let ntor_key_seed = h_key_seed(&secret_input);
let verify = h_verify(&secret_input);
let computed_auth: DigestVal = {
use digest::Digest;
let mut auth = DigestWriter(Sha3_256::default());
auth.write(&T_AUTH);
auth.write(&verify);
auth.write(&state.relay_public.id);
auth.write(&state.relay_public.pk);
auth.write(&y_pk);
auth.write(&state.my_public);
auth.write(&state.msg_mac);
auth.write(&Encap(encrypted_msg));
auth.write(PROTOID);
auth.write(&b"Server"[..]);
auth.take().finalize().into()
};
let okay = computed_auth.ct_eq(&auth)
& ct::bool_to_choice(yx.was_contributory())
& ct::bool_to_choice(state.shared_secret.was_contributory());
let (enc_key, keystream) = {
use digest::{ExtendableOutput, XofReader};
let mut xof = DigestWriter(Shake256::default());
xof.write(&T_FINAL);
xof.write(&ntor_key_seed);
let mut r = xof.take().finalize_xof();
let mut enc_key = Zeroizing::new([0_u8; ENC_KEY_LEN]);
r.read(&mut enc_key[..]);
(enc_key, r)
};
let server_reply = decrypt(&enc_key, encrypted_msg);
if okay.into() {
Ok((server_reply, keystream))
} else {
Err(Error::BadCircHandshake)
}
}
#[cfg(test)]
#[allow(non_snake_case)]
#[allow(clippy::many_single_char_names)]
#[allow(clippy::unwrap_used)]
mod test {
use super::*;
use hex_literal::hex;
use tor_basic_utils::test_rng::testing_rng;
#[test]
fn test_ntor3_roundtrip() {
let b = curve25519::StaticSecret::new(testing_rng().rng_compat());
let mut rng = rand::thread_rng();
let id = b"not identifier---but correct len";
let B: curve25519::PublicKey = (&b).into();
let relay_public = NtorV3PublicKey {
pk: B,
id: (*id).into(),
};
let relay_private = NtorV3SecretKey {
pk: relay_public.clone(),
sk: b,
};
let verification = &b"shared secret"[..];
let client_message = &b"Hello. I am a client. Let's be friends!"[..];
let relay_message = &b"Greetings, client. I am a robot. Beep boop."[..];
let (c_state, c_handshake) =
client_handshake_ntor_v3(&mut rng, &relay_public, client_message, verification);
struct Rep(Vec<u8>, Vec<u8>);
impl MsgReply for Rep {
fn reply(&mut self, msg: &[u8]) -> Option<Vec<u8>> {
self.0 = msg.to_vec();
Some(self.1.clone())
}
}
let mut rep = Rep(Vec::new(), relay_message.to_vec());
let (s_handshake, mut s_keygen) = server_handshake_ntor_v3(
&mut rng,
&mut rep,
&c_handshake,
&[relay_private],
verification,
)
.unwrap();
let (s_msg, mut c_keygen) =
client_handshake_ntor_v3_part2(&c_state, &s_handshake, verification).unwrap();
assert_eq!(rep.0[..], client_message[..]);
assert_eq!(s_msg[..], relay_message[..]);
use digest::XofReader;
let mut s_keys = [0_u8; 100];
let mut c_keys = [0_u8; 1000];
s_keygen.read(&mut s_keys);
c_keygen.read(&mut c_keys);
assert_eq!(s_keys[..], c_keys[..100]);
}
#[test]
fn test_ntor3_testvec() {
let b = hex!("4051daa5921cfa2a1c27b08451324919538e79e788a81b38cbed097a5dff454a");
let id = hex!("9fad2af287ef942632833d21f946c6260c33fae6172b60006e86e4a6911753a2");
let x = hex!("b825a3719147bcbe5fb1d0b0fcb9c09e51948048e2e3283d2ab7b45b5ef38b49");
let y = hex!("4865a5b7689dafd978f529291c7171bc159be076b92186405d13220b80e2a053");
let b: curve25519::StaticSecret = b.into();
let B: curve25519::PublicKey = (&b).into();
let id: Ed25519Identity = id.into();
let x: curve25519::StaticSecret = x.into();
let y: curve25519::StaticSecret = y.into();
let client_message = hex!("68656c6c6f20776f726c64");
let verification = hex!("78797a7a79");
let server_message = hex!("486f6c61204d756e646f");
let relay_public = NtorV3PublicKey { pk: B, id };
let relay_private = NtorV3SecretKey {
sk: b,
pk: relay_public.clone(),
};
let (state, client_handshake) =
client_handshake_ntor_v3_no_keygen(&relay_public, &client_message, &verification, x);
assert_eq!(client_handshake[..], hex!("9fad2af287ef942632833d21f946c6260c33fae6172b60006e86e4a6911753a2f8307a2bc1870b00b828bb74dbb8fd88e632a6375ab3bcd1ae706aaa8b6cdd1d252fe9ae91264c91d4ecb8501f79d0387e34ad8ca0f7c995184f7d11d5da4f463bebd9151fd3b47c180abc9e044d53565f04d82bbb3bebed3d06cea65db8be9c72b68cd461942088502f67")[..]);
struct Replier(Vec<u8>, Vec<u8>, bool);
impl MsgReply for Replier {
fn reply(&mut self, msg: &[u8]) -> Option<Vec<u8>> {
assert_eq!(msg, &self.0);
self.2 = true;
Some(self.1.clone())
}
}
let mut rep = Replier(client_message.to_vec(), server_message.to_vec(), false);
let (server_handshake, mut server_keygen) = server_handshake_ntor_v3_no_keygen(
&mut rep,
&y,
&client_handshake,
&[relay_private],
&verification,
)
.unwrap();
assert!(rep.2);
assert_eq!(server_handshake[..], hex!("4bf4814326fdab45ad5184f5518bd7fae25dc59374062698201a50a22954246d2fc5f8773ca824542bc6cf6f57c7c29bbf4e5476461ab130c5b18ab0a91276651202c3e1e87c0d32054c")[..]);
let (server_msg_received, mut client_keygen) =
client_handshake_ntor_v3_part2(&state, &server_handshake, &verification).unwrap();
assert_eq!(&server_msg_received, &server_message);
let (c_keys, s_keys) = {
use digest::XofReader;
let mut c = [0_u8; 256];
let mut s = [0_u8; 256];
client_keygen.read(&mut c);
server_keygen.read(&mut s);
(c, s)
};
assert_eq!(c_keys, s_keys);
assert_eq!(c_keys[..], hex!("9c19b631fd94ed86a817e01f6c80b0743a43f5faebd39cfaa8b00fa8bcc65c3bfeaa403d91acbd68a821bf6ee8504602b094a254392a07737d5662768c7a9fb1b2814bb34780eaee6e867c773e28c212ead563e98a1cd5d5b4576f5ee61c59bde025ff2851bb19b721421694f263818e3531e43a9e4e3e2c661e2ad547d8984caa28ebecd3e4525452299be26b9185a20a90ce1eac20a91f2832d731b54502b09749b5a2a2949292f8cfcbeffb790c7790ed935a9d251e7e336148ea83b063a5618fcff674a44581585fd22077ca0e52c59a24347a38d1a1ceebddbf238541f226b8f88d0fb9c07a1bcd2ea764bbbb5dacdaf5312a14c0b9e4f06309b0333b4a")[..]);
}
}