Secure Storage#

A service for safely storing sensitive key–value data using the platform’s native secure storage mechanisms—Keychain on iOS/macOS, Windows Credential Manager, libsecret on Linux, and Keystore on Android.

Powered by Flutter's flutter_secure_storage package.

Note

You need libsecret-1-dev on your machine to build the project, and libsecret-1-0 to run the application (add it as a dependency after packaging your app). If you using snapcraft to build the project use the following.

Apart from libsecret you also need a keyring service, for that you need either gnome-keyring (for Gnome users) or kwalletmanager (for KDE users) or other light provider like secret-service.

sudo apt-get install libsecret-1-dev libsecret-1-0

Platform Support#

Platform	Windows	macOS	Linux	iOS	Android	Web
Supported	✅	✅	✅	✅	✅	✅

Usage#

Add flet-secure-storage to your project dependencies:

uvpip

uv add flet-secure-storage

pip install flet-secure-storage  # (1)!

After this, you will have to manually add this package to your requirements.txt or pyproject.toml.

Hosting Rive files

Host .riv files locally or load them from a CDN. Use placeholder to keep layouts responsive while animations load.

Example#

import base64
import os

import flet as ft
import flet_secure_storage as fss


def main(page: ft.Page):
    page.vertical_alignment = ft.MainAxisAlignment.CENTER
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
    storage = fss.SecureStorage(
        web_options=fss.WebOptions(
            db_name="customstorage",
            public_key="publickey",
            wrap_key=base64.urlsafe_b64encode(os.urandom(32)).decode(),
            wrap_key_iv=base64.urlsafe_b64encode(os.urandom(16)).decode(),
        ),
        android_options=fss.AndroidOptions(
            reset_on_error=True,
            migrate_on_algorithm_change=True,
            enforce_biometrics=True,
            key_cipher_algorithm=fss.KeyCipherAlgorithm.AES_GCM_NO_PADDING,
            storage_cipher_algorithm=fss.StorageCipherAlgorithm.AES_GCM_NO_PADDING,
        ),
    )

    key = ft.TextField(label="Key", value="example_key")
    value = ft.TextField(label="Value", value="secret_value")
    result = ft.Text(theme_style=ft.TextThemeStyle.TITLE_LARGE)

    async def set_value(e):
        await storage.set(key.value, value.value)
        result.value = "Value saved"
        page.update()

    async def get_value(e):
        result.value = await storage.get(key.value)
        page.update()

    async def remove_value(e):
        await storage.remove(key.value)
        result.value = "Value removed"
        page.update()

    async def clear_storage(e):
        await storage.clear()
        result.value = "Storage cleared"
        page.update()

    async def contains_key(e):
        exists = await storage.contains_key(key.value)
        result.value = f"Key exists: {exists}"
        page.update()

    async def get_availability(e):
        is_availability = await storage.get_availability()
        page.show_dialog(
            ft.SnackBar(
                content=ft.Text(
                    value=f"Protected data available: {is_availability}"
                    if is_availability
                    else "Protected data available: None"
                )
            )
        )
        page.update()

    page.add(
        ft.Column(
            alignment=ft.MainAxisAlignment.CENTER,
            horizontal_alignment=ft.CrossAxisAlignment.CENTER,
            spacing=10,
            controls=[
                result,
                key,
                value,
                ft.Row(
                    width=300,
                    wrap=True,
                    controls=[
                        ft.Button("Set", on_click=set_value),
                        ft.Button("Get", on_click=get_value),
                        ft.Button("Contains key", on_click=contains_key),
                        ft.Button("Remove", on_click=remove_value),
                        ft.Button("Clear", on_click=clear_storage),
                        ft.Button("Check Data Availability", on_click=get_availability),
                    ],
                ),
            ],
        ),
    )


ft.run(main)

Description#

Inherits: Service

A class to manage secure storage in a Flet application across multiple platforms.

Properties

android_options(AndroidOptions) –

Android-specific configuration for secure storage.
ios_options(IOSOptions) –

