{"id":13801487,"url":"https://github.com/Carglglz/mpy-mbedtls","last_synced_at":"2025-05-13T11:31:16.489Z","repository":{"id":98841240,"uuid":"544245420","full_name":"Carglglz/mpy-mbedtls","owner":"Carglglz","description":"MicroPython bindings for some MbedTLS EC and x509 cert/csr functions.","archived":false,"fork":false,"pushed_at":"2025-04-12T02:33:51.000Z","size":62,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T03:29:26.766Z","etag":null,"topics":["ecdsa","mbedtls","micropython","tls"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Carglglz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-02T02:16:57.000Z","updated_at":"2025-04-12T02:33:56.000Z","dependencies_parsed_at":"2024-08-04T00:17:51.759Z","dependency_job_id":null,"html_url":"https://github.com/Carglglz/mpy-mbedtls","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carglglz%2Fmpy-mbedtls","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carglglz%2Fmpy-mbedtls/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carglglz%2Fmpy-mbedtls/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carglglz%2Fmpy-mbedtls/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Carglglz","download_url":"https://codeload.github.com/Carglglz/mpy-mbedtls/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253932842,"owners_count":21986461,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecdsa","mbedtls","micropython","tls"],"created_at":"2024-08-04T00:01:23.350Z","updated_at":"2025-05-13T11:31:12.577Z","avatar_url":"https://github.com/Carglglz.png","language":"C","funding_links":[],"categories":["Libraries"],"sub_categories":["Communications"],"readme":"### mpy-mbedtls\n\nMicroPython bindings for ECDSA keys basic functionality and x509 cert/csr utilities.\n*Supports both PEM and DER formats*\n\n#### Features:\n\n`mbedtls` module (low level):\n\n   - Generate ECDSA key pair\n\t\n   - Derive public key from private key\n\t\n   - Sign data\n    \n   - Verify signature\n\n`x509` module:\n\t\n   - Generate a certificate signing request (CSR)\n\t\n   - Parse certificate\n\t\n   - Verify certificate\n   \n`ecdsa` module (Same as mbedtls but OOP):\n   \n   - Generate ECDSA key pair\n\t\n   - Derive public key from private key\n   \n   - Parse private/public key file\n\t\n   - Sign data\n    \n   - Verify signature\n   \n   - Sign file \n   \n   - Verify file signature\n   \n   - Export private/public key to file\n\n\n\n#### Install\n\n`esp32` port:\n\nIn `micropython/ports/esp32`\n\nmake a `mbedtls` dir and copy `mpy-mbedtls/mbedtls/mbedtls_config.h` into this `mbedtls`\n\ne.g. \n```console\nports/esp32: $ mkdir mbedtls\nports/esp32: $ cp ../../../\u003cpath to user modules\u003e/mpy-mbedtls/mbedtls/mbedtls_config.h mbedtls/\n```\nthen build the firmware with:\n\n```console\nports/esp32: $ make BOARD=GENERIC USER_C_MODULES=../../../../\u003cpath to user modules\u003e/mpy-mbedtls/micropython.cmake FROZEN_MANIFEST=\u003cabsolute path to user modules\u003e/mpy-mbedtls/ports/esp32/manifest.py -j4\n```\n\nOther ports (e.g. `unix`):\n\nNeeds enabling additional options for mbedtls, see `mpy-mbedtls/mbedtls/mbedtls_config.h`\n\nIn `micropython/ports/unix`\n\n```\n$ make USER_C_MODULES=../../../\u003cpath to user modules\u003e/mpy-mbedtls FROZEN_MANIFEST=../../../\u003cpath to user modules\u003e/mpy-mbedtls/ports/unix/manifest.py -j4\n```\n\n#### Run tests\n\nIn `micropython/tests`\n\n```\n$ ./run-tests.py ../../\u003cpath to user modules\u003e/mpy-mbedtls/tests/test_*.py\npass  ../../user_modules/mpy-mbedtls/tests/test_mbedtls_ec_curves.py\npass  ../../user_modules/mpy-mbedtls/tests/test_mbedtls_ec_keyp_der.py\npass  ../../user_modules/mpy-mbedtls/tests/test_mbedtls_ec_keyp.py\npass  ../../user_modules/mpy-mbedtls/tests/test_x509_cert_parse.py\npass  ../../user_modules/mpy-mbedtls/tests/test_ecdsa.py\npass  ../../user_modules/mpy-mbedtls/tests/test_x509_gen_csr.py\npass  ../../user_modules/mpy-mbedtls/tests/test_x509_cert_validate.py\n7 tests performed (19 individual testcases)\n7 tests passed\n\n```\n\n#### Example \n\n```python\nimport ecdsa\n\nkeyp = ecdsa.ECKeyp()\n\nprint(\"PRIVATE KEY:\")\nprint(keyp.pkey.decode())\n\nprint(\"PUBLIC KEY:\")\nprint(keyp.pubkey.decode())\n\nmsg = \"hello world\"\n\n# Sign\nsignature = keyp.sign(msg)\n\nassert isinstance(signature, bytes)\nprint(\"Signature: OK\")\n\n# Verify signature\n\nverification = keyp.verify(msg, signature)\n\nassert verification\nprint(\"Verification: OK\")\n\n\n```\n\n```\n\u003e\u003e\u003e import example\nPRIVATE KEY:\n-----BEGIN EC PRIVATE KEY-----\nMHcCAQEEIGrK/lMb3BvPEk2LhBmRWj01duluiI/qagOFQaXfGIOAoAoGCCqGSM49\nAwEHoUQDQgAEzKw4gnXWWVfNy2dP6WYzJ4UN/E5DPhyJdUEtYC4j8PvXTnFPdpga\nXXN+n0oofGF/aTfwX3UqNkc+qvUKtkPzKg==\n-----END EC PRIVATE KEY-----\n\nPUBLIC KEY:\n-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEzKw4gnXWWVfNy2dP6WYzJ4UN/E5D\nPhyJdUEtYC4j8PvXTnFPdpgaXXN+n0oofGF/aTfwX3UqNkc+qvUKtkPzKg==\n-----END PUBLIC KEY-----\n\nSignature: OK\nVerification: OK\n```\n\n\nSee other examples in `mpy-mbedtls/tests`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCarglglz%2Fmpy-mbedtls","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCarglglz%2Fmpy-mbedtls","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCarglglz%2Fmpy-mbedtls/lists"}