iwlink 0.1.1

IntelliWallet Link - encrypted phone to computer protocol for IntelliWallet for Browser
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
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
//! Noise handshakes and the encrypted transport.
//!
//! The phone is always the initiator, the helper always the responder,
//! because the phone is the side that connects.
//!
//! | Handshake | Pattern | Initiator knows | Responder knows |
//! |---|---|---|---|
//! | Pairing | IKpsk2 | helper static key and PSK, from the QR code | its own key and the PSK it put in the QR code |
//! | Reconnect | KK | helper static key | the paired phone's static key |
//!
//! Both are two messages long: initiator, then responder. After the second
//! message both sides call [`Handshake::finish`] and switch to a [`Session`].
//!
//! # Prologue
//!
//! Every handshake mixes in a prologue of `iwlink`, the negotiated protocol
//! version and the handshake kind. If the two sides disagree on any of them,
//! for example because someone in the middle rewrote the `info`
//! characteristic to force an older version, the handshake fails instead of
//! silently running a different protocol.
//!
//! # Ordering
//!
//! The transport uses Noise's implicit nonces, so sealed messages must be
//! opened in the order they were sealed. GATT delivers writes and
//! notifications in order on one connection; a lost or reordered message
//! shows up as [`LinkError::Decrypt`], and the caller drops the session and
//! reconnects. There is deliberately no attempt to resynchronise: a session
//! that has lost a message is not trusted further.

use zeroize::Zeroizing;

use crate::error::{LinkError, Result};
use crate::keys::{KEY_LEN, PublicKey, StaticKeypair};
use crate::message::Message;
use crate::pairing::{PSK_LEN, PairingOffer};

/// Noise pattern used for pairing.
pub const PAIRING_PATTERN: &str = "Noise_IKpsk2_25519_ChaChaPoly_BLAKE2s";

/// Noise pattern used for every reconnect.
pub const RECONNECT_PATTERN: &str = "Noise_KK_25519_ChaChaPoly_BLAKE2s";

/// Largest Noise message, including the 16 byte tag.
pub const MAX_NOISE_MESSAGE: usize = 65_535;

/// Largest plaintext that fits in one sealed transport message.
pub const MAX_PLAINTEXT: usize = MAX_NOISE_MESSAGE - 16;

/// Largest payload carried inside a handshake message.
pub const MAX_HANDSHAKE_PAYLOAD: usize = 1_024;

/// Which handshake is running.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum HandshakeKind {
    Pairing,
    Reconnect,
}

impl HandshakeKind {
    fn tag(self) -> u8 {
        match self {
            HandshakeKind::Pairing => b'P',
            HandshakeKind::Reconnect => b'R',
        }
    }
}

fn prologue(version: u16, kind: HandshakeKind) -> [u8; 9] {
    let mut out = [0u8; 9];
    out[..6].copy_from_slice(b"iwlink");
    out[6..8].copy_from_slice(&version.to_be_bytes());
    out[8] = kind.tag();
    out
}

fn params(pattern: &str) -> Result<snow::params::NoiseParams> {
    pattern
        .parse()
        .map_err(|_| LinkError::Handshake("noise parameters".into()))
}

/// A handshake in progress.
pub struct Handshake {
    state: snow::HandshakeState,
    kind: HandshakeKind,
    version: u16,
}

impl Handshake {
    /// Phone side of pairing, from a scanned [`PairingOffer`].
    ///
    /// `local` is the fresh keypair the phone generated for this computer.
    /// `version` is the version negotiated from the helper's `info`
    /// characteristic, which must not exceed the offer's version.
    pub fn pairing_initiator(
        local: &StaticKeypair,
        offer: &PairingOffer,
        version: u16,
        now: i64,
    ) -> Result<Handshake> {
        if offer.is_expired(now) {
            return Err(LinkError::OfferExpired);
        }
        if version > offer.version || !crate::VersionRange::LOCAL.contains(version) {
            return Err(LinkError::VersionMismatch);
        }
        let kind = HandshakeKind::Pairing;
        let prologue = prologue(version, kind);
        let state = snow::Builder::new(params(PAIRING_PATTERN)?)
            .prologue(&prologue)?
            .local_private_key(local.secret_bytes())?
            .remote_public_key(offer.helper_public.as_bytes())?
            .psk(2, &offer.psk)?
            .build_initiator()?;
        Ok(Handshake {
            state,
            kind,
            version,
        })
    }

