Botan::PKCS11 Namespace Reference

Classes
class	AttributeContainer
	Helper class to build the Attribute / CK_ATTRIBUTE structures. More...
class	CertificateProperties
	Common attributes of all certificate objects. More...
class	DataObjectProperties
	Common attributes of all data objects. More...
class	DomainParameterProperties
	Common attributes of domain parameter. More...
class	KeyProperties
	Common attributes of all key objects. More...
class	LowLevel
	Provides access to all PKCS#11 functions. More...
class	MechanismWrapper
class	Module
class	Object
class	ObjectFinder
	Manages calls to C_FindObjects* functions (C_FindObjectsInit -> C_FindObjects -> C_FindObjectsFinal) More...
class	ObjectProperties
	Common attributes of all objects. More...
class	PKCS11_Error
class	PKCS11_ReturnError
class	PKCS11_RNG
	A random generator that only fetches random from the PKCS#11 RNG. More...
class	PrivateKeyProperties
	Common attributes of all private keys. More...
class	PublicKeyProperties
	Common attributes of all public key objects. More...
class	SecretKeyProperties
	Common attributes of all secret (symmetric) keys. More...
class	Session
	Represents a PKCS#11 session. More...
class	Slot
	Represents a PKCS#11 Slot, i.e., a card reader. More...
class	StorageObjectProperties
	Common attributes of all storage objects. More...

Typedefs
using	Attribute = CK_ATTRIBUTE
using	Bbool = CK_BBOOL
using	Byte = CK_BYTE
using	C_InitializeArgs = CK_C_INITIALIZE_ARGS
using	CreateMutex = CK_CREATEMUTEX
using	Date = CK_DATE
using	DestroyMutex = CK_DESTROYMUTEX
using	Ecdh1DeriveParams = CK_ECDH1_DERIVE_PARAMS
using	Flags = CK_FLAGS
using	FunctionListPtr = CK_FUNCTION_LIST_PTR
using	Info = CK_INFO
using	LockMutex = CK_LOCKMUTEX
using	Mechanism = CK_MECHANISM
using	MechanismInfo = CK_MECHANISM_INFO
using	Notify = CK_NOTIFY
using	ObjectHandle = CK_OBJECT_HANDLE
using	RsaPkcsOaepParams = CK_RSA_PKCS_OAEP_PARAMS
using	RsaPkcsPssParams = CK_RSA_PKCS_PSS_PARAMS
using	secure_string = secure_vector<uint8_t>
using	SessionHandle = CK_SESSION_HANDLE
using	SessionInfo = CK_SESSION_INFO
using	SlotId = CK_SLOT_ID
using	SlotInfo = CK_SLOT_INFO
using	TokenInfo = CK_TOKEN_INFO
using	Ulong = CK_ULONG
using	UnlockMutex = CK_UNLOCKMUTEX
using	Utf8Char = CK_UTF8CHAR
using	VoidPtr = CK_VOID_PTR

