SecureStorgageSample

A sample iOS app demonstrating the LocalData package capabilities for secure, typed storage across multiple domains.

Features

This app provides interactive demos for all LocalData storage options:

Tab	Demo	Storage Domain
Defaults	Save/load/remove values	UserDefaults
Keychain	Secure credentials with biometrics	Keychain
Files	User profiles with AnyCodable	File System
Encrypted	Encrypted logs (AES or ChaCha20)	Encrypted File System
Sync	Platform availability & sync policies	Multiple

The project also includes a watchOS companion app target for watch-specific demos.

Requirements

iOS 17.0+
watchOS 10.0+ (companion app target)
Xcode 15+

Getting Started

Open SecureStorgageSample.xcodeproj
Select an iOS simulator or device
Build and run (⌘R)

Project Structure

SharedPackage/
├── Package.swift
└── Sources/
    └── SharedKit/
        ├── Constants/
        │   └── StorageKeyNames.swift
        └── Models/
            └── UserProfile.swift
SecureStorgageSample/
├── ContentView.swift        # Tabbed navigation
├── Models/
│   ├── Credential.swift
│   └── SampleLocationData.swift
├── StorageKeys/
│   ├── UserDefaults/
│   ├── Keychain/
│   ├── FileSystem/
│   ├── EncryptedFileSystem/
│   └── Platform/
├── WatchOptimized.swift     # Watch data models
├── Services/
│   ├── ExternalKeyMaterialProvider.swift
│   └── WatchConnectivityService.swift
└── Views/
    ├── UserDefaultsDemo.swift
    ├── KeychainDemo.swift
    ├── FileSystemDemo.swift
    ├── EncryptedStorageDemo.swift
    └── PlatformSyncDemo.swift
SecureStorageSample Watch App/
├── SecureStorageSampleApp.swift
├── ContentView.swift
├── Models/
│   └── UserProfile.swift
├── Protocols/
│   └── WatchDataHandling.swift
├── State/
│   └── WatchProfileStore.swift
└── Services/
    ├── WatchConnectivityService.swift
    └── Handlers/
        └── UserProfileWatchHandler.swift

Storage Key Examples

The app demonstrates various storage configurations:

UserDefaults

Simple string storage with automatic sync
Custom suite support

Keychain

7 accessibility options (whenUnlocked, afterFirstUnlock, etc.)
6 access control options (biometry, passcode, etc.)

File System

Documents directory (persisted, backed up)
Caches directory (can be purged)
JSON and PropertyList serializers

Encrypted Storage

AES-256-GCM or ChaCha20-Poly1305 encryption
PBKDF2 or HKDF key derivation
Complete file protection
External key material example via KeyMaterialProviding

Platform & Sync

Platform availability (phoneOnly, watchOnly, all)
Sync policies (never, manual, automaticSmall)

Dependencies

LocalData - Local package for typed secure storage
SharedKit - Local package for shared iOS/watch models and constants

Notes

Storage keys are now split into one file per key and grouped by domain; platform-focused keys live in StorageKeys/Platform with comments calling out availability/sync focus.
The shared model/constants live in SharedPackage (SharedKit) to keep the watch/iOS data contract centralized.
The watch app uses a handler-based WatchConnectivity layer so new payload types can be added in Services/Handlers without bloating the main service.
A StorageKeyCatalog sample is included to generate a security audit report of all storage keys.

License

This sample is provided for demonstration purposes.

3.7 KiB Raw Blame History