Merge pull request #92 from grant100/wait_for_slot_event_f

pkcs11/_pkcs11.pyx: add wait_for_slot_event

Author: danni

docs/api.rst

@@ -59,6 +59,17 @@ Classes
 
             :rtype: Token
 
+        .. method:: wait_for_slot_event(blocking=True)
+
+            Waits for a slot event such as a token insertion or removal to occur.
+
+            Returns the Slot on which the event was detected. If not blocking and no slot events were detected
+            :class:`pkcs11.exceptions.NoEvent` is raised.
+
+            :param blocking: If true, the thread will block.
+
+            :rtype: Slot
+
         .. method:: reinitialize()
 
             Reinitializes the loaded PKCS#11 library.

pkcs11/_errors.pyx

@@ -38,6 +38,7 @@ cdef ERROR_MAP = {
     CKR_HOST_MEMORY: HostMemory,
     CKR_MECHANISM_INVALID: MechanismInvalid,
     CKR_MECHANISM_PARAM_INVALID: MechanismParamInvalid,
+    CKR_NO_EVENT: NoEvent,
     CKR_OBJECT_HANDLE_INVALID: ObjectHandleInvalid,
     CKR_OPERATION_ACTIVE: OperationActive,
     CKR_OPERATION_NOT_INITIALIZED: OperationNotInitialized,

pkcs11/_pkcs11.pyx

@@ -1550,6 +1550,27 @@ cdef class lib:
         except StopIteration:
             return token
 
+    def wait_for_slot_event(self, blocking=True):
+        cdef CK_SLOT_ID slot_id
+        cdef CK_FLAGS flag = 0
+
+        if not blocking:
+            flag |= CKF_DONT_BLOCK
+
+        with nogil:
+            assertRV(_funclist.C_WaitForSlotEvent(flag, &slot_id, NULL))
+
+        cdef CK_SLOT_INFO info
+
+        with nogil:
+            assertRV(_funclist.C_GetSlotInfo(slot_id, &info))
+
+        slotDescription = info.slotDescription[:sizeof(info.slotDescription)]
+        manufacturerID = info.manufacturerID[:sizeof(info.manufacturerID)]
+
+        return Slot(self, slot_id, slotDescription, manufacturerID,
+                 info.hardwareVersion, info.firmwareVersion, info.flags)
+
     def reinitialize(self):
         if _funclist != NULL:
             with nogil:

pkcs11/_pkcs11_defn.pxd

@@ -148,6 +148,7 @@ cdef extern from '../extern/cryptoki.h':
         CK_FALSE,
 
     cdef enum:  # CK_FLAGS
+        CKF_DONT_BLOCK,
         CKF_RW_SESSION,
         CKF_SERIAL_SESSION,
 

pkcs11/exceptions.py

@@ -202,6 +202,12 @@ class MultipleTokensReturned(PKCS11Error):
     """
 
 
+class NoEvent(PKCS11Error):
+    """
+    No slot events were detected.
+    """
+
+
 class NoSuchKey(PKCS11Error):
     """
     No key matching the parameters was found.