Enumerations
enum class	AttributeType : CK_ATTRIBUTE_TYPE {   Class = 0x00000000UL , Token = 0x00000001UL , Private = 0x00000002UL , Label = 0x00000003UL ,   Application = 0x00000010UL , Value = 0x00000011UL , ObjectId = 0x00000012UL , CertificateType = 0x00000080UL ,   Issuer = 0x00000081UL , SerialNumber = 0x00000082UL , AcIssuer = 0x00000083UL , Owner = 0x00000084UL ,   AttrTypes = 0x00000085UL , Trusted = 0x00000086UL , CertificateCategory = 0x00000087UL , JavaMidpSecurityDomain = 0x00000088UL ,   Url = 0x00000089UL , HashOfSubjectPublicKey = 0x0000008AUL , HashOfIssuerPublicKey = 0x0000008BUL , NameHashAlgorithm = 0x0000008CUL ,   CheckValue = 0x00000090UL , KeyType = 0x00000100UL , Subject = 0x00000101UL , Id = 0x00000102UL ,   Sensitive = 0x00000103UL , Encrypt = 0x00000104UL , Decrypt = 0x00000105UL , Wrap = 0x00000106UL ,   Unwrap = 0x00000107UL , Sign = 0x00000108UL , SignRecover = 0x00000109UL , Verify = 0x0000010AUL ,   VerifyRecover = 0x0000010BUL , Derive = 0x0000010CUL , StartDate = 0x00000110UL , EndDate = 0x00000111UL ,   Modulus = 0x00000120UL , ModulusBits = 0x00000121UL , PublicExponent = 0x00000122UL , PrivateExponent = 0x00000123UL ,   Prime1 = 0x00000124UL , Prime2 = 0x00000125UL , Exponent1 = 0x00000126UL , Exponent2 = 0x00000127UL ,   Coefficient = 0x00000128UL , PublicKeyInfo = 0x00000129UL , Prime = 0x00000130UL , Subprime = 0x00000131UL ,   Base = 0x00000132UL , PrimeBits = 0x00000133UL , SubprimeBits = 0x00000134UL , SubPrimeBits = 0x00000134UL ,   ValueBits = 0x00000160UL , ValueLen = 0x00000161UL , Extractable = 0x00000162UL , Local = 0x00000163UL ,   NeverExtractable = 0x00000164UL , AlwaysSensitive = 0x00000165UL , KeyGenMechanism = 0x00000166UL , Modifiable = 0x00000170UL ,   Copyable = 0x00000171UL , Destroyable = 0x00000172UL , EcdsaParams = 0x00000180UL , EcParams = 0x00000180UL ,   EcPoint = 0x00000181UL , SecondaryAuth = 0x00000200UL , AuthPinFlags = 0x00000201UL , AlwaysAuthenticate = 0x00000202UL ,   WrapWithTrusted = 0x00000210UL , WrapTemplate = ( 0x40000000UL |0x00000211UL) , UnwrapTemplate = ( 0x40000000UL |0x00000212UL) , DeriveTemplate = ( 0x40000000UL |0x00000213UL) ,   OtpFormat = 0x00000220UL , OtpLength = 0x00000221UL , OtpTimeInterval = 0x00000222UL , OtpUserFriendlyMode = 0x00000223UL ,   OtpChallengeRequirement = 0x00000224UL , OtpTimeRequirement = 0x00000225UL , OtpCounterRequirement = 0x00000226UL , OtpPinRequirement = 0x00000227UL ,   OtpCounter = 0x0000022EUL , OtpTime = 0x0000022FUL , OtpUserIdentifier = 0x0000022AUL , OtpServiceIdentifier = 0x0000022BUL ,   OtpServiceLogo = 0x0000022CUL , OtpServiceLogoType = 0x0000022DUL , Gostr3410Params = 0x00000250UL , Gostr3411Params = 0x00000251UL ,   Gost28147Params = 0x00000252UL , HwFeatureType = 0x00000300UL , ResetOnInit = 0x00000301UL , HasReset = 0x00000302UL ,   PixelX = 0x00000400UL , PixelY = 0x00000401UL , Resolution = 0x00000402UL , CharRows = 0x00000403UL ,   CharColumns = 0x00000404UL , Color = 0x00000405UL , BitsPerPixel = 0x00000406UL , CharSets = 0x00000480UL ,   EncodingMethods = 0x00000481UL , MimeTypes = 0x00000482UL , MechanismType = 0x00000500UL , RequiredCmsAttributes = 0x00000501UL ,   DefaultCmsAttributes = 0x00000502UL , SupportedCmsAttributes = 0x00000503UL , AllowedMechanisms = ( 0x40000000UL |0x00000600UL) , VendorDefined = 0x80000000UL }
enum class	CertificateCategory : CK_ULONG { Unspecified = 0UL , TokenUser = 1UL , Authority = 2UL , OtherEntity = 3UL }
enum class	CertificateType : CK_CERTIFICATE_TYPE { X509 = 0x00000000UL , X509AttrCert = 0x00000001UL , Wtls = 0x00000002UL , VendorDefined = 0x80000000UL }
enum class	Flag : CK_FLAGS {   None = 0 , TokenPresent = 0x00000001UL , RemovableDevice = 0x00000002UL , HwSlot = 0x00000004UL ,   Rng = 0x00000001UL , WriteProtected = 0x00000002UL , LoginRequired = 0x00000004UL , UserPinInitialized = 0x00000008UL ,   RestoreKeyNotNeeded = 0x00000020UL , ClockOnToken = 0x00000040UL , ProtectedAuthenticationPath = 0x00000100UL , DualCryptoOperations = 0x00000200UL ,   TokenInitialized = 0x00000400UL , SecondaryAuthentication = 0x00000800UL , UserPinCountLow = 0x00010000UL , UserPinFinalTry = 0x00020000UL ,   UserPinLocked = 0x00040000UL , UserPinToBeChanged = 0x00080000UL , SoPinCountLow = 0x00100000UL , SoPinFinalTry = 0x00200000UL ,   SoPinLocked = 0x00400000UL , SoPinToBeChanged = 0x00800000UL , ErrorState = 0x01000000UL , RwSession = 0x00000002UL ,   SerialSession = 0x00000004UL , ArrayAttribute = 0x40000000UL , Hw = 0x00000001UL , Encrypt = 0x00000100UL ,   Decrypt = 0x00000200UL , Digest = 0x00000400UL , Sign = 0x00000800UL , SignRecover = 0x00001000UL ,   Verify = 0x00002000UL , VerifyRecover = 0x00004000UL , Generate = 0x00008000UL , GenerateKeyPair = 0x00010000UL ,   Wrap = 0x00020000UL , Unwrap = 0x00040000UL , Derive = 0x00080000UL , EcFP = 0x00100000UL ,   EcF2m = 0x00200000UL , EcEcparameters = 0x00400000UL , EcNamedcurve = 0x00800000UL , EcUncompress = 0x01000000UL ,   EcCompress = 0x02000000UL , Extension = 0x80000000UL , LibraryCantCreateOsThreads = 0x00000001UL , OsLockingOk = 0x00000002UL ,   DontBlock = 1 , NextOtp = 0x00000001UL , ExcludeTime = 0x00000002UL , ExcludeCounter = 0x00000004UL ,   ExcludeChallenge = 0x00000008UL , ExcludePin = 0x00000010UL , UserFriendlyOtp = 0x00000020UL }
enum class	HardwareType : CK_HW_FEATURE_TYPE { MonotonicCounter = 0x00000001UL , Clock = 0x00000002UL , UserInterface = 0x00000003UL , VendorDefined = 0x80000000UL }
enum class	KeyDerivation : CK_ULONG {   Null = 0x00000001UL , Sha1Kdf = 0x00000002UL , Sha1KdfAsn1 = 0x00000003UL , Sha1KdfConcatenate = 0x00000004UL ,   Sha224Kdf = 0x00000005UL , Sha256Kdf = 0x00000006UL , Sha384Kdf = 0x00000007UL , Sha512Kdf = 0x00000008UL ,   CpdiversifyKdf = 0x00000009UL }
enum class	KeyType : CK_KEY_TYPE {   Rsa = 0x00000000UL , Dsa = 0x00000001UL , Dh = 0x00000002UL , Ecdsa = 0x00000003UL ,   Ec = 0x00000003UL , X942Dh = 0x00000004UL , Kea = 0x00000005UL , GenericSecret = 0x00000010UL ,   Rc2 = 0x00000011UL , Rc4 = 0x00000012UL , Des = 0x00000013UL , Des2 = 0x00000014UL ,   Des3 = 0x00000015UL , Cast = 0x00000016UL , Cast3 = 0x00000017UL , Cast5 = 0x00000018UL ,   Cast128 = 0x00000018UL , Rc5 = 0x00000019UL , Idea = 0x0000001AUL , Skipjack = 0x0000001BUL ,   Baton = 0x0000001CUL , Juniper = 0x0000001DUL , Cdmf = 0x0000001EUL , Aes = 0x0000001FUL ,   Blowfish = 0x00000020UL , Twofish = 0x00000021UL , Securid = 0x00000022UL , Hotp = 0x00000023UL ,   Acti = 0x00000024UL , Camellia = 0x00000025UL , Aria = 0x00000026UL , Md5Hmac = 0x00000027UL ,   Sha1Hmac = 0x00000028UL , Ripemd128Hmac = 0x00000029UL , Ripemd160Hmac = 0x0000002AUL , Sha256Hmac = 0x0000002BUL ,   Sha384Hmac = 0x0000002CUL , Sha512Hmac = 0x0000002DUL , Sha224Hmac = 0x0000002EUL , Seed = 0x0000002FUL ,   Gostr3410 = 0x00000030UL , Gostr3411 = 0x00000031UL , Gost28147 = 0x00000032UL , VendorDefined = 0x80000000UL }
enum class	MechanismType : CK_MECHANISM_TYPE {   RsaPkcsKeyPairGen = 0x00000000UL , RsaPkcs = 0x00000001UL , Rsa9796 = 0x00000002UL , RsaX509 = 0x00000003UL ,   Md2RsaPkcs = 0x00000004UL , Md5RsaPkcs = 0x00000005UL , Sha1RsaPkcs = 0x00000006UL , Ripemd128RsaPkcs = 0x00000007UL ,   Ripemd160RsaPkcs = 0x00000008UL , RsaPkcsOaep = 0x00000009UL , RsaX931KeyPairGen = 0x0000000AUL , RsaX931 = 0x0000000BUL ,   Sha1RsaX931 = 0x0000000CUL , RsaPkcsPss = 0x0000000DUL , Sha1RsaPkcsPss = 0x0000000EUL , DsaKeyPairGen = 0x00000010UL ,   Dsa = 0x00000011UL , DsaSha1 = 0x00000012UL , DsaSha224 = 0x00000013UL , DsaSha256 = 0x00000014UL ,   DsaSha384 = 0x00000015UL , DsaSha512 = 0x00000016UL , DhPkcsKeyPairGen = 0x00000020UL , DhPkcsDerive = 0x00000021UL ,   X942DhKeyPairGen = 0x00000030UL , X942DhDerive = 0x00000031UL , X942DhHybridDerive = 0x00000032UL , X942MqvDerive = 0x00000033UL ,   Sha256RsaPkcs = 0x00000040UL , Sha384RsaPkcs = 0x00000041UL , Sha512RsaPkcs = 0x00000042UL , Sha256RsaPkcsPss = 0x00000043UL ,   Sha384RsaPkcsPss = 0x00000044UL , Sha512RsaPkcsPss = 0x00000045UL , Sha224RsaPkcs = 0x00000046UL , Sha224RsaPkcsPss = 0x00000047UL ,   Sha512224 = 0x00000048UL , Sha512224Hmac = 0x00000049UL , Sha512224HmacGeneral = 0x0000004AUL , Sha512224KeyDerivation = 0x0000004BUL ,   Sha512256 = 0x0000004CUL , Sha512256Hmac = 0x0000004DUL , Sha512256HmacGeneral = 0x0000004EUL , Sha512256KeyDerivation = 0x0000004FUL ,   Sha512T = 0x00000050UL , Sha512THmac = 0x00000051UL , Sha512THmacGeneral = 0x00000052UL , Sha512TKeyDerivation = 0x00000053UL ,   Rc2KeyGen = 0x00000100UL , Rc2Ecb = 0x00000101UL , Rc2Cbc = 0x00000102UL , Rc2Mac = 0x00000103UL ,   Rc2MacGeneral = 0x00000104UL , Rc2CbcPad = 0x00000105UL , Rc4KeyGen = 0x00000110UL , Rc4 = 0x00000111UL ,   DesKeyGen = 0x00000120UL , DesEcb = 0x00000121UL , DesCbc = 0x00000122UL , DesMac = 0x00000123UL ,   DesMacGeneral = 0x00000124UL , DesCbcPad = 0x00000125UL , Des2KeyGen = 0x00000130UL , Des3KeyGen = 0x00000131UL ,   Des3Ecb = 0x00000132UL , Des3Cbc = 0x00000133UL , Des3Mac = 0x00000134UL , Des3MacGeneral = 0x00000135UL ,   Des3CbcPad = 0x00000136UL , Des3CmacGeneral = 0x00000137UL , Des3Cmac = 0x00000138UL , CdmfKeyGen = 0x00000140UL ,   CdmfEcb = 0x00000141UL , CdmfCbc = 0x00000142UL , CdmfMac = 0x00000143UL , CdmfMacGeneral = 0x00000144UL ,   CdmfCbcPad = 0x00000145UL , DesOfb64 = 0x00000150UL , DesOfb8 = 0x00000151UL , DesCfb64 = 0x00000152UL ,   DesCfb8 = 0x00000153UL , Md2 = 0x00000200UL , Md2Hmac = 0x00000201UL , Md2HmacGeneral = 0x00000202UL ,   Md5 = 0x00000210UL , Md5Hmac = 0x00000211UL , Md5HmacGeneral = 0x00000212UL , Sha1 = 0x00000220UL ,   Sha1Hmac = 0x00000221UL , Sha1HmacGeneral = 0x00000222UL , Ripemd128 = 0x00000230UL , Ripemd128Hmac = 0x00000231UL ,   Ripemd128HmacGeneral = 0x00000232UL , Ripemd160 = 0x00000240UL , Ripemd160Hmac = 0x00000241UL , Ripemd160HmacGeneral = 0x00000242UL ,   Sha256 = 0x00000250UL , Sha256Hmac = 0x00000251UL , Sha256HmacGeneral = 0x00000252UL , Sha224 = 0x00000255UL ,   Sha224Hmac = 0x00000256UL , Sha224HmacGeneral = 0x00000257UL , Sha384 = 0x00000260UL , Sha384Hmac = 0x00000261UL ,   Sha384HmacGeneral = 0x00000262UL , Sha512 = 0x00000270UL , Sha512Hmac = 0x00000271UL , Sha512HmacGeneral = 0x00000272UL ,   SecuridKeyGen = 0x00000280UL , Securid = 0x00000282UL , HotpKeyGen = 0x00000290UL , Hotp = 0x00000291UL ,   Acti = 0x000002A0UL , ActiKeyGen = 0x000002A1UL , CastKeyGen = 0x00000300UL , CastEcb = 0x00000301UL ,   CastCbc = 0x00000302UL , CastMac = 0x00000303UL , CastMacGeneral = 0x00000304UL , CastCbcPad = 0x00000305UL ,   Cast3KeyGen = 0x00000310UL , Cast3Ecb = 0x00000311UL , Cast3Cbc = 0x00000312UL , Cast3Mac = 0x00000313UL ,   Cast3MacGeneral = 0x00000314UL , Cast3CbcPad = 0x00000315UL , Cast5KeyGen = 0x00000320UL , Cast128KeyGen = 0x00000320UL ,   Cast5Ecb = 0x00000321UL , Cast128Ecb = 0x00000321UL , Cast5Cbc = 0x00000322UL , Cast128Cbc = 0x00000322UL ,   Cast5Mac = 0x00000323UL , Cast128Mac = 0x00000323UL , Cast5MacGeneral = 0x00000324UL , Cast128MacGeneral = 0x00000324UL ,   Cast5CbcPad = 0x00000325UL , Cast128CbcPad = 0x00000325UL , Rc5KeyGen = 0x00000330UL , Rc5Ecb = 0x00000331UL ,   Rc5Cbc = 0x00000332UL , Rc5Mac = 0x00000333UL , Rc5MacGeneral = 0x00000334UL , Rc5CbcPad = 0x00000335UL ,   IdeaKeyGen = 0x00000340UL , IdeaEcb = 0x00000341UL , IdeaCbc = 0x00000342UL , IdeaMac = 0x00000343UL ,   IdeaMacGeneral = 0x00000344UL , IdeaCbcPad = 0x00000345UL , GenericSecretKeyGen = 0x00000350UL , ConcatenateBaseAndKey = 0x00000360UL ,   ConcatenateBaseAndData = 0x00000362UL , ConcatenateDataAndBase = 0x00000363UL , XorBaseAndData = 0x00000364UL , ExtractKeyFromKey = 0x00000365UL ,   Ssl3PreMasterKeyGen = 0x00000370UL , Ssl3MasterKeyDerive = 0x00000371UL , Ssl3KeyAndMacDerive = 0x00000372UL , Ssl3MasterKeyDeriveDh = 0x00000373UL ,   TlsPreMasterKeyGen = 0x00000374UL , TlsMasterKeyDerive = 0x00000375UL , TlsKeyAndMacDerive = 0x00000376UL , TlsMasterKeyDeriveDh = 0x00000377UL ,   TlsPrf = 0x00000378UL , Ssl3Md5Mac = 0x00000380UL , Ssl3Sha1Mac = 0x00000381UL , Md5KeyDerivation = 0x00000390UL ,   Md2KeyDerivation = 0x00000391UL , Sha1KeyDerivation = 0x00000392UL , Sha256KeyDerivation = 0x00000393UL , Sha384KeyDerivation = 0x00000394UL ,   Sha512KeyDerivation = 0x00000395UL , Sha224KeyDerivation = 0x00000396UL , PbeMd2DesCbc = 0x000003A0UL , PbeMd5DesCbc = 0x000003A1UL ,   PbeMd5CastCbc = 0x000003A2UL , PbeMd5Cast3Cbc = 0x000003A3UL , PbeMd5Cast5Cbc = 0x000003A4UL , PbeMd5Cast128Cbc = 0x000003A4UL ,   PbeSha1Cast5Cbc = 0x000003A5UL , PbeSha1Cast128Cbc = 0x000003A5UL , PbeSha1Rc4128 = 0x000003A6UL , PbeSha1Rc440 = 0x000003A7UL ,   PbeSha1Des3EdeCbc = 0x000003A8UL , PbeSha1Des2EdeCbc = 0x000003A9UL , PbeSha1Rc2128Cbc = 0x000003AAUL , PbeSha1Rc240Cbc = 0x000003ABUL ,   Pkcs5Pbkd2 = 0x000003B0UL , PbaSha1WithSha1Hmac = 0x000003C0UL , WtlsPreMasterKeyGen = 0x000003D0UL , WtlsMasterKeyDerive = 0x000003D1UL ,   WtlsMasterKeyDeriveDhEcc = 0x000003D2UL , WtlsPrf = 0x000003D3UL , WtlsServerKeyAndMacDerive = 0x000003D4UL , WtlsClientKeyAndMacDerive = 0x000003D5UL ,   Tls10MacServer = 0x000003D6UL , Tls10MacClient = 0x000003D7UL , Tls12Mac = 0x000003D8UL , Tls12Kdf = 0x000003D9UL ,   Tls12MasterKeyDerive = 0x000003E0UL , Tls12KeyAndMacDerive = 0x000003E1UL , Tls12MasterKeyDeriveDh = 0x000003E2UL , Tls12KeySafeDerive = 0x000003E3UL ,   TlsMac = 0x000003E4UL , TlsKdf = 0x000003E5UL , KeyWrapLynks = 0x00000400UL , KeyWrapSetOaep = 0x00000401UL ,   CmsSig = 0x00000500UL , KipDerive = 0x00000510UL , KipWrap = 0x00000511UL , KipMac = 0x00000512UL ,   CamelliaKeyGen = 0x00000550UL , CamelliaEcb = 0x00000551UL , CamelliaCbc = 0x00000552UL , CamelliaMac = 0x00000553UL ,   CamelliaMacGeneral = 0x00000554UL , CamelliaCbcPad = 0x00000555UL , CamelliaEcbEncryptData = 0x00000556UL , CamelliaCbcEncryptData = 0x00000557UL ,   CamelliaCtr = 0x00000558UL , AriaKeyGen = 0x00000560UL , AriaEcb = 0x00000561UL , AriaCbc = 0x00000562UL ,   AriaMac = 0x00000563UL , AriaMacGeneral = 0x00000564UL , AriaCbcPad = 0x00000565UL , AriaEcbEncryptData = 0x00000566UL ,   AriaCbcEncryptData = 0x00000567UL , SeedKeyGen = 0x00000650UL , SeedEcb = 0x00000651UL , SeedCbc = 0x00000652UL ,   SeedMac = 0x00000653UL , SeedMacGeneral = 0x00000654UL , SeedCbcPad = 0x00000655UL , SeedEcbEncryptData = 0x00000656UL ,   SeedCbcEncryptData = 0x00000657UL , SkipjackKeyGen = 0x00001000UL , SkipjackEcb64 = 0x00001001UL , SkipjackCbc64 = 0x00001002UL ,   SkipjackOfb64 = 0x00001003UL , SkipjackCfb64 = 0x00001004UL , SkipjackCfb32 = 0x00001005UL , SkipjackCfb16 = 0x00001006UL ,   SkipjackCfb8 = 0x00001007UL , SkipjackWrap = 0x00001008UL , SkipjackPrivateWrap = 0x00001009UL , SkipjackRelayx = 0x0000100aUL ,   KeaKeyPairGen = 0x00001010UL , KeaKeyDerive = 0x00001011UL , KeaDerive = 0x00001012UL , FortezzaTimestamp = 0x00001020UL ,   BatonKeyGen = 0x00001030UL , BatonEcb128 = 0x00001031UL , BatonEcb96 = 0x00001032UL , BatonCbc128 = 0x00001033UL ,   BatonCounter = 0x00001034UL , BatonShuffle = 0x00001035UL , BatonWrap = 0x00001036UL , EcdsaKeyPairGen = 0x00001040UL ,   EcKeyPairGen = 0x00001040UL , Ecdsa = 0x00001041UL , EcdsaSha1 = 0x00001042UL , EcdsaSha224 = 0x00001043UL ,   EcdsaSha256 = 0x00001044UL , EcdsaSha384 = 0x00001045UL , EcdsaSha512 = 0x00001046UL , Ecdh1Derive = 0x00001050UL ,   Ecdh1CofactorDerive = 0x00001051UL , EcmqvDerive = 0x00001052UL , EcdhAesKeyWrap = 0x00001053UL , RsaAesKeyWrap = 0x00001054UL ,   JuniperKeyGen = 0x00001060UL , JuniperEcb128 = 0x00001061UL , JuniperCbc128 = 0x00001062UL , JuniperCounter = 0x00001063UL ,   JuniperShuffle = 0x00001064UL , JuniperWrap = 0x00001065UL , Fasthash = 0x00001070UL , AesKeyGen = 0x00001080UL ,   AesEcb = 0x00001081UL , AesCbc = 0x00001082UL , AesMac = 0x00001083UL , AesMacGeneral = 0x00001084UL ,   AesCbcPad = 0x00001085UL , AesCtr = 0x00001086UL , AesGcm = 0x00001087UL , AesCcm = 0x00001088UL ,   AesCts = 0x00001089UL , AesCmac = 0x0000108AUL , AesCmacGeneral = 0x0000108BUL , AesXcbcMac = 0x0000108CUL ,   AesXcbcMac96 = 0x0000108DUL , AesGmac = 0x0000108EUL , BlowfishKeyGen = 0x00001090UL , BlowfishCbc = 0x00001091UL ,   TwofishKeyGen = 0x00001092UL , TwofishCbc = 0x00001093UL , BlowfishCbcPad = 0x00001094UL , TwofishCbcPad = 0x00001095UL ,   DesEcbEncryptData = 0x00001100UL , DesCbcEncryptData = 0x00001101UL , Des3EcbEncryptData = 0x00001102UL , Des3CbcEncryptData = 0x00001103UL ,   AesEcbEncryptData = 0x00001104UL , AesCbcEncryptData = 0x00001105UL , Gostr3410KeyPairGen = 0x00001200UL , Gostr3410 = 0x00001201UL ,   Gostr3410WithGostr3411 = 0x00001202UL , Gostr3410KeyWrap = 0x00001203UL , Gostr3410Derive = 0x00001204UL , Gostr3411 = 0x00001210UL ,   Gostr3411Hmac = 0x00001211UL , Gost28147KeyGen = 0x00001220UL , Gost28147Ecb = 0x00001221UL , Gost28147 = 0x00001222UL ,   Gost28147Mac = 0x00001223UL , Gost28147KeyWrap = 0x00001224UL , DsaParameterGen = 0x00002000UL , DhPkcsParameterGen = 0x00002001UL ,   X942DhParameterGen = 0x00002002UL , DsaProbablisticParameterGen = 0x00002003UL , DsaShaweTaylorParameterGen = 0x00002004UL , AesOfb = 0x00002104UL ,   AesCfb64 = 0x00002105UL , AesCfb8 = 0x00002106UL , AesCfb128 = 0x00002107UL , AesCfb1 = 0x00002108UL ,   AesKeyWrap = 0x00002109UL , AesKeyWrapPad = 0x0000210AUL , RsaPkcsTpm11 = 0x00004001UL , RsaPkcsOaepTpm11 = 0x00004002UL ,   VendorDefined = 0x80000000UL }
enum class	MGF : CK_RSA_PKCS_MGF_TYPE {   MgfUnused = 0 , Mgf1Sha1 = 0x00000001UL , Mgf1Sha256 = 0x00000002UL , Mgf1Sha384 = 0x00000003UL ,   Mgf1Sha512 = 0x00000004UL , Mgf1Sha224 = 0x00000005UL }
enum class	Notification : CK_NOTIFICATION { Surrender = 0UL , OtpChanged = 1UL }
enum class	ObjectClass : CK_OBJECT_CLASS {   Data = 0x00000000UL , Certificate = 0x00000001UL , PublicKey = 0x00000002UL , PrivateKey = 0x00000003UL ,   SecretKey = 0x00000004UL , HwFeature = 0x00000005UL , DomainParameters = 0x00000006UL , Mechanism = 0x00000007UL ,   OtpKey = 0x00000008UL , VendorDefined = 0x80000000UL }
enum class	PseudoRandom : CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE {   Pkcs5Pbkd2HmacSha1 = 0x00000001UL , Pkcs5Pbkd2HmacGostr3411 = 0x00000002UL , Pkcs5Pbkd2HmacSha224 = 0x00000003UL , Pkcs5Pbkd2HmacSha256 = 0x00000004UL ,   Pkcs5Pbkd2HmacSha384 = 0x00000005UL , Pkcs5Pbkd2HmacSha512 = 0x00000006UL , Pkcs5Pbkd2HmacSha512224 = 0x00000007UL , Pkcs5Pbkd2HmacSha512256 = 0x00000008UL }
enum class	PublicPointEncoding : uint32_t { Raw , Der }
enum class	ReturnValue : CK_RV {   OK = 0x00000000UL , Cancel = 0x00000001UL , HostMemory = 0x00000002UL , SlotIdInvalid = 0x00000003UL ,   GeneralError = 0x00000005UL , FunctionFailed = 0x00000006UL , ArgumentsBad = 0x00000007UL , NoEvent = 0x00000008UL ,   NeedToCreateThreads = 0x00000009UL , CantLock = 0x0000000AUL , AttributeReadOnly = 0x00000010UL , AttributeSensitive = 0x00000011UL ,   AttributeTypeInvalid = 0x00000012UL , AttributeValueInvalid = 0x00000013UL , ActionProhibited = 0x0000001BUL , DataInvalid = 0x00000020UL ,   DataLenRange = 0x00000021UL , DeviceError = 0x00000030UL , DeviceMemory = 0x00000031UL , DeviceRemoved = 0x00000032UL ,   EncryptedDataInvalid = 0x00000040UL , EncryptedDataLenRange = 0x00000041UL , FunctionCanceled = 0x00000050UL , FunctionNotParallel = 0x00000051UL ,   FunctionNotSupported = 0x00000054UL , KeyHandleInvalid = 0x00000060UL , KeySizeRange = 0x00000062UL , KeyTypeInconsistent = 0x00000063UL ,   KeyNotNeeded = 0x00000064UL , KeyChanged = 0x00000065UL , KeyNeeded = 0x00000066UL , KeyIndigestible = 0x00000067UL ,   KeyFunctionNotPermitted = 0x00000068UL , KeyNotWrappable = 0x00000069UL , KeyUnextractable = 0x0000006AUL , MechanismInvalid = 0x00000070UL ,   MechanismParamInvalid = 0x00000071UL , ObjectHandleInvalid = 0x00000082UL , OperationActive = 0x00000090UL , OperationNotInitialized = 0x00000091UL ,   PinIncorrect = 0x000000A0UL , PinInvalid = 0x000000A1UL , PinLenRange = 0x000000A2UL , PinExpired = 0x000000A3UL ,   PinLocked = 0x000000A4UL , SessionClosed = 0x000000B0UL , SessionCount = 0x000000B1UL , SessionHandleInvalid = 0x000000B3UL ,   SessionParallelNotSupported = 0x000000B4UL , SessionReadOnly = 0x000000B5UL , SessionExists = 0x000000B6UL , SessionReadOnlyExists = 0x000000B7UL ,   SessionReadWriteSoExists = 0x000000B8UL , SignatureInvalid = 0x000000C0UL , SignatureLenRange = 0x000000C1UL , TemplateIncomplete = 0x000000D0UL ,   TemplateInconsistent = 0x000000D1UL , TokenNotPresent = 0x000000E0UL , TokenNotRecognized = 0x000000E1UL , TokenWriteProtected = 0x000000E2UL ,   UnwrappingKeyHandleInvalid = 0x000000F0UL , UnwrappingKeySizeRange = 0x000000F1UL , UnwrappingKeyTypeInconsistent = 0x000000F2UL , UserAlreadyLoggedIn = 0x00000100UL ,   UserNotLoggedIn = 0x00000101UL , UserPinNotInitialized = 0x00000102UL , UserTypeInvalid = 0x00000103UL , UserAnotherAlreadyLoggedIn = 0x00000104UL ,   UserTooManyTypes = 0x00000105UL , WrappedKeyInvalid = 0x00000110UL , WrappedKeyLenRange = 0x00000112UL , WrappingKeyHandleInvalid = 0x00000113UL ,   WrappingKeySizeRange = 0x00000114UL , WrappingKeyTypeInconsistent = 0x00000115UL , RandomSeedNotSupported = 0x00000120UL , RandomNoRng = 0x00000121UL ,   DomainParamsInvalid = 0x00000130UL , CurveNotSupported = 0x00000140UL , BufferTooSmall = 0x00000150UL , SavedStateInvalid = 0x00000160UL ,   InformationSensitive = 0x00000170UL , StateUnsaveable = 0x00000180UL , CryptokiNotInitialized = 0x00000190UL , CryptokiAlreadyInitialized = 0x00000191UL ,   MutexBad = 0x000001A0UL , MutexNotLocked = 0x000001A1UL , NewPinMode = 0x000001B0UL , NextOtp = 0x000001B1UL ,   ExceededMaxIterations = 0x000001B5UL , FipsSelfTestFailed = 0x000001B6UL , LibraryLoadFailed = 0x000001B7UL , PinTooWeak = 0x000001B8UL ,   PublicKeyInvalid = 0x000001B9UL , FunctionRejected = 0x00000200UL , VendorDefined = 0x80000000UL }
enum class	SessionState : CK_STATE {   RoPublicSession = 0UL , RoUserFunctions = 1UL , RwPublicSession = 2UL , RwUserFunctions = 3UL ,   RwSoFunctions = 4UL }
enum class	UserType : CK_USER_TYPE { SO = 0UL , User = 1UL , ContextSpecific = 2UL }

