slauth 0.7.21

oath HOTP and TOTP complient implementation
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
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
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
use std::io::{Cursor, Read, Write};

use byteorder::{BigEndian, LittleEndian, ReadBytesExt, WriteBytesExt};

use crate::u2f::{
    error::Error,
    proto::{
        constants::*,
        raw_message::apdu::{ApduFrame, Request, Response},
    },
};

pub struct RegisterRequest {
    pub challenge: [u8; U2F_CHAL_SIZE],
    pub application: [u8; U2F_APPID_SIZE],
}

pub struct RegisterResponse {
    pub reserved: u8,
    pub user_public_key: [u8; U2F_EC_POINT_SIZE],
    pub key_handle_length: u8,
    pub key_handle: String,
    pub attestation_cert: Vec<u8>,
    pub signature: Vec<u8>,
}

pub struct AuthenticateRequest {
    pub control: u8,
    pub challenge: [u8; U2F_CHAL_SIZE],
    pub application: [u8; U2F_CHAL_SIZE],
    pub key_h_len: u8,
    pub key_handle: Vec<u8>,
}

pub struct AuthenticateResponse {
    pub user_presence: u8,
    pub counter: u32,
    pub signature: Vec<u8>,
}

pub struct VersionRequest {}

pub struct VersionResponse {
    pub version: String,
}

pub trait Message {
    type Apdu: ApduFrame;
    fn from_apdu(apdu: Self::Apdu) -> Result<Self, Error>
    where
        Self: Sized;
    fn into_apdu(self) -> Result<Self::Apdu, Error>;
}

impl Message for RegisterRequest {
    type Apdu = Request;

    fn from_apdu(apdu: Self::Apdu) -> Result<Self, Error>
    where
        Self: Sized,
    {
        if apdu.command_mode != U2F_REGISTER {
            return Err(Error::UnexpectedApdu(format!(
                "Expecting Register Command Mode, got {}",
                apdu.command_mode
            )));
        }

        if apdu.data_len.filter(|l| *l == 64).is_none() {
            return Err(Error::MalformedApdu);
        }

        apdu.data.ok_or(Error::MalformedApdu).and_then(|data| {
            let mut cursor = Cursor::new(data);

            let mut challenge = [0u8; 32];

            cursor.read_exact(&mut challenge)?;

            let mut application = [0u8; 32];

            cursor.read_exact(&mut application)?;

            Ok(RegisterRequest { challenge, application })
        })
    }

    fn into_apdu(self) -> Result<Self::Apdu, Error> {
        let RegisterRequest { challenge, application } = self;

        let mut data = Vec::new();

        data.extend_from_slice(&challenge);
        data.extend_from_slice(&application);

        Ok(Request {
            class_byte: 0,
            command_mode: U2F_REGISTER,
            param_1: 0,
            param_2: 0,
            data_len: Some(64),
            data: Some(data),
            max_rsp_len: Some(MAX_RESPONSE_LEN_EXTENDED),
        })
    }
}

impl Message for RegisterResponse {
    type Apdu = Response;

    fn from_apdu(apdu: Self::Apdu) -> Result<Self, Error>
    where
        Self: Sized,
    {
        if apdu.status != U2F_SW_NO_ERROR {
            return Err(apdu.status.into());
        }

        apdu.data.ok_or(Error::MalformedApdu).and_then(|data| {
            let data_len = data.len();
            let mut cursor = Cursor::new(data);
            let reserved = cursor.read_u8()?;

            if reserved != U2F_REGISTER_ID {
                return Err(Error::MalformedApdu);
            }

            let mut user_public_key = [0u8; 65];
            cursor.read_exact(&mut user_public_key)?;

            let key_handle_length = cursor.read_u8()?;

            let mut key_handle_bytes = vec![0u8; key_handle_length as usize];

            cursor.read_exact(&mut key_handle_bytes[..])?;

            let key_handle = String::from_utf8(key_handle_bytes)
                .map_err(|e| Error::UnexpectedApdu(format!("Got error while parsing key_handle string: {:?}", e)))?;

            let mut attestation_cert = vec![0u8; data_len - cursor.position() as usize];
            cursor.read_exact(&mut attestation_cert[..])?;

            let read_len_max = if attestation_cert.len() < (ASN1_MAX_FOLLOWING_LEN_BYTES + 2) {
                attestation_cert.len()
            } else {
                ASN1_MAX_FOLLOWING_LEN_BYTES + 2
            };

            let cert_len = attestation_cert_length(&attestation_cert[0..read_len_max])?;

            if cert_len > U2F_MAX_ATT_CERT_SIZE || cert_len > attestation_cert.len() {
                return Err(Error::MalformedApdu);
            }

            let signature = attestation_cert.split_off(cert_len);

            Ok(RegisterResponse {
                reserved,
                user_public_key,
                key_handle_length,
                key_handle,
                attestation_cert,
                signature,
            })
        })
    }

