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. More...
Module &	module () const
	ObjectFinder (Session &session, const std::vector< Attribute > &search_template)
	ObjectFinder (const ObjectFinder &other)=default
	ObjectFinder (ObjectFinder &&other)=default
ObjectFinder &	operator= (const ObjectFinder &other)=delete
ObjectFinder &	operator= (ObjectFinder &&other)=delete
	~ObjectFinder () noexcept
	Terminates a search for token and session objects (calls C_FindObjectsFinal) More...

Detailed Description

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

Definition at line 127 of file p11_object.h.

Constructor & Destructor Documentation

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 87 of file p11_object.cpp.

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

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

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

default

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

default

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

noexcept

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

Definition at line 95 of file p11_object.cpp.

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

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

Member Function Documentation

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 110 of file p11_object.cpp.

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

Referenced by Botan::PKCS11::Object::search().

   {
   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;
   }

void Botan::PKCS11::ObjectFinder::finish

(

)

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

Definition at line 122 of file p11_object.cpp.

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

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

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

inline

Returns

the module this ObjectFinder belongs to

Definition at line 157 of file p11_object.h.

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

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

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

delete

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

delete

---

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