Functions
void	change_pin (Slot &slot, const secure_string &old_pin, const secure_string &new_pin)
void	change_so_pin (Slot &slot, const secure_string &old_so_pin, const secure_string &new_so_pin)
Flags	flags (Flag flags)
void	initialize_token (Slot &slot, std::string_view label, const secure_string &so_pin, const secure_string &pin)
Flag	operator| (Flag a, Flag b)
void	set_pin (Slot &slot, const secure_string &so_pin, const secure_string &pin)

Variables
const Bbool	False = 0
ReturnValue *	ThrowException = reinterpret_cast<ReturnValue*>(-1)
const Bbool	True = 1

Typedef Documentation

Attribute

using Botan::PKCS11::Attribute = CK_ATTRIBUTE

Definition at line 825 of file p11.h.

Bbool

using Botan::PKCS11::Bbool = CK_BBOOL

Definition at line 814 of file p11.h.

Byte

using Botan::PKCS11::Byte = CK_BYTE

Definition at line 827 of file p11.h.

C_InitializeArgs

using Botan::PKCS11::C_InitializeArgs = CK_C_INITIALIZE_ARGS

Definition at line 807 of file p11.h.

CreateMutex

using Botan::PKCS11::CreateMutex = CK_CREATEMUTEX

Definition at line 808 of file p11.h.

Date

using Botan::PKCS11::Date = CK_DATE

Definition at line 831 of file p11.h.

DestroyMutex

using Botan::PKCS11::DestroyMutex = CK_DESTROYMUTEX

Definition at line 809 of file p11.h.

Ecdh1DeriveParams

using Botan::PKCS11::Ecdh1DeriveParams = CK_ECDH1_DERIVE_PARAMS

Definition at line 830 of file p11.h.

Flags

using Botan::PKCS11::Flags = CK_FLAGS

Definition at line 812 of file p11.h.

FunctionListPtr

using Botan::PKCS11::FunctionListPtr = CK_FUNCTION_LIST_PTR

Definition at line 805 of file p11.h.

Info

using Botan::PKCS11::Info = CK_INFO

Definition at line 813 of file p11.h.

LockMutex

using Botan::PKCS11::LockMutex = CK_LOCKMUTEX

Definition at line 810 of file p11.h.

Mechanism

using Botan::PKCS11::Mechanism = CK_MECHANISM

Definition at line 819 of file p11.h.

MechanismInfo

using Botan::PKCS11::MechanismInfo = CK_MECHANISM_INFO

Definition at line 820 of file p11.h.

Notify

using Botan::PKCS11::Notify = CK_NOTIFY

Definition at line 822 of file p11.h.

ObjectHandle

using Botan::PKCS11::ObjectHandle = CK_OBJECT_HANDLE

Definition at line 826 of file p11.h.

RsaPkcsOaepParams

using Botan::PKCS11::RsaPkcsOaepParams = CK_RSA_PKCS_OAEP_PARAMS

Definition at line 828 of file p11.h.

RsaPkcsPssParams

using Botan::PKCS11::RsaPkcsPssParams = CK_RSA_PKCS_PSS_PARAMS

Definition at line 829 of file p11.h.

secure_string

using Botan::PKCS11::secure_string = secure_vector<uint8_t>

Definition at line 59 of file p11.h.

SessionHandle

using Botan::PKCS11::SessionHandle = CK_SESSION_HANDLE

Definition at line 823 of file p11.h.

SessionInfo

using Botan::PKCS11::SessionInfo = CK_SESSION_INFO

Definition at line 824 of file p11.h.

SlotId

using Botan::PKCS11::SlotId = CK_SLOT_ID

Definition at line 815 of file p11.h.

SlotInfo

using Botan::PKCS11::SlotInfo = CK_SLOT_INFO

Definition at line 817 of file p11.h.

TokenInfo

using Botan::PKCS11::TokenInfo = CK_TOKEN_INFO

Definition at line 818 of file p11.h.

Ulong

using Botan::PKCS11::Ulong = CK_ULONG

Definition at line 816 of file p11.h.

UnlockMutex

using Botan::PKCS11::UnlockMutex = CK_UNLOCKMUTEX

Definition at line 811 of file p11.h.

Utf8Char

using Botan::PKCS11::Utf8Char = CK_UTF8CHAR

Definition at line 821 of file p11.h.

VoidPtr

using Botan::PKCS11::VoidPtr = CK_VOID_PTR

Definition at line 806 of file p11.h.

Enumeration Type Documentation

AttributeType

enum class Botan::PKCS11::AttributeType : CK_ATTRIBUTE_TYPE

strong

Enumerator
Class
Token
Private
Label
Application
Value
ObjectId
CertificateType
Issuer
SerialNumber
AcIssuer
Owner
AttrTypes
Trusted
CertificateCategory
JavaMidpSecurityDomain
Url
HashOfSubjectPublicKey
HashOfIssuerPublicKey
NameHashAlgorithm
CheckValue
KeyType
Subject
Id
Sensitive
Encrypt
Decrypt
Wrap
Unwrap
Sign
SignRecover
Verify
VerifyRecover
Derive
StartDate
EndDate
Modulus
ModulusBits
PublicExponent
PrivateExponent
Prime1
Prime2
Exponent1
Exponent2
Coefficient
PublicKeyInfo
Prime
Subprime
Base
PrimeBits
SubprimeBits
SubPrimeBits
ValueBits
ValueLen
Extractable
Local
NeverExtractable
AlwaysSensitive
KeyGenMechanism
Modifiable
Copyable
Destroyable
EcdsaParams
EcParams
EcPoint
SecondaryAuth
AuthPinFlags
AlwaysAuthenticate
WrapWithTrusted
WrapTemplate
UnwrapTemplate
DeriveTemplate
OtpFormat
OtpLength
OtpTimeInterval
OtpUserFriendlyMode
OtpChallengeRequirement
OtpTimeRequirement
OtpCounterRequirement
OtpPinRequirement
OtpCounter
OtpTime
OtpUserIdentifier
OtpServiceIdentifier
OtpServiceLogo
OtpServiceLogoType
Gostr3410Params
Gostr3411Params
Gost28147Params
HwFeatureType
ResetOnInit
HasReset
PixelX
PixelY
Resolution
CharRows
CharColumns
Color
BitsPerPixel
CharSets
EncodingMethods
MimeTypes
MechanismType
RequiredCmsAttributes
DefaultCmsAttributes
SupportedCmsAttributes
AllowedMechanisms
VendorDefined

