Repository files navigation

Helps you define secure storages for your properties using Swiftproperty wrappers.

All keys are hashed usingSHA512 and all values are encrypted usingAES-GCM to keep user information safe, automagically.Symmetric key is stored in Keychain in a totally secure way.

This property wrapper will store your property inUserDefaults usingStoreKey (anyString but i recommend you a String typed enum).Optionally, you can assign a default value to the property that will be secure stored at initialization.

@UserDefault(<#StoreKey#>)varyourProperty:YourType?= yourDefaultValueIfNeeded

UserDefaultsStorage is also available, a subclass ofUserDefaults with all the security provided by this library, where you can customize suite name.

This property wrapper will store your property inKeychain usingStoreKey.

@Keychain(<#StoreKey#>)varyourProperty:YourType?= yourDefaultValueIfNeeded

AsUserDefaultsStorage,KeychainStorage is also available, where you can customize access, group and synchronize it with iCloud.

This property wrapper will store your property in a memorysingleton, every property with the same wrapper and key can access or modify the value from wherever it is.

@Singleton(<#StoreKey#>)varyourProperty:YourType?= yourDefaultValueIfNeeded

AsKeychainStorage,SingletonStorage is also available.

This property wrapper is similar to@Singleton but, together with@Register, will inject your dependencies. More details inDependency Injection usage guide.

@InjectvaryourDependency:YourProtocol?

AsSingletonStorage,InjectStorage is also available.

This is a custom wrapper, you can define your ownStorage protocol implementation.

@Store(<#YourStorage#>,<#StoreKey#>)varyourProperty:YourType?= yourDefaultValueIfNeeded

AsInjectStorage,DelegatedStorage is also available with all the magic of this library.

If your property conformsCodable protocol, just addCodable keyword as prefix of your property wrapper.

• @CodableUserDefault
• @CodableKeychain
• @CodableSingleton
• @CodableStore

To avoid continually unwrapping your property, just addUnwrapped keyword as prefix of your property wrapper, assign a default value (mandatory except for@UnwrappedInject), and it will return stored value or default value, but your property will always be there for you.

• @UnwrappedUserDefault
• @UnwrappedKeychain
• @UnwrappedSingleton
• @UnwrappedInject
• @UnwrappedStore

You can also combine previous cases in case you need it, unwrapped first please.

• @UnwrappedCodableUserDefault
• @UnwrappedCodableKeychain
• @UnwrappedCodableSingleton
• @UnwrappedCodableStore

@RegistervaryourDependency:YourProtocol=YourImplementation()@RegistervaryourDependency=YourImplementation()

@RegistervaryourDependency={YourImplementation()asYourProtocol}@RegistervaryourDependency={YourImplementation()}

InjectStorage.standard.errorClosure={ errorinif caseInjectError.notFound= error{YourImplementation.register()}}

staticfunc register(@Register yourDependency:YourProtocol=YourImplementation()){}

@InjectvaryourDependency:YourProtocol?@InjectvaryourDependency:YourImplementation?@UnwrappedInjectvaryourUnwrappedDependency:YourProtocol@UnwrappedInjectvaryourUnwrappedDependency:YourImplementation

@Inject(.instance)varyourDependency:YourProtocol?@UnwrappedInject(.instance)varyourUnwrappedDependency:YourProtocol

@RegistervaryourDependency={ parametersinYourImplementation(parameters)asYourProtocol}@Inject(YourParameters())varyourDependency:YourProtocol?@UnwrappedInject(YourParameters())varyourUnwrappedDependency:YourProtocol

protocolAnimal{func sound()}@objcprotocolDog{}@objcprotocolCat{}

classDogImplementation:Animal,Dog{func sound(){print("Woof!")}}classCatImplementation:Animal,Cat{func sound(){print("Meow!")}}

@RegistervarregisterDog:Animal=DogImplementation()@RegistervarregisterCat:Animal=CatImplementation()

@UnwrappedInject(Dog.self)vardog:Animal@UnwrappedInject(Cat.self)varcat:Animaldog.sound() // prints Woof!cat.sound() // prints Meow!

// App targetclassYourImplementation:YourProtocol{}@RegistervaryourDependency:YourProtocol=YourImplementation()@InjectvaryourDependency:YourProtocol?

// Test targetclassYourMock:YourProtocol,Mock{}@RegistervaryourDependency:YourProtocol=YourMock()

@Register(group:<#DependencyGroupKey#>)varyourDependency:YourProtocol=YourImplementation()

@Inject(group:<#DependencyGroupKey#>)varyourDependency:YourProtocol?

This library is designed with Swift's modern concurrency features in mind. Access to the underlying storage mechanisms (UserDefaults, Keychain, etc.) is serialized through a global actor (StorageActor), preventing data races during read and write operations performed by the library itself.

However, for your application to be fully concurrency-safe when using this library, it is crucial thatthe types you store and retrieve areSendable.

• Generic Types: When using generic property wrappers or methods like@Store var item: MyType?,storage.value(forKey: "key") as? MyType, orstorage.decodable(forKey: "key") as? MyDecodableType, ensure thatMyType andMyDecodableType conform to theSendable protocol.
• Object Archiving: If you use methods that rely onNSKeyedArchiver (such asstorage.set(object: myNSObject, forKey: "key")), the classmyNSObject should conform toNSSecureCoding for security and also beSendable for concurrency safety.
• Why isSendable important?: While the library ensures that the act of storing or retrieving data is safe, if the data itself (e.g., a class instance) is notSendable, then passing it across different concurrent tasks or actors after retrieval can lead to data races if the data is mutable. Conforming toSendable helps Swift enforce that such types can be safely shared.

Enabling strict concurrency checking in your project's build settings (e.g., "Strict Concurrency Checking" set to "Complete" in Xcode) is highly recommended to help identify potential concurrency issues at compile time.

Talk is cheap. Show me the code.

    // Securely stored in UserDefaults.@UserDefault("username")varusername:String?    // Securely stored in Keychain.@Keychain("password")varpassword:String?    // Securely stored in a Singleton storage.@Singleton("sessionToken")varsessionToken:String?    // Securely stored in a Singleton storage.    // Always has a value, the stored or the default.@UnwrappedSingleton("refreshToken")varrefreshToken:String="B0610306-A33F"structUser:Codable{letusername:Stringletpassword:String?letsessionToken:String?}    // Codable model securely stored in UserDefaults.@CodableUserDefault("user")varuser:User?

• macOS 11.5+
• iOS 13.0+
• iPadOS 13.0+
• tvOS 13.0+
• watchOS 6.0+
• visionOS 1.0+

.package(url:"https://github.com/alexruperez/SecurePropertyStorage", from:"0.7.1")

By default, all property wrappers are installed and you canimport them, but if you want, you can install only some of them:

• UserDefault: @*UserDefault property wrappers.
• Keychain: @*Keychain property wrappers.
• Singleton: @*Singleton property wrappers.
• Storage: @*Store property wrappers.
• Inject: @*Inject property wrappers.

For more information, seethe Swift Package Manager documentation.

github "alexruperez/SecurePropertyStorage"

• Featured inDave Verwer's iOS Dev Weekly -Issue 450, thanks Dave!
• Contributions are very welcome. ThanksAlberto Garcia,Manu andChen!
• Attribution is appreciated (let's spread the word!), but not mandatory.

Alex Rupérez –@alexruperez –me@alexruperez.com

SecurePropertyStorage is available under the MIT license. See theLICENSE file for more info.