v2.0.0
v2.0
This is a major release with many backward incompatible changes. If you are using a SDK version in the 1.x series, make sure to read the migration guide before upgrading.
Table of contents:
Highlights
Pre-registration
The Tanker SDK now allows pre-registration sharing. This means you can share resources with users who do not have registered their identity with Tanker yet.
Multi-device support improvement
With a SDK version in the 1.x series, users could register an invalid email at account creation, thus making it impossible for them to recover access to their data in case of device loss.
This and similar problems have been fixed in this release:
- It is no longer possible to register a device with Tanker without any verification method.
- Once a verification method has been chosen it must be verified right away - this means you should adapt the UX flow of account creation in your application.
API revamp
In order to implement these changes, the Tanker API has changed significantly. See the migration guide for details.
New concepts
Identities
The SDK version 1.10.x required IDs and user tokens to identify users of your application.
In 2.0, a single concept named "identity" is used instead.
Those identities can be sorted on two axes:
Public/Secret
- Public identity: used to share encrypted data (either directly or within a group).
- Secret identity: used to match a user of the application with a user registered in the Trustchain. It
should only be sent from the application server to the application after a successful authentication.
Permanent/Provisional
- Permanent identity: represents a user who is registered in the Trustchain.
- Provisional identity: represents a user who is not yet registered in the Trustchain.
Verification
The concept of "unlock" has been renamed to "verification". For instance, instead of "unlock devices", we use the term "verify identities".
Please check the guide for more information.
Removal of deprecated features
ChunkEncryptor class
The ChunkEncryptor class was deprecated in 1.10 and thus has been removed in the 2.0 release.
unlockRequired, waitingForValidation events
The unlockRequired
and waitingForValidation
events are gone. Instead of using a callback, use tanker.verifyIdentity()
after checking the returned value of tanker.start()
.