Definition at line 61 of file p11.h.

                         : CK_ATTRIBUTE_TYPE {
   Class = CKA_CLASS,
   Token = CKA_TOKEN,
   Private = CKA_PRIVATE,
   Label = CKA_LABEL,
   Application = CKA_APPLICATION,
   Value = CKA_VALUE,
   ObjectId = CKA_OBJECT_ID,
   CertificateType = CKA_CERTIFICATE_TYPE,
   Issuer = CKA_ISSUER,
   SerialNumber = CKA_SERIAL_NUMBER,
   AcIssuer = CKA_AC_ISSUER,
   Owner = CKA_OWNER,
   AttrTypes = CKA_ATTR_TYPES,
   Trusted = CKA_TRUSTED,
   CertificateCategory = CKA_CERTIFICATE_CATEGORY,
   JavaMidpSecurityDomain = CKA_JAVA_MIDP_SECURITY_DOMAIN,
   Url = CKA_URL,
   HashOfSubjectPublicKey = CKA_HASH_OF_SUBJECT_PUBLIC_KEY,
   HashOfIssuerPublicKey = CKA_HASH_OF_ISSUER_PUBLIC_KEY,
   NameHashAlgorithm = CKA_NAME_HASH_ALGORITHM,
   CheckValue = CKA_CHECK_VALUE,
   KeyType = CKA_KEY_TYPE,
   Subject = CKA_SUBJECT,
   Id = CKA_ID,
   Sensitive = CKA_SENSITIVE,
   Encrypt = CKA_ENCRYPT,
   Decrypt = CKA_DECRYPT,
   Wrap = CKA_WRAP,
   Unwrap = CKA_UNWRAP,
   Sign = CKA_SIGN,
   SignRecover = CKA_SIGN_RECOVER,
   Verify = CKA_VERIFY,
   VerifyRecover = CKA_VERIFY_RECOVER,
   Derive = CKA_DERIVE,
   StartDate = CKA_START_DATE,
   EndDate = CKA_END_DATE,
   Modulus = CKA_MODULUS,
   ModulusBits = CKA_MODULUS_BITS,
   PublicExponent = CKA_PUBLIC_EXPONENT,
   PrivateExponent = CKA_PRIVATE_EXPONENT,
   Prime1 = CKA_PRIME_1,
   Prime2 = CKA_PRIME_2,
   Exponent1 = CKA_EXPONENT_1,
   Exponent2 = CKA_EXPONENT_2,
   Coefficient = CKA_COEFFICIENT,
   PublicKeyInfo = CKA_PUBLIC_KEY_INFO,
   Prime = CKA_PRIME,
   Subprime = CKA_SUBPRIME,
   Base = CKA_BASE,
   PrimeBits = CKA_PRIME_BITS,
   SubprimeBits = CKA_SUBPRIME_BITS,
   SubPrimeBits = CKA_SUB_PRIME_BITS,
   ValueBits = CKA_VALUE_BITS,
   ValueLen = CKA_VALUE_LEN,
   Extractable = CKA_EXTRACTABLE,
   Local = CKA_LOCAL,
   NeverExtractable = CKA_NEVER_EXTRACTABLE,
   AlwaysSensitive = CKA_ALWAYS_SENSITIVE,
   KeyGenMechanism = CKA_KEY_GEN_MECHANISM,
   Modifiable = CKA_MODIFIABLE,
   Copyable = CKA_COPYABLE,
   Destroyable = CKA_DESTROYABLE,
   EcdsaParams = CKA_ECDSA_PARAMS,
   EcParams = CKA_EC_PARAMS,
   EcPoint = CKA_EC_POINT,
   SecondaryAuth = CKA_SECONDARY_AUTH,
   AuthPinFlags = CKA_AUTH_PIN_FLAGS,
   AlwaysAuthenticate = CKA_ALWAYS_AUTHENTICATE,
   WrapWithTrusted = CKA_WRAP_WITH_TRUSTED,
   WrapTemplate = CKA_WRAP_TEMPLATE,
   UnwrapTemplate = CKA_UNWRAP_TEMPLATE,
   DeriveTemplate = CKA_DERIVE_TEMPLATE,
   OtpFormat = CKA_OTP_FORMAT,
   OtpLength = CKA_OTP_LENGTH,
   OtpTimeInterval = CKA_OTP_TIME_INTERVAL,
   OtpUserFriendlyMode = CKA_OTP_USER_FRIENDLY_MODE,
   OtpChallengeRequirement = CKA_OTP_CHALLENGE_REQUIREMENT,
   OtpTimeRequirement = CKA_OTP_TIME_REQUIREMENT,
   OtpCounterRequirement = CKA_OTP_COUNTER_REQUIREMENT,
   OtpPinRequirement = CKA_OTP_PIN_REQUIREMENT,
   OtpCounter = CKA_OTP_COUNTER,
   OtpTime = CKA_OTP_TIME,
   OtpUserIdentifier = CKA_OTP_USER_IDENTIFIER,
   OtpServiceIdentifier = CKA_OTP_SERVICE_IDENTIFIER,
   OtpServiceLogo = CKA_OTP_SERVICE_LOGO,
   OtpServiceLogoType = CKA_OTP_SERVICE_LOGO_TYPE,
   Gostr3410Params = CKA_GOSTR3410_PARAMS,
   Gostr3411Params = CKA_GOSTR3411_PARAMS,
   Gost28147Params = CKA_GOST28147_PARAMS,
   HwFeatureType = CKA_HW_FEATURE_TYPE,
   ResetOnInit = CKA_RESET_ON_INIT,
   HasReset = CKA_HAS_RESET,
   PixelX = CKA_PIXEL_X,
   PixelY = CKA_PIXEL_Y,
   Resolution = CKA_RESOLUTION,
   CharRows = CKA_CHAR_ROWS,
   CharColumns = CKA_CHAR_COLUMNS,
   Color = CKA_COLOR,
   BitsPerPixel = CKA_BITS_PER_PIXEL,
   CharSets = CKA_CHAR_SETS,
   EncodingMethods = CKA_ENCODING_METHODS,
   MimeTypes = CKA_MIME_TYPES,
   MechanismType = CKA_MECHANISM_TYPE,
   RequiredCmsAttributes = CKA_REQUIRED_CMS_ATTRIBUTES,
   DefaultCmsAttributes = CKA_DEFAULT_CMS_ATTRIBUTES,
   SupportedCmsAttributes = CKA_SUPPORTED_CMS_ATTRIBUTES,
   AllowedMechanisms = CKA_ALLOWED_MECHANISMS,
   VendorDefined = CKA_VENDOR_DEFINED,
};

CertificateCategory

enum class Botan::PKCS11::CertificateCategory : CK_ULONG

strong

Indicates if a stored certificate is a user certificate for which the corresponding private key is available on the token ("token user"), a CA certificate ("authority"), or another end-entity certificate ("other entity").

Enumerator
Unspecified
TokenUser
Authority
OtherEntity

Definition at line 181 of file p11.h.

                               : CK_ULONG {
   Unspecified = CK_CERTIFICATE_CATEGORY_UNSPECIFIED,
   TokenUser = CK_CERTIFICATE_CATEGORY_TOKEN_USER,
   Authority = CK_CERTIFICATE_CATEGORY_AUTHORITY,
   OtherEntity = CK_CERTIFICATE_CATEGORY_OTHER_ENTITY
};

CertificateType

enum class Botan::PKCS11::CertificateType : CK_CERTIFICATE_TYPE

strong

Enumerator
X509
X509AttrCert
Wtls
VendorDefined

Definition at line 172 of file p11.h.

                           : CK_CERTIFICATE_TYPE {
   X509 = CKC_X_509,
   X509AttrCert = CKC_X_509_ATTR_CERT,
   Wtls = CKC_WTLS,
   VendorDefined = CKC_VENDOR_DEFINED,
};

Flag

enum class Botan::PKCS11::Flag : CK_FLAGS

strong

Enumerator
None
TokenPresent
RemovableDevice
HwSlot
Rng
WriteProtected
LoginRequired
UserPinInitialized
RestoreKeyNotNeeded
ClockOnToken
ProtectedAuthenticationPath
DualCryptoOperations
TokenInitialized
SecondaryAuthentication
UserPinCountLow
UserPinFinalTry
UserPinLocked
UserPinToBeChanged
SoPinCountLow
SoPinFinalTry
SoPinLocked
SoPinToBeChanged
ErrorState
RwSession
SerialSession
ArrayAttribute
Hw
Encrypt
Decrypt
Digest
Sign
SignRecover
Verify
VerifyRecover
Generate
GenerateKeyPair
Wrap
Unwrap
Derive
EcFP
EcF2m
EcEcparameters
EcNamedcurve
EcUncompress
EcCompress
Extension
LibraryCantCreateOsThreads
OsLockingOk
DontBlock
NextOtp
ExcludeTime
ExcludeCounter
ExcludeChallenge
ExcludePin
UserFriendlyOtp

Definition at line 200 of file p11.h.

                : CK_FLAGS {
   None = 0,
   TokenPresent = CKF_TOKEN_PRESENT,
   RemovableDevice = CKF_REMOVABLE_DEVICE,
   HwSlot = CKF_HW_SLOT,
   Rng = CKF_RNG,
   WriteProtected = CKF_WRITE_PROTECTED,
   LoginRequired = CKF_LOGIN_REQUIRED,
   UserPinInitialized = CKF_USER_PIN_INITIALIZED,
   RestoreKeyNotNeeded = CKF_RESTORE_KEY_NOT_NEEDED,
   ClockOnToken = CKF_CLOCK_ON_TOKEN,
   ProtectedAuthenticationPath = CKF_PROTECTED_AUTHENTICATION_PATH,
   DualCryptoOperations = CKF_DUAL_CRYPTO_OPERATIONS,
   TokenInitialized = CKF_TOKEN_INITIALIZED,
   SecondaryAuthentication = CKF_SECONDARY_AUTHENTICATION,
   UserPinCountLow = CKF_USER_PIN_COUNT_LOW,
   UserPinFinalTry = CKF_USER_PIN_FINAL_TRY,
   UserPinLocked = CKF_USER_PIN_LOCKED,
   UserPinToBeChanged = CKF_USER_PIN_TO_BE_CHANGED,
   SoPinCountLow = CKF_SO_PIN_COUNT_LOW,
   SoPinFinalTry = CKF_SO_PIN_FINAL_TRY,
   SoPinLocked = CKF_SO_PIN_LOCKED,
   SoPinToBeChanged = CKF_SO_PIN_TO_BE_CHANGED,
   ErrorState = CKF_ERROR_STATE,
   RwSession = CKF_RW_SESSION,
   SerialSession = CKF_SERIAL_SESSION,
   ArrayAttribute = CKF_ARRAY_ATTRIBUTE,
   Hw = CKF_HW,
   Encrypt = CKF_ENCRYPT,
   Decrypt = CKF_DECRYPT,
   Digest = CKF_DIGEST,
   Sign = CKF_SIGN,
   SignRecover = CKF_SIGN_RECOVER,
   Verify = CKF_VERIFY,
   VerifyRecover = CKF_VERIFY_RECOVER,
   Generate = CKF_GENERATE,
   GenerateKeyPair = CKF_GENERATE_KEY_PAIR,
   Wrap = CKF_WRAP,
   Unwrap = CKF_UNWRAP,
   Derive = CKF_DERIVE,
   EcFP = CKF_EC_F_P,
   EcF2m = CKF_EC_F_2M,
   EcEcparameters = CKF_EC_ECPARAMETERS,
   EcNamedcurve = CKF_EC_NAMEDCURVE,
   EcUncompress = CKF_EC_UNCOMPRESS,
   EcCompress = CKF_EC_COMPRESS,
   Extension = CKF_EXTENSION,
   LibraryCantCreateOsThreads = CKF_LIBRARY_CANT_CREATE_OS_THREADS,
   OsLockingOk = CKF_OS_LOCKING_OK,
   DontBlock = CKF_DONT_BLOCK,
   NextOtp = CKF_NEXT_OTP,
   ExcludeTime = CKF_EXCLUDE_TIME,
   ExcludeCounter = CKF_EXCLUDE_COUNTER,
   ExcludeChallenge = CKF_EXCLUDE_CHALLENGE,
   ExcludePin = CKF_EXCLUDE_PIN,
   UserFriendlyOtp = CKF_USER_FRIENDLY_OTP,
};

HardwareType

enum class Botan::PKCS11::HardwareType : CK_HW_FEATURE_TYPE

strong

Enumerator
MonotonicCounter
Clock
UserInterface
VendorDefined

Definition at line 272 of file p11.h.

                        : CK_HW_FEATURE_TYPE {
   MonotonicCounter = CKH_MONOTONIC_COUNTER,
   Clock = CKH_CLOCK,
   UserInterface = CKH_USER_INTERFACE,
   VendorDefined = CKH_VENDOR_DEFINED,
};

KeyDerivation

enum class Botan::PKCS11::KeyDerivation : CK_ULONG

strong

