Detailed Description

Allows a client request a secret from the system's secure secret storage service

This class allows clients to request the Secrets service to retrieve a secret identified by a given identifier(). The identifier() will identify either a standalone or collection-stored secret.

If the application making the request is the creator of the secret, or alternatively if the user has granted the application permission to read the specific secret, then the Secrets service will instruct the storage plugin to retrieve the secret.

If the application is not the creator of the secret and the user has not yet been asked if the application should have permission to read the secret, then a system-mediated access control UI flow may be triggered to obtain the user's permission (unless the given userInteractionMode is PreventInteraction in which case the request will fail).

If the secret uses an encryption key derived from the system device-lock, then the value will be able to be retrieved without any other UI flow being required if the secret (or the collection in which the secret is stored, if the secret is not a standalone secret) is currently unlocked; however, if the secret (or collection) uses an encryption key derived from a custom lock, then the custom lock authentication key will be obtained from the user via an authentication flow determined by the authentication plugin used for that secret (which may support ApplicationInteraction if the secret is an application-specific secret using an ApplicationSpecificAuthentication plugin, but otherwise will be a system-mediated UI flow, unless the userInteractionMode specified is PreventInteraction in which case the request will fail).

If the data contained in the secret is actually a cryptographic key created via the Sailfish::Crypto library, then only those components of the key which were allowed for retrieval via Sailfish::Crypto::Key::setComponentConstraints() will be able to be retrieved, even if the calling application is the owner of the secret. For more information about that topic, please see the documentation for the Sailfish::Crypto library.

An example of retrieving a collection-stored secret follows:

 Sailfish::Secrets::SecretManager sm;
 Sailfish::Secrets::StoredSecretRequest ssr;
 ssr.setManager(&sm);
 ssr.setIdentifier(Sailfish::Secrets::Secret::Identifier("ExampleSecret", "ExampleCollection"));
 ssr.setUserInteractionMode(Sailfish::Secrets::SecretManager::SystemInteraction);
 ssr.startRequest(); // status() will change to Finished when complete