iOS-specific configuration for secure storage.
macos_options(MacOsOptions) –

macOS-specific configuration for secure storage.
web_options(WebOptions) –

Web-specific configuration for secure storage.
windows_options(WindowsOptions) –

Windows-specific configuration for secure storage.

Events

on_change(EventHandler[SecureStorageEvent] | None) –

Fires when secure storage availability changes.

Methods

clear –

Clears all key-value pairs from secure storage.
contains_key –

Checks whether the given key exists in secure storage.
get –

Retrieves the value stored under the given key in secure storage.
get_all –

Retrieves all key-value pairs from secure storage.
get_availability –

Gets the current availability status of secure storage.
remove –

Removes the value stored under the given key in secure storage.
set –

Stores a value in secure storage under the given key.

Properties#

android_options `class-attribute` `instance-attribute` #

android_options: AndroidOptions = field(
    default_factory=lambda: AndroidOptions()
)

Android-specific configuration for secure storage.

ios_options `class-attribute` `instance-attribute` #

ios_options: IOSOptions = field(
    default_factory=lambda: IOSOptions()
)

iOS-specific configuration for secure storage.

macos_options `class-attribute` `instance-attribute` #

macos_options: MacOsOptions = field(
    default_factory=lambda: MacOsOptions()
)

macOS-specific configuration for secure storage.

web_options `class-attribute` `instance-attribute` #

web_options: WebOptions = field(
    default_factory=lambda: WebOptions()
)

Web-specific configuration for secure storage.

windows_options `class-attribute` `instance-attribute` #

windows_options: WindowsOptions = field(
    default_factory=lambda: WindowsOptions()
)

Windows-specific configuration for secure storage.

Events#

on_change `class-attribute` `instance-attribute` #

on_change: EventHandler[SecureStorageEvent] | None = None

Fires when secure storage availability changes.

iOS only feature. For unsupported platforms, this event will never fire. The payload is a SecureStorageEvent object with the available field.

Methods#

clear `async` #

clear(
    *,
    web: WebOptions | None = None,
    ios: IOSOptions | None = None,
    macos: MacOsOptions | None = None,
    android: AndroidOptions | None = None,
    windows: WindowsOptions | None = None,
) -> None

Clears all key-value pairs from secure storage.

Parameters:

web (WebOptions | None, default: None ) –

Optional web-specific configuration.
ios (IOSOptions | None, default: None ) –

Optional iOS-specific configuration.
macos (MacOsOptions | None, default: None ) –

Optional macOS-specific configuration.
android (AndroidOptions | None, default: None ) –

Optional Android-specific configuration.
windows (WindowsOptions | None, default: None ) –

Optional Windows-specific configuration.

contains_key `async` #

contains_key(
    key: str,
    *,
    web: WebOptions | None = None,
    ios: IOSOptions | None = None,
    macos: MacOsOptions | None = None,
    android: AndroidOptions | None = None,
    windows: WindowsOptions | None = None,
) -> bool

Checks whether the given key exists in secure storage.

Parameters:

key (str) –

The key to check.
web (WebOptions | None, default: None ) –

Optional web-specific configuration.
ios (IOSOptions | None, default: None ) –

Optional iOS-specific configuration.
macos (MacOsOptions | None, default: None ) –

Optional macOS-specific configuration.
android (AndroidOptions | None, default: None ) –

Optional Android-specific configuration.
windows (WindowsOptions | None, default: None ) –

Optional Windows-specific configuration.

Returns:

bool –

True if the key exists, False otherwise.

get `async` #

get(
    key: str,
    *,
    web: WebOptions | None = None,
    ios: IOSOptions | None = None,
    macos: MacOsOptions | None = None,
    android: AndroidOptions | None = None,
    windows: WindowsOptions | None = None,
) -> str | None

Retrieves the value stored under the given key in secure storage.

Parameters:

key (str) –

The key to retrieve.
web (WebOptions | None, default: None ) –

Optional web-specific configuration.
ios (IOSOptions | None, default: None ) –