Enumerator
Null
Sha1Kdf
Sha1KdfAsn1
Sha1KdfConcatenate
Sha224Kdf
Sha256Kdf
Sha384Kdf
Sha512Kdf
CpdiversifyKdf

Definition at line 188 of file p11.h.

                         : CK_ULONG {
   Null = CKD_NULL,
   Sha1Kdf = CKD_SHA1_KDF,
   Sha1KdfAsn1 = CKD_SHA1_KDF_ASN1,
   Sha1KdfConcatenate = CKD_SHA1_KDF_CONCATENATE,
   Sha224Kdf = CKD_SHA224_KDF,
   Sha256Kdf = CKD_SHA256_KDF,
   Sha384Kdf = CKD_SHA384_KDF,
   Sha512Kdf = CKD_SHA512_KDF,
   CpdiversifyKdf = CKD_CPDIVERSIFY_KDF,
};

KeyType

enum class Botan::PKCS11::KeyType : CK_KEY_TYPE

strong

Enumerator
Rsa
Dsa
Dh
Ecdsa
Ec
X942Dh
Kea
GenericSecret
Rc2
Rc4
Des
Des2
Des3
Cast
Cast3
Cast5
Cast128
Rc5
Idea
Skipjack
Baton
Juniper
Cdmf
Aes
Blowfish
Twofish
Securid
Hotp
Acti
Camellia
Aria
Md5Hmac
Sha1Hmac
Ripemd128Hmac
Ripemd160Hmac
Sha256Hmac
Sha384Hmac
Sha512Hmac
Sha224Hmac
Seed
Gostr3410
Gostr3411
Gost28147
VendorDefined

Definition at line 279 of file p11.h.

                   : CK_KEY_TYPE {
   Rsa = CKK_RSA,
   Dsa = CKK_DSA,
   Dh = CKK_DH,
   Ecdsa = CKK_ECDSA,
   Ec = CKK_EC,
   X942Dh = CKK_X9_42_DH,
   Kea = CKK_KEA,
   GenericSecret = CKK_GENERIC_SECRET,
   Rc2 = CKK_RC2,
   Rc4 = CKK_RC4,
   Des = CKK_DES,
   Des2 = CKK_DES2,
   Des3 = CKK_DES3,
   Cast = CKK_CAST,
   Cast3 = CKK_CAST3,
   Cast5 = CKK_CAST5,
   Cast128 = CKK_CAST128,
   Rc5 = CKK_RC5,
   Idea = CKK_IDEA,
   Skipjack = CKK_SKIPJACK,
   Baton = CKK_BATON,
   Juniper = CKK_JUNIPER,
   Cdmf = CKK_CDMF,
   Aes = CKK_AES,
   Blowfish = CKK_BLOWFISH,
   Twofish = CKK_TWOFISH,
   Securid = CKK_SECURID,
   Hotp = CKK_HOTP,
   Acti = CKK_ACTI,
   Camellia = CKK_CAMELLIA,
   Aria = CKK_ARIA,
   Md5Hmac = CKK_MD5_HMAC,
   Sha1Hmac = CKK_SHA_1_HMAC,
   Ripemd128Hmac = CKK_RIPEMD128_HMAC,
   Ripemd160Hmac = CKK_RIPEMD160_HMAC,
   Sha256Hmac = CKK_SHA256_HMAC,
   Sha384Hmac = CKK_SHA384_HMAC,
   Sha512Hmac = CKK_SHA512_HMAC,
   Sha224Hmac = CKK_SHA224_HMAC,
   Seed = CKK_SEED,
   Gostr3410 = CKK_GOSTR3410,
   Gostr3411 = CKK_GOSTR3411,
   Gost28147 = CKK_GOST28147,
   VendorDefined = CKK_VENDOR_DEFINED,
};

MechanismType

enum class Botan::PKCS11::MechanismType : CK_MECHANISM_TYPE

strong

Enumerator
RsaPkcsKeyPairGen
RsaPkcs
Rsa9796
RsaX509
Md2RsaPkcs
Md5RsaPkcs
Sha1RsaPkcs
Ripemd128RsaPkcs
Ripemd160RsaPkcs
RsaPkcsOaep
RsaX931KeyPairGen
RsaX931
Sha1RsaX931
RsaPkcsPss
Sha1RsaPkcsPss
DsaKeyPairGen
Dsa
DsaSha1
DsaSha224
DsaSha256
DsaSha384
DsaSha512
DhPkcsKeyPairGen
DhPkcsDerive
X942DhKeyPairGen
X942DhDerive
X942DhHybridDerive
X942MqvDerive
Sha256RsaPkcs
Sha384RsaPkcs
Sha512RsaPkcs
Sha256RsaPkcsPss
Sha384RsaPkcsPss
Sha512RsaPkcsPss
Sha224RsaPkcs
Sha224RsaPkcsPss
Sha512224
Sha512224Hmac
Sha512224HmacGeneral
Sha512224KeyDerivation
Sha512256
Sha512256Hmac
Sha512256HmacGeneral
Sha512256KeyDerivation
Sha512T
Sha512THmac
Sha512THmacGeneral
Sha512TKeyDerivation
Rc2KeyGen
Rc2Ecb
Rc2Cbc
Rc2Mac
Rc2MacGeneral
Rc2CbcPad
Rc4KeyGen
Rc4
DesKeyGen
DesEcb
DesCbc
DesMac
DesMacGeneral
DesCbcPad
Des2KeyGen
Des3KeyGen
Des3Ecb
Des3Cbc
Des3Mac
Des3MacGeneral
Des3CbcPad
Des3CmacGeneral
Des3Cmac
CdmfKeyGen
CdmfEcb
CdmfCbc
CdmfMac
CdmfMacGeneral
CdmfCbcPad
DesOfb64
DesOfb8
DesCfb64
DesCfb8
Md2
Md2Hmac
Md2HmacGeneral
Md5
Md5Hmac
Md5HmacGeneral
Sha1
Sha1Hmac
Sha1HmacGeneral
Ripemd128
Ripemd128Hmac
Ripemd128HmacGeneral
Ripemd160
Ripemd160Hmac
Ripemd160HmacGeneral
Sha256
Sha256Hmac
Sha256HmacGeneral
Sha224
Sha224Hmac
Sha224HmacGeneral
Sha384
Sha384Hmac
Sha384HmacGeneral
Sha512
Sha512Hmac
Sha512HmacGeneral
SecuridKeyGen
Securid
HotpKeyGen
Hotp
Acti
ActiKeyGen
CastKeyGen
CastEcb
CastCbc
CastMac
CastMacGeneral
CastCbcPad
Cast3KeyGen
Cast3Ecb
Cast3Cbc
Cast3Mac
Cast3MacGeneral
Cast3CbcPad
Cast5KeyGen
Cast128KeyGen
Cast5Ecb
Cast128Ecb
Cast5Cbc
Cast128Cbc
Cast5Mac
Cast128Mac
Cast5MacGeneral
Cast128MacGeneral
Cast5CbcPad
Cast128CbcPad
Rc5KeyGen
Rc5Ecb
Rc5Cbc
Rc5Mac
Rc5MacGeneral
Rc5CbcPad
IdeaKeyGen
IdeaEcb
IdeaCbc
IdeaMac
IdeaMacGeneral
IdeaCbcPad
GenericSecretKeyGen
ConcatenateBaseAndKey
ConcatenateBaseAndData
ConcatenateDataAndBase
XorBaseAndData
ExtractKeyFromKey
Ssl3PreMasterKeyGen
Ssl3MasterKeyDerive
Ssl3KeyAndMacDerive
Ssl3MasterKeyDeriveDh
TlsPreMasterKeyGen
TlsMasterKeyDerive
TlsKeyAndMacDerive
TlsMasterKeyDeriveDh
TlsPrf
Ssl3Md5Mac
Ssl3Sha1Mac
Md5KeyDerivation
Md2KeyDerivation
Sha1KeyDerivation
Sha256KeyDerivation
Sha384KeyDerivation
Sha512KeyDerivation
Sha224KeyDerivation
PbeMd2DesCbc
PbeMd5DesCbc
PbeMd5CastCbc
PbeMd5Cast3Cbc
PbeMd5Cast5Cbc
PbeMd5Cast128Cbc
PbeSha1Cast5Cbc
PbeSha1Cast128Cbc
PbeSha1Rc4128
PbeSha1Rc440
PbeSha1Des3EdeCbc
PbeSha1Des2EdeCbc
PbeSha1Rc2128Cbc
PbeSha1Rc240Cbc
Pkcs5Pbkd2
PbaSha1WithSha1Hmac
WtlsPreMasterKeyGen
WtlsMasterKeyDerive
WtlsMasterKeyDeriveDhEcc
WtlsPrf
WtlsServerKeyAndMacDerive
WtlsClientKeyAndMacDerive
Tls10MacServer
Tls10MacClient
Tls12Mac
Tls12Kdf
Tls12MasterKeyDerive
Tls12KeyAndMacDerive
Tls12MasterKeyDeriveDh
Tls12KeySafeDerive
TlsMac
TlsKdf
KeyWrapLynks
KeyWrapSetOaep
CmsSig
KipDerive
KipWrap
KipMac
CamelliaKeyGen
CamelliaEcb
CamelliaCbc
CamelliaMac
CamelliaMacGeneral
CamelliaCbcPad
CamelliaEcbEncryptData
CamelliaCbcEncryptData
CamelliaCtr
AriaKeyGen
AriaEcb
AriaCbc
AriaMac
AriaMacGeneral
AriaCbcPad
AriaEcbEncryptData
AriaCbcEncryptData
SeedKeyGen
SeedEcb
SeedCbc
SeedMac
SeedMacGeneral
SeedCbcPad
SeedEcbEncryptData
SeedCbcEncryptData
SkipjackKeyGen
SkipjackEcb64
SkipjackCbc64
SkipjackOfb64
SkipjackCfb64
SkipjackCfb32
SkipjackCfb16
SkipjackCfb8
SkipjackWrap
SkipjackPrivateWrap
SkipjackRelayx
KeaKeyPairGen
KeaKeyDerive
KeaDerive
FortezzaTimestamp
BatonKeyGen
BatonEcb128
BatonEcb96
BatonCbc128
BatonCounter
BatonShuffle
BatonWrap
EcdsaKeyPairGen
EcKeyPairGen
Ecdsa
EcdsaSha1
EcdsaSha224
EcdsaSha256
EcdsaSha384
EcdsaSha512
Ecdh1Derive
Ecdh1CofactorDerive
EcmqvDerive
EcdhAesKeyWrap
RsaAesKeyWrap
JuniperKeyGen
JuniperEcb128
JuniperCbc128
JuniperCounter
JuniperShuffle
JuniperWrap
Fasthash
AesKeyGen
AesEcb
AesCbc
AesMac
AesMacGeneral
AesCbcPad
AesCtr
AesGcm
AesCcm
AesCts
AesCmac
AesCmacGeneral
AesXcbcMac
AesXcbcMac96
AesGmac
BlowfishKeyGen
BlowfishCbc
TwofishKeyGen
TwofishCbc
BlowfishCbcPad
TwofishCbcPad
DesEcbEncryptData
DesCbcEncryptData
Des3EcbEncryptData
Des3CbcEncryptData
AesEcbEncryptData
AesCbcEncryptData
Gostr3410KeyPairGen
Gostr3410
Gostr3410WithGostr3411
Gostr3410KeyWrap
Gostr3410Derive
Gostr3411
Gostr3411Hmac
Gost28147KeyGen
Gost28147Ecb
Gost28147
Gost28147Mac
Gost28147KeyWrap
DsaParameterGen
DhPkcsParameterGen
X942DhParameterGen
DsaProbablisticParameterGen
DsaShaweTaylorParameterGen
AesOfb
AesCfb64
AesCfb8
AesCfb128
AesCfb1
AesKeyWrap
AesKeyWrapPad
RsaPkcsTpm11
RsaPkcsOaepTpm11
VendorDefined

