Changelog History
Page 1
-
v0.13.6 Changes
November 23, 2020This is a hotfix for Apple platforms: ObjCThemis and SwiftThemis , running on iOS and macOS, when installed via Carthage or CocoaPods.
themis
pod is now restored to use dynamic linkage again- Resolved errors related to
@rpath
when using CocoaPods - β Removed
arm64e
architecture slice from Carthage builds for iOS which prevented CocoaPods from functioning correctly
Code:
Objective-C / Swift
-
v0.13.5 Changes
November 12, 2020This is a hotfix for Apple platforms: ObjCThemis and SwiftThemis , running on macOS, when installed via Carthage.
iOS platform is not affected. Installations via CocoaPods are not affected too. You can continue using Themis 0.13.4 there.
- π Resolved issues with deploying macOS apps with Apple Silicon support when Themis is installed via Carthage
Code:
Objective-C / Swift
- Fixed code signing issues on macOS with Xcode 12 (#744).
-
v0.13.4 Changes
October 29, 2020This is a hotfix for Apple platforms: ObjCThemis and SwiftThemis , running on iOS and macOS, installed via Carthage or CocoaPods.
- π Resolved critical issues with App Store deployment (see #715)
- π Resolved issues with stable Xcode 12 support (disabled arm64 builds for iOS Simulator)
- π Improved Apple Silicon support (arm64 builds for macOS with Xcode 12.2 beta)
- β‘οΈ Updated OpenSSL to the latest 1.1.1h
- 0οΈβ£ CocoaPods is now using OpenSSL 1.1.1h by default (again)
Note that this hotfix is not compatible with Xcode 11. (Future releases of Themis will also require Xcode 12+) If you are using Xcode 11, please use older versions of Themis:
- CocoaPods:
pod 'themis', '0.13.0'
- Carthage:
github "cossacklabs/themis" "0.13.0"
π See #715, #725 for details.
Code:
Objective-C / Swift
-
v0.13.3 Changes
October 12, 2020π Hotfix for Themis CocoaPods and Xcode12:
- 0οΈβ£ Default Themis podspec is using OpenSSL 1.0.2u again ("themis/themis-openssl"). OpenSSL 1.1.1g podspec ("themis/openssl") might be broken for Xcode12, fixing is in progress. BoringSSL podspec ("themis/themis-boringssl") is available too.
Code:
Objective-C / Swift
- Themis CocoaPods podspec is updated with bitcode fixes and disabling arm64 simulator in order to support Xcode12 builds. This is a podspec change only, no changes in code, headers or whatsoever. Default podspec is set as "themis/themis-openssl", which uses OpenSSL 1.0.2u. Fixes for "themis/openssl" podspec (OpenSSL 1.1.1g) might arrive soon.
-
v0.13.2 Changes
August 14, 2020π Hotfix for Carthage, removing dysfunctional
ObjCThemis.xcodeproj
.π₯ Breaking changes and deprecations:
- ObjCThemis framework built by Carthage is now called
themis.framework
once again.
Code:
Objective-C
π₯ Breaking changes
-
ObjCThemis framework built by Carthage is now called
themis.framework
once again (#704).ObjCThemis 0.13.0 has initiated renaming of the framework produced by Carthage into
objcthemis.framework
from its historical namethemis.framework
. This decision has been a mistake. More information is available in the pull request linked above.π
objcthemis.framework
is removed and should not be used.Please continue linking your applications to
themis.framework
. Note as well that starting with ObjCThemis 0.13.1, you do not have to embedopenssl.framework
anymore when ObjCThemis is installed via Carthage. - ObjCThemis framework built by Carthage is now called
-
v0.13.1 Changes
August 13, 2020TL;DR:
- AndroidThemis is now available on JCenter
- β‘οΈ ObjCThemis and SwiftThemis get latest OpenSSL update
- ObjCThemis and SwiftThemis now require Xcode 11 (or later)
- π Minor security fixes in GoThemis, JsThemis, WasmThemis
Code:
Core
- Improved compatibility with OpenSSL 1.1.1 (#684).
Android
- AndroidThemis is now available on JCenter (#679).
Go
- Fixed panics on 32-bit systems when processing corrupted data (#677).
- Improved GoThemis package README and documentation (#699).
Node.js
- Minor dependency updates making the world a better place (#680).
WebAssembly
- Minor dependency updates making the world a better place (#680).
Swift
- Updated OpenSSL to the latest 1.1.1g (#692).
Objective-C
- Updated OpenSSL to the latest 1.1.1g (#692).
Infrastructure:
-
v0.13.0 Changes
July 08, 2020TL;DR:
- β Added API for generating symmetric keys for use with Secure Cell.
- β Added API for Secure Cell encryption with human-readable passphrases.
- π New supported platforms: Kotlin, Swift 5, iPadOS.
- π Updated look-and-feel of the documentation.
- π Squished many tricky bugs and added whole lot of extra security checks.
π₯ Breaking changes and deprecations:
- π Many languages received Secure Cell API overhaul with parts of the old API becoming deprecated. Refer to individual language sections for details.
- ObjCThemis installed via Carthage is now called
objcthemis
instead of justthemis
(read more). - 0οΈβ£ Themis 0.9.6 compatibility is now disabled by default (read more).
- Themis is known to be broken on big-endian architectures (read more).
- π Java 7 is no longer supported, breaking Android and Java builds on outdated systems (read more).
- π Python 2 is no longer supported (read more).
- π Serialisation of Secure Session state in JavaThemis is now deprecated (read more).
Code:
Core
- Added support for building with sanitizers like ASan and UBSan,
enabled by
WITH_ASAN=1
flags (#548, #556). - Fixed a number of possible use-after-free conditions (#546).
- Themis Core is now compiled with
-O2
optimizations enabled by default (#543). - Themis Core is now compiled with even more paranoid compiler flags (#578).
- Fixed various edge-case correctness issues pointed out by sanitizers, clang-tidy, and compiler warnings (#540, #545, #554, #570, #597, #613).
- Improved memory wiping, making sure that sensitive data doesn't stay in memory longer than absolutely necessary (#584, #585, #586, #612).
- Soter (low-level security core used by Themis)
- New function
soter_pbkdf2_sha256()
can be used to derive encryption keys from passphrases with PBKDF2 algorithm (#574). - Key generation
- New function
themis_gen_sym_key()
can be used to securely generate symmetric keys for Secure Cell (#560). - Secure Cell
- New functions:
themis_secure_cell_encrypt_seal_with_passphrase()
themis_secure_cell_decrypt_seal_with_passphrase()
provide Seal mode API that is safe to use with passphrases (#577, #582, #640).
- Secure Session
- Fixed serialization issue in
secure_session_save()
andsecure_session_load()
methods (#658). - Breaking changes
- Secure Cell compatibility with Themis 0.9.6 is now disabled by default (#614).
Old versions of Themis have been calculating encrypted data length incorrectly, which made Secure Cells encrypted on 64-bit machines impossible to decrypt on 32-bit machines (see #279 for details).
Themis 0.10 and later versions include a fix for that issue and a compatiblity workaround that allows to decrypt data encrypted by Themis 0.9.6 on 64-bit platforms. This workaround was enabled by default and could be disabled by setting the
NO_SCELL_COMPAT
varible.Since Themis 0.13 the workaround for Themis 0.9.6 compatibility is disabled by default (as it has performance implications). It can be enabled if needed by compling with
WITH_SCELL_COMPAT
.We are planning to remove the workaround completely after Themis 0.9.6 reaches end-of-life in December 2020. Please use this time to migrate existing data if you have been using Themis 0.9.6. To migrate the data, decrypt it and encrypt it back with the latest Themis version.
Themis has never committed to supporting machines with big-endian architectures. However, it was expected to accidentally work to some degree on such machines, with certain compatibility restrictions on interaction with little-endian machines.
Recent changes in Themis Core are known to introduce compatibility issues on big-endian architectures. If you believe you are affected by this change, please reach out to us via [email protected].
- Added support for building with sanitizers like ASan and UBSan,
enabled by
Android
See also: Java API updates.
- Kotlin is now officially supported language on Android (#637).
- Fixed a crash when decrypting corrupted Secure Cell data (#639).
- Updated embedded BoringSSL to the latest version (#643).
Fixed broken
SecureSession#save
andSecureSession#restore
methods (#658).Breaking changes
- Android build now uses Gradle 5.6 and requires Java 8 (#633).
It is no longer possible to build AndroidThemis with Java 7. Please upgrade to Java 8 or later version.
Deprecations
- Unqualified Gradle targets are now deprecated (#633).
To build Themis for Android, run
./gradlew :android:assembleRelease
instead of
./gradlew assembleRelease
The unqualified form still works for now, but may break in future releases.
- C++
Secure Cell API updates (#588)
- ThemisPP now supports passphrase API of Secure Cell in Seal mode:
#include <themispp/secure_cell.hpp> auto cell = themispp::secure_cell_seal_with_passphrase("string"); uint8_t[] plaintext = "message"; std::vector<uint8_t> encrypted = cell.encrypt(plaintext); std::vector<uint8_t> decrypted = cell.decrypt(encrypted);
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (
themispp::secure_cell_seal
and other modes) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated bythemispp::gen_sym_key()
(#561). Use passphrase API with human-readable passphrases.- All modes of Secure Cell get a new initialisation API to avoid ambiguity over whether Secure Cell is secured with a passphrase or a master key (since both are effectively byte arrays in C++):
themispp::secure_cell_seal_with_key(master_key)
themispp::secure_cell_token_protect_with_key(master_key)
themispp::secure_cell_context_imprint_with_key(master_key)
New API has additional benefits:
- broader range of input types is accepted, including STL-compatible containers such as
std::vector
,std::array
,std::span
, C arrays, etc. - Token Protect API is much easier to use
- Secure Cell is now thread-safe
- Deprecated API
The following classes are deprecated:
themispp::secure_cell_seal_t
themispp::secure_cell_token_protect_t
themispp::secure_cell_context_imprint_t
They should be replaced with their
_with_key
counterparts. In most cases migration should be a trivial renaming but there are caveats with Token Protect mode and iterator usage. Please see #588 for details.New function
themispp::gen_sym_key()
can be used to generate symmetric keys for Secure Cell (#561, #576).Updated test suite to test C++14 and C++17 (in addition to C++11 and C++03) (#572).
Breaking changes
get_pub_key_by_id()
method ofsecure_session_callback_interface_t
now has to return non-const vector (#540).
Change your implementation like this:
-const std::vector<uint8_t> get_pub_key_by_id(const std::vector<uint8_t>& id) override +std::vector<uint8_t> get_pub_key_by_id(const std::vector<uint8_t>& id) override { // ... }
- Go
New function
keys.NewSymmetricKey()
can be used to generate symmetric keys for Secure Cell (#561).Improved
ThemisError
introspection: added error constants, numeric error codes (#622).Secure Cell API updates:
- New API with improved usability and consistent naming (#624).
func SealWithKey(key *keys.SymmetricKey) (*SecureCellSeal, error) func (sc *SecureCellSeal) Encrypt(plaintext, context []byte) ([]byte, error) func (sc *SecureCellSeal) Decrypt(encrypted, context []byte) ([]byte, error) func TokenProtectWithKey(key *keys.SymmetricKey) (*SecureCellTokenProtect, error) func (sc *SecureCellTokenProtect) Encrypt(plaintext, context []byte) (encrypted, token []byte, error) func (sc *SecureCellTokenProtect) Decrypt(encrypted, token, context []byte) ([]byte, error) func ContextImprintWithKey(key *keys.SymmetricKey) (*SecureCellContextImprint, error) func (sc *SecureCellContextImprint) Encrypt(plaintext, context []byte) ([]byte, error) func (sc *SecureCellContextImprint) Decrypt(encrypted, context []byte) ([]byte, error)
This API is less ambiguous and more convenient to use.
- GoThemis now supports passphrase API in Seal mode (#625).
scell, err := cell.SealWithPassphrase("secret") if err != nil { return err } encrypted, err := scell.Encrypt([]byte("message"), nil) if err != nil { return err } decrypted, err := scell.Decrypt(encrypted, nil) if err != nil { return err }
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (
cell.SealWithKey()
orcell.New()
) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated bykeys.NewSymmetricKey()
(#561). Use passphrase API with human-readable passphrases.Deprecated API
- Run-time mode-setting for Secure Cell is deprecated (#624).
Please use new constructors
cell.SealWithKey()
instead ofcell.New()
andcell.ModeSeal...
constants. Encryption is now performed withEncrypt()
method instead ofProtect()
. For decryption useDecrypt()
instead ofUnprotect()
.Old API is retained for compatibility.
- π iOS and macOS
New function
TSGenerateSymmetricKey()
(available in Objective-C and Swift) can be used to generate symmetric keys for Secure Cell (#561).Mac Catalyst is explicitly disabled (#598).
Improved test coverage of platforms (#599, #607, #610, #642).
SwiftThemis is now tested with Swift 5 (#605).
iPadOS is now officially supported target for ObjCThemis (#641).
Secure Cell API updates:
- New encryption/decryption API with consistent naming:
encrypt
anddecrypt
(#606). - Improved Token Protect API (#606):
- Encryption results use
NSData
now which bridges with SwiftData
directly. - Decryption no longer requires an intermediate
TSCellTokenEncryptedData
object.
- Encryption results use
- ObjCThemis now supports passphrase API of in Seal mode (#609).
In Swift:
let cell = TSCellSeal(passphrase: "secret") let encrypted = try cell.encrypt("message".data(using: .utf8)!) let decrypted = try cell.decrypt(encrypted)
In Objective-C:
TSCellSeal *cell = [[TSCellSeal alloc] initWithPassphrase:@"secret"]; NSData *encrypted = [cell encrypt:[@"message" dataUsingEncoding:NSUTF8StringEncoding]]; NSData *decrypted = [cell decrypt:encrypted];
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (
TSCellSeal(key: ...)
orinitWithKey:...
) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated byTSGenerateSymmetricKey()
(#561). Use passphrase API with human-readable passphrases.- New encryption/decryption API with consistent naming:
Deprecated API
- Secure Cell wrapData/unwrapData renamed into encrypt/decrypt (#606).
As a result, the following methods are deprecated. There are no plans for their removal.
Swift ModeDeprecationReplacement TSCellSeal wrap(:, context:)wrap encrypt(:, context:)encrypt unwrapData(:, context:)unwrapData decrypt(:, context:)decrypt TSCellToken wrap(:, context:)wrap encrypt(:, context:)encrypt unwrapData(:, context:)unwrapData decrypt(:, token:, context:)decrypt(:, token:) TSCellContextImprint wrap(:, context:)wrap encrypt(:, context:)encrypt unwrapData(:, context:)unwrapData decrypt(_:, context:)decrypt
Objective-C ModeDeprecationReplacement TSCellSeal wrapData:context:error:wrapData:error: encrypt:context:error:encrypt:error: unwrapData:context:error:unwrapData:error: decrypt:context:error:decrypt:error: TSCellToken wrapData:context:error:wrapData:error: encrypt:context:error:encrypt:error: unwrapData:context:error:unwrapData:error: decrypt:token:context:error:decrypt:token:error: TSCellContextImprint wrapData:context:error:wrapData:error: encrypt:context:error:encrypt:error: unwrapData:context:error:unwrapData:error: decrypt:context:error:decrypt:error:
Breaking changes
- ObjCThemis framework built by Carthage is now called
objcthemis.framework
(#604).
We have renamed the Carthage framework from
themis.framework
toobjcthemis.framework
in order to improve compatibility with CocoaPods and avoid possible import conflicts with Themis Core.β οΈ Please migrate to
objcthemis.framework
in a timely manner.themis.framework
is deprecated since Themis 0.13 and will be removed in the next release due to maintainability issues.βΉοΈ Installations via CocoaPods are not affected. If you get Themis via CocoaPods then no action is necessary.
Migration instructions (click to reveal)
After upgrading to Themis 0.13 and running
carthage update
you will notice that two Themis projects have been built:*** Building scheme "OpenSSL (iOS)" in OpenSSL.xcodeproj *** Building scheme "ObjCThemis (iOS)" in ObjCThemis.xcodeproj *** Building scheme "Themis (iOS)" in Themis.xcodeproj
Your project is currently using βThemisβ. In order to migrate to βObjCThemisβ you need to do the following:
- update `#import` statements in code (for Objective-C only) - link against `objcthemis.framework` in Xcode project - remove link to `themis.framework` in Xcode project
Use the new syntax to import ObjCThemis in Objective-C projects:
// NEW: #import <objcthemis/objcthemis.h> // old and deprecated: #import <themis/themis.h>
The new syntax is now the same as used by CocoaPods.
If you are using Swift, the import syntax is unchanged:
import themis
After updating imports you also need to link against the new framework (regardless of the language).
- ObjCThemis framework built by Carthage is now called
1. Add `objcthemis.framework` to your project (can be found in `Carthage/Build/iOS` or `Mac`). 2. For each Xcode target: 1. Open **General** tab, **Frameworks and Libraries** section 2. Drag `objcthemis.framework` there. Select _Embed & Sign_ if necessary. 3. Remove `themis.framework` from dependencies. 3. Finally, remove `themis.framework` reference from the project. Migration is complete, your project should build successfully now. We are sorry for the inconvenience. </details>
Java
- JDK location is now detected automatically in most cases, you should not need to set JAVA_HOME or JDK_INCLUDE_PATH manually (#551).
- JNI libraries are now available as
libthemis-jni
packages for supported Linux systems (#552, #553). - Fixed a NullPointerException bug in
SecureSocket
initialisation (#557). - Some Themis exceptions have been converted from checked
Exception
to uncheckedRuntimeException
, relaxing requirements forthrows
specifiers (#563). - Introduced
IKey
interface with accessors to raw key data (#564). - New class
SymmetricKey
can be used to generate symmetric keys for Secure Cell (#565). - It is now possible to build desktop Java with Gradle.
Run
./gradlew :desktop:tasks
to learn more (#633). - Kotlin is now officially supported language for JavaThemis (#637).
- Fixed broken
SecureSession#save
andSecureSession#restore
methods (#658). - Java source code is now ASCII-only for improved compatibility (#655).
- Secure Cell API updates:
- New encryption/decryption API with consistent naming:
encrypt
anddecrypt
(#634). Improved Token Protect API (#634).
- Decryption no longer requires an intermediate
SecureCellData
object. SecureCellData
can now be destructured in Kotlin (#638).
// You can now write like this: val (encrypted, authToken) = cellTP.encrypt(message, context) // Instead of having to spell it out like this: val result = cellTP.protect(context, message) val encrypted = result.protectedData val authToken = result.additionalData
- Decryption no longer requires an intermediate
Secure Cell mode can now be selected by instantiating an appropriate interface:
| New API | Old API | | ------- | ------- | |
SecureCell.SealWithKey(key)
|new SecureCell(key, SecureCell.MODE_SEAL)
| |SecureCell.SealWithPassphrase(passphrase)
| not available | |SecureCell.TokenProtectWithKey(key)
|new SecureCell(key, SecureCell.MODE_TOKEN_PROTECT)
| |SecureCell.ContextImprintWithKey(key)
|new SecureCell(key, SecureCell.MODE_CONTEXT_IMPRINT)
|- JavaThemis now supports passphrase API of in Seal mode (#635).
In Kotlin:
import com.cossacklabs.themis.SecureCell val cell = SecureCell.SealWithPassphrase("secret") val message = "message".toByteArray() val encrypted = cell.encrypt(message) val decrypted = cell.decrypt(encrypted) assertArrayEquals(decrypted, message)
In Java:
import com.cossacklabs.themis.SecureCell; SecureCell.Seal cell = SecureCell.SealWithPassphrase("secret"); byte[] message = "message".getBytes(StandardCharsets.UTF_8); byte[] encrypted = cell.encrypt(message); byte[] decrypted = cell.decrypt(encrypted); assertArrayEquals(decrypted, message);
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing symmetric key API (
SecureCell.SealWithKey(...)
ornew SecureCell(...)
) should not be used with passphrases or passwords. Use symmetric key API with symmetric encryption keys, such as generated bySymmetricKey
(#565). Use passphrase API with human-readable passphrases.- Deprecated API
- Secure Cell has received API overhaul which deprecates old API (#636).
The following items are deprecated:
- Constructors: - `new SecureCell(int mode)` - `new SecureCell(byte[] key)` - `new SecureCell(byte[] key, int mode)` - `new SecureCell(String password)` β οΈ **not recommended, insecure** - `new SecureCell(String password, int mode)` β οΈ **not recommended, insecure** - Methods: - `protect(byte[] key, byte[] context, byte[] data)` - `protect(byte[] constext, byte[] data)` - `protect(String password, String context, byte[] data)` β οΈ **not recommended, insecure** - `protect(String context, byte[] data)` - `unprotect(byte[] key, byte[] context, SecureCellData protected)` - `unprotect(byte[] context, SecureCellData protected)` - `unprotect(String password, String context, SecureCellData protected)` β οΈ **not recommended, insecure** - `unprotect(String context, SecureCellData protected)` - Constants: - `SecureCell.MODE_SEAL` - `SecureCell.MODE_TOKEN_PROTECT` - `SecureCell.MODE_CONTEXT_IMPRINT`
Some methods are not secure when used with short passphrases, consider using new passphrase API instead. Other methods have easier to use replacements in the new API, consider using them instead.
Deprecated API is still supported, there are no plans for its removal.
-
SecureSession
methodssave
andrestore
are now deprecated (#659).
An improved API for serialisation might appear in some next version of JavaThemis. For now, please refrain from using
SecureSession#save
andSecureSession#restore
which may be removed in the future.Node.js
- New class
SymmetricKey
can be used to generate symmetric keys for Secure Cell (#562). - New makefile target
make jsthemis
can be used to build JsThemis from source (#618). SecureCell
now allowsnull
to explicitly specify omitted encryption context (#620).SecureMessage
now allowsnull
for omitted keys in sign/verify mode (#620).- Fixed a crash when an exception is thrown from
SecureSession
callback (#620). - Node.js v14 is now supported (#654).
- Passphrase API support in Secure Cell (#621).
JsThemis now supports passphrase API of Secure Cell in Seal mode:
const themis = require('jsthemis') let cell = themis.SecureCellSeal.withPassphrase('secret') let encrypted = cell.encrypt(Buffer.from('message data')) let decrypted = cell.decrypt(encrypted)
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (available as
themis.SecureCellSeal.withKey(...)
) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated bySymmetricKey
(#562). Use passphrase API with human-readable passphrases.- Deprecated API
- Secure Cell construction with
new
is deprecated (#621).
Passphrase API makes it ambiguous whether a Secure Cell is initialised with a master key or a passphrase. All Secure Cell classes β
SecureCellSeal
,SecureCellTokenProtect
,SecureCellContextImprint
β get a static factory methodwithKey
to reduce the ambiguity. Please use it instead:// NEW, write like this: let cell = themis.SecureCellSeal.withKey(secret) // old, avoid this: let cell = new themis.SecureCellSeal(secret)
new
constructors are not recommended for use but they are still supported and will always work with master keys, as they did before.- New class
PHP
- New function
phpthemis_gen_sym_key()
can be used to generate symmetric keys for Secure Cell (#561). - Resolved PHP Composer checksum issues once and for all (#566, #567).
- PHPThemis now supports passphrase API of Secure Cell in Seal mode (#594, #601).
$encrypted = phpthemis_scell_seal_encrypt_with_passphrase('passphrase', 'message'); $decrypted = phpthemis_scell_seal_decrypt_with_passphrase('passphrase', $encrypted);
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (
phpthemis_scell_seal_{encrypt,decrypt}
and other modes) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated byphpthemis_gen_sym_key()
(#561). Use passphrase API with human-readable passphrases.- New function
Python
- Fixed compatibility issues on 32-bit platforms (#555).
- New function
skeygen.GenerateSymmetricKey()
can be used to generate symmetric keys for Secure Cell (#561). - PyThemis now supports passphrase API of Secure Cell in Seal mode (#596).
from pythemis.scell import SCellSeal cell = SCellSeal(passphrase='my passphrase') encrypted = cell.encrypt(b'message data') decrypted = cell.decrypt(encrypted)
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (
SCellSeal(key=...)
) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated byGenerateSymmetricKey()
(#561). Use passphrase API with human-readable passphrases.- Python 2 is no longer supported (#648).
Python 2 had reached EOL on 2020-01-01.
In fact, we are not making any changes in this release that break compatibility, but we no longer officially support it. This means that we do not run any CI tests for Python 2, and in the future we will develop code compatible only with Python 3+.
π Ruby
- New function
Themis::gen_sym_key()
can be used to generate symmetric keys for Secure Cell (#561). - Secure Cell API updates (#603).
- RbThemis now supports passphrase API of Secure Cell in Seal mode:
require 'rbthemis' cell = Themis::ScellSealPassphrase.new('secret string') encrypted = cell.encrypt('message data') decrypted = cell.decrypt(encrypted)
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (
Themis::Scell...
) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated byThemis::gen_sym_key
(#561). Use passphrase API with human-readable passphrases.- Secure Cell mode can now be selected by instantiating an appropriate subclass:
| New API | Old API | | ------- | ------- | |
Themis::ScellSeal.new(key)
|Themis::Scell.new(key, Themis::Scell::SEAL_MODE)
| |Themis::ScellSealPassphrase.new(passphrase)
| not available | |Themis::ScellTokenProtect.new(key)
|Themis::Scell.new(key, Themis::Scell::TOKEN_PROTECT_MODE)
| |Themis::ScellContextImprint.new(key
|Themis::Scell.new(key, Themis::Scell::CONTEXT_IMPRINT_MODE)
|Themis::Scell
class is deprecated and should be replaced with new API.- Token Protect mode now accepts encrypted data and token as separate arguments instead of requiring an array:
decrypted = cell.decrypt([encrypted, token], context) # old decrypted = cell.decrypt(encrypted, token, context) # new
(Arrays are still accepted for compatibility but this API is deprecated.)
- New function
Rust
- New object
themis::keys::SymmetricKey
can be used to generate symmetric keys for Secure Cell (#561, #631). - Significantly reduced compilation time by removing
bindgen
crate from dependencies (#626). - Bindgen 0.54.1 or later is now required for RustThemis development (#664).
- Passphrase API support in Secure Cell (#630).
RustThemis now supports passphrase API of Secure Cell in Seal mode:
use themis::secure_cell::SecureCell; let cell = SecureCell::with_passphase("secret")?.seal(); let encrypted = cell.encrypt(b"message data")?; let decrypted = cell.decrypt(&encrypted)?;
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (available as
SecureCell::with_key(...)
) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated bythemis::keys::SymmetricKey
(#561). Use passphrase API with human-readable passphrases.- New object
WebAssembly
- New class
SymmetricKey
can be used to generate symmetric keys for Secure Cell (#561). - Fixed an issue with webpack Terser plugin (#568).
- Updated Emscripten toolchain to the latest version (#550, #569, #602, #653).
- Updated embedded BoringSSL and other dependencies to the latest versions (#608, #643).
- Node.js v14 is now supported (#654).
- Passphrase API support in Secure Cell (#616).
WasmThemis now supports passphrase API of Secure Cell in Seal mode:
const themis = require('wasm-themis') let cell = themis.SecureCellSeal.withPassphrase('secret') let encrypted = cell.encrypt(Buffer.from('message data')) let decrypted = cell.decrypt(encrypted)
You can safely and securely use short, human-readable passphrases as strings with this new API.
Existing master key API (available as
themis.SecureCellSeal.withKey(...)
) should not be used with passphrases or passwords. Use master key API with symmetric encryption keys, such as generated bySymmetricKey
(#561). Use passphrase API with human-readable passphrases.- Deprecated API
- Secure Cell construction with
new
is deprecated (#616).
Passphrase API makes it ambiguous whether a Secure Cell is initialised with a master key or a passphrase. All Secure Cell classes β
SecureCellSeal
,SecureCellTokenProtect
,SecureCellContextImprint
β get a static factory methodwithKey
to reduce the ambiguity. Please use it instead:// NEW, write like this: let cell = themis.SecureCellSeal.withKey(secret) // old, avoid this: let cell = new themis.SecureCellSeal(secret)
new
constructors are not recommended for use but they are still supported and will always work with master keys, as they did before.- New class
π Docs:
- π New improved design and structure of Themis documentation.
- β‘οΈ Updated templates for GitHub issues and pull requests (#549).
- π Miscellaneous quality improvements in various pieces of documentation (#558, #575, #581, #587, #590).
- Clarified information on data privacy regulations (#593).
- β Removed last surviving links to deprecated GitHub Wiki (#589).
Infrastructure:
- π Changed name of the tarball produced by
make dist
tothemis_X.Y.Z.tar.gz
(#544). - π Fixed Doxygen support (#559).
- π Automated benchmarking harness is now tracking Themis performance.
See
benches
(#580, #582). - Automated regular fuzzing of the code with AFL (#579, #583).
- β Added automated tests for all code samples in documentation, ensuring they are always up-to-date (#600).
- β All 13 supported platforms are verified on GitHub Actions, along with existing CircleCI and Bitrise tests (#600).
- π New Makefile targets:
make jsthemis
builds JsThemis from source (#618).
- Resolved issues with library search paths on CentOS
when Themis Core is built from source and installed with
make install
(#645. - Resolved issues with library search paths on Debian when Themis Core is installed from packages (#651).
- π Introduced
./configure
script to significantly improve rebuild performance (#611, #628). - π Improved package installation testing and platform coverage (#595, #650).
β‘οΈ Miscellaneous minor improvements and updates in the build system (#542, #573, #615, #617, #629, #627, #632, #644, #646, #649, #656).
π New supported platforms
- CentOS 8 is now fully fully supported.
- Ubuntu 20.04 βFocal Fossaβ is now fully fully supported.
- GoThemis is now tested with Go 1.14 (#595).
- SwiftThemis is now tested with Swift 5 (#605).
- Kotlin API of JavaThemis is now verified by all CI platforms (#637).
- iPadOS is now officially supported target for ObjCThemis (#641).
- Node.js v14 is now supported for JsThemis and WasmThemis (#654).
π₯ Breaking changes
- Java 7 is no longer supported (#633).
Updates in Gradle build infrastructure require Java 8.
- Debian 8 βJessieβ is no longer supported (#633).
This version is no longer maintained by the Debian team and it lacks Java 8. We no longer provide binary packages for this distribution.
- Python 2 is no longer supported (#648).
Python 2 had finally reached EOL on 2020-01-01. PyThemis 0.13 is the last version guaranteed to be compatible with Python 2.
-
v0.12.2 Changes
December 19, 2019Fixed an issue in WasmThemis which caused an error when packaging with webpack (#568).
-
v0.12.1
September 26, 2019 -
v0.12.0 Changes
September 25, 2019TL;DR:
- β Added WasmThemis to support WebAssembly (works with Electron and Node.js);
- β added experimental support for Windows (using MSYS2 compiler and NSIS installer);
- β added support of Go Modules;
- β added package for ThemisPP;
- β added support for Node.js v12 LTS (in addition to v10 and v8) in jsThemis;
- β added extra safety checks and fixes for tricky bugs.
π₯ Breaking changes:
- π§ Linux: when building from sources, the default installation path of Themis Core library has been changed from
/usr
to/usr/local
. If youβre affected, read the instructions on how to make a clean upgrade below. - Go: some of GoThemis APIs have been renamed to comply with Go naming convention (old API are marked as deprecated and will be removed in the next release). If youβre using Go β please switch to new functions.
- π Ruby: deprecated
rubythemis
gem has been completely removed in favour ofrbthemis
.
Code:
Core
- Soter (low-level security core used by Themis)
Improved security and code quality, implemented better handling of secrets and memory management. These changes decrease the chance of potential memory leaks.
- Introduced new internal function:
soter_wipe()
. It can be used to securely wipe sensitive data from memory after it's no longer needed. All Themis cryptosystems now use this new API (#488). - Improved usage and error handling of OpenSSL/BoringSSL PRNGs. Thank you, @veorq for bringing up this issue (#485).
- Improved memory safety and fixed potential corner-case issues in OpenSSL/BoringSSL usage. Thanks, @outspace for identifying these issues (#501, #524, #525, #535).
- Key generation
- Improved key validity checks across all Themis cryptosystems. Now itβs harder to use wrong keys or misuse them (#486).
- Improved error handling for EC key generator that could produce an invalid public key without returning an error. Thanks, @vixentael for finding this issue (#500).
- Secure Cell
- Improved handling of edge cases with large data buffers (#496, #497).
- Improved performance of Secure Cell's encryption/decryption (#496).
- Library ABI
- Themis shared libraries now have a formal ABI version. This ensures that no compatibility issues arise if we ever need to introduce breaking changes in the ABI (#454).
- Removed private symbols from public export lists. Themis has been accidentally exporting various private utility functions. Private functions not intended for public use are now hidden (#458, #472).
- Installation & packaging
- Themis now installs to
/usr/local
by default when building from source on Linux (#448).
This may be a breaking change if your system has non-standard precedence rules. If you install Themis from source code directly, please do a clean upgrade the following way:
make uninstall PREFIX=/usr make install PREFIX=/usr/local
Please consider using binary repositories to install Themis. If your system or package manager is not supported yet, please let us know via [email protected].
- Themis packages now support multiarch installations (#512).
Multiarch enables parallel installation of 32-bit and 64-bit versions of the library. This is particularly important on CentOS where some tools like pkg-config would fail to locate Themis due to non-standard installation path.
- Updated Makefile to support a number of standard GNU variables like
libdir
(#453, #455). - Improved accuracy of package dependencies to make sure you don't have to install anything manually after installing Themis from package repositories (#446).
- NSIS installer is now available for Windows. To build NSIS installer, use
make nsis_installer
command in MSYS2 environment. You can read more about MSYS2 target here (#474). - Dependency updates
- Embedded BoringSSL submodule has been updated to the latest upstream version (#528).
- Only the necessary parts of embedded BoringSSL are now built, leading to 2x build speedup (#447).
- Other changes
- Miscellaneous improvements and cleanups in the Makefile (#450, #451, #452, #459, #523, #527).
- Core libraries are now linked dynamically to test binaries (#460).
Android
C++
- ThemisPP is now available as a system package through Cossack Labs repositories (#506).
Use
libthemispp-dev
for Debian and Ubuntu,libthemispp-devel
for CentOS.
Go
- Breaking changes
- Some APIs have been renamed to conform with the Go naming conventions (#424).
The old names are now deprecated and scheduled for removal in the next release. Please migrate to using the new names when you upgrade.
| Old API | New API | | -------------------------------------- | -------------------------- | |
cell.CELL_MODE_SEAL
|cell.ModeSeal
| |compare.COMPARE_MATCH
|compare.Match
| |keys.KEYTYPE_EC
|keys.TypeEC
| |session.STATE_ESTABLISHED
|session.StateEstablished
| |(*session.SecureSession) GetRemoteId
|GetRemoteID
|- GoThemis is now compatible with Go 1.11 modules starting with this release. For example, you are now able to pin a specific version of GoThemis in your projects (#505).
π iOS, macOS
Java
- JNI wrapper for desktop Java does not require a separate installation of Themis Core from now on (#450).
Node.js
PHP
- Updated PHP installer to use the latest Composer version (#519).
π Ruby
- Breaking changes
rubythemis
gem has been completely removed after being deprecated in Themis 0.11. Please userequire 'rbthemis'
in your projects (#508).
Rust
- Minor internal code style modernizations (#466).
WebAssembly
- WasmThemis brings Themis to Web using WebAssembly. Thank you to @ilammy for adding it.
WasmThemis supports the full functionality of other Themis wrappers: Secure Cell, Secure Message, Secure Session, and Secure Comparator. WasmThemis package is available via npm as
wasm-themis
, sample code can be found in docs/examples/js, and the How-To guide is available on the documentation server (#457, #461, #462, #473, #482, #489, #490, #491, #492,#494, #495, #498, #507, #513).π Windows
- It is now possible to compile Themis Core for Windows using MSYS2 environment. See the instructions here (#469).
- NSIS installer is now provided for the distribution of Themis on Windows. It's compatible with the new MSYS2 builds (#474).
- It is now possible to compile JsThemis on Windows, given that Themis Core is installed (#475).
- Miscellaneous compatibility fixes should make it possible to compile Themis Core with Microsoft Visual Studio. This platform does not have full official support yet, though (#470, #471).
π Docs:
π Themis GitHub Wiki is being deprecated. Please find the latest documentation for Themis on Cossack Labs Documentation Server. If you're used to using the Themis Wiki or have bookmarked a few pages for further use, don't worry - its pages and table of contents stay where they were, but each will now link to its corresponding Cossack Labs Documentation Server counterpart.
Code of Conduct has been introduced to make sure that Themis project has a welcoming environment (#518).
π Improved and updated installation guides for numerous languages and platforms.
Infrastructure:
π New Makefile targets and use cases:
emmake make all
builds WasmThemis in Emscripten environment (#475);make all
can be run in MSYS2 environment on Windows now (#469);make nsis_installer
builds NSIS installer for Windows binaries (#474);make deb
andmake rpm
now build ThemisPP packages, too (#506);NO_NIST_STS
environment variable can be used to disable the long-running NIST statistical test suite when doingmake test
(#456).
β Removed Makefile targets:
- Deprecated
rubythemis
targets have been completely removed. Usemake rbthemis_install
to install RubyThemis instead (#508).
- Deprecated
β‘οΈ Multiple updates in the way Themis is installed and packaged. The most significant are switch to
/usr/local
for installation from source code and added support for multiarch installation packages (Read more).β JsThemis and WasmThemis are now tested on all current LTS versions of Node.js (#502, #510).
β Integration tests are getting stronger with WebAssembly platform being added to the suite (#511).
β CI servers are now using the latest RVM for testing RubyThemis (#503, #504).