spezistorage
Spezi module to store information and credentials encrypted at rest
Science Score: 77.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.7%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Spezi module to store information and credentials encrypted at rest
Basic Info
- Host: GitHub
- Owner: StanfordSpezi
- License: mit
- Language: Swift
- Default Branch: main
- Homepage: https://swiftpackageindex.com/StanfordSpezi/SpeziStorage/documentation/
- Size: 135 KB
Statistics
- Stars: 5
- Watchers: 11
- Forks: 0
- Open Issues: 3
- Releases: 25
Topics
Metadata Files
README.md
Spezi Storage
The Spezi Storage framework provides two Modules that enable on-disk storage of information.
The LocalStorage module can be used to store information that does not need to be encrypted.
Credentials, keys, and other sensitive information that needs to be encrypted may be stored by using the KeychainStorage module.
Setup
You need to add the Spezi Storage Swift package to your app in Xcode or Swift package.
[!IMPORTANT] If your application is not yet configured to use Spezi, follow the Spezi setup article to set up the core Spezi infrastructure.
You can configure the LocalStorage or KeychainStorage module in the SpeziAppDelegate.
[!IMPORTANT] If you use SpeziStorage on the macOS platform, ensure to add the
Keychain Access Groupsentitlement to the enclosing Xcode project via PROJECT_NAME > Signing&Capabilities > + Capability. The array of keychain groups can be left empty, only the base entitlement is required.
```swift import Spezi import SpeziLocalStorage import SpeziKeychainStorage
class ExampleDelegate: SpeziAppDelegate { override var configuration: Configuration { Configuration { LocalStorage() KeychainStorage() // ... } } } ```
You can then use the LocalStorage or KeychainStorage class in any SwiftUI view.
```swift struct ExampleStorageView: View { @Environment(LocalStorage.self) var localStorage @Environment(KeychainStorage.self) var keychainStorage
var body: some View {
// ...
}
} ```
Alternatively, it is common to use the LocalStorage or KeychainStorage module in other modules as a dependency: Spezi Module dependencies.
Local Storage
The LocalStorage module enables the on-disk storage of data in mobile applications.
The LocalStorage module defaults to storing data encrypted supported by the KeychainStorage module.
The LocalStorageKey type is used to define storage entries, and specify how data should be persisted.
Keychain Storage
The KeychainStorage module allows for the encrypted storage of small chunks of sensitive user data, such as usernames and passwords for internet services, or cryptographic keys, using Apple's Keychain documentation.
Credentials can be stored in the Secure Enclave (if available) or the Keychain. Credentials stored in the Keychain can be made synchronizable between different instances of user devices.
Handling Credentials
Use the KeychainStorage module to store a set of Credentials instances in the Keychain associated with a server that is synchronizable between different devices.
Handling Keys
Similar to Credentials instances, you can also use the KeychainStorage module to interact with cryptographic keys.
For more information, please refer to the API documentation.
The Spezi Template Application
The Spezi Template Application provides a great starting point and example using the Spezi Storage module.
Contributing
Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first.
License
This project is licensed under the MIT License. See Licenses for more information.
Owner
- Name: Stanford Spezi
- Login: StanfordSpezi
- Kind: organization
- Repositories: 1
- Profile: https://github.com/StanfordSpezi
Citation (CITATION.cff)
# # This source file is part of the Stanford Spezi open-source project # # SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md) # # SPDX-License-Identifier: MIT # cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Schmiedmayer" given-names: "Paul" orcid: "https://orcid.org/0000-0002-8607-9148" - family-names: "Ravi" given-names: "Vishnu" orcid: "https://orcid.org/0000-0003-0359-1275" - family-names: "Aalami" given-names: "Oliver" orcid: "https://orcid.org/0000-0002-7799-2429" title: "SpeziStorage" doi: 10.5281/zenodo.7804028 url: "https://github.com/StanfordSpezi/SpeziStorage"
GitHub Events
Total
- Create event: 15
- Issues event: 3
- Release event: 6
- Watch event: 1
- Delete event: 8
- Issue comment event: 16
- Push event: 86
- Pull request review comment event: 57
- Pull request review event: 57
- Pull request event: 18
- Fork event: 1
Last Year
- Create event: 15
- Issues event: 3
- Release event: 6
- Watch event: 1
- Delete event: 8
- Issue comment event: 16
- Push event: 86
- Pull request review comment event: 57
- Pull request review event: 57
- Pull request event: 18
- Fork event: 1
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Paul Schmiedmayer | P****r | 11 |
| Vishnu Ravi | v****i@g****m | 3 |
| Andreas Bauer | a****r@s****u | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 5
- Total pull requests: 31
- Average time to close issues: 4 months
- Average time to close pull requests: 3 days
- Total issue authors: 3
- Total pull request authors: 6
- Average comments per issue: 0.6
- Average comments per pull request: 1.55
- Merged pull requests: 28
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 16
- Average time to close issues: 2 days
- Average time to close pull requests: 3 days
- Issue authors: 2
- Pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 1.63
- Merged pull requests: 13
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- PSchmiedmayer (3)
- lukaskollmer (1)
- philippzagar (1)
Pull Request Authors
- lukaskollmer (13)
- Supereg (13)
- PSchmiedmayer (5)
- philippzagar (4)
- pauljohanneskraft (2)
- vishnuravi (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 25
swiftpackageindex.com: github.com/StanfordSpezi/SpeziStorage
Spezi module to store information and credentials encrypted at rest
- Homepage: https://swiftpackageindex.com/StanfordSpezi/SpeziStorage/documentation/
- Documentation: https://swiftpackageindex.com/StanfordSpezi/SpeziStorage/documentation
- License: mit
-
Latest release: 2.1.1
published 9 months ago