Definition at line 326 of file p11.h.

                         : CK_MECHANISM_TYPE {
   RsaPkcsKeyPairGen = CKM_RSA_PKCS_KEY_PAIR_GEN,
   RsaPkcs = CKM_RSA_PKCS,
   Rsa9796 = CKM_RSA_9796,
   RsaX509 = CKM_RSA_X_509,
   Md2RsaPkcs = CKM_MD2_RSA_PKCS,
   Md5RsaPkcs = CKM_MD5_RSA_PKCS,
   Sha1RsaPkcs = CKM_SHA1_RSA_PKCS,
   Ripemd128RsaPkcs = CKM_RIPEMD128_RSA_PKCS,
   Ripemd160RsaPkcs = CKM_RIPEMD160_RSA_PKCS,
   RsaPkcsOaep = CKM_RSA_PKCS_OAEP,
   RsaX931KeyPairGen = CKM_RSA_X9_31_KEY_PAIR_GEN,
   RsaX931 = CKM_RSA_X9_31,
   Sha1RsaX931 = CKM_SHA1_RSA_X9_31,
   RsaPkcsPss = CKM_RSA_PKCS_PSS,
   Sha1RsaPkcsPss = CKM_SHA1_RSA_PKCS_PSS,
   DsaKeyPairGen = CKM_DSA_KEY_PAIR_GEN,
   Dsa = CKM_DSA,
   DsaSha1 = CKM_DSA_SHA1,
   DsaSha224 = CKM_DSA_SHA224,
   DsaSha256 = CKM_DSA_SHA256,
   DsaSha384 = CKM_DSA_SHA384,
   DsaSha512 = CKM_DSA_SHA512,
   DhPkcsKeyPairGen = CKM_DH_PKCS_KEY_PAIR_GEN,
   DhPkcsDerive = CKM_DH_PKCS_DERIVE,
   X942DhKeyPairGen = CKM_X9_42_DH_KEY_PAIR_GEN,
   X942DhDerive = CKM_X9_42_DH_DERIVE,
   X942DhHybridDerive = CKM_X9_42_DH_HYBRID_DERIVE,
   X942MqvDerive = CKM_X9_42_MQV_DERIVE,
   Sha256RsaPkcs = CKM_SHA256_RSA_PKCS,
   Sha384RsaPkcs = CKM_SHA384_RSA_PKCS,
   Sha512RsaPkcs = CKM_SHA512_RSA_PKCS,
   Sha256RsaPkcsPss = CKM_SHA256_RSA_PKCS_PSS,
   Sha384RsaPkcsPss = CKM_SHA384_RSA_PKCS_PSS,
   Sha512RsaPkcsPss = CKM_SHA512_RSA_PKCS_PSS,
   Sha224RsaPkcs = CKM_SHA224_RSA_PKCS,
   Sha224RsaPkcsPss = CKM_SHA224_RSA_PKCS_PSS,
   Sha512224 = CKM_SHA512_224,
   Sha512224Hmac = CKM_SHA512_224_HMAC,
   Sha512224HmacGeneral = CKM_SHA512_224_HMAC_GENERAL,
   Sha512224KeyDerivation = CKM_SHA512_224_KEY_DERIVATION,
   Sha512256 = CKM_SHA512_256,
   Sha512256Hmac = CKM_SHA512_256_HMAC,
   Sha512256HmacGeneral = CKM_SHA512_256_HMAC_GENERAL,
   Sha512256KeyDerivation = CKM_SHA512_256_KEY_DERIVATION,
   Sha512T = CKM_SHA512_T,
   Sha512THmac = CKM_SHA512_T_HMAC,
   Sha512THmacGeneral = CKM_SHA512_T_HMAC_GENERAL,
   Sha512TKeyDerivation = CKM_SHA512_T_KEY_DERIVATION,
   Rc2KeyGen = CKM_RC2_KEY_GEN,
   Rc2Ecb = CKM_RC2_ECB,
   Rc2Cbc = CKM_RC2_CBC,
   Rc2Mac = CKM_RC2_MAC,
   Rc2MacGeneral = CKM_RC2_MAC_GENERAL,
   Rc2CbcPad = CKM_RC2_CBC_PAD,
   Rc4KeyGen = CKM_RC4_KEY_GEN,
   Rc4 = CKM_RC4,
   DesKeyGen = CKM_DES_KEY_GEN,
   DesEcb = CKM_DES_ECB,
   DesCbc = CKM_DES_CBC,
   DesMac = CKM_DES_MAC,
   DesMacGeneral = CKM_DES_MAC_GENERAL,
   DesCbcPad = CKM_DES_CBC_PAD,
   Des2KeyGen = CKM_DES2_KEY_GEN,
   Des3KeyGen = CKM_DES3_KEY_GEN,
   Des3Ecb = CKM_DES3_ECB,
   Des3Cbc = CKM_DES3_CBC,
   Des3Mac = CKM_DES3_MAC,
   Des3MacGeneral = CKM_DES3_MAC_GENERAL,
   Des3CbcPad = CKM_DES3_CBC_PAD,
   Des3CmacGeneral = CKM_DES3_CMAC_GENERAL,
   Des3Cmac = CKM_DES3_CMAC,
   CdmfKeyGen = CKM_CDMF_KEY_GEN,
   CdmfEcb = CKM_CDMF_ECB,
   CdmfCbc = CKM_CDMF_CBC,
   CdmfMac = CKM_CDMF_MAC,
   CdmfMacGeneral = CKM_CDMF_MAC_GENERAL,
   CdmfCbcPad = CKM_CDMF_CBC_PAD,
   DesOfb64 = CKM_DES_OFB64,
   DesOfb8 = CKM_DES_OFB8,
   DesCfb64 = CKM_DES_CFB64,
   DesCfb8 = CKM_DES_CFB8,
   Md2 = CKM_MD2,
   Md2Hmac = CKM_MD2_HMAC,
   Md2HmacGeneral = CKM_MD2_HMAC_GENERAL,
   Md5 = CKM_MD5,
   Md5Hmac = CKM_MD5_HMAC,
   Md5HmacGeneral = CKM_MD5_HMAC_GENERAL,
   Sha1 = CKM_SHA_1,
   Sha1Hmac = CKM_SHA_1_HMAC,
   Sha1HmacGeneral = CKM_SHA_1_HMAC_GENERAL,
   Ripemd128 = CKM_RIPEMD128,
   Ripemd128Hmac = CKM_RIPEMD128_HMAC,
   Ripemd128HmacGeneral = CKM_RIPEMD128_HMAC_GENERAL,
   Ripemd160 = CKM_RIPEMD160,
   Ripemd160Hmac = CKM_RIPEMD160_HMAC,
   Ripemd160HmacGeneral = CKM_RIPEMD160_HMAC_GENERAL,
   Sha256 = CKM_SHA256,
   Sha256Hmac = CKM_SHA256_HMAC,
   Sha256HmacGeneral = CKM_SHA256_HMAC_GENERAL,
   Sha224 = CKM_SHA224,
   Sha224Hmac = CKM_SHA224_HMAC,
   Sha224HmacGeneral = CKM_SHA224_HMAC_GENERAL,
   Sha384 = CKM_SHA384,
   Sha384Hmac = CKM_SHA384_HMAC,
   Sha384HmacGeneral = CKM_SHA384_HMAC_GENERAL,
   Sha512 = CKM_SHA512,
   Sha512Hmac = CKM_SHA512_HMAC,
   Sha512HmacGeneral = CKM_SHA512_HMAC_GENERAL,
   SecuridKeyGen = CKM_SECURID_KEY_GEN,
   Securid = CKM_SECURID,
   HotpKeyGen = CKM_HOTP_KEY_GEN,
   Hotp = CKM_HOTP,
   Acti = CKM_ACTI,
   ActiKeyGen = CKM_ACTI_KEY_GEN,
   CastKeyGen = CKM_CAST_KEY_GEN,
   CastEcb = CKM_CAST_ECB,
   CastCbc = CKM_CAST_CBC,
   CastMac = CKM_CAST_MAC,
   CastMacGeneral = CKM_CAST_MAC_GENERAL,
   CastCbcPad = CKM_CAST_CBC_PAD,
   Cast3KeyGen = CKM_CAST3_KEY_GEN,
   Cast3Ecb = CKM_CAST3_ECB,
   Cast3Cbc = CKM_CAST3_CBC,
   Cast3Mac = CKM_CAST3_MAC,
   Cast3MacGeneral = CKM_CAST3_MAC_GENERAL,
   Cast3CbcPad = CKM_CAST3_CBC_PAD,
   Cast5KeyGen = CKM_CAST5_KEY_GEN,
   Cast128KeyGen = CKM_CAST128_KEY_GEN,
   Cast5Ecb = CKM_CAST5_ECB,
   Cast128Ecb = CKM_CAST128_ECB,
   Cast5Cbc = CKM_CAST5_CBC,
   Cast128Cbc = CKM_CAST128_CBC,
   Cast5Mac = CKM_CAST5_MAC,
   Cast128Mac = CKM_CAST128_MAC,
   Cast5MacGeneral = CKM_CAST5_MAC_GENERAL,
   Cast128MacGeneral = CKM_CAST128_MAC_GENERAL,
   Cast5CbcPad = CKM_CAST5_CBC_PAD,
   Cast128CbcPad = CKM_CAST128_CBC_PAD,
   Rc5KeyGen = CKM_RC5_KEY_GEN,
   Rc5Ecb = CKM_RC5_ECB,
   Rc5Cbc = CKM_RC5_CBC,
   Rc5Mac = CKM_RC5_MAC,
   Rc5MacGeneral = CKM_RC5_MAC_GENERAL,
   Rc5CbcPad = CKM_RC5_CBC_PAD,
   IdeaKeyGen = CKM_IDEA_KEY_GEN,
   IdeaEcb = CKM_IDEA_ECB,
   IdeaCbc = CKM_IDEA_CBC,
   IdeaMac = CKM_IDEA_MAC,
   IdeaMacGeneral = CKM_IDEA_MAC_GENERAL,
   IdeaCbcPad = CKM_IDEA_CBC_PAD,
   GenericSecretKeyGen = CKM_GENERIC_SECRET_KEY_GEN,
   ConcatenateBaseAndKey = CKM_CONCATENATE_BASE_AND_KEY,
   ConcatenateBaseAndData = CKM_CONCATENATE_BASE_AND_DATA,
   ConcatenateDataAndBase = CKM_CONCATENATE_DATA_AND_BASE,
   XorBaseAndData = CKM_XOR_BASE_AND_DATA,
   ExtractKeyFromKey = CKM_EXTRACT_KEY_FROM_KEY,
   Ssl3PreMasterKeyGen = CKM_SSL3_PRE_MASTER_KEY_GEN,
   Ssl3MasterKeyDerive = CKM_SSL3_MASTER_KEY_DERIVE,
   Ssl3KeyAndMacDerive = CKM_SSL3_KEY_AND_MAC_DERIVE,
   Ssl3MasterKeyDeriveDh = CKM_SSL3_MASTER_KEY_DERIVE_DH,
   TlsPreMasterKeyGen = CKM_TLS_PRE_MASTER_KEY_GEN,
   TlsMasterKeyDerive = CKM_TLS_MASTER_KEY_DERIVE,
   TlsKeyAndMacDerive = CKM_TLS_KEY_AND_MAC_DERIVE,
   TlsMasterKeyDeriveDh = CKM_TLS_MASTER_KEY_DERIVE_DH,
   TlsPrf = CKM_TLS_PRF,
   Ssl3Md5Mac = CKM_SSL3_MD5_MAC,
   Ssl3Sha1Mac = CKM_SSL3_SHA1_MAC,
   Md5KeyDerivation = CKM_MD5_KEY_DERIVATION,
   Md2KeyDerivation = CKM_MD2_KEY_DERIVATION,
   Sha1KeyDerivation = CKM_SHA1_KEY_DERIVATION,
   Sha256KeyDerivation = CKM_SHA256_KEY_DERIVATION,
   Sha384KeyDerivation = CKM_SHA384_KEY_DERIVATION,
   Sha512KeyDerivation = CKM_SHA512_KEY_DERIVATION,
   Sha224KeyDerivation = CKM_SHA224_KEY_DERIVATION,
   PbeMd2DesCbc = CKM_PBE_MD2_DES_CBC,
   PbeMd5DesCbc = CKM_PBE_MD5_DES_CBC,
   PbeMd5CastCbc = CKM_PBE_MD5_CAST_CBC,
   PbeMd5Cast3Cbc = CKM_PBE_MD5_CAST3_CBC,
   PbeMd5Cast5Cbc = CKM_PBE_MD5_CAST5_CBC,
   PbeMd5Cast128Cbc = CKM_PBE_MD5_CAST128_CBC,
   PbeSha1Cast5Cbc = CKM_PBE_SHA1_CAST5_CBC,
   PbeSha1Cast128Cbc = CKM_PBE_SHA1_CAST128_CBC,
   PbeSha1Rc4128 = CKM_PBE_SHA1_RC4_128,
   PbeSha1Rc440 = CKM_PBE_SHA1_RC4_40,
   PbeSha1Des3EdeCbc = CKM_PBE_SHA1_DES3_EDE_CBC,
   PbeSha1Des2EdeCbc = CKM_PBE_SHA1_DES2_EDE_CBC,
   PbeSha1Rc2128Cbc = CKM_PBE_SHA1_RC2_128_CBC,
   PbeSha1Rc240Cbc = CKM_PBE_SHA1_RC2_40_CBC,
   Pkcs5Pbkd2 = CKM_PKCS5_PBKD2,
   PbaSha1WithSha1Hmac = CKM_PBA_SHA1_WITH_SHA1_HMAC,
   WtlsPreMasterKeyGen = CKM_WTLS_PRE_MASTER_KEY_GEN,
   WtlsMasterKeyDerive = CKM_WTLS_MASTER_KEY_DERIVE,
   WtlsMasterKeyDeriveDhEcc = CKM_WTLS_MASTER_KEY_DERIVE_DH_ECC,
   WtlsPrf = CKM_WTLS_PRF,
   WtlsServerKeyAndMacDerive = CKM_WTLS_SERVER_KEY_AND_MAC_DERIVE,
   WtlsClientKeyAndMacDerive = CKM_WTLS_CLIENT_KEY_AND_MAC_DERIVE,
   Tls10MacServer = CKM_TLS10_MAC_SERVER,
   Tls10MacClient = CKM_TLS10_MAC_CLIENT,
   Tls12Mac = CKM_TLS12_MAC,
   Tls12Kdf = CKM_TLS12_KDF,
   Tls12MasterKeyDerive = CKM_TLS12_MASTER_KEY_DERIVE,
   Tls12KeyAndMacDerive = CKM_TLS12_KEY_AND_MAC_DERIVE,
   Tls12MasterKeyDeriveDh = CKM_TLS12_MASTER_KEY_DERIVE_DH,
   Tls12KeySafeDerive = CKM_TLS12_KEY_SAFE_DERIVE,
   TlsMac = CKM_TLS_MAC,
   TlsKdf = CKM_TLS_KDF,
   KeyWrapLynks = CKM_KEY_WRAP_LYNKS,
   KeyWrapSetOaep = CKM_KEY_WRAP_SET_OAEP,
   CmsSig = CKM_CMS_SIG,
   KipDerive = CKM_KIP_DERIVE,
   KipWrap = CKM_KIP_WRAP,
   KipMac = CKM_KIP_MAC,
   CamelliaKeyGen = CKM_CAMELLIA_KEY_GEN,
   CamelliaEcb = CKM_CAMELLIA_ECB,
   CamelliaCbc = CKM_CAMELLIA_CBC,
   CamelliaMac = CKM_CAMELLIA_MAC,
   CamelliaMacGeneral = CKM_CAMELLIA_MAC_GENERAL,
   CamelliaCbcPad = CKM_CAMELLIA_CBC_PAD,
   CamelliaEcbEncryptData = CKM_CAMELLIA_ECB_ENCRYPT_DATA,
   CamelliaCbcEncryptData = CKM_CAMELLIA_CBC_ENCRYPT_DATA,
   CamelliaCtr = CKM_CAMELLIA_CTR,
   AriaKeyGen = CKM_ARIA_KEY_GEN,
   AriaEcb = CKM_ARIA_ECB,
   AriaCbc = CKM_ARIA_CBC,
   AriaMac = CKM_ARIA_MAC,
   AriaMacGeneral = CKM_ARIA_MAC_GENERAL,
   AriaCbcPad = CKM_ARIA_CBC_PAD,
   AriaEcbEncryptData = CKM_ARIA_ECB_ENCRYPT_DATA,
   AriaCbcEncryptData = CKM_ARIA_CBC_ENCRYPT_DATA,
   SeedKeyGen = CKM_SEED_KEY_GEN,
   SeedEcb = CKM_SEED_ECB,
   SeedCbc = CKM_SEED_CBC,
   SeedMac = CKM_SEED_MAC,
   SeedMacGeneral = CKM_SEED_MAC_GENERAL,
   SeedCbcPad = CKM_SEED_CBC_PAD,
   SeedEcbEncryptData = CKM_SEED_ECB_ENCRYPT_DATA,
   SeedCbcEncryptData = CKM_SEED_CBC_ENCRYPT_DATA,
   SkipjackKeyGen = CKM_SKIPJACK_KEY_GEN,
   SkipjackEcb64 = CKM_SKIPJACK_ECB64,
   SkipjackCbc64 = CKM_SKIPJACK_CBC64,
   SkipjackOfb64 = CKM_SKIPJACK_OFB64,
   SkipjackCfb64 = CKM_SKIPJACK_CFB64,
   SkipjackCfb32 = CKM_SKIPJACK_CFB32,
   SkipjackCfb16 = CKM_SKIPJACK_CFB16,
   SkipjackCfb8 = CKM_SKIPJACK_CFB8,
   SkipjackWrap = CKM_SKIPJACK_WRAP,
   SkipjackPrivateWrap = CKM_SKIPJACK_PRIVATE_WRAP,
   SkipjackRelayx = CKM_SKIPJACK_RELAYX,
   KeaKeyPairGen = CKM_KEA_KEY_PAIR_GEN,
   KeaKeyDerive = CKM_KEA_KEY_DERIVE,
   KeaDerive = CKM_KEA_DERIVE,
   FortezzaTimestamp = CKM_FORTEZZA_TIMESTAMP,
   BatonKeyGen = CKM_BATON_KEY_GEN,
   BatonEcb128 = CKM_BATON_ECB128,
   BatonEcb96 = CKM_BATON_ECB96,
   BatonCbc128 = CKM_BATON_CBC128,
   BatonCounter = CKM_BATON_COUNTER,
   BatonShuffle = CKM_BATON_SHUFFLE,
   BatonWrap = CKM_BATON_WRAP,
   EcdsaKeyPairGen = CKM_ECDSA_KEY_PAIR_GEN,
   EcKeyPairGen = CKM_EC_KEY_PAIR_GEN,
   Ecdsa = CKM_ECDSA,
   EcdsaSha1 = CKM_ECDSA_SHA1,
   EcdsaSha224 = CKM_ECDSA_SHA224,
   EcdsaSha256 = CKM_ECDSA_SHA256,
   EcdsaSha384 = CKM_ECDSA_SHA384,
   EcdsaSha512 = CKM_ECDSA_SHA512,
   Ecdh1Derive = CKM_ECDH1_DERIVE,
   Ecdh1CofactorDerive = CKM_ECDH1_COFACTOR_DERIVE,
   EcmqvDerive = CKM_ECMQV_DERIVE,
   EcdhAesKeyWrap = CKM_ECDH_AES_KEY_WRAP,
   RsaAesKeyWrap = CKM_RSA_AES_KEY_WRAP,
   JuniperKeyGen = CKM_JUNIPER_KEY_GEN,
   JuniperEcb128 = CKM_JUNIPER_ECB128,
   JuniperCbc128 = CKM_JUNIPER_CBC128,
   JuniperCounter = CKM_JUNIPER_COUNTER,
   JuniperShuffle = CKM_JUNIPER_SHUFFLE,
   JuniperWrap = CKM_JUNIPER_WRAP,
   Fasthash = CKM_FASTHASH,
   AesKeyGen = CKM_AES_KEY_GEN,
   AesEcb = CKM_AES_ECB,
   AesCbc = CKM_AES_CBC,
   AesMac = CKM_AES_MAC,
   AesMacGeneral = CKM_AES_MAC_GENERAL,
   AesCbcPad = CKM_AES_CBC_PAD,
   AesCtr = CKM_AES_CTR,
   AesGcm = CKM_AES_GCM,
   AesCcm = CKM_AES_CCM,
   AesCts = CKM_AES_CTS,
   AesCmac = CKM_AES_CMAC,
   AesCmacGeneral = CKM_AES_CMAC_GENERAL,
   AesXcbcMac = CKM_AES_XCBC_MAC,
   AesXcbcMac96 = CKM_AES_XCBC_MAC_96,
   AesGmac = CKM_AES_GMAC,
   BlowfishKeyGen = CKM_BLOWFISH_KEY_GEN,
   BlowfishCbc = CKM_BLOWFISH_CBC,
   TwofishKeyGen = CKM_TWOFISH_KEY_GEN,
   TwofishCbc = CKM_TWOFISH_CBC,
   BlowfishCbcPad = CKM_BLOWFISH_CBC_PAD,
   TwofishCbcPad = CKM_TWOFISH_CBC_PAD,
   DesEcbEncryptData = CKM_DES_ECB_ENCRYPT_DATA,
   DesCbcEncryptData = CKM_DES_CBC_ENCRYPT_DATA,
   Des3EcbEncryptData = CKM_DES3_ECB_ENCRYPT_DATA,
   Des3CbcEncryptData = CKM_DES3_CBC_ENCRYPT_DATA,
   AesEcbEncryptData = CKM_AES_ECB_ENCRYPT_DATA,
   AesCbcEncryptData = CKM_AES_CBC_ENCRYPT_DATA,
   Gostr3410KeyPairGen = CKM_GOSTR3410_KEY_PAIR_GEN,
   Gostr3410 = CKM_GOSTR3410,
   Gostr3410WithGostr3411 = CKM_GOSTR3410_WITH_GOSTR3411,
   Gostr3410KeyWrap = CKM_GOSTR3410_KEY_WRAP,
   Gostr3410Derive = CKM_GOSTR3410_DERIVE,
   Gostr3411 = CKM_GOSTR3411,
   Gostr3411Hmac = CKM_GOSTR3411_HMAC,
   Gost28147KeyGen = CKM_GOST28147_KEY_GEN,
   Gost28147Ecb = CKM_GOST28147_ECB,
   Gost28147 = CKM_GOST28147,
   Gost28147Mac = CKM_GOST28147_MAC,
   Gost28147KeyWrap = CKM_GOST28147_KEY_WRAP,
   DsaParameterGen = CKM_DSA_PARAMETER_GEN,
   DhPkcsParameterGen = CKM_DH_PKCS_PARAMETER_GEN,
   X942DhParameterGen = CKM_X9_42_DH_PARAMETER_GEN,
   DsaProbablisticParameterGen = CKM_DSA_PROBABLISTIC_PARAMETER_GEN,
   DsaShaweTaylorParameterGen = CKM_DSA_SHAWE_TAYLOR_PARAMETER_GEN,
   AesOfb = CKM_AES_OFB,
   AesCfb64 = CKM_AES_CFB64,
   AesCfb8 = CKM_AES_CFB8,
   AesCfb128 = CKM_AES_CFB128,
   AesCfb1 = CKM_AES_CFB1,
   AesKeyWrap = CKM_AES_KEY_WRAP,
   AesKeyWrapPad = CKM_AES_KEY_WRAP_PAD,
   RsaPkcsTpm11 = CKM_RSA_PKCS_TPM_1_1,
   RsaPkcsOaepTpm11 = CKM_RSA_PKCS_OAEP_TPM_1_1,
   VendorDefined = CKM_VENDOR_DEFINED,
};