    /// Helper side of pairing, while its QR code is on screen.
    ///
    /// The caller checks the offer's expiry before calling this, and
    /// discards the pre-shared key once one pairing has completed.
    pub fn pairing_responder(
        local: &StaticKeypair,
        psk: &[u8; PSK_LEN],
        version: u16,
    ) -> Result<Handshake> {
        if !crate::VersionRange::LOCAL.contains(version) {
            return Err(LinkError::VersionMismatch);
        }
        let kind = HandshakeKind::Pairing;
        let prologue = prologue(version, kind);
        let state = snow::Builder::new(params(PAIRING_PATTERN)?)
            .prologue(&prologue)?
            .local_private_key(local.secret_bytes())?
            .psk(2, psk)?
            .build_responder()?;
        Ok(Handshake {
            state,
            kind,
            version,
        })
    }

    /// Phone side of a reconnect to a paired helper.
    pub fn reconnect_initiator(
        local: &StaticKeypair,
        helper: &PublicKey,
        version: u16,
    ) -> Result<Handshake> {
        Self::reconnect(local, helper, version, true)
    }

    /// Helper side of a reconnect from the paired phone.
    pub fn reconnect_responder(
        local: &StaticKeypair,
        phone: &PublicKey,
        version: u16,
    ) -> Result<Handshake> {
        Self::reconnect(local, phone, version, false)
    }

    fn reconnect(
        local: &StaticKeypair,
        remote: &PublicKey,
        version: u16,
        initiator: bool,
    ) -> Result<Handshake> {
        if !crate::VersionRange::LOCAL.contains(version) {
            return Err(LinkError::VersionMismatch);
        }
        let kind = HandshakeKind::Reconnect;
        let prologue = prologue(version, kind);
        let builder = snow::Builder::new(params(RECONNECT_PATTERN)?)
            .prologue(&prologue)?
            .local_private_key(local.secret_bytes())?
            .remote_public_key(remote.as_bytes())?;
        let state = if initiator {
            builder.build_initiator()?
        } else {
            builder.build_responder()?
        };
        Ok(Handshake {
            state,
            kind,
            version,
        })
    }

    pub fn kind(&self) -> HandshakeKind {
        self.kind
    }

    pub fn version(&self) -> u16 {
        self.version
    }

    /// Whether this side should write the next handshake message.
    pub fn is_my_turn(&self) -> bool {
        self.state.is_my_turn()
    }

    pub fn is_finished(&self) -> bool {
        self.state.is_handshake_finished()
    }

    /// Produce the next handshake message, carrying `payload`.
    ///
    /// In the first message of either pattern the payload is encrypted but
    /// the responder has not yet proved its identity, so callers send nothing
    /// sensitive there. The phone's display name is the only payload in use.
    pub fn write(&mut self, payload: &[u8]) -> Result<Vec<u8>> {
        if payload.len() > MAX_HANDSHAKE_PAYLOAD {
            return Err(LinkError::TooLarge);
        }
        let mut out = vec![0u8; MAX_NOISE_MESSAGE];
        let n = self.state.write_message(payload, &mut out)?;
        out.truncate(n);
        Ok(out)
    }

    /// Consume the peer's handshake message and return its payload.
    pub fn read(&mut self, message: &[u8]) -> Result<Vec<u8>> {
        if message.len() > MAX_NOISE_MESSAGE {
            return Err(LinkError::TooLarge);
        }
        let mut out = vec![0u8; MAX_NOISE_MESSAGE];
        let n = self.state.read_message(message, &mut out)?;
        out.truncate(n);
        if out.len() > MAX_HANDSHAKE_PAYLOAD {
            return Err(LinkError::TooLarge);
        }
        Ok(out)
    }

