Sailfish Crypto
API DocumentationSeedRandomDataGeneratorRequest Class
(Sailfish::Crypto::SeedRandomDataGeneratorRequest)Allows a client request that the system crypto service seed its RNG with specific data. More...
Header: | #include <Crypto/seedrandomdatageneratorrequest.h> |
Instantiated By: | SeedRandomDataGeneratorRequest |
Inherits: | Sailfish::Crypto::Request |
Properties
- cryptoPluginName : QString
- csprngEngineName : QString
- entropyEstimate : double
- seedData : QByteArray
- 4 properties inherited from Sailfish::Crypto::Request
Public Functions
SeedRandomDataGeneratorRequest(QObject *parent = Q_NULLPTR) | |
~SeedRandomDataGeneratorRequest() | |
QString | cryptoPluginName() const |
QString | csprngEngineName() const |
double | entropyEstimate() const |
QByteArray | seedData() const |
void | setCryptoPluginName(const QString &pluginName) |
void | setCsprngEngineName(const QString &engineName) |
void | setEntropyEstimate(double estimate) |
void | setSeedData(const QByteArray &data) |
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 | csprngEngineNameChanged() |
void | entropyEstimateChanged() |
void | seedDataChanged() |
- 4 signals inherited from Sailfish::Crypto::Request
Detailed Description
Allows a client request that the system crypto service seed its RNG with specific data.
Property Documentation
cryptoPluginName : QString
Access functions:
QString | cryptoPluginName() const |
void | setCryptoPluginName(const QString &pluginName) |
Notifier signal:
void | cryptoPluginNameChanged() |
csprngEngineName : QString
Access functions:
QString | csprngEngineName() const |
void | setCsprngEngineName(const QString &engineName) |
Notifier signal:
void | csprngEngineNameChanged() |
entropyEstimate : double
Access functions:
double | entropyEstimate() const |
void | setEntropyEstimate(double estimate) |
Notifier signal:
void | entropyEstimateChanged() |
seedData : QByteArray
Access functions:
QByteArray | seedData() const |
void | setSeedData(const QByteArray &data) |
Notifier signal:
void | seedDataChanged() |
Member Function Documentation
SeedRandomDataGeneratorRequest::SeedRandomDataGeneratorRequest(QObject *parent = Q_NULLPTR)
Constructs a new SeedRandomDataGeneratorRequest object with the given parent.
SeedRandomDataGeneratorRequest::~SeedRandomDataGeneratorRequest()
Destroys the SeedRandomDataGeneratorRequest
QString SeedRandomDataGeneratorRequest::cryptoPluginName() const
Returns the name of the crypto plugin which the client wishes to perform the key generation operation
Note: Getter function for property cryptoPluginName.
See also setCryptoPluginName().
QString SeedRandomDataGeneratorRequest::csprngEngineName() const
Returns the name of the cryptographically secure random number generator engine offered by the crypto plugin which the client wishes to seed.
Note: Getter function for property csprngEngineName.
See also setCsprngEngineName().
[virtual]
QVariantMap SeedRandomDataGeneratorRequest::customParameters() const
See also setCustomParameters().
double SeedRandomDataGeneratorRequest::entropyEstimate() const
Returns the client's estimate for how much entropy is contained in the seed data
The entropy estimate must be between 0.0 (no randomness) and 1.0 (totally random). The default entropy estimate is 1.0.
Note: Getter function for property entropyEstimate.
See also setEntropyEstimate().
[virtual]
Sailfish::Crypto::CryptoManager *SeedRandomDataGeneratorRequest::manager() const
See also setManager().
[virtual]
Sailfish::Crypto::Result SeedRandomDataGeneratorRequest::result() const
QByteArray SeedRandomDataGeneratorRequest::seedData() const
Returns the seed data
Note: Getter function for property seedData.
See also setSeedData().
void SeedRandomDataGeneratorRequest::setCryptoPluginName(const QString &pluginName)
Sets the name of the crypto plugin which the client wishes to perform the key generation operation to pluginName
Note: Setter function for property cryptoPluginName.
See also cryptoPluginName().
void SeedRandomDataGeneratorRequest::setCsprngEngineName(const QString &engineName)
Sets the name of the cryptographically secure random number generator engine offered by the crypto plugin which the client wishes to seed to engineName
Usually, the default engine offered by the plugin is the correct CSPRNG engine to use (and in fact, most plugins will only offer that one engine), so clients should not have to set this parameter in the majority of cases.
Note: Setter function for property csprngEngineName.
See also csprngEngineName().
[virtual]
void SeedRandomDataGeneratorRequest::setCustomParameters(const QVariantMap ¶ms)
See also customParameters().
void SeedRandomDataGeneratorRequest::setEntropyEstimate(double estimate)
Sets the client's estimate for how much entropy is contained in the seed data to estimate
The value of estimate will be clamped to between 0.0 (no randomness) and 1.0 (totally random).
Note: Setter function for property entropyEstimate.
See also entropyEstimate().
[virtual]
void SeedRandomDataGeneratorRequest::setManager(Sailfish::Crypto::CryptoManager *manager)
See also manager().
void SeedRandomDataGeneratorRequest::setSeedData(const QByteArray &data)
Sets the seed data to data
Note: Setter function for property seedData.
See also seedData().