Virgil Security Crypto library  2.4.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
virgil::crypto::VirgilSigner Class Reference

This class provides high-level interface to sign and verify data using Virgil Security keys. More...

#include <VirgilSigner.h>

Inheritance diagram for virgil::crypto::VirgilSigner:
virgil::crypto::VirgilSignerBase

Public Member Functions

 VirgilSigner (foundation::VirgilHash::Algorithm hashAlgorithm=foundation::VirgilHash::Algorithm::SHA384)
 Create signer with predefined hash function. More...
 
VirgilByteArray sign (const VirgilByteArray &data, const VirgilByteArray &privateKey, const VirgilByteArray &privateKeyPassword=VirgilByteArray())
 Sign data with given private key. More...
 
bool verify (const VirgilByteArray &data, const VirgilByteArray &sign, const VirgilByteArray &publicKey)
 Verify sign and data to be conformed to the given public key. More...
 
- Public Member Functions inherited from virgil::crypto::VirgilSignerBase
 VirgilSignerBase (foundation::VirgilHash::Algorithm hashAlgorithm=foundation::VirgilHash::Algorithm::SHA384)
 Create signer with predefined hash function. More...
 
foundation::VirgilHash::Algorithm getHashAlgorithm () const
 Return hash algorithm that SHOULD be used to calculate digest of the data to be signed. More...
 
VirgilByteArray signHash (const VirgilByteArray &digest, const VirgilByteArray &privateKey, const VirgilByteArray &privateKeyPassword=VirgilByteArray())
 Create signature over pre-calculated hash. More...
 
bool verifyHash (const VirgilByteArray &digest, const VirgilByteArray &signature, const VirgilByteArray &publicKey)
 Verify signature over pre-calculated hash. More...
 

Additional Inherited Members

- Protected Member Functions inherited from virgil::crypto::VirgilSignerBase
VirgilByteArray packSignature (const VirgilByteArray &signature) const
 Pack given signature to the ASN.1 structure. More...
 
VirgilByteArray unpackSignature (const VirgilByteArray &packedSignature)
 Unpack signature and correspond hash algorithm from the ASN.1 structure. More...
 

Detailed Description

This class provides high-level interface to sign and verify data using Virgil Security keys.

This module can sign / verify as raw data and Virgil Security tickets.

Constructor & Destructor Documentation

virgil::crypto::VirgilSigner::VirgilSigner ( foundation::VirgilHash::Algorithm  hashAlgorithm = foundation::VirgilHash::Algorithm::SHA384)
inlineexplicit

Create signer with predefined hash function.

Note
Specified hash function algorithm is used only during signing.

Member Function Documentation

VirgilByteArray virgil::crypto::VirgilSigner::sign ( const VirgilByteArray data,
const VirgilByteArray privateKey,
const VirgilByteArray privateKeyPassword = VirgilByteArray() 
)

Sign data with given private key.

Returns
Virgil Security sign.
bool virgil::crypto::VirgilSigner::verify ( const VirgilByteArray data,
const VirgilByteArray sign,
const VirgilByteArray publicKey 
)

Verify sign and data to be conformed to the given public key.

Returns
true if sign is valid and data was not malformed.

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