    /// Switch to transport mode once both messages have been exchanged.
    pub fn finish(self) -> Result<Established> {
        if !self.state.is_handshake_finished() {
            return Err(LinkError::Handshake("handshake not finished".into()));
        }
        let remote_static = self
            .state
            .get_remote_static()
            .ok_or_else(|| LinkError::Handshake("no remote static key".into()))
            .and_then(PublicKey::from_slice)?;
        let hash = self.state.get_handshake_hash();
        let handshake_hash: [u8; KEY_LEN] = hash
            .get(..KEY_LEN)
            .and_then(|h| h.try_into().ok())
            .ok_or_else(|| LinkError::Handshake("handshake hash length".into()))?;
        let version = self.version;
        let transport = self.state.into_transport_mode()?;
        Ok(Established {
            session: Session { transport, version },
            remote_static,
            handshake_hash,
        })
    }
}

impl std::fmt::Debug for Handshake {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Handshake")
            .field("kind", &self.kind)
            .field("version", &self.version)
            .field("finished", &self.is_finished())
            .finish_non_exhaustive()
    }
}

/// The result of a completed handshake.
#[derive(Debug)]
pub struct Established {
    pub session: Session,
    /// The peer's static key. After pairing, the helper stores this as the
    /// paired phone's key.
    pub remote_static: PublicKey,
    /// Identical on both sides; feeds [`crate::pairing::confirmation_code`].
    pub handshake_hash: [u8; KEY_LEN],
}

/// An established, encrypted session.
pub struct Session {
    transport: snow::TransportState,
    version: u16,
}

impl Session {
    pub fn version(&self) -> u16 {
        self.version
    }

    /// Seal raw bytes.
    pub fn seal(&mut self, plaintext: &[u8]) -> Result<Vec<u8>> {
        if plaintext.len() > MAX_PLAINTEXT {
            return Err(LinkError::TooLarge);
        }
        let mut out = vec![0u8; plaintext.len() + 16];
        let n = self.transport.write_message(plaintext, &mut out)?;
        out.truncate(n);
        Ok(out)
    }

    /// Open raw bytes. The plaintext is wiped when the returned value drops.
    pub fn open(&mut self, ciphertext: &[u8]) -> Result<Zeroizing<Vec<u8>>> {
        if ciphertext.len() > MAX_NOISE_MESSAGE {
            return Err(LinkError::TooLarge);
        }
        if ciphertext.len() < 16 {
            return Err(LinkError::Decrypt);
        }
        let mut out = Zeroizing::new(vec![0u8; ciphertext.len()]);
        let n = self
            .transport
            .read_message(ciphertext, &mut out)
            .map_err(|_| LinkError::Decrypt)?;
        out.truncate(n);
        Ok(out)
    }

    /// Encode and seal a protocol message.
    pub fn seal_message(&mut self, message: &Message) -> Result<Vec<u8>> {
        let plaintext = message.encode()?;
        self.seal(&plaintext)
    }

    /// Open and decode a protocol message.
    pub fn open_message(&mut self, ciphertext: &[u8]) -> Result<Message> {
        let plaintext = self.open(ciphertext)?;
        Message::decode(&plaintext)
    }
}

impl std::fmt::Debug for Session {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Session")
            .field("version", &self.version)
            .finish_non_exhaustive()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::pairing::{HelperId, confirmation_code};

    const NOW: i64 = 10_000;

    fn run(mut phone: Handshake, mut helper: Handshake) -> Result<(Established, Established)> {
        let m1 = phone.write(b"phone")?;
        assert_eq!(helper.read(&m1)?, b"phone");
        let m2 = helper.write(b"helper")?;
        assert_eq!(phone.read(&m2)?, b"helper");
        Ok((phone.finish()?, helper.finish()?))
    }

