Sailfish OS
  • Info
  • User Experience
  • Cases
  • Community
  • Developers
  • Contact
  • Get Sailfish OS
Select Page
  • Info
  • User Experience
  • Cases
  • Community
  • Developers
  • Contact
  • Get Sailfish OS

Sailfish Crypto

API Documentation
  • API Documentation
  • Libsailfishapp
  • Sailfish Silica
    • Documentation
    • Icon Reference
  • Sailfish Components
    • Sailfish Accounts
    • Sailfish Bluetooth
    • Sailfish Contacts
    • Sailfish Crypto
    • Sailfish Gallery
    • Sailfish Media
    • Sailfish Pickers
    • Sailfish Secrets
    • Sailfish Share
    • Sailfish Telephony
    • Sailfish Webview
    • Amber Web Authorization
    • Amber MPRIS
  • Nemo QML Plugins
    • Configuration
    • Contacts
    • D-Bus
    • Keepalive
    • Notifications
    • Thumbnailer
  • Sailfish Middleware
    • MDM Framework
    • MDM Policy Framework
    • User Manager Daemon
  • API Documentation
  • Libsailfishapp
  • Sailfish Silica
    • Documentation
    • Icon Reference
  • Sailfish Components
    • Sailfish Accounts
    • Sailfish Bluetooth
    • Sailfish Contacts
    • Sailfish Crypto
    • Sailfish Gallery
    • Sailfish Media
    • Sailfish Pickers
    • Sailfish Secrets
    • Sailfish Share
    • Sailfish Telephony
    • Sailfish Webview
    • Amber Web Authorization
    • Amber MPRIS
  • Nemo QML Plugins
    • Configuration
    • Contacts
    • D-Bus
    • Keepalive
    • Notifications
    • Thumbnailer
  • Sailfish Middleware
    • MDM Framework
    • MDM Policy Framework
    • User Manager Daemon

Contents

  • Properties
  • Public Functions
  • Reimplemented Public Functions
  • Signals
  • Detailed Description

GenerateStoredKeyRequest Class

(Sailfish::Crypto::GenerateStoredKeyRequest)
Instantiated By: GenerateStoredKeyRequest
Inherits: Sailfish::Crypto::Request
  • List of all members, including inherited members

Properties

  • cryptoPluginName : QString
  • generatedKeyReference : const Sailfish::Crypto::Key
  • interactionParameters : Sailfish::Crypto::InteractionParameters
  • keyDerivationParameters : Sailfish::Crypto::KeyDerivationParameters
  • keyPairGenerationParameters : Sailfish::Crypto::KeyPairGenerationParameters
  • keyTemplate : Sailfish::Crypto::Key
  • 4 properties inherited from Sailfish::Crypto::Request

Public Functions

GenerateStoredKeyRequest(QObject *parent = Q_NULLPTR)
~GenerateStoredKeyRequest()
QString cryptoPluginName() const
Sailfish::Crypto::Key generatedKeyReference() const
Sailfish::Crypto::InteractionParameters interactionParameters() const
Sailfish::Crypto::KeyDerivationParameters keyDerivationParameters() const
Sailfish::Crypto::KeyPairGenerationParameters keyPairGenerationParameters() const
Sailfish::Crypto::Key keyTemplate() const
void setCryptoPluginName(const QString &pluginName)
void setInteractionParameters(const Sailfish::Crypto::InteractionParameters &uiParams)
void setKeyDerivationParameters(const Sailfish::Crypto::KeyDerivationParameters &params)
void setKeyPairGenerationParameters(const Sailfish::Crypto::KeyPairGenerationParameters &params)
void setKeyTemplate(const Sailfish::Crypto::Key &key)

Reimplemented Public Functions

virtual QVariantMap customParameters() const
virtual Sailfish::Crypto::CryptoManager *manager() const
virtual Sailfish::Crypto::Result result() const
virtual void setCustomParameters(const QVariantMap &params)
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 generatedKeyReferenceChanged()
void interactionParametersChanged()
void keyDerivationParametersChanged()
void keyPairGenerationParametersChanged()
void keyTemplateChanged()
  • 4 signals inherited from Sailfish::Crypto::Request

Property Documentation

cryptoPluginName : QString

Access functions:

QString cryptoPluginName() const
void setCryptoPluginName(const QString &pluginName)

Notifier signal:

void cryptoPluginNameChanged()

generatedKeyReference : const Sailfish::Crypto::Key

Access functions:

Sailfish::Crypto::Key generatedKeyReference() const

Notifier signal:

void generatedKeyReferenceChanged()

interactionParameters : Sailfish::Crypto::InteractionParameters

Access functions:

Sailfish::Crypto::InteractionParameters interactionParameters() const
void setInteractionParameters(const Sailfish::Crypto::InteractionParameters &uiParams)

