Skip to content

encryption specification #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 20, 2018
Merged

encryption specification #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c127c9
encryption specification
jamesnocentini Jun 15, 2018
bc416f6
update review
jamesnocentini Jun 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions modules/ROOT/pages/_partials/database-encryption.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Couchbase Lite 2.1 introduces database encryption, this functionality is exclusively available in the Enterprise Edition.

The xref:#database-upgrade[automatic database upgrade] functionality is *not supported* for encrypted databases. Furthermore, databases encrypted with one SDK (i.e Swift, C#, Java or Objective-C) *cannot* be opened with another SDK.
If you're migrating an application from Couchbase Lite 1.x to 2.x, note that the xref:#database-upgrade[automatic database upgrade] functionality is *not supported* for encrypted databases.

The code below demonstrates how to open or create an existing database with an encryption key. This code will not compile if you are running the Community Edition of Couchbase Lite.
An encrypted database can only be opened with the same language SDK that was used to encrypt it in the first place (Swift, C#, Java or Objective-C). For example, if a database is encrypted with the Swift SDK and then exported, it will only be readable with the Swift SDK.

The encryption specification is 256-bit AES.

The code below demonstrates how to open or create an existing database with an encryption key. This code will not compile if you are running the Community Edition of Couchbase Lite.