Optional iOS-specific configuration.
macos (MacOsOptions | None, default: None ) –

Optional macOS-specific configuration.
android (AndroidOptions | None, default: None ) –

Optional Android-specific configuration.
windows (WindowsOptions | None, default: None ) –

Optional Windows-specific configuration.

Returns:

str | None –

The stored string value, or None if the key does not exist.

get_all `async` #

get_all(
    *,
    web: WebOptions | None = None,
    ios: IOSOptions | None = None,
    macos: MacOsOptions | None = None,
    android: AndroidOptions | None = None,
    windows: WindowsOptions | None = None,
) -> dict[str, str]

Retrieves all key-value pairs from secure storage.

Parameters:

web (WebOptions | None, default: None ) –

Optional web-specific configuration.
ios (IOSOptions | None, default: None ) –

Optional iOS-specific configuration.
macos (MacOsOptions | None, default: None ) –

Optional macOS-specific configuration.
android (AndroidOptions | None, default: None ) –

Optional Android-specific configuration.
windows (WindowsOptions | None, default: None ) –

Optional Windows-specific configuration.

Returns:

dict[str, str] –

A dictionary with all stored key-value pairs.

get_availability `async` #

get_availability() -> bool | None

Gets the current availability status of secure storage.

iOS and macOS only. On macOS, available only on macOS 12+. On older macOS versions, always returns True. On unsupported platforms, returns None.

Returns:

bool | None –

A boolean indicating storage availability, or None if unsupported.

remove `async` #

remove(
    key: str,
    *,
    web: WebOptions | None = None,
    ios: IOSOptions | None = None,
    macos: MacOsOptions | None = None,
    android: AndroidOptions | None = None,
    windows: WindowsOptions | None = None,
) -> None

Removes the value stored under the given key in secure storage.

Parameters:

key (str) –

The key to remove.
web (WebOptions | None, default: None ) –

Optional web-specific configuration.
ios (IOSOptions | None, default: None ) –

Optional iOS-specific configuration.
macos (MacOsOptions | None, default: None ) –

Optional macOS-specific configuration.
android (AndroidOptions | None, default: None ) –

Optional Android-specific configuration.
windows (WindowsOptions | None, default: None ) –

Optional Windows-specific configuration.

set `async` #

set(
    key: str,
    value: Any,
    *,
    web: WebOptions | None = None,
    ios: IOSOptions | None = None,
    macos: MacOsOptions | None = None,
    android: AndroidOptions | None = None,
    windows: WindowsOptions | None = None,
) -> None

Stores a value in secure storage under the given key.

Parameters:

key (str) –

The key to store the value under.
value (Any) –

The value to store (cannot be None).
web (WebOptions | None, default: None ) –

Optional web-specific configuration.
ios (IOSOptions | None, default: None ) –

Optional iOS-specific configuration.
macos (MacOsOptions | None, default: None ) –

Optional macOS-specific configuration.
android (AndroidOptions | None, default: None ) –

Optional Android-specific configuration.
windows (WindowsOptions | None, default: None ) –

Optional Windows-specific configuration.

Raises:

ValueError –

If value is None.

Secure Storage#

Platform Support#

Usage#

Example#

Description#

Properties#

android_options class-attribute instance-attribute #

ios_options class-attribute instance-attribute #

macos_options class-attribute instance-attribute #

web_options class-attribute instance-attribute #

windows_options class-attribute instance-attribute #

Events#

on_change class-attribute instance-attribute #

Methods#

clear async #

contains_key async #

get async #

get_all async #

get_availability async #

remove async #

set async #

android_options `class-attribute` `instance-attribute` #

ios_options `class-attribute` `instance-attribute` #

macos_options `class-attribute` `instance-attribute` #

web_options `class-attribute` `instance-attribute` #

windows_options `class-attribute` `instance-attribute` #

on_change `class-attribute` `instance-attribute` #

clear `async` #

contains_key `async` #

get `async` #

get_all `async` #

get_availability `async` #

remove `async` #

set `async` #