    fn into_apdu(self) -> Result<Self::Apdu, Error> {
        let RegisterResponse {
            reserved,
            user_public_key,
            key_handle_length,
            key_handle,
            attestation_cert,
            signature,
        } = self;

        let mut data = Vec::new();

        data.write_u8(reserved)?;
        data.write_all(&user_public_key)?;
        data.write_u8(key_handle_length)?;
        data.write_all(key_handle.as_bytes())?;
        data.write_all(&attestation_cert)?;
        data.write_all(&signature)?;

        Ok(Response {
            data: Some(data),
            status: U2F_SW_NO_ERROR,
        })
    }
}

impl Message for AuthenticateRequest {
    type Apdu = Request;

    fn from_apdu(apdu: Self::Apdu) -> Result<Self, Error>
    where
        Self: Sized,
    {
        if apdu.command_mode != U2F_AUTHENTICATE {
            return Err(Error::UnexpectedApdu(format!(
                "Expecting Version Command Mode, got {}",
                apdu.command_mode
            )));
        }

        let control = apdu.param_1;

        match control {
            U2F_AUTH_CHECK_ONLY | U2F_AUTH_ENFORCE | U2F_AUTH_DONT_ENFORCE => {}
            _ => {
                return Err(Error::MalformedApdu);
            }
        }

        apdu.data.ok_or(Error::MalformedApdu).and_then(move |data| {
            let mut cursor = Cursor::new(data);

            let mut challenge = [0u8; 32];
            cursor.read_exact(&mut challenge)?;

            let mut application = [0u8; 32];
            cursor.read_exact(&mut application)?;

            let key_h_len = cursor.read_u8()?;
            let mut key_handle = vec![0u8; key_h_len as usize];
            cursor.read_exact(&mut key_handle[..])?;

            Ok(AuthenticateRequest {
                control,
                challenge,
                application,
                key_h_len,
                key_handle,
            })
        })
    }

    fn into_apdu(self) -> Result<Self::Apdu, Error> {
        let AuthenticateRequest {
            control,
            challenge,
            application,
            key_h_len,
            key_handle,
        } = self;

        let mut data = Vec::new();

        data.write_all(&challenge)?;
        data.write_all(&application)?;

        data.write_u8(key_h_len)?;
        data.write_all(&key_handle)?;

        let data_len = data.len();

        Ok(Request {
            class_byte: 0,
            command_mode: U2F_AUTHENTICATE,
            param_1: control,
            param_2: 0,
            data_len: Some(data_len),
            data: Some(data),
            max_rsp_len: Some(MAX_RESPONSE_LEN_EXTENDED),
        })
    }
}

impl Message for AuthenticateResponse {
    type Apdu = Response;

    fn from_apdu(apdu: Self::Apdu) -> Result<Self, Error>
    where
        Self: Sized,
    {
        if apdu.status != U2F_SW_NO_ERROR {
            return Err(apdu.status.into());
        }

        apdu.data.ok_or(Error::MalformedApdu).and_then(|data| {
            let data_len = data.len();
            let mut cursor = Cursor::new(data);

            let user_presence = cursor.read_u8()?;
            let counter = cursor.read_u32::<LittleEndian>()?;

            let mut signature = vec![0u8; data_len - cursor.position() as usize];
            cursor.read_exact(&mut signature[..])?;

            Ok(AuthenticateResponse {
                user_presence,
                counter,
                signature,
            })
        })
    }

