Pkcs11Interop  4.0.0
Public Member Functions | Properties | List of all members
Net.Pkcs11Interop.Common.Pkcs11UriBuilder Class Reference

PKCS#11 URI builder More...

Public Member Functions

 Pkcs11UriBuilder ()
 Intializes new instance of Pkcs11UriBuilder class that checks max lengths of path attribute values More...
 
 Pkcs11UriBuilder (bool checkLengths)
 Intializes new instance of Pkcs11UriBuilder class More...
 
 Pkcs11UriBuilder (Pkcs11Uri pkcs11Uri)
 Intializes new instance of Pkcs11UriBuilder class with specified PKCS#11 URI whose ChecksLengths property specifies whether max lengths of path attribute values should be checked More...
 
 Pkcs11UriBuilder (Pkcs11Uri pkcs11Uri, bool checkLengths)
 Intializes new instance of Pkcs11UriBuilder class with specified PKCS#11 URI More...
 
override string ToString ()
 Generates PKCS#11 URI representing contents of Pkcs11UriBuilder instance More...
 
Pkcs11Uri ToPkcs11Uri ()
 Converts Pkcs11UriBuilder instance to Pkcs11Uri instance More...
 

Properties

bool ChecksLengths [get]
 Flag indicating whether max lengths of path attribute values are checked More...
 
string Token [get, set]
 Value of path attribute "token" that corresponds to the "label" member of the CK_TOKEN_INFO structure More...
 
string Manufacturer [get, set]
 Value of path attribute "manufacturer" that corresponds to the "manufacturerID" member of CK_TOKEN_INFO structure More...
 
string Serial [get, set]
 Value of path attribute "serial" that corresponds to the "serialNumber" member of CK_TOKEN_INFO structure More...
 
string Model [get, set]
 Value of path attribute "model" that corresponds to the "model" member of CK_TOKEN_INFO structure More...
 
string LibraryManufacturer [get, set]
 Value of path attribute "library-manufacturer" that corresponds to the "manufacturerID" member of CK_INFO structure More...
 
string LibraryDescription [get, set]
 Value of path attribute "library-description" that corresponds to the "libraryDescription" member of CK_INFO structure More...
 
string LibraryVersion [get, set]
 Value of path attribute "library-version" that corresponds to the "libraryVersion" member of CK_INFO structure More...
 
string Object [get, set]
 Value of path attribute "object" that corresponds to the "CKA_LABEL" object attribute More...
 
CKO Type [get, set]
 Value of path attribute "type" that corresponds to the "CKA_CLASS" object attribute More...
 
byte[] Id [get, set]
 Value of path attribute "id" that corresponds to the "CKA_ID" object attribute More...
 
string SlotManufacturer [get, set]
 Value of path attribute "slot-manufacturer" that corresponds to the "manufacturerID" member of CK_SLOT_INFO structure More...
 
string SlotDescription [get, set]
 Value of path attribute "slot-description" that corresponds to the "slotDescription" member of CK_SLOT_INFO structure More...
 
ulong SlotId [get, set]
 Value of path attribute "slot-id" that corresponds to the decimal number of "CK_SLOT_ID" type More...
 
Dictionary< string, string > UnknownPathAttributes [get, set]
 Collection of unknown vendor specific path attributes that is validated when ToString() or ToPkcs11Uri() method is called More...
 
string PinSource [get, set]
 Value of query attribute "pin-source" that specifies where token PIN can be obtained More...
 
string PinValue [get, set]
 Value of query attribute "pin-value" that contains token PIN More...
 
string ModuleName [get, set]
 Value of query attribute "module-name" that specifies name of the PKCS#11 library More...
 
string ModulePath [get, set]
 Value of query attribute "module-path" that specifies path to the PKCS#11 library More...
 
Dictionary< string, List< string > > UnknownQueryAttributes [get, set]
 Collection of unknown vendor specific query attributes that is validated when ToString() or ToPkcs11Uri() method is called More...
 

Detailed Description

PKCS#11 URI builder

Implementation note: As recommended by PKCS#11 URI specification Pkcs11UriBuilder class percent-encodes the whole value of the "id" attribute which is supposed to be handled as arbitrary binary data. Therefore it is not possible to construct URIs with arbitrary string value of the "id" attribute.

Implementation note: Validation of each individual attribute value is performed by the setter of corresponding Pkcs11UriBuilder class property with the exception to UnknownPathAttributes and UnknownQueryAttributes properties whose values are validated when ToString() or ToPkcs11Uri() method is called.