    struct Pairing {
        helper_keys: StaticKeypair,
        phone_keys: StaticKeypair,
        offer: PairingOffer,
    }

    fn pairing() -> Pairing {
        let helper_keys = StaticKeypair::generate().unwrap();
        let offer = PairingOffer::create(
            HelperId::generate().unwrap(),
            helper_keys.public(),
            "Mac",
            NOW,
        )
        .unwrap();
        Pairing {
            helper_keys,
            phone_keys: StaticKeypair::generate().unwrap(),
            offer,
        }
    }

    #[test]
    fn pairing_then_reconnect() {
        let p = pairing();
        let phone = Handshake::pairing_initiator(&p.phone_keys, &p.offer, 1, NOW).unwrap();
        let helper = Handshake::pairing_responder(&p.helper_keys, &p.offer.psk, 1).unwrap();
        let (mut a, mut b) = run(phone, helper).unwrap();

        // Each side learned the other's static key.
        assert_eq!(a.remote_static, p.helper_keys.public());
        assert_eq!(b.remote_static, p.phone_keys.public());
        // Both screens show the same code.
        assert_eq!(
            confirmation_code(&a.handshake_hash),
            confirmation_code(&b.handshake_hash)
        );

        // Transport works both ways.
        let sealed = a.session.seal(b"to helper").unwrap();
        assert_eq!(b.session.open(&sealed).unwrap().as_slice(), b"to helper");
        let sealed = b.session.seal(b"to phone").unwrap();
        assert_eq!(a.session.open(&sealed).unwrap().as_slice(), b"to phone");

        // Later connections use KK with the stored keys.
        let phone =
            Handshake::reconnect_initiator(&p.phone_keys, &p.helper_keys.public(), 1).unwrap();
        let helper =
            Handshake::reconnect_responder(&p.helper_keys, &p.phone_keys.public(), 1).unwrap();
        let (mut a, mut b) = run(phone, helper).unwrap();
        let sealed = a.session.seal(b"again").unwrap();
        assert_eq!(b.session.open(&sealed).unwrap().as_slice(), b"again");
    }

    #[test]
    fn wrong_psk_fails() {
        let p = pairing();
        let phone = Handshake::pairing_initiator(&p.phone_keys, &p.offer, 1, NOW).unwrap();
        let helper = Handshake::pairing_responder(&p.helper_keys, &[0u8; PSK_LEN], 1).unwrap();
        assert!(run(phone, helper).is_err());
    }

    #[test]
    fn wrong_helper_key_fails() {
        let p = pairing();
        let impostor = StaticKeypair::generate().unwrap();
        let phone = Handshake::pairing_initiator(&p.phone_keys, &p.offer, 1, NOW).unwrap();
        let helper = Handshake::pairing_responder(&impostor, &p.offer.psk, 1).unwrap();
        assert!(run(phone, helper).is_err());
    }

    #[test]
    fn expired_offer_is_refused() {
        let p = pairing();
        let late = p.offer.expires_at;
        assert_eq!(
            Handshake::pairing_initiator(&p.phone_keys, &p.offer, 1, late).unwrap_err(),
            LinkError::OfferExpired
        );
    }

    #[test]
    fn reconnect_with_an_unknown_phone_fails() {
        let p = pairing();
        let stranger = StaticKeypair::generate().unwrap();
        let phone = Handshake::reconnect_initiator(&stranger, &p.helper_keys.public(), 1).unwrap();
        let helper =
            Handshake::reconnect_responder(&p.helper_keys, &p.phone_keys.public(), 1).unwrap();
        assert!(run(phone, helper).is_err());
    }

    #[test]
    fn reconnect_to_an_impostor_helper_fails() {
        let p = pairing();
        let impostor = StaticKeypair::generate().unwrap();
        let phone =
            Handshake::reconnect_initiator(&p.phone_keys, &p.helper_keys.public(), 1).unwrap();
        let helper = Handshake::reconnect_responder(&impostor, &p.phone_keys.public(), 1).unwrap();
        assert!(run(phone, helper).is_err());
    }