    fn into_apdu(self) -> Result<Self::Apdu, Error> {
        let AuthenticateResponse {
            user_presence,
            counter,
            mut signature,
        } = self;

        let mut data = Vec::new();

        data.write_u8(user_presence)?;

        data.write_u32::<BigEndian>(counter)?;

        data.append(&mut signature);

        Ok(Response {
            data: Some(data),
            status: U2F_SW_NO_ERROR,
        })
    }
}

impl Message for VersionRequest {
    type Apdu = Request;

    fn from_apdu(apdu: Self::Apdu) -> Result<Self, Error>
    where
        Self: Sized,
    {
        if apdu.command_mode != U2F_VERSION {
            return Err(Error::UnexpectedApdu(format!(
                "Expecting Version Command Mode, got {}",
                apdu.command_mode
            )));
        }

        Ok(VersionRequest {})
    }

    fn into_apdu(self) -> Result<Self::Apdu, Error> {
        Ok(Request {
            class_byte: 0,
            command_mode: U2F_VERSION,
            param_1: 0,
            param_2: 0,
            data_len: None,
            data: None,
            max_rsp_len: Some(MAX_RESPONSE_LEN_EXTENDED),
        })
    }
}

impl Message for VersionResponse {
    type Apdu = Response;

    fn from_apdu(apdu: Self::Apdu) -> Result<Self, Error>
    where
        Self: Sized,
    {
        if apdu.status != U2F_SW_NO_ERROR {
            return Err(apdu.status.into());
        }

        apdu.data.ok_or(Error::MalformedApdu).and_then(|data| {
            Ok(VersionResponse {
                version: String::from_utf8(data)
                    .map_err(|e| Error::UnexpectedApdu(format!("Got error while parsing version string: {:?}", e)))?,
            })
        })
    }

    fn into_apdu(self) -> Result<Self::Apdu, Error> {
        Ok(Response {
            data: Some(self.version.as_bytes().to_vec()),
            status: U2F_SW_NO_ERROR,
        })
    }
}

pub mod apdu {
    use std::io::{Cursor, Read, Write};

    use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};

    use crate::u2f::{
        error::Error,
        proto::constants::{MAX_RESPONSE_LEN_EXTENDED, MAX_RESPONSE_LEN_SHORT},
    };

    pub trait ApduFrame {
        fn read_from(slice: &[u8]) -> Result<Self, Error>
        where
            Self: Sized;
        fn write_to<W: Write>(self, writer: &mut W) -> Result<(), Error>;
        fn get_frame_size(&self) -> usize;
    }

    #[derive(Clone)]
    pub struct Request {
        pub class_byte: u8,
        pub command_mode: u8,
        pub param_1: u8,
        pub param_2: u8,
        pub data_len: Option<usize>,
        pub data: Option<Vec<u8>>,
        pub max_rsp_len: Option<usize>,
    }

    impl ApduFrame for Request {
        fn read_from(slice: &[u8]) -> Result<Self, Error>
        where
            Self: Sized,
        {
            let slice_len = slice.len();
            let mut reader = Cursor::new(slice);
            let class_byte = reader.read_u8()?;
            let command_mode = reader.read_u8()?;
            let param_1 = reader.read_u8()?;
            let param_2 = reader.read_u8()?;

            let mut data_len = None;
            let mut data = None;
            let mut max_rsp_len = None;

            // Try to figure out if this is short of extended encoding
            // assuming this slice where b1 to b4 may not be present
            //
            //              +--+--+--+--+--+--+--+--+
            //              |cl|in|p1|p2|b1|b2|b3|b4|
            //              +--+--+--+--+--+--+--+--+
            // (0) if b1 don't exists --> L_c N_c and L_e are omitted
            // (1) if b2 don't exists --> b1 is L_e, L_c is omitted
            //     if b2 exists --> check 2 more bytes
            //          if b3 don't exists -> Short Enc
            // (2)          if b1 = 0x01 --> b1 is L_c, data is b2, L_e is omitted
            //          if b3 exists
            //              if b4 don't exists
            // (3)              if b1 is 0x00 --> Extended enc, L_e is BE(b2, b3), L_c is omitted
            // (4)              if b1 is 0x01 --> b1 is L_c, data is b2, L_e is b3
            //              if b4 exists
            // (5)              if b1 is 0x00 --> extended encoding
            // (6)              if b1 is not 0x00 --> short encoding
            {
                let remaining_len = slice_len - reader.position() as usize;

                match remaining_len {
                    1 => {
                        // (1)
                        let l_e = reader.read_u8()?;
                        if l_e == 0x00 {
                            max_rsp_len = Some(MAX_RESPONSE_LEN_SHORT)
                        } else {
                            max_rsp_len = Some(l_e as usize)
                        };
                    }
                    2 => {
                        // (2)
                        let l_c = reader.read_u8()?;
                        if l_c != 0x01 {
                            return Err(Error::MalformedApdu);
                        }
                        data_len = Some(l_c as usize);
                        let mut data_vec = vec![0u8; l_c as usize];
                        reader.read_exact(&mut data_vec[..])?;
                        data = Some(data_vec);
                    }
                    3 => {
                        let b_1 = reader.read_u8()?;
                        if b_1 == 0x00 {
                            // (3)
                            let l_e = reader.read_u16::<BigEndian>()?;
                            if l_e == 0x0000 {
                                max_rsp_len = Some(MAX_RESPONSE_LEN_EXTENDED);
                            } else {
                                max_rsp_len = Some(l_e as usize);
                            }
                        } else if b_1 == 0x01 {
                            // (4)
                            let mut data_vec = vec![0u8; b_1 as usize];
                            reader.read_exact(&mut data_vec[..])?;
                            data_len = Some(b_1 as usize);
                            data = Some(data_vec);
                            let l_e = reader.read_u8()?;
                            if l_e == 0x00 {
                                max_rsp_len = Some(MAX_RESPONSE_LEN_SHORT)
                            } else {
                                max_rsp_len = Some(l_e as usize)
                            };
                        } else {
                            return Err(Error::MalformedApdu);
                        }
                    }
                    len if len > 3 => {
                        let b_1 = reader.read_u8()?;
                        if b_1 == 0x00 {
                            // (5)
                            let l_c = reader.read_u16::<BigEndian>()?;
                            let mut data_vec = vec![0u8; l_c as usize];
                            reader.read_exact(&mut data_vec[..])?;
                            let l_e = reader.read_u16::<BigEndian>()?;
                            data_len = Some(l_c as usize);
                            data = Some(data_vec);
                            if l_e == 0x0000 {
                                max_rsp_len = Some(MAX_RESPONSE_LEN_EXTENDED);
                            } else {
                                max_rsp_len = Some(l_e as usize);
                            }
                        } else {
                            // (6)
                            let mut data_vec = vec![0u8; b_1 as usize];
                            reader.read_exact(&mut data_vec[..])?;
                            data_len = Some(b_1 as usize);
                            data = Some(data_vec);
                            let l_e = reader.read_u8()?;
                            if l_e == 0x00 {
                                max_rsp_len = Some(MAX_RESPONSE_LEN_SHORT)
                            } else {
                                max_rsp_len = Some(l_e as usize)
                            };
                        }
                    }
                    _ => {}
                }
            }

            Ok(Request {
                class_byte,
                command_mode,
                param_1,
                param_2,
                data_len,
                data,
                max_rsp_len,
            })
        }

        fn write_to<W: Write + WriteBytesExt>(self, writer: &mut W) -> Result<(), Error> {
            let Request {
                class_byte,
                command_mode,
                param_1,
                param_2,
                data_len,
                data,
                max_rsp_len,
            } = self;

            writer.write_u8(class_byte)?;
            writer.write_u8(command_mode)?;
            writer.write_u8(param_1)?;
            writer.write_u8(param_2)?;

            let mut l_e_offset = true;

            if let Some((data_len, data)) = data_len.and_then(|l| data.map(move |d| (l, d))) {
                l_e_offset = false;
                writer.write_u8(0x00)?;
                writer.write_u16::<BigEndian>(data_len as u16)?;
                writer.write_all(&data[..])?;
            }

            if let Some(max_len) = max_rsp_len {
                if l_e_offset {
                    writer.write_u8(0x00)?;
                }

                if max_len == MAX_RESPONSE_LEN_EXTENDED {
                    writer.write_u16::<BigEndian>(0x0000)?;
                } else {
                    writer.write_u16::<BigEndian>(max_len as u16)?;
                }
            }

            Ok(())
        }

        fn get_frame_size(&self) -> usize {
            let mut len = 4;
            let mut need_offset = false;

            if let Some(ref data_len) = self.data_len {
                if *data_len > 0 {
                    len += data_len + 2; // len of the request data + 2 byte for the extended encoding of the length
                    need_offset = true;
                }
            }

            if let Some(ref max_rsp_len) = self.max_rsp_len {
                if *max_rsp_len > 0 {
                    len += 2;
                    need_offset = true;
                }
            }

            if need_offset {
                len += 1;
            }

            len
        }
    }

    #[derive(Clone)]
    pub struct Response {
        pub data: Option<Vec<u8>>,
        pub status: u16,
    }

    impl Response {
        pub fn from_status(sw: u16) -> Self {
            Response { data: None, status: sw }
        }
    }

    impl ApduFrame for Response {
        fn read_from(slice: &[u8]) -> Result<Self, Error>
        where
            Self: Sized,
        {
            let slice_len = slice.len();

            if slice_len < 2 {
                return Err(Error::MalformedApdu);
            }

            let rsp_data = &slice[0..slice_len - 2];

            let status = (&slice[slice_len - 2..slice_len]).read_u16::<BigEndian>()?;

            let data = if !rsp_data.is_empty() { Some(rsp_data.to_vec()) } else { None };

            Ok(Response { data, status })
        }

        fn write_to<W: Write + WriteBytesExt>(self, writer: &mut W) -> Result<(), Error> {
            let Response { data, status } = self;

            if let Some(data) = data {
                writer.write_all(&data[..])?;
            }

            Ok(writer.write_u16::<BigEndian>(status)?)
        }

        fn get_frame_size(&self) -> usize {
            let mut len = 2; // status bytes
            if let Some(ref data) = self.data {
                len += data.len();
            }
            len
        }
    }
}

