Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vpeschenkov/securedefaults
Elevate the security of your UserDefaults with this lightweight wrapper that adds a layer of AES-256 encryption
https://github.com/vpeschenkov/securedefaults
aes aes-256 aes-encryption ios macos swift swift5 userdefaults
Last synced: 13 days ago
JSON representation
Elevate the security of your UserDefaults with this lightweight wrapper that adds a layer of AES-256 encryption
- Host: GitHub
- URL: https://github.com/vpeschenkov/securedefaults
- Owner: vpeschenkov
- License: mit
- Created: 2019-04-03T17:26:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T13:37:24.000Z (6 months ago)
- Last Synced: 2024-10-25T05:54:08.651Z (20 days ago)
- Topics: aes, aes-256, aes-encryption, ios, macos, swift, swift5, userdefaults
- Language: Swift
- Homepage:
- Size: 597 KB
- Stars: 227
- Watchers: 7
- Forks: 17
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SecureDefaults for iOS, macOS
[](https://travis-ci.com/vpeschenkov/SecureDefaults)
[](https://cocoapods.org/pods/SecureDefaults)
[](https://cocoapods.org/pods/SecureDefaults)
[](https://github.com/Carthage/Carthage)
[](https://github.com/apple/swift-package-manager)
[](https://cocoapods.org/pods/SecureDefaults)
`SecureDefaults` is a wrapper over `UserDefaults/NSUserDefaults` with an extra [AES-256](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) encryption layer (key size has **256-bit** length). It encludes:
- AES-256 encryption
- Password stretching with PBKDF2
- Encrypt-then-hash HMAC
- Password salting
- Random IV
> The design and strength of all key lengths of the AES algorithm (i.e., 128, 192 and 256) are sufficient to protect classified information up to the SECRET level. TOP SECRET information will require use of either the 192 or 256 key lengths. The implementation of AES in products intended to protect national security systems and/or information must be reviewed and certified by NSA prior to their acquisition and use. [\[1\]](https://csrc.nist.gov/projects/cryptographic-standards-and-guidelines/archived-crypto-projects/aes-development)
# Table of Contents
- [Requirements](#requirements)
- [Usage](#usage)
- [Installation](#installation)
- [Acknowledgments](#acknowledgments)
- [Contributing](#contributing)
- [Author](#author)
- [License](#license)
## Requirements
- iOS 12+
- Swift 5+
## Usage
It is pretty simple to use `SecureDefaults` instead of `UserDefaults/NSUserDefaults`. In most cases, it is the same thing that is `UserDefaults`. You just need to set a password to make it work.
Replace the following code:
```swift
UserDefaults.standard
```
by this one:
```swift
let defaults = SecureDefaults.shared
// Ensures that a password has not already been set.
// Setting a password multiple times will cause the key to be regenerated,
// resulting in the loss of any previously encrypted data.
if !defaults.isKeyCreated {
defaults.password = NSUUID().uuidString // Or any password you wish
}
```
To use the app and keychain groups:
```swift
let defaults = SecureDefaults(suiteName: "app.group") // Sets a shared app group
defaults.keychainAccessGroup = "keychain.group" // Sets a shrared keychain group
if !defaults.isKeyCreated {
defaults.password = NSUUID().uuidString // Or any password you wish
}
```
`SecureDefaults` is not able to catch that any particular data is encrypted, to obtain a raw value, use the following method:
```swift
public func rawObject(forKey defaultName: String) -> Any?
```
## Installation
### [CocoaPods](https://cocoapods.org)
`SecureDefaults` is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'SecureDefaults', '1.2.2' # Swift 5.0
```
### [Carthage](https://github.com/Carthage/Carthage)
Add this to `Cartfile`
```ruby
github "vpeschenkov/SecureDefaults" == 1.2.2
```
```sh
$ carthage update
```
### [Swift Package Manager](https://github.com/apple/swift-package-manager)
Create a `Package.swift` file.
```swift
import PackageDescription
let package = Package(
name: "YourProject",
dependencies: [
.package(url: "https://github.com/vpeschenkov/SecureDefaults", "1.2.2")
],
targets: [
.target(name: "YourProject", dependencies: ["SecureDefaults"])
]
)
```
```sh
$ swift build
```
## Contributing
- If you **need help** or you'd like to **ask a general question**, open an issue.
- If you **found a bug**, open an issue.
- If you **have a feature request**, open an issue.
- If you **want to contribute**, submit a pull request.
## Acknowledgments
A big thanks to the following individuals:
- [Rob Napier](https://github.com/rnapier) - for this awesome article ["Properly Encrypting With AES With CommonCrypto"](http://robnapier.net/aes-commoncrypto)
- [Håvard Fossli](https://github.com/hfossli) - for this awesome Gist ["AES 256 in swift 4 with CommonCrypto"](https://gist.github.com/hfossli/7165dc023a10046e2322b0ce74c596f8)
## Author
Victor Peschenkov, [email protected]
## License
`SecureDefaults` is available under the MIT license. See the [LICENSE](LICENSE) file for more info.