Python CryptoAuthLib module
Introduction
This module provides a thin python ctypes layer to evaluate the cryptoauthlib interface to Microchip CryptoAuthentication devices.
Code Examples
Code examples for python are available on github as part of CryptoAuthTools under the python/examples directory
Installation
CryptoAuthLib python module can be installed through Python's pip tool:
pip install cryptoauthlib
To upgrade your installation when new releases are made:
pip install -U cryptoauthlib
If you ever need to remove your installation:
pip uninstall cryptoauthlib
What does python CryptoAuthLib package do?
CryptoAuthLib module gives access to most functions available as part of standard cryptoauthlib (which is written in 'C'). These python functions for the most part are very similar to 'C' functions. The module in short acts as a wrapper over the 'C' cryptoauth library functions.
Microchip cryptoauthlib product page: Link
Supported hardware
Supported devices
The family of devices supported currently are:
Using cryptoauthlib python module
The following is a 'C' code made using cryptoauthlib 'C' library.
#include "cryptoauthlib.h"
void main()
{
ATCA_STATUS status;
uint8_t revision[4];
uint8_t randomnum[32];
status = atcab_init(cfg_ateccx08a_kitcdc_default);
if (status != ATCA_SUCCESS)
{
printf("Error");
exit();
}
status = atcab_info(revision);
if (status != ATCA_SUCCESS)
{
printf("Error");
exit();
}
status = atcab_random(randomnum);
if (status != ATCA_SUCCESS)
{
printf("Error");
exit();
}
}
The same code in python would be:
from cryptoauthlib import *
ATCA_SUCCESS = 0x00
revision = bytearray(4)
randomnum = bytearray(32)
# Locate and load the compiled library
load_cryptoauthlib()
assert ATCA_SUCCESS == atcab_init(cfg_ateccx08a_kithid_default())
assert ATCA_SUCCESS == atcab_info(revision)
print(''.join(['%02X ' % x for x in revision]))
assert ATCA_SUCCESS == atcab_random(randomnum)
print(''.join(['%02X ' % x for x in randomnum]))
In the above python code, "import cryptoauthlib" imports the python module. load_cryptoauthlib() function loads the compiled library. The load_cryptoauthlib() is a function that you will not see in the 'C' library, this is a python specific utility function and is required for python scripts to locate and load the compiled library.
In Summary
Step I: Import the module
from cryptoauthlib import *
Step II: Initilize the module
load_cryptoauthlib()
assert ATCA_SUCCESS == atcab_init(cfg_ateccx08a_kithid_default())
Step III: Use Cryptoauthlib APIs
Call library APIs of your choice
Code portability
Microchip's CryptoAuthentication products can now be evaluated with the power and flexibility of python. Once the evaluation stage is done the python code can be ported to 'C' code.
As seen above the python API maintains a 1 to 1 equivalence to the 'C' API in order to easy the transition between the two.
Cryptoauthlib module API documentation
help() command
All of the python function's documentation can be viewed through python's built in help() function.
For example, to get the documentation of atcab_info() function:
>>> help(cryptoauthlib.atcab_info)
Help on function atcab_info in module cryptoauthlib.atcab:
atcab_info(revision)
Used to get the device revision number. (DevRev)
Args:
revision 4-byte bytearray receiving the revision number
from the device. (Expects bytearray)
Returns:
Status code
dir() command
The dir command without arguments, return the list of names in the current local scope. With an argument, attempt to return a list of valid attributes for that object. For example dir(cryptoauthlib) will return all the methods available in the cryptoauthlib module.
Code Examples
Code examples for python are available on github as part of CryptoAuthTools under the python/examples directory
Tests
Module tests can be located in the python/tests of the main cryptoauthlib repository. The README.md has details for how to run the tests. The module tests are not comprehensive for the entire functionality of cryptoauthlib but rather are meant to test the python module code only against the library to ensure the interfaces are correct and ctypes structures match the platform.
Release notes
See Release Notes
1 maintainer
Metadata
1 maintainer
Release files for cryptoauthlib 20240926
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cryptoauthlib-20240926.tar.gz | 546.4 kB | Details |
Built distributions (wheels)
Total release size: 6.8 MB
Release files / cryptoauthlib-20240926.tar.gz
| Download URL | cryptoauthlib-20240926.tar.gz |
|---|---|
| Size | 546.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1e6a01411cf6381524eda4fc88a02305a9def992fa3a5e1448e55750c070d8ae
|
|
BLAKE2b-256 checksum How to use checksums |
a0195fde6580f32b21c8d641c58917a98c3d11da70482a8493277fed7f577806
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-pp310-pypy310_pp73-win_amd64.whl
| Download URL | cryptoauthlib-20240926-pp310-pypy310_pp73-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | PyPy 3.10 PyPy 3.10 7.3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
74d046b77effb4f1c7017341c1d8fdcf8327c60fcc8a85135df90a537ce934d8
|
|
BLAKE2b-256 checksum How to use checksums |
5833cdad1fc56e536b4d220605976fc0074a803f99a3411ac1c56b87d6791c57
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-pp39-pypy39_pp73-win_amd64.whl
| Download URL | cryptoauthlib-20240926-pp39-pypy39_pp73-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | PyPy 3.9 PyPy 3.9 7.3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
2931af7fc54a32c004399a34f8f73d815c4b3a262209cd250cb38d0f88b51f1b
|
|
BLAKE2b-256 checksum How to use checksums |
2415aa7303b660571ef81b7485f0606bbc2d6f9b6547c6f857b6c7e39a0cc76c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-pp38-pypy38_pp73-win_amd64.whl
| Download URL | cryptoauthlib-20240926-pp38-pypy38_pp73-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | PyPy 3.8 PyPy 3.8 7.3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
d16051db2fbe89b8df71fdf088d6b613e9e791f414011c6ff5e94be89e5ab6e4
|
|
BLAKE2b-256 checksum How to use checksums |
f66ebb37d78a689bcceaff9f290d5a8ad4b53d7a79e61e6cde299d6bdad2710e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp313-cp313-win_amd64.whl
| Download URL | cryptoauthlib-20240926-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
d8ba79e94e4fa92eef7b4502d9e1ba4cac0a54534db75a0d000f7983772e827e
|
|
BLAKE2b-256 checksum How to use checksums |
16a1d631dec218ee23aa88a34709f636bf8542c05277191b945d86ede1d796a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp313-cp313-win32.whl
| Download URL | cryptoauthlib-20240926-cp313-cp313-win32.whl |
|---|---|
| Size | 130.9 kB |
| Tags | CPython 3.13 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
de10367332f227fa95305ce4e7641d6180cfc5313f2a4115a2c667630a94c9f4
|
|
BLAKE2b-256 checksum How to use checksums |
37b9b01b787d7fe44d92bdd821912986b8c854631c0cdcce889411e0782c213a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp312-cp312-win_amd64.whl
| Download URL | cryptoauthlib-20240926-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
6af758919c3de7477e538db518a87d3a3f500cb0d461a22f64c80c5aa1fd2709
|
|
BLAKE2b-256 checksum How to use checksums |
9f4d575fc8b76d8dd3540569b037802d0b986535cd9c1a97ee8477b5849f9d84
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp312-cp312-win32.whl
| Download URL | cryptoauthlib-20240926-cp312-cp312-win32.whl |
|---|---|
| Size | 130.9 kB |
| Tags | CPython 3.12 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
c616cafb42c235129268b3f3d30eacd613997e1851eb5328cd83e4e3c85e528a
|
|
BLAKE2b-256 checksum How to use checksums |
cc51ae51594be148954e498804306524b8b634bd726537caaac4eb9d3198a009
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | cryptoauthlib-20240926-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
42755f21ea0483743d9fc383982a19abd85fd357d3d3f824404c0aef18369925
|
|
BLAKE2b-256 checksum How to use checksums |
97a866a9afce8e24b1772ea4bc74c534798f1c168fe15c11416d216ef13d0a76
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp312-cp312-macosx_10_9_x86_64.whl
| Download URL | cryptoauthlib-20240926-cp312-cp312-macosx_10_9_x86_64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.12 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
f637629f20d693ba06cc5e1a729caab368479dcc12eecb95028bcbcf38655e7f
|
|
BLAKE2b-256 checksum How to use checksums |
720340e8418c688caadebb69fa3bd5ab08624505ac1a259a14bfcd40add5da7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp311-cp311-win_amd64.whl
| Download URL | cryptoauthlib-20240926-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
bfa4941de1f91fa6e8f73b24caf1ff534e862adba1a37e1681363996ab7fd1f8
|
|
BLAKE2b-256 checksum How to use checksums |
1dcfe82f47dba72d57b30747da32a4c06271c4ff5c72ed65a31f241d8cb80ebc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp311-cp311-win32.whl
| Download URL | cryptoauthlib-20240926-cp311-cp311-win32.whl |
|---|---|
| Size | 130.9 kB |
| Tags | CPython 3.11 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
b6a1962662a4363cd8aca537e90f27eb30491958e9da7d3bb5ad9b4a64a51f00
|
|
BLAKE2b-256 checksum How to use checksums |
40beca218fc16707c6bf8fb691daf805919458b410eb337d942a0f1ab229da4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | cryptoauthlib-20240926-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
0ef66210a315f8c2307a34d149184b76f4bb87ca08f07e7fa1592a0f90d9a8e0
|
|
BLAKE2b-256 checksum How to use checksums |
40e1acd0bf462d4248c478cc11764a3156883b06936c8b642eda6bbb690b9a22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp311-cp311-macosx_10_9_x86_64.whl
| Download URL | cryptoauthlib-20240926-cp311-cp311-macosx_10_9_x86_64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.11 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
88005d1dea35f94aeb84e8f795de1112a58f4b6ed8bb3c01a68a617e76601959
|
|
BLAKE2b-256 checksum How to use checksums |
2a17100fb11c86e728eb80aedfa046a3e252620677529c4d76c889bc86580e0f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp310-cp310-win_amd64.whl
| Download URL | cryptoauthlib-20240926-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
ec492eab395f493f456857fe32c5b4069a441d67d83cc7ab925efd1ef758b89c
|
|
BLAKE2b-256 checksum How to use checksums |
888356acc2ddd50a176edf10200edbc771dd088261cf622e1ff8415f7c5a27cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp310-cp310-win32.whl
| Download URL | cryptoauthlib-20240926-cp310-cp310-win32.whl |
|---|---|
| Size | 130.9 kB |
| Tags | CPython 3.10 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
a4fdfffa8c246d6355c277ceb02a8057dc14512b0e44d296967aab8d0366b803
|
|
BLAKE2b-256 checksum How to use checksums |
05403b455d1fe8f1809b2082b21dbcfd1df75c05e8847862da52ecfa1fda491f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | cryptoauthlib-20240926-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
8196bc44a15f2dd823869de4311251df98c44beb968ffccbb67c49a273b6dcef
|
|
BLAKE2b-256 checksum How to use checksums |
5d60d5834d4ee30434bb83f5f2a835db4e945cc08c72a4354586c627923c4d31
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp310-cp310-macosx_10_9_x86_64.whl
| Download URL | cryptoauthlib-20240926-cp310-cp310-macosx_10_9_x86_64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.10 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
06b62babb2e87063fab369792ed09d7451c9dd12e687369d7c528924afb09a6e
|
|
BLAKE2b-256 checksum How to use checksums |
bdff0daecdab6483c66b3ccdd3115217aff048c599991ec4db88e1760ae1e633
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp39-cp39-win_amd64.whl
| Download URL | cryptoauthlib-20240926-cp39-cp39-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | CPython 3.9 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
7cd1e593798824a28418126e696047f3850358001c0afbc72359d1e7615979bd
|
|
BLAKE2b-256 checksum How to use checksums |
05c99199ae785945f0f86d28db998bcaabe82fa4db277aa719613511f224a5e5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp39-cp39-win32.whl
| Download URL | cryptoauthlib-20240926-cp39-cp39-win32.whl |
|---|---|
| Size | 130.9 kB |
| Tags | CPython 3.9 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
6ca9cfbc0c87c96a0ea3d864263c6f936835270712ec0cc0341c1e82395ad05c
|
|
BLAKE2b-256 checksum How to use checksums |
73ea9ba67213ee900c9fbba7e30ce3e5bb2ff40121f2261f611a04d2282a0c8d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp39-cp39-macosx_11_0_arm64.whl
| Download URL | cryptoauthlib-20240926-cp39-cp39-macosx_11_0_arm64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.9 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
c06fd0b73645eb1e699b03ed9fc3bddf2a23eb8fc0a02d748ace71772e19be68
|
|
BLAKE2b-256 checksum How to use checksums |
af8d89c002f0b6a457fde17f61fe2f4be225643bb1dd57a0e120a9a8f7779032
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp39-cp39-macosx_10_9_x86_64.whl
| Download URL | cryptoauthlib-20240926-cp39-cp39-macosx_10_9_x86_64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.9 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
d6518e6e5a5fe4018ba74faaee8456b1cc386179b81db73613454ef28759395c
|
|
BLAKE2b-256 checksum How to use checksums |
154183f0a34d59d173fa21fdd266c5012bdeae919a921da4c7cec3c97fb92501
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp38-cp38-win_amd64.whl
| Download URL | cryptoauthlib-20240926-cp38-cp38-win_amd64.whl |
|---|---|
| Size | 149.4 kB |
| Tags | CPython 3.8 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
e38d2690e1367d04ea876334696cd8f3777113cc2d8488e3b8bb56689db24f07
|
|
BLAKE2b-256 checksum How to use checksums |
e0cb0bc72bf1ed03a7977e4a8e6dcda22676e5d35a630858d3abb224e82d3877
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp38-cp38-win32.whl
| Download URL | cryptoauthlib-20240926-cp38-cp38-win32.whl |
|---|---|
| Size | 130.9 kB |
| Tags | CPython 3.8 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
abc4dea4befdaf36ad45057f717502aef3911651d014ffdbb5593ea50899e177
|
|
BLAKE2b-256 checksum How to use checksums |
99dc7be940f139b88ac0dda795a8a1bd2a90f7ff3f69f30abd2bc82d95e8a3d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / cryptoauthlib-20240926-cp38-cp38-macosx_11_0_arm64.whl
| Download URL | cryptoauthlib-20240926-cp38-cp38-macosx_11_0_arm64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.8 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
acdb6efb6f5143e8cc4812467b0582b3827e256db9d4960e0a5c9f1f147fea2a
|
|
BLAKE2b-256 checksum How to use checksums |
8feb3eb06c6a92e12dd40360afbae3314ba2f4734ac3ba26521bb23991402e01
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
Release files / cryptoauthlib-20240926-cp38-cp38-macosx_10_9_x86_64.whl
| Download URL | cryptoauthlib-20240926-cp38-cp38-macosx_10_9_x86_64.whl |
|---|---|
| Size | 412.6 kB |
| Tags | CPython 3.8 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
ed1c7da2ce5564faff1122540f00014e8d7db1e06fcfdbc5d4a79a3d9c5b86b9
|
|
BLAKE2b-256 checksum How to use checksums |
448d98717a68f73f7502453ed15f45d02a25fdb76ffdd870065219a29234037e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.20
|