Notifier signal:

void interactionParametersChanged()

keyDerivationParameters : Sailfish::Crypto::KeyDerivationParameters

Access functions:

Sailfish::Crypto::KeyDerivationParameters keyDerivationParameters() const
void setKeyDerivationParameters(const Sailfish::Crypto::KeyDerivationParameters &params)

Notifier signal:

void keyDerivationParametersChanged()

keyPairGenerationParameters : Sailfish::Crypto::KeyPairGenerationParameters

Access functions:

Sailfish::Crypto::KeyPairGenerationParameters keyPairGenerationParameters() const
void setKeyPairGenerationParameters(const Sailfish::Crypto::KeyPairGenerationParameters &params)

Notifier signal:

void keyPairGenerationParametersChanged()

keyTemplate : Sailfish::Crypto::Key

Access functions:

Sailfish::Crypto::Key keyTemplate() const
void setKeyTemplate(const Sailfish::Crypto::Key &key)

Notifier signal:

void keyTemplateChanged()

Member Function Documentation

GenerateStoredKeyRequest::GenerateStoredKeyRequest(QObject *parent = Q_NULLPTR)

Constructs a new GenerateStoredKeyRequest object with the given parent.

GenerateStoredKeyRequest::~GenerateStoredKeyRequest()

Destroys the GenerateStoredKeyRequest

QString GenerateStoredKeyRequest::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().

[virtual] QVariantMap GenerateStoredKeyRequest::customParameters() const

See also setCustomParameters().

Sailfish::Crypto::Key GenerateStoredKeyRequest::generatedKeyReference() const

Returns a key reference to the securely-stored generated key

Note: this value is only valid if the status of the request is Request::Finished.

The key reference will contain metadata and a valid identifier, but no private or secret key data.

Note: Getter function for property generatedKeyReference.

Sailfish::Crypto::InteractionParameters GenerateStoredKeyRequest::interactionParameters() const

Returns the user input parameters which should be used when requesting the input data from the user

These interaction parameters are only meaningful if the template key algorithm is a symmetric cipher algorithm, and if a set of valid symmetric key derivation parameters are also specified for the request.

If specified, the user will be prompted to enter some data (for example, a passphrase or PIN) which will then be used as input data to the key derivation function, which will produce the key data.

Note: Getter function for property interactionParameters.

See also setInteractionParameters().

Sailfish::Crypto::KeyDerivationParameters GenerateStoredKeyRequest::keyDerivationParameters() const

Returns the symmetric key derivation parameters which should be used to generate the secret key data

These interaction parameters are only meaningful if the template key algorithm is a symmetric cipher algorithm.

Note: Getter function for property keyDerivationParameters.

See also setKeyDerivationParameters().

Sailfish::Crypto::KeyPairGenerationParameters GenerateStoredKeyRequest::keyPairGenerationParameters() const

Returns the asymmetric key pair generation parameters which should be used to generate the public and private key data

These parameters are only meaningful if the template key algorithm is an asymmetric cipher algorithm.

Note: Getter function for property keyPairGenerationParameters.

See also setKeyPairGenerationParameters().

Sailfish::Crypto::Key GenerateStoredKeyRequest::keyTemplate() const

Returns the key which should be used as a template when generating the full key

Note: Getter function for property keyTemplate.

See also setKeyTemplate().

[virtual] Sailfish::Crypto::CryptoManager *GenerateStoredKeyRequest::manager() const

See also setManager().

[virtual] Sailfish::Crypto::Result GenerateStoredKeyRequest::result() const

void GenerateStoredKeyRequest::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().

[virtual] void GenerateStoredKeyRequest::setCustomParameters(const QVariantMap &params)

See also customParameters().

void GenerateStoredKeyRequest::setInteractionParameters(const Sailfish::Crypto::InteractionParameters &uiParams)

Sets the user input parameters which should be used when requesting the input data from the user to uiParams

Note: Setter function for property interactionParameters.

See also interactionParameters().

void GenerateStoredKeyRequest::setKeyDerivationParameters(const Sailfish::Crypto::KeyDerivationParameters &params)

Sets the symmetric key derivation parameters which should be used to generate the secret key data to params

Note: Setter function for property keyDerivationParameters.

See also keyDerivationParameters().

[virtual] void GenerateStoredKeyRequest::setManager(Sailfish::Crypto::CryptoManager *manager)

See also manager().

[virtual] void GenerateStoredKeyRequest::startRequest()

[virtual] Sailfish::Crypto::Request::Status GenerateStoredKeyRequest::status() const

[virtual] void GenerateStoredKeyRequest::waitForFinished()

  • Legal
  • Contact Us
  • Jollyboys Ltd © 2024

  • Facebook
  • Twitter
  • Mastodon
  • YouTube
  • LinkedIn