8 releases (4 breaking)

0.5.0 Apr 20, 2020
0.4.2 Apr 4, 2020
0.4.1 Dec 5, 2019
0.4.0 Oct 9, 2019
0.1.0 Nov 9, 2017

#13 in Hardware support

Download history 675/week @ 2020-01-25 721/week @ 2020-02-01 624/week @ 2020-02-08 668/week @ 2020-02-15 718/week @ 2020-02-22 609/week @ 2020-02-29 670/week @ 2020-03-07 586/week @ 2020-03-14 633/week @ 2020-03-21 598/week @ 2020-03-28 466/week @ 2020-04-04 772/week @ 2020-04-11 836/week @ 2020-04-18 587/week @ 2020-04-25 603/week @ 2020-05-02 558/week @ 2020-05-09

2,820 downloads per month
Used in parsec-service

Apache-2.0

305KB
7K SLoC

Rust PKCS#11 Library

Latest version Documentation Build status Build status Build status Build status codecov License

This is a library which brings support for PKCS#11 to Rust. It is aiming at having both a very low-level API to map the PKCS#11 functionality to Rust as well as having a higher-level API for more easy usage as well as bringing more safety for programming against PKCS#11.

Status

The library has full support for all functions in PKCS#11 v2.40. It should technically work with any Cryptoki version from v2.00. For example there is special handling for C_WaitForSlotEvent which has been added only in v2.01. You can successfully implement and reach all low-level Cryptoki semantics and structures. All of them are integration tested using SoftHSM. For better interoperability the low-level API is using nearly the same function/method calls and data structures as defined in the official standard. That means that using the low-level API should be very easy for people who are familiar with PKCS#11 as the naming and variables/constants/defines are the same.

A high-level more Rust-friendly API is in the design process. Its goal is to hide most of the low-level PKCS#11 semantics that one does not need to be aware of as they can be very verbose. Furthermore using Rust datastructures it is possible to come up with a more type-safe library at compile time to help users to use PKCS#11 more successfully and to make it more robust. It will also provide easier primitives for multi-part encrypting/decrypting/signing/etc. Ideally by providing a streaming API. Last but not least it will provide session management and lock/unlock free sessions as they are available from the context. Especially on tokens that provide parallel processing this can be a very tedious and error-prone process.

Compatiblity Matrix

TODO: This is still in the making, and most likely very incomplete.

As PKCS#11 implementations are not always sticking to the standard, your token might still have problems, unfortunately. These are known tokens as reported by users that definitely work together with this library.

If you use this library with an HSM that is not listed here, please open an issue (or even better a PR) so that I can update this matrix. If your token does not work, please also open an issue, of course, so that we can investigate.

Testing

Testing is currently done with SoftHSM2. A trillion thanks to the people at OpenDNSSEC for writing SoftHSM. This makes it possible to develop applications that need to support PKCS#11. I would have no idea what to do without it. (Suggestions are always welcome.)

TODO

Here is a list of the implementation status and plans on what to do next:

  • Dynamic loading of PKCS#11 module (thanks to libloading)
  • Initializing and Dropping PKCS#11 context
  • Implementing Token and PIN Management functions
  • Implementing Session Management functions
  • Implementing Object Management functions
  • Implementing Key Management functions
  • Implementing Encryption/Decryption functions
  • Implementing Message Digest functions
  • Implementing Signing and MACing
  • Implementing Verifying of signatures and MACs
  • Implementing Dual-function cryptographic operations
  • Implementing Legacy PKCS#11 functions
  • Reorganize code of low-level API (too bloated, which we all know is what PKCS#11 is like)
  • Import the rest of the C header pkcs11t.h types into rust
  • Import the rest of the C header pkcs11f.h functions into rust
  • Publish on crates.io (wow, that was easy)
  • C type constants to string converter functions, and the reverse (maybe part of the high-level API?)
  • Design and implement high-level API
  • Write and Generate Documentation for Rust docs
  • Better Testing (lots of repetitive code + we need a testing framework and different SoftHSM versions for different platforms)
  • Suppport for PKCS#11 v3.00
  • make packed struct and CK_ULONG / CK_LONG feature flags with platform defaults when it becomes possible - currently the default when the target is Windows as PKCS#11 explicitly demands packed structs on Windows and unsigned long and long are both only 32bit on Microsoft compilers by default. However, on any other unix platform the defaults are not really defined and one might need to opt in for one or the other.

Dependencies

~495–660KB
~13K SLoC