| Name | spsdk-pkcs11 JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Signature Provider plugin for SPSDK using PKCS#11 interface |
| upload_time | 2024-12-19 12:28:03 |
| 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 <michal.starecek@nxp.com>",
"keywords": "NXP, SPSDK, pkcs11",
"author": "NXP",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3b/24/727ecf560767148ac6c6be7dc044e2e6ab27fec788aed6dd765a80102c22/spsdk_pkcs11-0.3.0.tar.gz",
"platform": null,
"description": "\r\nPKCS#11 Signature Provider\r\n==========================\r\n\r\nSignature Provider plugin for SPSDK using PKCS#11 interface\r\n\r\n\r\nFeatures\r\n--------\r\n\r\n* Using a PKCS#11 library to sign data using HSM\r\n* Supported signing schemes: RSA, RSA-PSS, ECDSA\r\n\r\nInstallation\r\n------------\r\n\r\n* Activate virtual env, where you have SPSDK\r\n - to install spsdk run: `pip install spsdk`\r\n* `pip install spsdk-pkcs11`\r\n\r\n\r\nUsage\r\n-----\r\n\r\n* To use this Signature Provider, you have to update your signature provider configuration string(s) in YAML file(s)\r\n* Configuration string Parameters:\r\n - `type`: set to `pkcs11`\r\n - `so_path`: Path to (or name of) your PKCS#11 library (usually delivered by HSM vendor)\r\n - Plugin is looking for the library in current directory, and paths defined in PATH environment variable\r\n - Path can be set also in an environment variable (e.g.: $MY_PKCS_LIB)\r\n - `user_pin`: Pin to your HSM\r\n - Pin can be placed directly in the config string (not recommended!)\r\n - You may place your pin into environment variable (e.g: $MY_PKCS_PIN)\r\n - You may place your pin into a file, then simply provide the path\r\n - `token_label` and/or `token_serial`: Label or serial to identify the Token in your HSM containing your key\r\n - `key_label` and/or `key_id`: Label or ID to identify the key you want to use\r\n\r\n* Configuration string example:\r\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`\r\n\r\nLimitations\r\n-----------\r\n\r\nCurrently the plugin doesn't wok on Windows when using Python 3.12 (https://github.com/pyauth/python-pkcs11/issues/165)\r\n\r\n\r\nCredits\r\n-------\r\n\r\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).\r\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Signature Provider plugin for SPSDK using PKCS#11 interface",
"version": "0.3.0",
"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": "",
"digests": {
"blake2b_256": "06ba808eca60c58a676137b2f3a15c11c9bf23932e253d469309d24f6b232ea7",
"md5": "c3a55fcf9a2c81060d0fece354874ba4",
"sha256": "ae83b44925dc61d9d2b1c5c07e91896346ede1aa6e545303fe67b9e62ead0d31"
},
"downloads": -1,
"filename": "spsdk_pkcs11-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c3a55fcf9a2c81060d0fece354874ba4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7682,
"upload_time": "2024-12-19T12:28:00",
"upload_time_iso_8601": "2024-12-19T12:28:00.826749Z",
"url": "https://files.pythonhosted.org/packages/06/ba/808eca60c58a676137b2f3a15c11c9bf23932e253d469309d24f6b232ea7/spsdk_pkcs11-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b24727ecf560767148ac6c6be7dc044e2e6ab27fec788aed6dd765a80102c22",
"md5": "28e854b8fbe15651789c0e70eefe8c81",
"sha256": "02411e085f913bc15725e9e4c921b6450ff1d31b0bcbf3a52b191bb713a0629f"
},
"downloads": -1,
"filename": "spsdk_pkcs11-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "28e854b8fbe15651789c0e70eefe8c81",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8649,
"upload_time": "2024-12-19T12:28:03",
"upload_time_iso_8601": "2024-12-19T12:28:03.876427Z",
"url": "https://files.pythonhosted.org/packages/3b/24/727ecf560767148ac6c6be7dc044e2e6ab27fec788aed6dd765a80102c22/spsdk_pkcs11-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 12:28:03",
"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"
}