    #[test]
    fn version_disagreement_fails() {
        // Prologues differ, so the handshake cannot complete. Only version 1
        // exists today, so the disagreement is simulated through the kind tag,
        // which is mixed into the same prologue.
        assert_ne!(
            prologue(1, HandshakeKind::Pairing),
            prologue(2, HandshakeKind::Pairing)
        );
        assert_ne!(
            prologue(1, HandshakeKind::Pairing),
            prologue(1, HandshakeKind::Reconnect)
        );
        let p = pairing();
        assert_eq!(
            Handshake::reconnect_initiator(&p.phone_keys, &p.helper_keys.public(), 99).unwrap_err(),
            LinkError::VersionMismatch
        );
    }

    #[test]
    fn replayed_first_message_gives_the_attacker_nothing() {
        let p = pairing();
        let mut phone =
            Handshake::reconnect_initiator(&p.phone_keys, &p.helper_keys.public(), 1).unwrap();
        let m1 = phone.write(b"").unwrap();

        // An attacker replays m1 to a fresh helper handshake. The helper
        // answers, but the answer is bound to the phone's ephemeral key, so
        // only the real phone could finish, and it has moved on.
        let mut helper =
            Handshake::reconnect_responder(&p.helper_keys, &p.phone_keys.public(), 1).unwrap();
        helper.read(&m1).unwrap();
        let m2 = helper.write(b"").unwrap();

        let mut second_phone =
            Handshake::reconnect_initiator(&p.phone_keys, &p.helper_keys.public(), 1).unwrap();
        second_phone.write(b"").unwrap();
        assert!(
            second_phone.read(&m2).is_err(),
            "a different session must not accept m2"
        );
    }

    fn sessions() -> (Session, Session) {
        let p = pairing();
        let phone = Handshake::pairing_initiator(&p.phone_keys, &p.offer, 1, NOW).unwrap();
        let helper = Handshake::pairing_responder(&p.helper_keys, &p.offer.psk, 1).unwrap();
        let (a, b) = run(phone, helper).unwrap();
        (a.session, b.session)
    }

    #[test]
    fn tampered_transport_message_fails() {
        let (mut a, mut b) = sessions();
        let mut sealed = a.seal(b"hello").unwrap();
        sealed[0] ^= 1;
        assert_eq!(b.open(&sealed).unwrap_err(), LinkError::Decrypt);
    }

    #[test]
    fn reordered_transport_messages_fail() {
        let (mut a, mut b) = sessions();
        let _first = a.seal(b"one").unwrap();
        let second = a.seal(b"two").unwrap();
        assert_eq!(b.open(&second).unwrap_err(), LinkError::Decrypt);
    }

    #[test]
    fn replayed_transport_message_fails() {
        let (mut a, mut b) = sessions();
        let sealed = a.seal(b"once").unwrap();
        b.open(&sealed).unwrap();
        assert_eq!(b.open(&sealed).unwrap_err(), LinkError::Decrypt);
    }

    #[test]
    fn messages_round_trip_through_a_session() {
        let (mut a, mut b) = sessions();
        let sealed = a.seal_message(&Message::Ping).unwrap();
        assert_eq!(b.open_message(&sealed).unwrap(), Message::Ping);
    }

    #[test]
    fn oversized_input_is_refused() {
        let p = pairing();
        let mut phone = Handshake::pairing_initiator(&p.phone_keys, &p.offer, 1, NOW).unwrap();
        assert_eq!(
            phone
                .write(&vec![0u8; MAX_HANDSHAKE_PAYLOAD + 1])
                .unwrap_err(),
            LinkError::TooLarge
        );
    }

    #[test]
    fn finish_before_the_end_is_refused() {
        let p = pairing();
        let phone = Handshake::pairing_initiator(&p.phone_keys, &p.offer, 1, NOW).unwrap();
        assert!(phone.finish().is_err());
    }
}