MGF

enum class Botan::PKCS11::MGF : CK_RSA_PKCS_MGF_TYPE

strong

Enumerator
MgfUnused
Mgf1Sha1
Mgf1Sha256
Mgf1Sha384
Mgf1Sha512
Mgf1Sha224

Definition at line 263 of file p11.h.

               : CK_RSA_PKCS_MGF_TYPE {
   MgfUnused = 0,
   Mgf1Sha1 = CKG_MGF1_SHA1,
   Mgf1Sha256 = CKG_MGF1_SHA256,
   Mgf1Sha384 = CKG_MGF1_SHA384,
   Mgf1Sha512 = CKG_MGF1_SHA512,
   Mgf1Sha224 = CKG_MGF1_SHA224,
};

Notification

enum class Botan::PKCS11::Notification : CK_NOTIFICATION

strong

Enumerator
Surrender
OtpChanged

Definition at line 662 of file p11.h.

                        : CK_NOTIFICATION {
   Surrender = CKN_SURRENDER,
   OtpChanged = CKN_OTP_CHANGED,
};

ObjectClass

enum class Botan::PKCS11::ObjectClass : CK_OBJECT_CLASS

strong

Enumerator
Data
Certificate
PublicKey
PrivateKey
SecretKey
HwFeature
DomainParameters
Mechanism
OtpKey
VendorDefined

Definition at line 667 of file p11.h.

                       : CK_OBJECT_CLASS {
   Data = CKO_DATA,
   Certificate = CKO_CERTIFICATE,
   PublicKey = CKO_PUBLIC_KEY,
   PrivateKey = CKO_PRIVATE_KEY,
   SecretKey = CKO_SECRET_KEY,
   HwFeature = CKO_HW_FEATURE,
   DomainParameters = CKO_DOMAIN_PARAMETERS,
   Mechanism = CKO_MECHANISM,
   OtpKey = CKO_OTP_KEY,
   VendorDefined = CKO_VENDOR_DEFINED,
};

PseudoRandom

enum class Botan::PKCS11::PseudoRandom : CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE

strong

Enumerator
Pkcs5Pbkd2HmacSha1
Pkcs5Pbkd2HmacGostr3411
Pkcs5Pbkd2HmacSha224
Pkcs5Pbkd2HmacSha256
Pkcs5Pbkd2HmacSha384
Pkcs5Pbkd2HmacSha512
Pkcs5Pbkd2HmacSha512224
Pkcs5Pbkd2HmacSha512256

Definition at line 680 of file p11.h.

                        : CK_PKCS5_PBKD2_PSEUDO_RANDOM_FUNCTION_TYPE {
   Pkcs5Pbkd2HmacSha1 = CKP_PKCS5_PBKD2_HMAC_SHA1,
   Pkcs5Pbkd2HmacGostr3411 = CKP_PKCS5_PBKD2_HMAC_GOSTR3411,
   Pkcs5Pbkd2HmacSha224 = CKP_PKCS5_PBKD2_HMAC_SHA224,
   Pkcs5Pbkd2HmacSha256 = CKP_PKCS5_PBKD2_HMAC_SHA256,
   Pkcs5Pbkd2HmacSha384 = CKP_PKCS5_PBKD2_HMAC_SHA384,
   Pkcs5Pbkd2HmacSha512 = CKP_PKCS5_PBKD2_HMAC_SHA512,
   Pkcs5Pbkd2HmacSha512224 = CKP_PKCS5_PBKD2_HMAC_SHA512_224,
   Pkcs5Pbkd2HmacSha512256 = CKP_PKCS5_PBKD2_HMAC_SHA512_256,
};

PublicPointEncoding

enum class Botan::PKCS11::PublicPointEncoding : uint32_t

strong

Enumerator
Raw
Der

Definition at line 803 of file p11.h.

: uint32_t { Raw, Der };

ReturnValue

enum class Botan::PKCS11::ReturnValue : CK_RV

strong

Enumerator
OK
Cancel
HostMemory
SlotIdInvalid
GeneralError
FunctionFailed
ArgumentsBad
NoEvent
NeedToCreateThreads
CantLock
AttributeReadOnly
AttributeSensitive
AttributeTypeInvalid
AttributeValueInvalid
ActionProhibited
DataInvalid
DataLenRange
DeviceError
DeviceMemory
DeviceRemoved
EncryptedDataInvalid
EncryptedDataLenRange
FunctionCanceled
FunctionNotParallel
FunctionNotSupported
KeyHandleInvalid
KeySizeRange
KeyTypeInconsistent
KeyNotNeeded
KeyChanged
KeyNeeded
KeyIndigestible
KeyFunctionNotPermitted
KeyNotWrappable
KeyUnextractable
MechanismInvalid
MechanismParamInvalid
ObjectHandleInvalid
OperationActive
OperationNotInitialized
PinIncorrect
PinInvalid
PinLenRange
PinExpired
PinLocked
SessionClosed
SessionCount
SessionHandleInvalid
SessionParallelNotSupported
SessionReadOnly
SessionExists
SessionReadOnlyExists
SessionReadWriteSoExists
SignatureInvalid
SignatureLenRange
TemplateIncomplete
TemplateInconsistent
TokenNotPresent
TokenNotRecognized
TokenWriteProtected
UnwrappingKeyHandleInvalid
UnwrappingKeySizeRange
UnwrappingKeyTypeInconsistent
UserAlreadyLoggedIn
UserNotLoggedIn
UserPinNotInitialized
UserTypeInvalid
UserAnotherAlreadyLoggedIn
UserTooManyTypes
WrappedKeyInvalid
WrappedKeyLenRange
WrappingKeyHandleInvalid
WrappingKeySizeRange
WrappingKeyTypeInconsistent
RandomSeedNotSupported
RandomNoRng
DomainParamsInvalid
CurveNotSupported
BufferTooSmall
SavedStateInvalid
InformationSensitive
StateUnsaveable
CryptokiNotInitialized
CryptokiAlreadyInitialized
MutexBad
MutexNotLocked
NewPinMode
NextOtp
ExceededMaxIterations
FipsSelfTestFailed
LibraryLoadFailed
PinTooWeak
PublicKeyInvalid
FunctionRejected
VendorDefined

