SoftHSMv2/src/lib/slot_mgr/SlotManager.h

   1 /*
   2  * Copyright (c) 2010 SURFnet bv
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  20  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  22  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  24  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 /*****************************************************************************
  28  SlotManager.h
  29
  30  The slot manager is a class that forms part of the PKCS #11 core. It manages
  31  all the slots that SoftHSM is aware of. To make it possible to add new
  32  tokens, SoftHSM always has one slot available that contains an uninitialised
  33  token. Users can choose to initialise this token to create a new token.
  34  *****************************************************************************/
  35
  36 #ifndef _SOFTHSM_V2_SLOTMANAGER_H
  37 #define _SOFTHSM_V2_SLOTMANAGER_H
  38
  39 #include "config.h"
  40 #include "ByteString.h"
  41 #include "ObjectStore.h"
  42 #include "Slot.h"
  43 #include <string>
  44 #include <map>
  45 typedef std::map<const CK_SLOT_ID, Slot*const> SlotMap;
  46
  47 class SlotManager
  48 {
  49 public:
  50         // Constructor
  51         SlotManager(ObjectStore* objectStore);
  52
  53         // Destructor
  54         virtual ~SlotManager();
  55
  56         // Get the slots
  57         SlotMap getSlots();
  58
  59         // Get the slot list
  60         CK_RV getSlotList(ObjectStore* objectStore, CK_BBOOL tokenPresent, CK_SLOT_ID_PTR pSlotList, CK_ULONG_PTR pulCount);
  61
  62         // Get one slot
  63         Slot* getSlot(CK_SLOT_ID slotID);
  64 private:
  65         void insertToken(ObjectStore* objectStore, CK_SLOT_ID slotID, ObjectStoreToken* pToken);
  66         // The slots
  67         SlotMap slots;
  68 };
  69
  70 #endif // !_SOFTHSM_V2_SLOTMANAGER_H
  71