Constructor & Destructor Documentation

Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Pkcs11UriBuilder ( )

Intializes new instance of Pkcs11UriBuilder class that checks max lengths of path attribute values

Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Pkcs11UriBuilder ( bool  checkLengths)

Intializes new instance of Pkcs11UriBuilder class

Parameters
checkLengthsFlag indicating whether max lengths of path attribute values should be checked
Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Pkcs11UriBuilder ( Pkcs11Uri  pkcs11Uri)

Intializes new instance of Pkcs11UriBuilder class with specified PKCS#11 URI whose ChecksLengths property specifies whether max lengths of path attribute values should be checked

Parameters
pkcs11UriPKCS#11 URI with default values
Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Pkcs11UriBuilder ( Pkcs11Uri  pkcs11Uri,
bool  checkLengths 
)

Intializes new instance of Pkcs11UriBuilder class with specified PKCS#11 URI

Parameters
pkcs11UriPKCS#11 URI with default values
checkLengthsFlag indicating whether max lengths of path attribute values should be checked

Member Function Documentation

Pkcs11Uri Net.Pkcs11Interop.Common.Pkcs11UriBuilder.ToPkcs11Uri ( )

Converts Pkcs11UriBuilder instance to Pkcs11Uri instance

Returns
Pkcs11Uri instance representing contents of Pkcs11UriBuilder instance
override string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.ToString ( )

Generates PKCS#11 URI representing contents of Pkcs11UriBuilder instance

Returns
PKCS#11 URI representing contents of Pkcs11UriBuilder instance

Property Documentation

bool Net.Pkcs11Interop.Common.Pkcs11UriBuilder.ChecksLengths
get

Flag indicating whether max lengths of path attribute values are checked

byte [] Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Id
getset

Value of path attribute "id" that corresponds to the "CKA_ID" object attribute

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.LibraryDescription
getset

Value of path attribute "library-description" that corresponds to the "libraryDescription" member of CK_INFO structure

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.LibraryManufacturer
getset

Value of path attribute "library-manufacturer" that corresponds to the "manufacturerID" member of CK_INFO structure

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.LibraryVersion
getset

Value of path attribute "library-version" that corresponds to the "libraryVersion" member of CK_INFO structure

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Manufacturer
getset

Value of path attribute "manufacturer" that corresponds to the "manufacturerID" member of CK_TOKEN_INFO structure

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Model
getset

Value of path attribute "model" that corresponds to the "model" member of CK_TOKEN_INFO structure

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.ModuleName
getset

Value of query attribute "module-name" that specifies name of the PKCS#11 library

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.ModulePath
getset

Value of query attribute "module-path" that specifies path to the PKCS#11 library

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Object
getset

Value of path attribute "object" that corresponds to the "CKA_LABEL" object attribute

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.PinSource
getset

Value of query attribute "pin-source" that specifies where token PIN can be obtained

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.PinValue
getset

Value of query attribute "pin-value" that contains token PIN

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Serial
getset

Value of path attribute "serial" that corresponds to the "serialNumber" member of CK_TOKEN_INFO structure

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.SlotDescription
getset

Value of path attribute "slot-description" that corresponds to the "slotDescription" member of CK_SLOT_INFO structure

ulong Net.Pkcs11Interop.Common.Pkcs11UriBuilder.SlotId
getset

Value of path attribute "slot-id" that corresponds to the decimal number of "CK_SLOT_ID" type

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.SlotManufacturer
getset

Value of path attribute "slot-manufacturer" that corresponds to the "manufacturerID" member of CK_SLOT_INFO structure

string Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Token
getset

Value of path attribute "token" that corresponds to the "label" member of the CK_TOKEN_INFO structure

CKO Net.Pkcs11Interop.Common.Pkcs11UriBuilder.Type
getset

Value of path attribute "type" that corresponds to the "CKA_CLASS" object attribute

Dictionary<string, string> Net.Pkcs11Interop.Common.Pkcs11UriBuilder.UnknownPathAttributes
getset

Collection of unknown vendor specific path attributes that is validated when ToString() or ToPkcs11Uri() method is called

Dictionary<string, List<string> > Net.Pkcs11Interop.Common.Pkcs11UriBuilder.UnknownQueryAttributes
getset

Collection of unknown vendor specific query attributes that is validated when ToString() or ToPkcs11Uri() method is called


The documentation for this class was generated from the following file: