| Name | spsdk-pkcs11 JSON |
| Version |
0.3.5
JSON |
| download |
| home_page | None |
| Summary | Signature Provider plugin for SPSDK using PKCS#11 interface |
| upload_time | 2025-08-29 06:24:07 |
| maintainer | None |
| docs_url | None |
| author | NXP |
| requires_python | >=3.9 |
| license | BSD-3-Clause |
| keywords |
nxp
spsdk
pkcs11
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
PKCS#11 Signature Provider
==========================
Signature Provider plugin for SPSDK using PKCS#11 interface
Features
--------
* Using a PKCS#11 library to sign data using HSM
* Supported signing schemes: RSA, RSA-PSS, ECDSA
Installation
------------
* Activate virtual env, where you have SPSDK
- to install spsdk run: `pip install spsdk`
* `pip install spsdk-pkcs11`
Usage
-----
* To use this Signature Provider, you have to update your signature provider configuration string(s) in YAML file(s)
* Configuration string Parameters:
- `type`: set to `pkcs11`
- `so_path`: Path to (or name of) your PKCS#11 library (usually delivered by HSM vendor)
- Plugin is looking for the library in current directory, and paths defined in PATH environment variable
- Path can be set also in an environment variable (e.g.: $MY_PKCS_LIB)
- `user_pin`: Pin to your HSM
- Pin can be placed directly in the config string (not recommended!)
- You may place your pin into environment variable (e.g: $MY_PKCS_PIN)
- You may place your pin into a file, then simply provide the path
- `token_label` and/or `token_serial`: Label or serial to identify the Token in your HSM containing your key
- `key_label` and/or `key_id`: Label or ID to identify the key you want to use
* Configuration string example:
- `type=pkcs11;so_path:c:/SoftHSM2/lib/softhsm2-x64.dll;user_pin=~/test_pin.txt;token_label=My token 1;key_label=rsa_2048`
Limitations
-----------
Currently the plugin doesn't wok on Windows when using Python 3.12 (https://github.com/pyauth/python-pkcs11/issues/165)
Credits
-------
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [SPSDK Signature Provider project template](https://github.com/nxp-mcuxpresso/spsdk/blob/master/examples/plugins/templates/cookiecutter-spsdk-sp-plugin.zip).
Raw data
{
"_id": null,
"home_page": null,
"name": "spsdk-pkcs11",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Michal Starecek <spsdk@nxp.com>",
"keywords": "NXP, SPSDK, pkcs11",
"author": "NXP",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d0/ac/113128d92bc745b77c2d52200e8068b62c6534a5a2711f8746c4971603b0/spsdk_pkcs11-0.3.5.tar.gz",
"platform": null,
"description": "\nPKCS#11 Signature Provider\n==========================\n\nSignature Provider plugin for SPSDK using PKCS#11 interface\n\n\nFeatures\n--------\n\n* Using a PKCS#11 library to sign data using HSM\n* Supported signing schemes: RSA, RSA-PSS, ECDSA\n\nInstallation\n------------\n\n* Activate virtual env, where you have SPSDK\n - to install spsdk run: `pip install spsdk`\n* `pip install spsdk-pkcs11`\n\n\nUsage\n-----\n\n* To use this Signature Provider, you have to update your signature provider configuration string(s) in YAML file(s)\n* Configuration string Parameters:\n - `type`: set to `pkcs11`\n - `so_path`: Path to (or name of) your PKCS#11 library (usually delivered by HSM vendor)\n - Plugin is looking for the library in current directory, and paths defined in PATH environment variable\n - Path can be set also in an environment variable (e.g.: $MY_PKCS_LIB)\n - `user_pin`: Pin to your HSM\n - Pin can be placed directly in the config string (not recommended!)\n - You may place your pin into environment variable (e.g: $MY_PKCS_PIN)\n - You may place your pin into a file, then simply provide the path\n - `token_label` and/or `token_serial`: Label or serial to identify the Token in your HSM containing your key\n - `key_label` and/or `key_id`: Label or ID to identify the key you want to use\n\n* Configuration string example:\n - `type=pkcs11;so_path:c:/SoftHSM2/lib/softhsm2-x64.dll;user_pin=~/test_pin.txt;token_label=My token 1;key_label=rsa_2048`\n\nLimitations\n-----------\n\nCurrently the plugin doesn't wok on Windows when using Python 3.12 (https://github.com/pyauth/python-pkcs11/issues/165)\n\n\nCredits\n-------\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [SPSDK Signature Provider project template](https://github.com/nxp-mcuxpresso/spsdk/blob/master/examples/plugins/templates/cookiecutter-spsdk-sp-plugin.zip).\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Signature Provider plugin for SPSDK using PKCS#11 interface",
"version": "0.3.5",
"project_urls": {
"Homepage": "https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/pkcs11",
"Issues": "https://github.com/nxp-mcuxpresso/spsdk_plugins/issues"
},
"split_keywords": [
"nxp",
" spsdk",
" pkcs11"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d0ac113128d92bc745b77c2d52200e8068b62c6534a5a2711f8746c4971603b0",
"md5": "6a73cfa0c3498fddadb1c5eebbb33f5a",
"sha256": "ceb4249e652b10da1dd6ed2faee137961d1a6d69c01ea52dc064e1647ee71279"
},
"downloads": -1,
"filename": "spsdk_pkcs11-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "6a73cfa0c3498fddadb1c5eebbb33f5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8850,
"upload_time": "2025-08-29T06:24:07",
"upload_time_iso_8601": "2025-08-29T06:24:07.422037Z",
"url": "https://files.pythonhosted.org/packages/d0/ac/113128d92bc745b77c2d52200e8068b62c6534a5a2711f8746c4971603b0/spsdk_pkcs11-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 06:24:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nxp-mcuxpresso",
"github_project": "spsdk_plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spsdk-pkcs11"
}