pub trait MessageFrame {
    fn read_from<R: Read>(reader: &mut R) -> Result<Self, Error>
    where
        Self: Sized;
    fn write_to<W: Write>(self, writer: &mut W) -> Result<(), Error>;
    fn get_size(&self) -> usize;
}

/// Check bytes to find len of the cert according to the ASN1 DER len encoding.
/// http://en.wikipedia.org/wiki/X.690
pub fn attestation_cert_length(asn1: &[u8]) -> Result<usize, Error> {
    if asn1.len() < 2 {
        return Err(Error::AsnFormatError("Invalid data len".to_string()));
    }

    if asn1[0] != ASN1_SEQ_TYPE {
        return Err(Error::AsnFormatError("Invalid type".to_string()));
    }

    let len = asn1[1];
    if len & ASN1_DEFINITE_SHORT_MASK == 0 {
        // check if len is definite short (len <= 127)
        return Ok(len as usize);
    }

    let following_bytes = len & ASN1_DEFINITE_LONG_FOLLOWING_MASK; // get following len bytes
    if following_bytes == 0 {
        return Err(Error::AsnFormatError("Invalid ans len, expected definite long".to_string()));
    }

    if following_bytes as usize + 2 >= asn1.len() {
        return Err(Error::AsnFormatError(
            "Invalid ans len, too many following len bytes expected".to_string(),
        ));
    }

    let mut len: usize = 0;
    for i in 0..following_bytes as usize {
        len = len * 256 + (asn1[2 + i] as usize);
        if len > U2F_MAX_ATT_CERT_SIZE {
            return Err(Error::Other("Attestation certificate don't meet len requirements".to_string()));
        }
    }

    len += following_bytes as usize;

    Ok(len + 2) // Add type + len bytes
}