Botan::PKCS11::ObjectFinder Class Reference

Manages calls to C_FindObjects* functions (C_FindObjectsInit -> C_FindObjects -> C_FindObjectsFinal). More...

#include <p11_object.h>

Public Member Functions
std::vector< ObjectHandle >	find (std::uint32_t max_count=100) const
void	finish ()
	Finishes the search operation manually to allow a new ObjectFinder to exist.
Module &	module () const
	ObjectFinder (const ObjectFinder &other)=delete
	ObjectFinder (ObjectFinder &&other) noexcept
	ObjectFinder (Session &session, const std::vector< Attribute > &search_template)
ObjectFinder &	operator= (const ObjectFinder &other)=delete
ObjectFinder &	operator= (ObjectFinder &&other)=delete
	~ObjectFinder () noexcept
	Terminates a search for token and session objects (calls C_FindObjectsFinal).

Detailed Description

Manages calls to C_FindObjects* functions (C_FindObjectsInit -> C_FindObjects -> C_FindObjectsFinal).

Definition at line 113 of file p11_object.h.

Constructor & Destructor Documentation

ObjectFinder() [1/3]

Botan::PKCS11::ObjectFinder::ObjectFinder	(	Session &	session,
		const std::vector< Attribute > &	search_template )

Initializes a search for token and session objects that match a template (calls C_FindObjectsInit)

Parameters

session	the session to use for the search
search_template	the search_template as a vector of Attribute

Definition at line 73 of file p11_object.cpp.

                                                                                        :
      m_session(session), m_search_terminated(false) {
   module()->C_FindObjectsInit(m_session.get().handle(),
                               const_cast<Attribute*>(search_template.data()),
                               checked_ulong_cast(search_template.size()));
}

References Botan::PKCS11::LowLevel::C_FindObjectsInit(), Botan::PKCS11::checked_ulong_cast(), and module().

Referenced by ObjectFinder(), ObjectFinder(), operator=(), and operator=().

ObjectFinder() [2/3]

Botan::PKCS11::ObjectFinder::ObjectFinder ( const ObjectFinder & other )

delete

References ObjectFinder().

ObjectFinder() [3/3]

Botan::PKCS11::ObjectFinder::ObjectFinder ( ObjectFinder && other )

inlinenoexcept

Definition at line 125 of file p11_object.h.

                                                  :
            m_session(other.m_session), m_search_terminated(other.m_search_terminated) {
         other.m_search_terminated = true;
      }

References ObjectFinder().

~ObjectFinder()

Botan::PKCS11::ObjectFinder::~ObjectFinder ( )

noexcept

Terminates a search for token and session objects (calls C_FindObjectsFinal).

Definition at line 80 of file p11_object.cpp.

                                     {
   try {
      if(!m_search_terminated) {
         module()->C_FindObjectsFinal(m_session.get().handle(), nullptr);
      }
   } catch(...) {
      // ignore error during noexcept function
   }
}

References Botan::PKCS11::LowLevel::C_FindObjectsFinal(), and module().

Member Function Documentation

find()

std::vector< ObjectHandle > Botan::PKCS11::ObjectFinder::find

(

std::uint32_t

max_count = 100

)

const

Starts or continues a search for token and session objects that match a template, obtaining additional object handles (calls C_FindObjects)

Parameters

max_count

maximum amount of object handles to retrieve. Default = 100

Returns

the result of the search as a vector of ObjectHandle

Definition at line 90 of file p11_object.cpp.

                                                                   {
   std::vector<ObjectHandle> result(max_count);
   Ulong objectCount = 0;
   module()->C_FindObjects(m_session.get().handle(), result.data(), max_count, &objectCount);
   if(objectCount < max_count) {
      result.resize(objectCount);
   }
   return result;
}

References Botan::PKCS11::LowLevel::C_FindObjects(), and module().

Referenced by operator=(), and Botan::PKCS11::Object::search().

finish()

void Botan::PKCS11::ObjectFinder::finish

(

)

Finishes the search operation manually to allow a new ObjectFinder to exist.

Definition at line 100 of file p11_object.cpp.

                          {
   module()->C_FindObjectsFinal(m_session.get().handle());
   m_search_terminated = true;
}

References Botan::PKCS11::LowLevel::C_FindObjectsFinal(), and module().

Referenced by operator=().

module()

Module & Botan::PKCS11::ObjectFinder::module ( ) const

inline

Returns

the module this ObjectFinder belongs to

Definition at line 146 of file p11_object.h.

{ return m_session.get().module(); }

References module().

Referenced by find(), finish(), module(), ObjectFinder(), and ~ObjectFinder().

operator=() [1/2]

ObjectFinder & Botan::PKCS11::ObjectFinder::operator= ( const ObjectFinder & other )

delete

References ObjectFinder().

operator=() [2/2]

ObjectFinder & Botan::PKCS11::ObjectFinder::operator= ( ObjectFinder && other )

delete

References find(), finish(), and ObjectFinder().

---

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

• src/lib/prov/pkcs11/p11_object.h
• src/lib/prov/pkcs11/p11_object.cpp