Sailfish Secrets

API Documentation

Secrets Namespace

(Sailfish::Secrets)

This namespace provides various types related to storing secret data in the Sailfish OS system. More...

Header: #include <Secrets>

Namespaces

namespace Plugin

Classes

class	AuthenticationPlugin
class	CollectionNamesRequest
class	CollectionNamesRequestPrivate
class	CreateCollectionRequest
class	CreateCollectionRequestPrivate
class	DeleteCollectionRequest
class	DeleteCollectionRequestPrivate
class	DeleteSecretRequest
class	DeleteSecretRequestPrivate
class	EncryptedStoragePlugin
class	EncryptionPlugin
class	FindSecretsRequest
class	FindSecretsRequestPrivate
class	HealthCheckRequest
class	HealthCheckRequestPrivate
class	InteractionParameters
class	InteractionParametersPrivate
class	InteractionRequest
class	InteractionRequestPrivate
class	InteractionRequestWatcher
class	InteractionResponse
class	InteractionResponsePrivate
class	InteractionService
class	InteractionView
class	LockCodeRequest
class	LockCodeRequestPrivate
class	PluginBase
class	PluginInfo
class	PluginInfoPrivate
class	PluginInfoRequest
class	PluginInfoRequestPrivate
class	Request
class	Result
class	ResultPrivate
class	Secret
class	SecretIdentifierPrivate
class	SecretManager
class	SecretPrivate
class	SecretsDaemonConnection
class	SecretsDaemonConnectionPrivate
class	StoragePlugin
class	StoreSecretRequest
class	StoreSecretRequestPrivate
class	StoredSecretRequest
class	StoredSecretRequestPrivate

Functions

bool	operator!=(const Sailfish::Secrets::InteractionParameters &lhs, const Sailfish::Secrets::InteractionParameters &rhs)
bool	operator!=(const Sailfish::Secrets::InteractionResponse &lhs, const Sailfish::Secrets::InteractionResponse &rhs)
bool	operator!=(const Sailfish::Secrets::PluginInfo &lhs, const Sailfish::Secrets::PluginInfo &rhs)
bool	operator!=(const Sailfish::Secrets::Result &lhs, const Sailfish::Secrets::Result &rhs)
bool	operator!=(const Sailfish::Secrets::Secret::Identifier &lhs, const Sailfish::Secrets::Secret::Identifier &rhs)
bool	operator!=(const Sailfish::Secrets::Secret &lhs, const Sailfish::Secrets::Secret &rhs)
bool	operator<(const Sailfish::Secrets::InteractionParameters &lhs, const Sailfish::Secrets::InteractionParameters &rhs)
bool	operator<(const Sailfish::Secrets::InteractionParameters::PromptText &lhs, const Sailfish::Secrets::InteractionParameters::PromptText &rhs)
bool	operator<(const Sailfish::Secrets::InteractionResponse &lhs, const Sailfish::Secrets::InteractionResponse &rhs)
bool	operator<(const Sailfish::Secrets::PluginInfo &lhs, const Sailfish::Secrets::PluginInfo &rhs)
bool	operator<(const Sailfish::Secrets::Result &lhs, const Sailfish::Secrets::Result &rhs)
bool	operator<(const Sailfish::Secrets::Secret::Identifier &lhs, const Sailfish::Secrets::Secret::Identifier &rhs)
bool	operator<(const Sailfish::Secrets::Secret &lhs, const Sailfish::Secrets::Secret &rhs)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::Result &result)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::Secret &secret)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::Secret::Identifier &identifier)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::UserInteractionMode mode)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::AccessControlMode mode)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::DeviceLockUnlockSemantic semantic)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::CustomLockUnlockSemantic semantic)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::FilterOperator filterOperator)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::PluginInfo &info)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::InteractionParameters::InputType &type)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::InteractionParameters::EchoMode &mode)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::InteractionParameters::Operation &op)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::InteractionParameters::PromptText &prompt)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::InteractionParameters &request)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::InteractionResponse &response)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::LockCodeRequest::LockCodeTargetType &type)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::LockCodeRequest::LockStatus &status)
QDBusArgument &	operator<<(QDBusArgument &argument, const Sailfish::Secrets::HealthCheckRequest::Health &h)
bool	operator==(const Sailfish::Secrets::InteractionParameters &lhs, const Sailfish::Secrets::InteractionParameters &rhs)
bool	operator==(const Sailfish::Secrets::InteractionResponse &lhs, const Sailfish::Secrets::InteractionResponse &rhs)
bool	operator==(const Sailfish::Secrets::PluginInfo &lhs, const Sailfish::Secrets::PluginInfo &rhs)
bool	operator==(const Sailfish::Secrets::Result &lhs, const Sailfish::Secrets::Result &rhs)
bool	operator==(const Sailfish::Secrets::Secret::Identifier &lhs, const Sailfish::Secrets::Secret::Identifier &rhs)
bool	operator==(const Sailfish::Secrets::Secret &lhs, const Sailfish::Secrets::Secret &rhs)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::Result &result)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::Secret &secret)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::Secret::Identifier &identifier)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::SecretManager::UserInteractionMode &mode)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::SecretManager::AccessControlMode &mode)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::SecretManager::DeviceLockUnlockSemantic &semantic)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::SecretManager::CustomLockUnlockSemantic &semantic)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::SecretManager::FilterOperator &filterOperator)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::PluginInfo &info)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::InteractionParameters::InputType &type)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::InteractionParameters::EchoMode &mode)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::InteractionParameters::Operation &op)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::InteractionParameters::PromptText &prompt)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::InteractionParameters &request)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::InteractionResponse &response)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::LockCodeRequest::LockCodeTargetType &type)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::LockCodeRequest::LockStatus &status)
const QDBusArgument &	operator>>(const QDBusArgument &argument, Sailfish::Secrets::HealthCheckRequest::Health &h)

