Module Class

The PKCS#11 driver module

The PKCS#11 driver module (middleware) manages the cryptographic devices of a particular type.

Note: The PKCS#11 interface requires special handling of the driver modules:

In each application, the module can only be loaded once, so there can only be a single Module instance for each driver. Since this object is fully thread-safe, it might be used by multiple threads though.
The object must be closed before the application terminates.

Inheritance Hierarchy

SystemObject
  PdfTools.InternalNativeBase
    PdfTools.InternalNativeObject
      PdfTools.Crypto.Providers.Pkcs11Module

Namespace: PdfTools.Crypto.Providers.Pkcs11
Assembly: PdfTools (in PdfTools.dll) Version: 1.7.0+cfcc11b476b3e1eb4320f0f37269191f64e36bd8

Syntax

Copy

public class Module : NativeObject, IDisposable

The Module type exposes the following members.

Properties

	Name	Description
	Devices	The list of devices managed by this module Most often there is only a single device, so the method GetSingle can be used.
	EnableFullParallelization	Enable full parallelization The PKCS#11 standard specifies that "an application can specify that it will be accessing the library concurrently from multiple threads, and the library must [...] ensure proper thread-safe behavior." However, some PKCS#11 modules (middleware) implementations are not thread-safe. For this reason, the SDK synchronizes all access to the module. If the middleware is thread-safe, full parallel usage of the cryptographic device can be enabled by setting this property to and thereby improving the performance. Default:

Name

Description

Devices

The list of devices managed by this module

Most often there is only a single device, so the method GetSingle can be used.

EnableFullParallelization

Enable full parallelization

The PKCS#11 standard specifies that "an application can specify that it will be accessing the library concurrently from multiple threads, and the library must [...] ensure proper thread-safe behavior." However, some PKCS#11 modules (middleware) implementations are not thread-safe. For this reason, the SDK synchronizes all access to the module. If the middleware is thread-safe, full parallel usage of the cryptographic device can be enabled by setting this property to and thereby improving the performance.

Default:

Top

Methods

	Name	Description
	Dispose	Close all open sessions and unload the module After unloading, the module cannot be loaded again in the same process. Proper unloading is crucial. Otherwise, the application might crash and/or the HSM, USB token, or smart card might not be unlocked. When using the C interface, this method must not be called from the context of the destructor of a global or static object, nor an atexit() handler, nor the DllMain() entry point.
	Equals	(Inherited from NativeObject)
	GetHashCode	(Inherited from NativeObject)
	Load	Load a PKCS#11 driver module

Top

Reference

PdfTools.Crypto.Providers.Pkcs11 Namespace