WinStd
Windows Win32 API using Standard C++
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
winstd::crypt_key Class Reference

HCRYPTKEY wrapper class. More...

#include <WinStd/Crypt.h>

Inheritance diagram for winstd::crypt_key:
winstd::dplhandle< HCRYPTKEY, NULL > winstd::handle< T, INVAL >

Public Member Functions

virtual ~crypt_key ()
 Destroys the key.
 
bool create_exp1 (HCRYPTPROV hProv, DWORD dwKeySpec)
 Creates Exponent-of-one key.
 
- Public Member Functions inherited from winstd::dplhandle< HCRYPTKEY, NULL >
 dplhandle () noexcept
 Initializes a new class instance with the object handle set to INVAL.
 
 dplhandle (handle_type h) noexcept
 Initializes a new class instance with an already available object handle.
 
 dplhandle (const dplhandle< handle_type, INVAL > &h)
 Copy constructor.
 
 dplhandle (dplhandle< handle_type, INVAL > &&h) noexcept
 Move constructor.
 
dplhandle< handle_type, INVAL > & operator= (handle_type h) noexcept
 Attaches already available object handle.
 
dplhandle< handle_type, INVAL > & operator= (const dplhandle< handle_type, INVAL > &h) noexcept
 Duplicates the object.
 
dplhandle< handle_type, INVAL > & operator= (dplhandle< handle_type, INVAL > &&h) noexcept
 Moves the object.
 
handle_type duplicate () const
 Duplicates and returns a new object handle.
 
void attach_duplicated (handle_type h)
 Duplicates an object handle and sets a new object handle.
 
- Public Member Functions inherited from winstd::handle< T, INVAL >
 handle () noexcept
 Initializes a new class instance with the object handle set to INVAL.
 
 handle (handle_type h) noexcept
 Initializes a new class instance with an already available object handle.
 
 handle (handle< handle_type, INVAL > &&h) noexcept
 Move constructor.
 
handle< handle_type, INVAL > & operator= (handle_type h) noexcept
 Attaches already available object handle.
 
handle< handle_type, INVAL > & operator= (handle< handle_type, INVAL > &&h) noexcept
 Move assignment.
 
 operator handle_type () const
 Auto-typecasting operator.
 
handle_type *& operator* () const
 Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.).
 
handle_typeoperator& ()
 Returns the object handle reference.
 
handle_type operator-> () const
 Provides object handle member access when the object handle is a pointer to a class or struct.
 
bool operator! () const
 Tests if the object handle is invalid.
 
bool operator< (handle_type h) const
 Is handle less than?
 
bool operator<= (handle_type h) const
 Is handle less than or equal to?
 
bool operator>= (handle_type h) const
 Is handle greater than or equal to?
 
bool operator> (handle_type h) const
 Is handle greater than?
 
bool operator!= (handle_type h) const
 Is handle not equal to?
 
bool operator== (handle_type h) const
 Is handle equal to?
 
void attach (handle_type h) noexcept
 Sets a new object handle for the class.
 
handle_type detach ()
 Dismisses the object handle from this class.
 
void free ()
 Destroys the object.
 

Protected Member Functions

void free_internal () noexcept override
 Destroys the key.
 
handle_type duplicate_internal (handle_type h) const override
 Duplicates the key.
 
virtual handle_type duplicate_internal (handle_type h) const=0
 Abstract member function that must be implemented by child classes to do the actual object handle duplication. On failure, it should throw appropriate exception describing the cause, rather than return an invalid handle.
 
virtual void free_internal () noexcept=0
 Abstract member function that must be implemented by child classes to do the actual object destruction.
 

Additional Inherited Members

- Public Types inherited from winstd::handle< T, INVAL >
typedef T handle_type
 Datatype of the object handle this template class handles.
 
- Static Public Attributes inherited from winstd::handle< T, INVAL >
static const T invalid = INVAL
 Invalid handle value.
 
- Protected Attributes inherited from winstd::handle< T, INVAL >
handle_type m_h
 Object handle.
 

Detailed Description

HCRYPTKEY wrapper class.

See also
CryptGenKey function
CryptImportKey function
CryptImportPublicKeyInfo function
CryptDeriveKey function

Constructor & Destructor Documentation

◆ ~crypt_key()

virtual winstd::crypt_key::~crypt_key ( )
inlinevirtual

Destroys the key.

See also
CryptDestroyKey function

Member Function Documentation

◆ create_exp1()

bool winstd::crypt_key::create_exp1 ( HCRYPTPROV  hProv,
DWORD  dwKeySpec 
)
inline

Creates Exponent-of-one key.

See also
How to export and import plain text session keys by using CryptoAPI
Parameters
[in]hProvHandle of cryptographics provider to use
[in]dwKeySpecKey specification (AT_KEYEXCHANGE or AT_SIGNATURE)

◆ duplicate_internal()

handle_type winstd::crypt_key::duplicate_internal ( handle_type  h) const
inlineoverrideprotectedvirtual

Duplicates the key.

Parameters
[in]hObject handle of existing key
Returns
Duplicated key handle
See also
CryptDuplicateKey function

Implements winstd::dplhandle< HCRYPTKEY, NULL >.

◆ free_internal()

void winstd::crypt_key::free_internal ( )
inlineoverrideprotectedvirtualnoexcept

Destroys the key.

See also
CryptDestroyKey function

Implements winstd::handle< T, INVAL >.


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