Detailed Description

This namespace provides various types related to storing secret data in the Sailfish OS system.

Namespaces

namespace Secrets::Plugin

Classes

class AuthenticationPlugin

Specifies an interface allowing verification of a user's identity, retrieval of an authentication code or passphrase from a user, or both. More...

class CollectionNamesRequest

Allows a client request the names of collections of secrets from the system secrets service More...

class CollectionNamesRequestPrivate

class CreateCollectionRequest

Allows a client request that the system secrets service create a collection for secrets storage More...

class CreateCollectionRequestPrivate

class DeleteCollectionRequest

Allows a client request that the system secrets service delete a collection from secrets storage More...

class DeleteCollectionRequestPrivate

class DeleteSecretRequest

Allows a client request that a secret be deleted from the system's secure secret storage service More...

class DeleteSecretRequestPrivate

class EncryptedStoragePlugin

Specifies an interface allowing storage and retrieval of secrets into and from an encrypted backing store. More...

class EncryptionPlugin

Specifies an interface to derive an encryption key from input data, and encrypt or decrypt secret data. More...

class FindSecretsRequest

Allows a client find the identifiers of secrets which match a specific filter from the system's secure secret storage service More...

class FindSecretsRequestPrivate

class HealthCheckRequest

Allows a client request information about the well-being of secrets data. More...

class HealthCheckRequestPrivate

class InteractionParameters

Encapsulates parameters related to requesting input from the user More...

class InteractionParametersPrivate

class InteractionRequest

Allows a client request user input, mediated by the secrets service More...

class InteractionRequestPrivate

class InteractionRequestWatcher

class InteractionResponse

Encapsulates a user-input response from an authentication plugin More...

class InteractionResponsePrivate

class InteractionService

class InteractionView

Interface for implementing in-app authentication More...

class LockCodeRequest

Allows a client to request that the system service either unlock, lock, or modify the lock code associated with the device, an extension plugin, a standalone secret or a collection. More...

class LockCodeRequestPrivate

class PluginBase

Provides the base interface for extension plugins for the Sailfish OS Secrets and Crypto Framework. More...

class PluginInfo

Information about a plugin More...

class PluginInfoPrivate

class PluginInfoRequest

Allows a client request information about available storage, encryption and authentication plugins More...

class PluginInfoRequestPrivate

class Request

Base-class of specific secrets service requests. More...

class Result

The result of a secrets operation More...

class ResultPrivate

class Secret

An instance of a secret More...

class SecretIdentifierPrivate

class SecretManager

Allows clients to make requests of the system secrets service. More...

class SecretPrivate

class SecretsDaemonConnection

class SecretsDaemonConnectionPrivate

class StoragePlugin

Specifies an interface allowing storage and retrieval of secrets More...

class StoreSecretRequest

Allows a client request that the system secrets service securely store a secret More...

class StoreSecretRequestPrivate

class StoredSecretRequest

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

class StoredSecretRequestPrivate

Function Documentation

