Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dmazzella/ucryptoauthlib

Lightweight driver for Microchip's Crypto Authentication secure elements written in pure python for micropython
https://github.com/dmazzella/ucryptoauthlib

atecc atecc508a atecc608a micropython pyboard

Last synced: 25 days ago
JSON representation

Lightweight driver for Microchip's Crypto Authentication secure elements written in pure python for micropython

Awesome Lists containing this project

README 

        
# ucryptoauthlib



Lightweight driver for Microchip Crypto Authentication secure elements written in pure python for micropython.



WARNING: this project is in beta stage and is subject to changes of the

code-base, including project-wide name changes and API changes.



> [!TIP]

> If you find **ucryptoauthlib** useful, consider :star: this project

> and why not ... [Buy me a coffee](https://www.buymeacoffee.com/damianomazp) :smile:



Features

---------------------



- Allows PyBoard to control Microchip Crypto Authentication secure elements

- Automatic recognition of the Microchip Crypto Authentication secure element

- The API are the same of the [Library](https://github.com/MicrochipTech/cryptoauthlib) wrote by Microchip



Usage

---------------------



- PyBoard basic connection:



PYBOARD plus ATECCX08A



- BASIC



```python

MicroPython v1.10-127-g5801a003f-dirty on 2019-02-24; PYBv1.1 with STM32F405RG

Type "help()" for more information.

>>> from cryptoauthlib.device import ATECCX08A

>>> device = ATECCX08A()

>>> print(device)



>>>

```



- TESTS:



```python

MicroPython v1.10-127-g5801a003f-dirty on 2019-02-24; PYBv1.1 with STM32F405RG

Type "help()" for more information.

>>> import ateccX08a; ateccX08a.test()

INFO:ateccX08a 

INFO:ateccX08a INFO SUCCEDED

INFO:ateccX08a SHA SUCCEDED

INFO:ateccX08a RANDOM SUCCEDED

INFO:ateccX08a NONCE SUCCEDED

INFO:ateccX08a READ SUCCEDED

INFO:ateccX08a WRITE SUCCEDED

INFO:ateccX08a LOCK SKIPPED

INFO:ateccX08a VERIFY SUCCEDED

INFO:ateccX08a SIGN SUCCEDED

INFO:ateccX08a SELFTEST SUCCEDED

>>> 

```



Enable DEBUG:

```python

import logging

logging.basicConfig(level=logging.DEBUG)

```



External dependencies

---------------------



Only for tests:

'logging' already available into folder 'micropython-lib' of this repository



Install 'cryptoauthlib' into the PyBoard

---------------------



1. Freeze package using FROZEN_MANIFEST:

   ```bash

   $ git clone https://github.com/micropython/micropython.git

   $ cd micropython

   micropython$ git submodule update --init

   micropython$ git clone https://github.com/dmazzella/ucryptoauthlib.git micropython-lib/ucryptoauthlib

   micropython$ make -C mpy-cross && make -C ports/stm32 BOARD=PYBD_SF6 FROZEN_MANIFEST="$(pwd)/micropython-lib/ucryptoauthlib/manifest.py"

   ```

   P.S.

   'micropython-lib' is an example where to copy 'ucryptoauthlib', if you prefer to change this directory you need to modify manifest.py to reflect the changes



Software

---------------------



Currently supported commands are:



* INFO

* LOCK

* NONCE

* RANDOM

* READ (1)

* SHA (1)

* WRITE (1)

* VERIFY (1)

* GENKEY

* SIGN

* SELFTEST



  (1) Not all features are implemented, see follow list for details



Currently implemented methods are:



![API Implemented](https://progress-bar.dev/61)



- [x] ```atcab_version()```

- [x] ```atcab_get_addr(zone, slot=0, block=0, offset=0)```

- [x] ```atcab_get_zone_size(zone, slot=0)```

- [ ] ```atcab_checkmac(mode, key_id, challenge, response,  other_data)```

- [ ] ```atcab_counter(mode, counter_id)```

- [ ] ```atcab_counter_increment(counter_id)```

- [ ] ```atcab_counter_read(counter_id)```

- [ ] ```atcab_derivekey(mode, key_id, mac)```

- [ ] ```atcab_ecdh_base(mode, key_id, public_key)```

- [ ] ```atcab_ecdh(key_id, public_key)```

- [ ] ```atcab_ecdh_enc(key_id, public_key, read_key, read_key_id)```

- [ ] ```atcab_ecdh_ioenc(key_id, public_key, io_key)```

- [ ] ```atcab_ecdh_tempkey(public_key)```

- [ ] ```atcab_ecdh_tempkey_ioenc(public_key, io_key)```

- [x] ```atcab_gendig(zone, key_id, other_data)```

- [x] ```atcab_genkey_base(mode, key_id, other_data=None)```

- [x] ```atcab_genkey(key_id)```

- [x] ```atcab_get_pubkey(key_id)```

- [ ] ```atcab_hmac(mode, key_id)```

- [x] ```atcab_info_base(mode=0)```

- [x] ```atcab_info()```

- [ ] ```atcab_kdf(mode, key_id, details, message)```

- [x] ```atcab_lock(mode, crc=0)```

- [x] ```atcab_lock_config_zone()```

- [x] ```atcab_lock_config_zone_crc(crc)```

- [x] ```atcab_lock_data_zone()```

- [x] ```atcab_lock_data_zone_crc(crc)```

- [x] ```atcab_lock_data_slot(slot)```

- [ ] ```atcab_mac(mode, key_id, challenge)```

- [x] ```atcab_nonce_base(mode, zero=0, numbers=None)```

- [x] ```atcab_nonce(numbers=None)```

- [x] ```atcab_nonce_load(target, numbers=None)```

- [x] ```atcab_nonce_rand(numbers=None)```

- [x] ```atcab_challenge(numbers=None)```

- [x] ```atcab_challenge_seed_update(numbers=None)```

- [ ] ```atcab_priv_write(key_id, priv_key, write_key_id, write_key)```

- [x] ```atcab_random()```

- [x] ```atcab_read_zone(zone, slot=0, block=0, offset=0, length=0)```

- [x] ```atcab_read_serial_number()```

- [x] ```atcab_read_bytes_zone(zone, slot=0, block=0, offset=0, length=0)```

- [x] ```atcab_is_slot_locked(slot)```

- [x] ```atcab_is_locked(zone)```

- [x] ```atcab_read_config_zone()```

- [x] ```atcab_read_enc(key_id, block, data, enc_key, enc_key_id)```

- [ ] ```atcab_cmp_config_zone(config_data)```

- [ ] ```atcab_read_sig(slot)```

- [x] ```atcab_read_pubkey(slot)```

- [ ] ```atcab_secureboot(mode, param2, digest, signature)```

- [ ] ```atcab_secureboot_mac(mode, digest, signature, num_in, io_key)```

- [x] ```atcab_selftest(mode, param2=0)```

- [x] ```atcab_sha_base(mode=0, data=b'', key_slot=None)```

- [x] ```atcab_sha(data)```

- [ ] ```atcab_sha_hmac(data, key_slot, target)```

- [x] ```atcab_sign_base(mode, key_id)```

- [x] ```atcab_sign(key_id, message)```

- [x] ```atcab_sign_internal(key_id, is_invalidate=False, is_full_sn=False)```

- [x] ```atcab_updateextra(mode, value)```

- [x] ```atcab_verify(mode, key_id, signature, public_key=None, other_data=None, mac=None)```

- [x] ```atcab_verify_extern(message, signature, public_key)```

- [ ] ```atcab_verify_extern_mac(message, signature, public_key, num_in, io_key, is_verified)```

- [x] ```atcab_verify_stored(message, signature, key_id)```

- [ ] ```atcab_verify_stored_mac(message, signature, key_id, num_in, io_key, is_verified)```

- [ ] ```atcab_verify_validate( key_id, signature, other_data, is_verified)```

- [ ] ```atcab_verify_invalidate( key_id, signature, other_data, is_verified)```

- [x] ```atcab_write(zone, address, value=None, mac=None)```

- [x] ```atcab_write_zone(zone, slot=0, block=0, offset=0, data=None)```

- [x] ```atcab_write_bytes_zone(zone, slot=0, offset=0, data=None)```

- [x] ```atcab_write_pubkey(slot, public_key)```

- [x] ```atcab_write_config_zone(config_data)```

- [ ] ```atcab_write_enc(key_id, block, data, enc_key, enc_key_id)```

- [ ] ```atcab_write_config_counter(counter_id, counter_value)```



Hardware

---------------------



Currently supported devices are:



- [ATECC508A](http://www.microchip.com/ATECC508A)

- [ATECC608A](http://www.microchip.com/ATECC608A)