Definition at line 699 of file p11.h.

                       : CK_RV {
   OK = CKR_OK,
   Cancel = CKR_CANCEL,
   HostMemory = CKR_HOST_MEMORY,
   SlotIdInvalid = CKR_SLOT_ID_INVALID,
   GeneralError = CKR_GENERAL_ERROR,
   FunctionFailed = CKR_FUNCTION_FAILED,
   ArgumentsBad = CKR_ARGUMENTS_BAD,
   NoEvent = CKR_NO_EVENT,
   NeedToCreateThreads = CKR_NEED_TO_CREATE_THREADS,
   CantLock = CKR_CANT_LOCK,
   AttributeReadOnly = CKR_ATTRIBUTE_READ_ONLY,
   AttributeSensitive = CKR_ATTRIBUTE_SENSITIVE,
   AttributeTypeInvalid = CKR_ATTRIBUTE_TYPE_INVALID,
   AttributeValueInvalid = CKR_ATTRIBUTE_VALUE_INVALID,
   ActionProhibited = CKR_ACTION_PROHIBITED,
   DataInvalid = CKR_DATA_INVALID,
   DataLenRange = CKR_DATA_LEN_RANGE,
   DeviceError = CKR_DEVICE_ERROR,
   DeviceMemory = CKR_DEVICE_MEMORY,
   DeviceRemoved = CKR_DEVICE_REMOVED,
   EncryptedDataInvalid = CKR_ENCRYPTED_DATA_INVALID,
   EncryptedDataLenRange = CKR_ENCRYPTED_DATA_LEN_RANGE,
   FunctionCanceled = CKR_FUNCTION_CANCELED,
   FunctionNotParallel = CKR_FUNCTION_NOT_PARALLEL,
   FunctionNotSupported = CKR_FUNCTION_NOT_SUPPORTED,
   KeyHandleInvalid = CKR_KEY_HANDLE_INVALID,
   KeySizeRange = CKR_KEY_SIZE_RANGE,
   KeyTypeInconsistent = CKR_KEY_TYPE_INCONSISTENT,
   KeyNotNeeded = CKR_KEY_NOT_NEEDED,
   KeyChanged = CKR_KEY_CHANGED,
   KeyNeeded = CKR_KEY_NEEDED,
   KeyIndigestible = CKR_KEY_INDIGESTIBLE,
   KeyFunctionNotPermitted = CKR_KEY_FUNCTION_NOT_PERMITTED,
   KeyNotWrappable = CKR_KEY_NOT_WRAPPABLE,
   KeyUnextractable = CKR_KEY_UNEXTRACTABLE,
   MechanismInvalid = CKR_MECHANISM_INVALID,
   MechanismParamInvalid = CKR_MECHANISM_PARAM_INVALID,
   ObjectHandleInvalid = CKR_OBJECT_HANDLE_INVALID,
   OperationActive = CKR_OPERATION_ACTIVE,
   OperationNotInitialized = CKR_OPERATION_NOT_INITIALIZED,
   PinIncorrect = CKR_PIN_INCORRECT,
   PinInvalid = CKR_PIN_INVALID,
   PinLenRange = CKR_PIN_LEN_RANGE,
   PinExpired = CKR_PIN_EXPIRED,
   PinLocked = CKR_PIN_LOCKED,
   SessionClosed = CKR_SESSION_CLOSED,
   SessionCount = CKR_SESSION_COUNT,
   SessionHandleInvalid = CKR_SESSION_HANDLE_INVALID,
   SessionParallelNotSupported = CKR_SESSION_PARALLEL_NOT_SUPPORTED,
   SessionReadOnly = CKR_SESSION_READ_ONLY,
   SessionExists = CKR_SESSION_EXISTS,
   SessionReadOnlyExists = CKR_SESSION_READ_ONLY_EXISTS,
   SessionReadWriteSoExists = CKR_SESSION_READ_WRITE_SO_EXISTS,
   SignatureInvalid = CKR_SIGNATURE_INVALID,
   SignatureLenRange = CKR_SIGNATURE_LEN_RANGE,
   TemplateIncomplete = CKR_TEMPLATE_INCOMPLETE,
   TemplateInconsistent = CKR_TEMPLATE_INCONSISTENT,
   TokenNotPresent = CKR_TOKEN_NOT_PRESENT,
   TokenNotRecognized = CKR_TOKEN_NOT_RECOGNIZED,
   TokenWriteProtected = CKR_TOKEN_WRITE_PROTECTED,
   UnwrappingKeyHandleInvalid = CKR_UNWRAPPING_KEY_HANDLE_INVALID,
   UnwrappingKeySizeRange = CKR_UNWRAPPING_KEY_SIZE_RANGE,
   UnwrappingKeyTypeInconsistent = CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT,
   UserAlreadyLoggedIn = CKR_USER_ALREADY_LOGGED_IN,
   UserNotLoggedIn = CKR_USER_NOT_LOGGED_IN,
   UserPinNotInitialized = CKR_USER_PIN_NOT_INITIALIZED,
   UserTypeInvalid = CKR_USER_TYPE_INVALID,
   UserAnotherAlreadyLoggedIn = CKR_USER_ANOTHER_ALREADY_LOGGED_IN,
   UserTooManyTypes = CKR_USER_TOO_MANY_TYPES,
   WrappedKeyInvalid = CKR_WRAPPED_KEY_INVALID,
   WrappedKeyLenRange = CKR_WRAPPED_KEY_LEN_RANGE,
   WrappingKeyHandleInvalid = CKR_WRAPPING_KEY_HANDLE_INVALID,
   WrappingKeySizeRange = CKR_WRAPPING_KEY_SIZE_RANGE,
   WrappingKeyTypeInconsistent = CKR_WRAPPING_KEY_TYPE_INCONSISTENT,
   RandomSeedNotSupported = CKR_RANDOM_SEED_NOT_SUPPORTED,
   RandomNoRng = CKR_RANDOM_NO_RNG,
   DomainParamsInvalid = CKR_DOMAIN_PARAMS_INVALID,
   CurveNotSupported = CKR_CURVE_NOT_SUPPORTED,
   BufferTooSmall = CKR_BUFFER_TOO_SMALL,
   SavedStateInvalid = CKR_SAVED_STATE_INVALID,
   InformationSensitive = CKR_INFORMATION_SENSITIVE,
   StateUnsaveable = CKR_STATE_UNSAVEABLE,
   CryptokiNotInitialized = CKR_CRYPTOKI_NOT_INITIALIZED,
   CryptokiAlreadyInitialized = CKR_CRYPTOKI_ALREADY_INITIALIZED,
   MutexBad = CKR_MUTEX_BAD,
   MutexNotLocked = CKR_MUTEX_NOT_LOCKED,
   NewPinMode = CKR_NEW_PIN_MODE,
   NextOtp = CKR_NEXT_OTP,
   ExceededMaxIterations = CKR_EXCEEDED_MAX_ITERATIONS,
   FipsSelfTestFailed = CKR_FIPS_SELF_TEST_FAILED,
   LibraryLoadFailed = CKR_LIBRARY_LOAD_FAILED,
   PinTooWeak = CKR_PIN_TOO_WEAK,
   PublicKeyInvalid = CKR_PUBLIC_KEY_INVALID,
   FunctionRejected = CKR_FUNCTION_REJECTED,
   VendorDefined = CKR_VENDOR_DEFINED,
};

SessionState

enum class Botan::PKCS11::SessionState : CK_STATE

strong

Enumerator
RoPublicSession
RoUserFunctions
RwPublicSession
RwUserFunctions
RwSoFunctions

Definition at line 691 of file p11.h.

                        : CK_STATE {
   RoPublicSession = CKS_RO_PUBLIC_SESSION,
   RoUserFunctions = CKS_RO_USER_FUNCTIONS,
   RwPublicSession = CKS_RW_PUBLIC_SESSION,
   RwUserFunctions = CKS_RW_USER_FUNCTIONS,
   RwSoFunctions = CKS_RW_SO_FUNCTIONS,
};

UserType

enum class Botan::PKCS11::UserType : CK_USER_TYPE

strong

Enumerator
SO
User
ContextSpecific

Definition at line 797 of file p11.h.

                    : CK_USER_TYPE {
   SO = CKU_SO,
   User = CKU_USER,
   ContextSpecific = CKU_CONTEXT_SPECIFIC,
};

Function Documentation

change_pin()

void Botan::PKCS11::change_pin	(	Slot &	slot,
		const secure_string &	old_pin,
		const secure_string &	new_pin )

Change PIN with old PIN to new PIN

Parameters

slot	The slot with the attached token
old_pin	The old user PIN
new_pin	The new user PIN

Definition at line 46 of file p11.cpp.

                                                                                        {
   Session session(slot, false);
   session.login(UserType::User, old_pin);
   session.set_pin(old_pin, new_pin);
}

References Botan::PKCS11::Session::login(), Botan::PKCS11::Session::set_pin(), and User.

change_so_pin()

void Botan::PKCS11::change_so_pin	(	Slot &	slot,
		const secure_string &	old_so_pin,
		const secure_string &	new_so_pin )

Change SO_PIN with old SO_PIN to new SO_PIN

Parameters

slot	The slot with the attached token
old_so_pin	The old SO_PIN
new_so_pin	The new SO_PIN

Definition at line 52 of file p11.cpp.

                                                                                                 {
   Session session(slot, false);
   session.login(UserType::SO, old_so_pin);
   session.set_pin(old_so_pin, new_so_pin);
}

References Botan::PKCS11::Session::login(), Botan::PKCS11::Session::set_pin(), and SO.

flags()

Flags Botan::PKCS11::flags ( Flag flags )

inline

Definition at line 838 of file p11.h.

                               {
   return static_cast<Flags>(flags);
}

References flags().

Referenced by Botan::PKCS11::LowLevel::C_OpenSession(), Botan::PKCS11::LowLevel::C_WaitForSlotEvent(), flags(), Botan::PKCS11::Session::Session(), and Botan::PKCS11::Session::Session().

initialize_token()

void Botan::PKCS11::initialize_token	(	Slot &	slot,
		std::string_view	label,
		const secure_string &	so_pin,
		const secure_string &	pin )

Initializes a token

Parameters

slot	The slot with the attached token that should be initialized
label	The token label
so_pin	PIN of the security officer. Will be set if the token is uninitialized other this has to be the current SO_PIN
pin	The user PIN that will be set

Definition at line 41 of file p11.cpp.

                                                                                                               {
   slot.initialize(label, so_pin);
   set_pin(slot, so_pin, pin);
}

References Botan::PKCS11::Slot::initialize(), and set_pin().

operator|()

Flag Botan::PKCS11::operator| ( Flag a, Flag b )

inline

Definition at line 258 of file p11.h.

                                      {
   // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
   return static_cast<Flag>(static_cast<CK_FLAGS>(a) | static_cast<CK_FLAGS>(b));
}

set_pin()

void Botan::PKCS11::set_pin	(	Slot &	slot,
		const secure_string &	so_pin,
		const secure_string &	pin )

Sets user PIN with SO_PIN

Parameters

slot	The slot with the attached token
so_pin	PIN of the security officer
pin	The user PIN that should be set

Definition at line 58 of file p11.cpp.

                                                                                {
   Session session(slot, false);
   session.login(UserType::SO, so_pin);
   session.init_pin(pin);
}

References Botan::PKCS11::Session::init_pin(), Botan::PKCS11::Session::login(), and SO.

Referenced by initialize_token().

Variable Documentation

False

const Bbool Botan::PKCS11::False = 0

Definition at line 836 of file p11.h.

Referenced by Botan::PKCS11::AttributeContainer::add_bool().

ThrowException

ReturnValue * Botan::PKCS11::ThrowException = reinterpret_cast<ReturnValue*>(-1)

Definition at line 21 of file p11.cpp.

Referenced by Botan::PKCS11::LowLevel::C_Decrypt(), Botan::PKCS11::LowLevel::C_Encrypt(), Botan::PKCS11::LowLevel::C_GetAttributeValue(), Botan::PKCS11::LowLevel::C_InitPIN(), Botan::PKCS11::LowLevel::C_InitToken(), Botan::PKCS11::LowLevel::C_Login(), Botan::PKCS11::LowLevel::C_SetAttributeValue(), Botan::PKCS11::LowLevel::C_SetPIN(), Botan::PKCS11::LowLevel::C_Sign(), Botan::PKCS11::LowLevel::C_SignFinal(), Botan::PKCS11::LowLevel::C_SignUpdate(), Botan::PKCS11::LowLevel::C_Verify(), Botan::PKCS11::LowLevel::C_VerifyUpdate(), and Botan::PKCS11::LowLevel::handle_return_value().

True

const Bbool Botan::PKCS11::True = 1

Definition at line 835 of file p11.h.

Referenced by Botan::PKCS11::AttributeContainer::add_bool().