Welcome to PyKCS11’s documentation

Download

The PyKCS11 project is available from different sources:

• pypi https://pypi.org/project/pykcs11/

• github https://github.com/LudovicRousseau/PyKCS11

• sourceforge https://sourceforge.net/projects/pkcs11wrap/

Bug reports

Report bugs or issues on github issues

Report patches as github pull requests

API Documentation

Contents:

• API documentation
  • AES_CTR_Mechanism
    • AES_CTR_Mechanism.to_native()
  • AES_GCM_Mechanism
    • AES_GCM_Mechanism.to_native()
  • CK_INFO
    • CK_INFO.fields
  • CK_MECHANISM_INFO
    • CK_MECHANISM_INFO.fields
    • CK_MECHANISM_INFO.flags_dict
  • CK_OBJECT_HANDLE
    • CK_OBJECT_HANDLE.to_dict()
  • CK_SESSION_INFO
    • CK_SESSION_INFO.fields
    • CK_SESSION_INFO.flags_dict
    • CK_SESSION_INFO.state2text()
  • CK_SLOT_INFO
    • CK_SLOT_INFO.fields
    • CK_SLOT_INFO.flags_dict
  • CK_TOKEN_INFO
    • CK_TOKEN_INFO.fields
    • CK_TOKEN_INFO.flags_dict
  • CONCATENATE_BASE_AND_DATA_Mechanism
  • CONCATENATE_BASE_AND_KEY_Mechanism
    • CONCATENATE_BASE_AND_KEY_Mechanism.to_native()
  • CONCATENATE_DATA_AND_BASE_Mechanism
  • CkClass
    • CkClass.fields
    • CkClass.flags
    • CkClass.flags2text()
    • CkClass.flags_dict
    • CkClass.state2text()
    • CkClass.to_dict()
  • DigestSession
    • DigestSession.digestKey()
    • DigestSession.final()
    • DigestSession.update()
  • ECDH1_DERIVE_Mechanism
    • ECDH1_DERIVE_Mechanism.to_native()
  • EDDSA_Mechanism
    • EDDSA_Mechanism.to_native()
  • EXTRACT_KEY_FROM_KEY_Mechanism
    • EXTRACT_KEY_FROM_KEY_Mechanism.to_native()
  • KEY_DERIVATION_STRING_DATA_MechanismBase
    • KEY_DERIVATION_STRING_DATA_MechanismBase.to_native()
  • Mechanism
    • Mechanism.to_native()
  • PyKCS11Error
  • PyKCS11Lib
    • PyKCS11Lib.closeAllSessions()
    • PyKCS11Lib.getInfo()
    • PyKCS11Lib.getMechanismInfo()
    • PyKCS11Lib.getMechanismList()
    • PyKCS11Lib.getSlotInfo()
    • PyKCS11Lib.getSlotList()
    • PyKCS11Lib.getTokenInfo()
    • PyKCS11Lib.initToken()
    • PyKCS11Lib.load()
    • PyKCS11Lib.openSession()
    • PyKCS11Lib.unload()
    • PyKCS11Lib.waitForSlotEvent()
  • RSAOAEPMechanism
    • RSAOAEPMechanism.to_native()
  • RSA_PSS_Mechanism
    • RSA_PSS_Mechanism.to_native()
  • Session
    • Session.closeSession()
    • Session.createObject()
    • Session.decrypt()
    • Session.decryptFinal()
    • Session.decryptInit()
    • Session.decryptUpdate()
    • Session.deriveKey()
    • Session.destroyObject()
    • Session.digest()
    • Session.digestSession()
    • Session.encrypt()
    • Session.encryptFinal()
    • Session.encryptInit()
    • Session.encryptUpdate()
    • Session.findObjects()
    • Session.generateKey()
    • Session.generateKeyPair()
    • Session.generateRandom()
    • Session.getAttributeValue()
    • Session.getAttributeValue_fragmented()
    • Session.getSessionInfo()
    • Session.initPin()
    • Session.isAttributeList()
    • Session.isBin()
    • Session.isBool()
    • Session.isNum()
    • Session.isString()
    • Session.lib
    • Session.login()
    • Session.logout()
    • Session.seedRandom()
    • Session.setAttributeValue()
    • Session.setPin()
    • Session.sign()
    • Session.unwrapKey()
    • Session.verify()
    • Session.wrapKey()
  • XOR_BASE_AND_DATA_Mechanism
  • ckbytelist
• PyKCS11 samples codes
  • Unblock a user PIN
  • Generate a key pair
  • Encrypt and decrypt
  • Get token events
  • Get a public key modulus
  • RSA sign & verify
  • Get token information
  • Dump all the token objects
• License

Indices and tables

• Index

• Search Page