// Define the secret.
 Sailfish::Secrets::Secret exampleSecret(
         Sailfish::Secrets::Secret::Identifier(
                 QLatin1String("ExampleSecret"),
                 QLatin1String("ExampleCollection"),
                 Sailfish::Secrets::SecretManager::DefaultEncryptedStoragePluginName));
 exampleSecret.setData("Some secret data");
 exampleSecret.setType(Sailfish::Secrets::Secret::TypeBlob);
 exampleSecret.setFilterData(QLatin1String("domain"),
                             QLatin1String("sailfishos.org"));
 exampleSecret.setFilterData(QLatin1String("example"),
                             QLatin1String("true"));

 // Request that the secret be securely stored.
 Sailfish::Secrets::SecretManager sm;
 Sailfish::Secrets::StoreSecretRequest ssr;
 ssr.setManager(&sm);
 ssr.setSecretStorageType(Sailfish::Secrets::StoreSecretRequest::CollectionSecret);
 ssr.setUserInteractionMode(Sailfish::Secrets::SecretManager::SystemInteraction);
 ssr.setSecret(exampleSecret);
 ssr.startRequest(); // status() will change to Finished when complete

 // Define a standalone secret (no collection name specified in the identifier)
 Sailfish::Secrets::Secret standaloneSecret(
         Sailfish::Secrets::Secret::Identifier(
              QStringLiteral("StandaloneSecret"),
              QString(),
              Sailfish::Secrets::SecretManager::DefaultEncryptedStoragePluginName));
 standaloneSecret.setData("Example secret data");
 standaloneSecret.setType(Secret::TypeBlob);
 standaloneSecret.setFilterData(QLatin1String("domain"),
                                QLatin1String("sailfishos.org"));
 standaloneSecret.setFilterData(QLatin1String("example"),
                                QLatin1String("true"));

 // Request that the secret be stored by the default storage plugin
 Sailfish::Secrets::SecretManager sm;
 Sailfish::Secrets::StoreSecretRequest ssr;
 ssr.setManager(&sm);
 ssr.setSecretStorageType(StoreSecretRequest::StandaloneDeviceLockSecret);
 ssr.setDeviceLockUnlockSemantic(Sailfish::Secrets::SecretManager::DeviceLockKeepUnlocked);
 ssr.setAccessControlMode(Sailfish::Secrets::SecretManager::OwnerOnlyMode);
 ssr.setEncryptionPluginName(Sailfish::Secrets::SecretManager::DefaultEncryptionPluginName);
 ssr.setUserInteractionMode(Sailfish::Secrets::SecretManager::SystemInteraction);
 ssr.setSecret(standaloneSecret);
 ssr.startRequest(); // status() will change to Finished when complete

 // Define the secret data request prompt parameters.
 Sailfish::Secrets::InteractionParameters uiParams;
 uiParams.setInputType(Sailfish::Secrets::InteractionParameters::AlphaNumericInput);
 uiParams.setEchoMode(Sailfish::Secrets::InteractionParameters::NormalEcho);

 // Define the secret.  Note that it contains metadata only.
 Sailfish::Secrets::Secret exampleSecret(
         Sailfish::Secrets::Secret::Identifier(
                 QLatin1String("ExampleSecret"),
                 QLatin1String("ExampleCollection"),
                 Sailfish::Secrets::SecretManager::DefaultEncryptedStoragePluginName));
 exampleSecret.setType(Sailfish::Secrets::Secret::TypeBlob);
 exampleSecret.setFilterData(QLatin1String("domain"),
                             QLatin1String("sailfishos.org"));
 exampleSecret.setFilterData(QLatin1String("example"),
                             QLatin1String("true"));

 // Request that the secret be securely stored.
 Sailfish::Secrets::SecretManager sm;
 Sailfish::Secrets::StoreSecretRequest ssr;
 ssr.setManager(&sm);
 ssr.setInteractionParameters(uiParams);
 ssr.setSecretStorageType(Sailfish::Secrets::StoreSecretRequest::CollectionSecret);
 ssr.setUserInteractionMode(Sailfish::Secrets::SecretManager::SystemInteraction);
 ssr.setSecret(exampleSecret);
 ssr.startRequest(); // status() will change to Finished when complete

Member Function Documentation

StoreSecretRequest::StoreSecretRequest(QObject *parent = Q_NULLPTR)

Constructs a new StoreSecretRequest object with the given parent.

StoreSecretRequest::~StoreSecretRequest()

Destroys the StoreSecretRequest

Sailfish::Secrets::SecretManager::AccessControlMode StoreSecretRequest::accessControlMode() const

Returns the access control mode which will be enforced for the secret

Note: Getter function for property accessControlMode.

See also setAccessControlMode().

QString StoreSecretRequest::authenticationPluginName() const

