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
use crate::command::{Ecdh, SharedSecret};
use super::clock_divider::ClockDivider;
use super::command::{
self, GenKey, Info, Lock, NonceCtx, PrivWrite, PublicKey, Random, Serial, Word,
};
use super::datalink::I2c;
use super::error::{Error, ErrorKind};
use super::memory::{CertificateRepr, Size, Slot, Zone};
use super::packet::{Packet, PacketBuilder, Response};
use super::tngtls::TrustAndGo;
use super::{Block, Digest, Signature};
use core::cell::RefCell;
use core::convert::TryInto;
use core::convert::{identity, TryFrom};
use core::fmt::Debug;
use embedded_hal::blocking::delay::DelayUs;
use embedded_hal::blocking::i2c::{Read, Write};
use heapless::Vec;
pub struct Verifier<'a, PHY, D>(RefCell<Verify<'a, PHY, D>>);
impl<'a, PHY, D> From<Verify<'a, PHY, D>> for Verifier<'a, PHY, D> {
fn from(verify: Verify<'a, PHY, D>) -> Self {
Self(RefCell::new(verify))
}
}
impl<'a, PHY, D> signature::Verifier<Signature> for Verifier<'a, PHY, D>
where
PHY: Read + Write,
<PHY as Read>::Error: Debug,
<PHY as Write>::Error: Debug,
D: DelayUs<u32>,
{
fn verify(&self, msg: &[u8], signature: &Signature) -> Result<(), signature::Error> {
let digest = self
.0
.borrow_mut()
.atca
.sha()
.digest(msg)
.map_err(|_| signature::Error::new())?;
let key_id = self.0.borrow_mut().key_id.clone();
let public_key = self
.0
.borrow_mut()
.atca
.generate_pubkey(key_id)
.map_err(|_| signature::Error::new())?;
self.0
.borrow_mut()
.verify_digest(&digest, signature, &public_key)
.map_err(|_| signature::Error::new())
}
}
pub struct Signer<'a, PHY, D>(RefCell<Sign<'a, PHY, D>>);
impl<'a, PHY, D> From<Sign<'a, PHY, D>> for Signer<'a, PHY, D> {
fn from(sign: Sign<'a, PHY, D>) -> Self {
Self(RefCell::new(sign))
}
}
impl<'a, PHY, D> signature::Signer<Signature> for Signer<'a, PHY, D>
where
PHY: Read + Write,
<PHY as Read>::Error: Debug,
<PHY as Write>::Error: Debug,
D: DelayUs<u32>,
{
fn try_sign(&self, msg: &[u8]) -> Result<Signature, signature::Error> {
let digest = self
.0
.borrow_mut()
.atca
.sha()
.digest(msg)
.map_err(|_| signature::Error::new())?;
self.0
.borrow_mut()
.sign_digest(&digest)
.map_err(|_| signature::Error::new())
}
}
pub struct AtCaClient<PHY, D> {
i2c: I2c<PHY, D>,
buffer: Vec<u8, 192>,
clock_divider: ClockDivider,
}
impl<PHY, D> AtCaClient<PHY, D> {
pub fn new(phy: PHY, delay: D) -> Self {
let i2c = I2c::new(phy, delay);
let buffer = Vec::new();
Self {
i2c,
buffer,
clock_divider: ClockDivider::Zero,
}
}
fn packet_builder(&mut self) -> PacketBuilder<'_> {
let capacity = self.buffer.capacity();
self.buffer.clear();
self.buffer
.resize(capacity, 0x00u8)
.unwrap_or_else(|()| unreachable!("Input length equals to the current capacity."));
PacketBuilder::new(&mut self.buffer)
}
pub fn memory(&mut self) -> Memory<'_, PHY, D> {
Memory { atca: self }
}
pub fn aes(&mut self, key_id: Slot) -> Aes<'_, PHY, D> {
Aes { atca: self, key_id }
}
pub fn sha(&mut self) -> Sha<'_, PHY, D> {
let remaining_bytes = Vec::new();
Sha {
atca: self,
remaining_bytes,
}
}
pub fn sign(&mut self, key_id: Slot) -> Sign<'_, PHY, D> {
Sign { atca: self, key_id }
}
pub fn verify(&mut self, key_id: Slot) -> Verify<'_, PHY, D> {
Verify { atca: self, key_id }
}
}
impl<PHY, D> AtCaClient<PHY, D>
where
PHY: Read + Write,
<PHY as Read>::Error: Debug,
<PHY as Write>::Error: Debug,
D: DelayUs<u32>,
{
fn execute(&mut self, packet: Packet) -> Result<Response<'_>, Error> {
let exec_time = self.clock_divider.execution_time(packet.opcode());
self.i2c.execute(&mut self.buffer, packet, exec_time)
}
pub fn signer(&mut self, key_id: Slot) -> Signer<'_, PHY, D> {
self.sign(key_id).into()
}
pub fn verifier(&mut self, key_id: Slot) -> Verifier<'_, PHY, D> {
self.verify(key_id).into()
}
pub fn tng(&mut self) -> Result<TrustAndGo<'_, PHY, D>, Error> {
self.try_into()
}
pub fn sleep(&mut self) -> Result<(), Error> {
self.i2c.sleep()
}
pub fn info(&mut self) -> Result<Word, Error> {
let packet = Info::new(self.packet_builder()).revision()?;
self.execute(packet)?.as_ref().try_into()
}
pub fn random(&mut self) -> Result<Block, Error> {
let packet = Random::new(self.packet_builder()).random()?;
self.execute(packet)?.as_ref().try_into()
}
pub fn write_message_digest_buffer(&mut self, msg: &Digest) -> Result<(), Error> {
let packet = NonceCtx::new(self.packet_builder()).message_digest_buffer(msg)?;
self.execute(packet).map(drop)
}
pub fn create_private_key(&mut self, key_id: Slot) -> Result<PublicKey, Error> {
let packet = GenKey::new(self.packet_builder()).private_key(key_id)?;
self.execute(packet)?.as_ref().try_into()
}
pub fn write_private_key(&mut self, key_id: Slot, private_key: &Block) -> Result<(), Error> {
let packet =
PrivWrite::new(self.packet_builder()).write_private_key(key_id, private_key)?;
self.execute(packet).map(drop)
}
pub fn generate_pubkey(&mut self, key_id: Slot) -> Result<PublicKey, Error> {
let packet = GenKey::new(self.packet_builder()).public_key(key_id)?;
self.execute(packet)?.as_ref().try_into()
}
pub fn diffie_hellman(
&mut self,
key_id: Slot,
public_key: PublicKey,
) -> Result<SharedSecret, Error> {
let packet = Ecdh::new(self.packet_builder()).diffie_hellman(key_id, public_key)?;
self.execute(packet)?.as_ref().try_into()
}
}
pub struct Memory<'a, PHY, D> {
atca: &'a mut AtCaClient<PHY, D>,
}
impl<'a, PHY, D> Memory<'a, PHY, D> {
pub(crate) const SLOT_CONFIG_INDEX: usize = 20;
pub(crate) const CHIP_OPTIONS_INDEX: usize = 90;
pub(crate) const KEY_CONFIG_INDEX: usize = 96;
}
impl<'a, PHY, D> Memory<'a, PHY, D>
where
PHY: Read + Write,
<PHY as Read>::Error: Debug,
<PHY as Write>::Error: Debug,
D: DelayUs<u32>,
{
pub fn serial_number(&mut self) -> Result<Serial, Error> {
let packet =
command::Read::new(self.atca.packet_builder()).read(Zone::Config, Size::Block, 0, 0)?;
self.atca.execute(packet)?.as_ref().try_into()
}
pub fn pubkey(&mut self, key_id: Slot) -> Result<PublicKey, Error> {
let mut pubkey = PublicKey::default();
CertificateRepr::new()
.enumerate()
.scan(0, |offset, (i, ranges)| {
let result = command::Read::new(self.atca.packet_builder())
.slot(key_id, i as u8)
.and_then(|packet| {
let response = self.atca.execute(packet)?;
for range in ranges {
let dst = *offset..*offset + range.len();
pubkey.as_mut()[dst].copy_from_slice(&response.as_ref()[range.clone()]);
*offset += range.len();
}
Ok(())
});
Some(result)
})
.try_for_each(identity)
.map(|()| pubkey)
}
pub fn write_pubkey(&mut self, key_id: Slot, pubkey: impl AsRef<[u8]>) -> Result<(), Error> {
let mut data = Block::default();
CertificateRepr::new()
.enumerate()
.scan(0, |offset, (i, ranges)| {
data.as_mut().iter_mut().for_each(|value| *value = 0);
for range in ranges {
let src = *offset..*offset + range.len();
data.as_mut()[range.clone()].copy_from_slice(&pubkey.as_ref()[src]);
*offset += range.len();
}
let result = command::Write::new(self.atca.packet_builder())
.slot(key_id, i as u8, &data)
.and_then(|packet| self.atca.execute(packet).map(drop));
Some(result)
})
.try_for_each(identity)
}
pub fn write_aes_key(&mut self, key_id: Slot, aes_key: impl AsRef<[u8]>) -> Result<(), Error> {
let mut data = Block::default();
data.as_mut()[..0x10].copy_from_slice(aes_key.as_ref());
let packet =
command::Write::new(self.atca.packet_builder()).slot(key_id, 0 as u8, &data)?;
self.atca.execute(packet).map(drop)
}
pub fn is_slot_locked(&mut self, slot: Slot) -> Result<bool, Error> {
let zone = Zone::Config;
let size = Size::Word;
let block = 2;
let word_offset = 6;
let packet =
command::Read::new(self.atca.packet_builder()).read(zone, size, block, word_offset)?;
let response = self.atca.execute(packet)?;
let word = Word::try_from(response.as_ref())?;
let slot_locked_bytes = word.as_ref()[..2]
.try_into()
.map(u16::from_le_bytes)
.unwrap_or_else(|_| unreachable!());
Ok(slot_locked_bytes & (0x01u16 << slot as u32) == 0x00)
}
pub fn is_locked(&mut self, zone: Zone) -> Result<bool, Error> {
let size = Size::Word;
let block = 2;
let word_offset = 5;
let packet = command::Read::new(self.atca.packet_builder()).read(
Zone::Config,
size,
block,
word_offset,
)?;
let response = self.atca.execute(packet)?;
let word = Word::try_from(response.as_ref())?;
match zone {
Zone::Config => Ok(word.as_ref()[3] != 0x55),
Zone::Data => Ok(word.as_ref()[2] != 0x55),
Zone::Otp => Err(ErrorKind::BadParam.into()),
}
}
pub fn lock_slot(&mut self, key_id: Slot) -> Result<(), Error> {
let packet = Lock::new(self.atca.packet_builder()).slot(key_id)?;
self.atca.execute(packet).map(drop)
}
pub fn lock(&mut self, zone: Zone) -> Result<(), Error> {
let packet = Lock::new(self.atca.packet_builder()).zone(zone, None)?;
self.atca.execute(packet).map(drop)
}
pub fn lock_crc(&mut self, zone: Zone, crc: u16) -> Result<(), Error> {
let packet = Lock::new(self.atca.packet_builder()).zone(zone, Some(crc))?;
self.atca.execute(packet).map(drop)
}
pub fn chip_options(&mut self) -> Result<u16, Error> {
let (block, offset, pos) = Zone::locate_index(Self::CHIP_OPTIONS_INDEX);
let range = pos as usize..pos as usize + 2;
self.read_config(Size::Word, block, offset).map(|resp| {
resp.as_ref()[range]
.try_into()
.map(u16::from_le_bytes)
.unwrap_or_else(|_| unreachable!())
})
}
pub fn permission(&mut self, slot: Slot) -> Result<u16, Error> {
let index = Self::SLOT_CONFIG_INDEX + (slot as usize * 2);
let (block, offset, pos) = Zone::locate_index(index);
let range = pos as usize..pos as usize + 2;
self.read_config(Size::Word, block, offset).map(|resp| {
resp.as_ref()[range]
.try_into()
.map(u16::from_le_bytes)
.unwrap_or_else(|_| unreachable!())
})
}
pub fn key_type(&mut self, slot: Slot) -> Result<u16, Error> {
let index = Self::KEY_CONFIG_INDEX + (slot as usize * 2);
let (block, offset, pos) = Zone::locate_index(index);
let range = pos as usize..pos as usize + 2;
self.read_config(Size::Word, block, offset).map(|resp| {
resp.as_ref()[range]
.try_into()
.map(u16::from_le_bytes)
.unwrap_or_else(|_| unreachable!())
})
}
pub fn read_config(
&mut self,
size: Size,
block: u8,
offset: u8,
) -> Result<Response<'_>, Error> {
let packet = command::Read::new(self.atca.packet_builder()).read(
Zone::Config,
size,
block,
offset,
)?;
self.atca.execute(packet)
}
pub fn write_config(
&mut self,
size: Size,
block: u8,
offset: u8,
data: impl AsRef<[u8]>,
) -> Result<(), Error> {
let packet = command::Write::new(self.atca.packet_builder()).write(
Zone::Config,
size,
block,
offset,
data,
)?;
self.atca.execute(packet).map(drop)
}
}
pub struct Aes<'a, PHY, D> {
atca: &'a mut AtCaClient<PHY, D>,
key_id: Slot,
}
impl<'a, PHY, D> Aes<'a, PHY, D>
where
PHY: Read + Write,
<PHY as Read>::Error: Debug,
<PHY as Write>::Error: Debug,
D: DelayUs<u32>,
{
pub fn encrypt(&mut self, plaintext: &[u8], ciphertext: &mut [u8]) -> Result<(), Error> {
use command::Aes as AesCmd;
if plaintext.len() != ciphertext.len() {
return Err(ErrorKind::BadParam.into());
}
for (plain, cipher) in plaintext
.chunks(AesCmd::DATA_SIZE)
.zip(ciphertext.chunks_mut(AesCmd::DATA_SIZE))
{
let packet = AesCmd::new(self.atca.packet_builder()).encrypt(self.key_id, plain)?;
let response = self.atca.execute(packet)?;
if response.as_ref().len() != AesCmd::DATA_SIZE {
return Err(ErrorKind::InvalidSize.into());
}
cipher.copy_from_slice(response.as_ref());
}
Ok(())
}
pub fn decrypt(&mut self, ciphertext: &[u8], plaintext: &mut [u8]) -> Result<(), Error> {
use command::Aes as AesCmd;
if ciphertext.len() != plaintext.len() {
return Err(ErrorKind::BadParam.into());
}
for (cipher, plain) in ciphertext
.chunks(AesCmd::DATA_SIZE)
.zip(plaintext.chunks_mut(AesCmd::DATA_SIZE))
{
let packet = AesCmd::new(self.atca.packet_builder()).decrypt(self.key_id, cipher)?;
let response = self.atca.execute(packet)?;
if response.as_ref().len() != AesCmd::DATA_SIZE {
return Err(ErrorKind::InvalidSize.into());
}
plain.copy_from_slice(response.as_ref());
}
Ok(())
}
}
pub struct Sha<'a, PHY, D> {
atca: &'a mut AtCaClient<PHY, D>,
remaining_bytes: Vec<u8, 64>,
}
impl<'a, PHY, D> Sha<'a, PHY, D>
where
PHY: Read + Write,
<PHY as Read>::Error: Debug,
<PHY as Write>::Error: Debug,
D: DelayUs<u32>,
{
pub fn init(&mut self) -> Result<(), Error> {
let packet = command::Sha::new(self.atca.packet_builder()).start()?;
self.atca.execute(packet).map(drop)
}
pub fn update(&mut self, data: impl AsRef<[u8]>) -> Result<(), Error> {
let capacity = 0x40;
let length = data.as_ref().len();
let remainder_length = data.as_ref().len() % capacity;
let (bytes, remainder) = data.as_ref().split_at(length - remainder_length);
self.remaining_bytes.extend_from_slice(remainder).ok();
bytes.chunks(capacity).try_for_each(|chunk| {
let packet = command::Sha::new(self.atca.packet_builder()).update(chunk)?;
self.atca.execute(packet).map(drop)
})
}
pub fn chain(&mut self, data: impl AsRef<[u8]>) -> Result<&mut Self, Error> {
if self.remaining_bytes.len() != 0 {
}
self.update(data)?;
Ok(self)
}
pub fn finalize(&mut self) -> Result<Digest, Error> {
let packet = command::Sha::new(self.atca.packet_builder()).end(&self.remaining_bytes)?;
self.atca.execute(packet)?.as_ref().try_into()
}
pub fn digest(&mut self, data: &[u8]) -> Result<Digest, Error> {
self.init()?;
self.update(data)?;
self.finalize()
}
}
pub struct Sign<'a, PHY, D> {
atca: &'a mut AtCaClient<PHY, D>,
key_id: Slot,
}
impl<'a, PHY, D> Sign<'a, PHY, D>
where
PHY: Read + Write,
<PHY as Read>::Error: Debug,
<PHY as Write>::Error: Debug,
D: DelayUs<u32>,
{
pub fn sign_digest(&mut self, digest: &Digest) -> Result<Signature, Error> {
self.atca.random()?;
self.atca.write_message_digest_buffer(digest)?;
let packet = command::Sign::new(self.atca.packet_builder()).external(self.key_id)?;
self.atca.execute(packet)?.as_ref().try_into()
}
}
pub struct Verify<'a, PHY, D> {
atca: &'a mut AtCaClient<PHY, D>,
key_id: Slot,
}
impl<'a, PHY, D> Verify<'a, PHY, D>
where
PHY: Read + Write,
<PHY as Read>::Error: Debug,
<PHY as Write>::Error: Debug,
D: DelayUs<u32>,
{
pub fn verify_digest(
&mut self,
digest: &Digest,
signature: &Signature,
public_key: &PublicKey,
) -> Result<(), Error> {
self.atca.write_message_digest_buffer(digest)?;
let packet =
command::Verify::new(self.atca.packet_builder()).external(signature, public_key)?;
self.atca.execute(packet).map(drop)
}
}