Repository navigation
Releases
Kotlin 1.1.0
The Kotlin version of ObscuraCrypto, for Android and the JVM (io.orlio:obscura-crypto 1.1.0, in the kotlin folder), and a command-line tool, obscura, that does the same as the Swift one. This is a separate release line from the Swift package: Swift versions keep their plain 1.x.y tags and this one is tagged kotlin-x.y.z, so Swift Package Manager does not see it.
It reads and writes the same files as the Swift package: vault headers, folder passwords, photos and videos in both media formats, and .obscura exports. Files made by one are opened by the other, and the test suite checks this in both directions against files in the repository. FORMATS.md describes every byte layout.
What is in it:
- AES-256-GCM, PBKDF2-HMAC-SHA256 at 600,000 rounds for vaults and exports and 100,000 for folders, using only the platform's own crypto. It is tested with both the JDK's providers and Conscrypt, the one Android uses.
- An Android app can install a faster PBKDF2 once at start-up. The library checks it against its own before accepting it.
- Keys are zeroed when closed, and a closed key refuses to be used again.
- A reader and writer for
.obscuraexports, with limits on what a hostile export can make the reader allocate or recurse into. - Gradle's wrapper and every dependency are pinned by checksum.
Without a Mac: VERIFYING.md has a section on checking an Android vault's files with the command-line tool.
What it does not protect against is written down: the README says file headers are not sealed, and the SecureBytes documentation says the JVM cannot promise a key was never copied in memory before it was zeroed.
Used by Obscura Photo Vault for Android.
1.0.1
Encrypting and decrypting large files now uses a small, fixed amount of memory, whatever the file size. Before, memory could grow with the file being processed.
No change to the file format, keys or output: files written by 1.0.0 and 1.0.1 read the same way, and the existing compatibility tests pass unchanged.
Used by Obscura Photo Vault for iOS from version 1.16.0.
1.0.0
First public release.
The encryption used by Obscura Photo Vault for iOS from version 1.14.0:
- password key derivation (PBKDF2-HMAC-SHA256, 600,000 rounds)
- the vault file header and key hierarchy
- photo and video encryption (AES-256-GCM)
- the second layer for password-protected folders
- reading encrypted .obscura backup files
It includes the obscura command-line tool, tests that open files made by the app, and VERIFYING.md, a step-by-step guide to checking the files on your own iPhone against this code.
Licensed under GPL-3.0-or-later. Please report security issues privately, as described in SECURITY.md.