Returns the name of the authentication plugin which the client wishes to use to authenticate the user (in order to unlock the secret)

Note: Getter function for property authenticationPluginName.

See also setAuthenticationPluginName().

Sailfish::Secrets::SecretManager::CustomLockUnlockSemantic StoreSecretRequest::customLockUnlockSemantic() const

Returns the unlock semantic which will apply to the secret if it is protected by a custom lock.

Note: Getter function for property customLockUnlockSemantic.

See also setCustomLockUnlockSemantic().

Sailfish::Secrets::SecretManager::DeviceLockUnlockSemantic StoreSecretRequest::deviceLockUnlockSemantic() const

Returns the unlock semantic which will apply to the secret if it is protected by the device lock.

Note: Getter function for property deviceLockUnlockSemantic.

See also setDeviceLockUnlockSemantic().

QString StoreSecretRequest::encryptionPluginName() const

Returns the name of the encryption plugin which the client wishes to use to encrypt the standalone secret

Note: Getter function for property encryptionPluginName.

See also setEncryptionPluginName().

InteractionParameters StoreSecretRequest::interactionParameters() const

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

If the user input parameters are not valid, the secret data which is contained within the secret() will be stored. If the user input parameters are valid, then the secret data which is contained within the secret() will be overwritten prior to storage with the data retrieved from the user.

Note: specifying user input parameters implies that system-mediated user interaction flows are allowed by the calling application.

Note: Getter function for property interactionParameters.

See also setInteractionParameters().

[virtual] Sailfish::Secrets::SecretManager *StoreSecretRequest::manager() const

See also setManager().

[virtual] Sailfish::Secrets::Result StoreSecretRequest::result() const

Sailfish::Secrets::Secret StoreSecretRequest::secret() const

Returns the secret which the client wishes to store securely

Note: Getter function for property secret.

See also setSecret().

SecretStorageType StoreSecretRequest::secretStorageType() const

Returns the type of storage which will apply to the stored secret

A secret whose storage type is StoreSecretRequest::CollectionSecret will be stored in the collection whose name is specified in the secret's identifier's Sailfish::Secrets::Secret::Identifier::collectionName() field. The collection will have either a custom lock or device lock depending on the semantics defined for it when it was created.

A secret whose storage type is StoreSecretRequest::StandaloneCustomLockSecret will be individually encrypted with the custom lock code, and then the encrypted version will be stored in a standalone, unencrypted collection.

A secret whose storage type is StoreSecretRequest::StandaloneDeviceLockSecret will be individually encrypted with the device lock code, and then the encrypted version will be stored in a standalone, unencrypted collection.

Note: Getter function for property secretStorageType.

See also setSecretStorageType().

void StoreSecretRequest::setAuthenticationPluginName(const QString &pluginName)

Sets the name of the authentication plugin which the client wishes to use to authenticate the user (in order to unlock the secret) to pluginName

Note: this will only apply to secrets whose secretStorageType() is StoreSecretRequest::StandaloneCustomLockSecret.

Note: Setter function for property authenticationPluginName.

See also authenticationPluginName().

void StoreSecretRequest::setEncryptionPluginName(const QString &pluginName)

Sets the name of the encryption plugin which the client wishes to use to encrypt the standalone secret to pluginName

Note: this will only apply to secrets whose secretStorageType() is StoreSecretRequest::StandaloneCustomLockSecret or StoreSecretRequest::StandaloneDeviceLockSecret.

Note: Setter function for property encryptionPluginName.

See also encryptionPluginName().

void StoreSecretRequest::setInteractionParameters(const InteractionParameters &params)

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

If the user input parameters are not valid, the secret data which is contained within the secret() will be stored. If the user input parameters are valid, then the secret data which is contained within the secret() will be overwritten prior to storage with the data retrieved from the user.

Note: specifying user input parameters implies that system-mediated user interaction flows are allowed by the calling application.

Note: Setter function for property interactionParameters.

See also interactionParameters().

[virtual] void StoreSecretRequest::setManager(Sailfish::Secrets::SecretManager *manager)

See also manager().

void StoreSecretRequest::setSecretStorageType(SecretStorageType type)

Sets the type of storage which will apply to the stored secret to type

Note: Setter function for property secretStorageType.

See also secretStorageType().

[virtual] void StoreSecretRequest::startRequest()

[virtual] Sailfish::Secrets::Request::Status StoreSecretRequest::status() const

Sailfish::Secrets::SecretManager::UserInteractionMode StoreSecretRequest::userInteractionMode() const

Returns the user interaction mode required when storing the secret (e.g. if a custom lock code must be requested from the user)

Note: Getter function for property userInteractionMode.

See also setUserInteractionMode().

[virtual] void StoreSecretRequest::waitForFinished()