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 ⭐ this project and why not ... Buy me a coffee 😄
- 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 wrote by Microchip
- PyBoard basic connection:
- BASIC
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)
<ATECC608A address=0x60 retries=20>
>>>- TESTS:
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 <ATECC608A address=0x60 retries=20>
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:
import logging
logging.basicConfig(level=logging.DEBUG)Only for tests: 'logging' already available into folder 'micropython-lib' of this repository
- Freeze package using FROZEN_MANIFEST:
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
$ 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"
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:
-
atcab_version() -
atcab_get_addr(zone, slot=0, block=0, offset=0) -
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) -
atcab_gendig(zone, key_id, other_data) -
atcab_genkey_base(mode, key_id, other_data=None) -
atcab_genkey(key_id) -
atcab_get_pubkey(key_id) -
atcab_hmac(mode, key_id) -
atcab_info_base(mode=0) -
atcab_info() -
atcab_kdf(mode, key_id, details, message) -
atcab_lock(mode, crc=0) -
atcab_lock_config_zone() -
atcab_lock_config_zone_crc(crc) -
atcab_lock_data_zone() -
atcab_lock_data_zone_crc(crc) -
atcab_lock_data_slot(slot) -
atcab_mac(mode, key_id, challenge) -
atcab_nonce_base(mode, zero=0, numbers=None) -
atcab_nonce(numbers=None) -
atcab_nonce_load(target, numbers=None) -
atcab_nonce_rand(numbers=None) -
atcab_challenge(numbers=None) -
atcab_challenge_seed_update(numbers=None) -
atcab_priv_write(key_id, priv_key, write_key_id, write_key) -
atcab_random() -
atcab_read_zone(zone, slot=0, block=0, offset=0, length=0) -
atcab_read_serial_number() -
atcab_read_bytes_zone(zone, slot=0, block=0, offset=0, length=0) -
atcab_is_slot_locked(slot) -
atcab_is_locked(zone) -
atcab_read_config_zone() -
atcab_read_enc(key_id, block, data, enc_key, enc_key_id) -
atcab_cmp_config_zone(config_data) -
atcab_read_sig(slot) -
atcab_read_pubkey(slot) -
atcab_secureboot(mode, param2, digest, signature) -
atcab_secureboot_mac(mode, digest, signature, num_in, io_key) -
atcab_selftest(mode, param2=0) -
atcab_sha_base(mode=0, data=b'', key_slot=None) -
atcab_sha(data) -
atcab_sha_hmac(data, key_slot, target) -
atcab_sign_base(mode, key_id) -
atcab_sign(key_id, message) -
atcab_sign_internal(key_id, is_invalidate=False, is_full_sn=False) -
atcab_updateextra(mode, value) -
atcab_verify(mode, key_id, signature, public_key=None, other_data=None, mac=None) -
atcab_verify_extern(message, signature, public_key) -
atcab_verify_extern_mac(message, signature, public_key, num_in, io_key, is_verified) -
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) -
atcab_write(zone, address, value=None, mac=None) -
atcab_write_zone(zone, slot=0, block=0, offset=0, data=None) -
atcab_write_bytes_zone(zone, slot=0, offset=0, data=None) -
atcab_write_pubkey(slot, public_key) -
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)
Currently supported devices are: