-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extend and slightly re-phrase README.md
Signed-off-by: Ondrej Moris <[email protected]>
- Loading branch information
Showing
1 changed file
with
21 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,27 @@ | ||
[](https://github.com/latchset/pkcs11-provider/actions/workflows/build.yml) | ||
[](https://opensource.org/licenses/Apache-2.0) | ||
|
||
This is an Openssl 3.x provider to access Hardware or Software Tokens | ||
using the PKCS#11 Cryptographic Token Interface. | ||
# pkcs11-provider | ||
|
||
This code targets PKCS#11 version 3.1 but is backwards compatible to | ||
version 3.0 and 2.40 as well. | ||
|
||
Spec: | ||
https://docs.oasis-open.org/pkcs11/pkcs11-spec/v3.1/pkcs11-spec-v3.1.html | ||
This is an OpenSSL 3.x provider to access Hardware and Software Tokens using | ||
the PKCS#11 Cryptographic Token Interface. Access to tokens depends | ||
on loading an appropriate PKCS#11 driver that knows how to talk to the specific | ||
token. The PKCS#11 provider is a connector that allows OpenSSL to make proper | ||
use of such drivers. This code targets PKCS#11 version 3.1 but is backwards | ||
compatible to version 3.0 and 2.40 as well. | ||
|
||
To report Security Vulnerabilities, please use the "Report a Security | ||
Vulnerability" template in the issues reporting page. | ||
|
||
### Installation | ||
|
||
See [BUILD](BUILD.md) for more details about building and installing the provider. | ||
|
||
### Usage | ||
|
||
Configuration directives for the provider are documented in [provider-pkcs11(7)](docs/provider-pkcs11.7.md) | ||
man page. Example configurations and basic use cases can be found in [HOWTO](HOWTO.md). | ||
|
||
### Notes | ||
|
||
* [PKCS #11 Specification Version 3.1](https://docs.oasis-open.org/pkcs11/pkcs11-spec/v3.1/pkcs11-spec-v3.1.html) |