bool Secrets::operator!=(const Sailfish::Secrets::InteractionParameters &lhs, const Sailfish::Secrets::InteractionParameters &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::InteractionResponse &lhs, const Sailfish::Secrets::InteractionResponse &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::PluginInfo &lhs, const Sailfish::Secrets::PluginInfo &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::Result &lhs, const Sailfish::Secrets::Result &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::Secret::Identifier &lhs, const Sailfish::Secrets::Secret::Identifier &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::Secret &lhs, const Sailfish::Secrets::Secret &rhs)

bool Secrets::operator<(const Sailfish::Secrets::InteractionParameters &lhs, const Sailfish::Secrets::InteractionParameters &rhs)

bool Secrets::operator<(const Sailfish::Secrets::InteractionParameters::PromptText &lhs, const Sailfish::Secrets::InteractionParameters::PromptText &rhs)

Sailfish Secrets

Contents

Secrets Namespace

Namespaces

Classes

Functions

Detailed Description

Namespaces

namespace Secrets::Plugin

Classes

class AuthenticationPlugin

class CollectionNamesRequest

class CollectionNamesRequestPrivate

class CreateCollectionRequest

class CreateCollectionRequestPrivate

class DeleteCollectionRequest

class DeleteCollectionRequestPrivate

class DeleteSecretRequest

class DeleteSecretRequestPrivate

class EncryptedStoragePlugin

class EncryptionPlugin

class FindSecretsRequest

class FindSecretsRequestPrivate

class HealthCheckRequest

class HealthCheckRequestPrivate

class InteractionParameters

class InteractionParametersPrivate

class InteractionRequest

class InteractionRequestPrivate

class InteractionRequestWatcher

class InteractionResponse

class InteractionResponsePrivate

class InteractionService

class InteractionView

class LockCodeRequest

class LockCodeRequestPrivate

class PluginBase

class PluginInfo

class PluginInfoPrivate

class PluginInfoRequest

class PluginInfoRequestPrivate

class Request

class Result

class ResultPrivate

class Secret

class SecretIdentifierPrivate

class SecretManager

class SecretPrivate

class SecretsDaemonConnection

class SecretsDaemonConnectionPrivate

class StoragePlugin

class StoreSecretRequest

class StoreSecretRequestPrivate

class StoredSecretRequest

class StoredSecretRequestPrivate

Function Documentation

bool Secrets::operator!=(const Sailfish::Secrets::InteractionParameters &lhs, const Sailfish::Secrets::InteractionParameters &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::InteractionResponse &lhs, const Sailfish::Secrets::InteractionResponse &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::PluginInfo &lhs, const Sailfish::Secrets::PluginInfo &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::Result &lhs, const Sailfish::Secrets::Result &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::Secret::Identifier &lhs, const Sailfish::Secrets::Secret::Identifier &rhs)

bool Secrets::operator!=(const Sailfish::Secrets::Secret &lhs, const Sailfish::Secrets::Secret &rhs)

bool Secrets::operator<(const Sailfish::Secrets::InteractionParameters &lhs, const Sailfish::Secrets::InteractionParameters &rhs)

bool Secrets::operator<(const Sailfish::Secrets::InteractionParameters::PromptText &lhs, const Sailfish::Secrets::InteractionParameters::PromptText &rhs)

bool Secrets::operator<(const Sailfish::Secrets::InteractionResponse &lhs, const Sailfish::Secrets::InteractionResponse &rhs)

bool Secrets::operator<(const Sailfish::Secrets::PluginInfo &lhs, const Sailfish::Secrets::PluginInfo &rhs)

bool Secrets::operator<(const Sailfish::Secrets::Result &lhs, const Sailfish::Secrets::Result &rhs)

bool Secrets::operator<(const Sailfish::Secrets::Secret::Identifier &lhs, const Sailfish::Secrets::Secret::Identifier &rhs)

bool Secrets::operator<(const Sailfish::Secrets::Secret &lhs, const Sailfish::Secrets::Secret &rhs)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::Result &result)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::Secret &secret)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::Secret::Identifier &identifier)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::UserInteractionMode mode)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::AccessControlMode mode)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::DeviceLockUnlockSemantic semantic)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::CustomLockUnlockSemantic semantic)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::SecretManager::FilterOperator filterOperator)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::PluginInfo &info)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::InteractionParameters::InputType &type)

QDBusArgument &Secrets::operator<<(QDBusArgument &argument, const Sailfish::Secrets::InteractionParameters::EchoMode &mode)