Sailfish Crypto
API DocumentationSignRequest Class
(Sailfish::Crypto::SignRequest)Allows a client request the system crypto service to sign data with a specific key More...
| Header: | #include <Crypto/signrequest.h> |
| Instantiated By: | SignRequest |
| Inherits: | Sailfish::Crypto::Request |
Properties
|
|
- 4 properties inherited from Sailfish::Crypto::Request
Public Functions
| SignRequest(QObject *parent = Q_NULLPTR) | |
| ~SignRequest() | |
| QString | cryptoPluginName() const |
| QByteArray | data() const |
| Sailfish::Crypto::CryptoManager::DigestFunction | digestFunction() const |
| Sailfish::Crypto::Key | key() const |
| Sailfish::Crypto::CryptoManager::SignaturePadding | padding() const |
| void | setCryptoPluginName(const QString &pluginName) |
| void | setData(const QByteArray &data) |
| void | setDigestFunction(Sailfish::Crypto::CryptoManager::DigestFunction digestFn) |
| void | setKey(const Sailfish::Crypto::Key &key) |
| void | setPadding(Sailfish::Crypto::CryptoManager::SignaturePadding padding) |
| QByteArray | signature() const |
| int | signatureLength() const |
Reimplemented Public Functions
| virtual QVariantMap | customParameters() const |
| virtual Sailfish::Crypto::CryptoManager * | manager() const |
| virtual Sailfish::Crypto::Result | result() const |
| virtual void | setCustomParameters(const QVariantMap ¶ms) |
| virtual void | setManager(Sailfish::Crypto::CryptoManager *manager) |
| virtual void | startRequest() |
| virtual Sailfish::Crypto::Request::Status | status() const |
| virtual void | waitForFinished() |
- 8 public functions inherited from Sailfish::Crypto::Request
Signals
| void | cryptoPluginNameChanged() |
| void | dataChanged() |
| void | digestFunctionChanged() |
| void | keyChanged() |
| void | paddingChanged() |
| void | signatureChanged() |
- 4 signals inherited from Sailfish::Crypto::Request
Detailed Description
Allows a client request the system crypto service to sign data with a specific key
Property Documentation
cryptoPluginName : QString
Access functions:
| QString | cryptoPluginName() const |
| void | setCryptoPluginName(const QString &pluginName) |
Notifier signal:
| void | cryptoPluginNameChanged() |
data : QByteArray
Access functions:
Notifier signal:
| void | dataChanged() |
digestFunction : Sailfish::Crypto::CryptoManager::DigestFunction
Access functions:
| Sailfish::Crypto::CryptoManager::DigestFunction | digestFunction() const |
| void | setDigestFunction(Sailfish::Crypto::CryptoManager::DigestFunction digestFn) |
Notifier signal:
| void | digestFunctionChanged() |
key : Sailfish::Crypto::Key
Access functions:
| Sailfish::Crypto::Key | key() const |
| void | setKey(const Sailfish::Crypto::Key &key) |
Notifier signal:
| void | keyChanged() |
padding : Sailfish::Crypto::CryptoManager::SignaturePadding
Access functions:
| Sailfish::Crypto::CryptoManager::SignaturePadding | padding() const |
| void | setPadding(Sailfish::Crypto::CryptoManager::SignaturePadding padding) |
Notifier signal:
| void | paddingChanged() |
signature : const QByteArray
Access functions:
| QByteArray | signature() const |
Notifier signal:
| void | signatureChanged() |
signatureLength : const int
Access functions:
| int | signatureLength() const |
Notifier signal:
| void | signatureChanged() |
Member Function Documentation
SignRequest::SignRequest(QObject *parent = Q_NULLPTR)
Constructs a new SignRequest object with the given parent.
SignRequest::~SignRequest()
Destroys the SignRequest
QString SignRequest::cryptoPluginName() const
Returns the name of the crypto plugin which the client wishes to perform the sign operation
Note: Getter function for property cryptoPluginName.
See also setCryptoPluginName().
[virtual] QVariantMap SignRequest::customParameters() const
See also setCustomParameters().
QByteArray SignRequest::data() const
Returns the data which the client wishes the system service to sign
Note: Getter function for property data.
See also setData().
Sailfish::Crypto::CryptoManager::DigestFunction SignRequest::digestFunction() const
Returns the digest which should be used to generate the signature
Note: Getter function for property digestFunction.
See also setDigestFunction().
Sailfish::Crypto::Key SignRequest::key() const
Returns the key which the client wishes the system service to use to sign the data
Note: Getter function for property key.
See also setKey().
[virtual] Sailfish::Crypto::CryptoManager *SignRequest::manager() const
See also setManager().
Sailfish::Crypto::CryptoManager::SignaturePadding SignRequest::padding() const
Returns the signature padding mode which should be used when signing the data
Note: Getter function for property padding.
See also setPadding().
[virtual] Sailfish::Crypto::Result SignRequest::result() const
void SignRequest::setCryptoPluginName(const QString &pluginName)
Sets the name of the crypto plugin which the client wishes to perform the sign operation to pluginName
Note: Setter function for property cryptoPluginName.
See also cryptoPluginName().
[virtual] void SignRequest::setCustomParameters(const QVariantMap ¶ms)
See also customParameters().
void SignRequest::setData(const QByteArray &data)
Sets the data which the client wishes the system service to sign to data
Note: Setter function for property data.
See also data().
void SignRequest::setDigestFunction(Sailfish::Crypto::CryptoManager::DigestFunction digestFn)
Sets the digest which should be used to generate the signature to digestFn
Note: Setter function for property digestFunction.
See also digestFunction().
[virtual] void SignRequest::setManager(Sailfish::Crypto::CryptoManager *manager)
See also manager().
void SignRequest::setPadding(Sailfish::Crypto::CryptoManager::SignaturePadding padding)
Sets the signature padding mode which should be used when signing the data to padding
Note: Setter function for property padding.
See also padding().
QByteArray SignRequest::signature() const
Returns the signature result of the sign operation.
Note: this value is only valid if the status of the request is Request::Finished.
Note: Getter function for property signature.
int SignRequest::signatureLength() const
Returns the length of the signature result of the sign operation.
Note: this value is only valid if the status of the request is Request::Finished.
Note: Getter function for property signatureLength.