Enabling Encyption on an Unencrypted Alpha

vvbalaji · May 14, 2020, 12:59pm

Should we also disable the option to enable encryption on an existing datastore and ask them to instead try backup/restore?

Paras · May 14, 2020, 2:57pm

Yes. That will be caught by badger as “Encryption Key Mismatch” and panic. @ibrahim can we return an error instead so dgraph can propagate a useful log and exit gracefully?

Also, I realized even the mechanism to “change” an encryption key is not clean. It needs to be exported and then live-loaded onto an alpha with the new key. Bulk/Restore assumes same key for encryption and decryption.

Summarizing
Fixes:

Allow Bulk/Restore to have enc-key and dec-key. (Paras). This will allow changing keys and removing encryption.
exit dgraph gracefully when error on key. (Paras)
badger to send error when key mismatches. (Ibrahim)
More tests (Ibrahim and Paras)

https://dgraph.atlassian.net/browse/DGRAPH-1577

ibrahim · May 15, 2020, 12:05pm

Badger is returning an error. We’re not handling it gracefully in dgraph

github.com

dgraph-io/dgraph/blob/2a1e3fb0004cd3c570213ad28a57acfe356fd027/worker/server_state.go#L164


      
          		opt = setBadgerOptions(opt)
          
          		// Print the options w/o exposing key.
          		// TODO: Build a stringify interface in Badger options, which is used to print nicely here.
          		key := opt.EncryptionKey
          		opt.EncryptionKey = nil
          		glog.Infof("Opening postings BadgerDB with options: %+v\n", opt)
          		opt.EncryptionKey = key
          
          		s.Pstore, err = badger.OpenManaged(opt)
          		x.Checkf(err, "Error while creating badger KV posting store")
          
          		// zero out from memory
          		opt.EncryptionKey = nil
          	}
          
          	s.gcCloser = y.NewCloser(2)
          	go x.RunVlogGC(s.Pstore, s.gcCloser)
          	go x.RunVlogGC(s.WALstore, s.gcCloser)
          }

vvbalaji · May 18, 2020, 2:04pm

@balaji: we have to update the blog linked above to correct the steps for encrypting an unencrypted installation cc: @LGalatin

LGalatin · May 18, 2020, 9:23pm

Created this Jira: https://dgraph.atlassian.net/browse/DGRAPH-1572

ibrahim · May 26, 2020, 6:45am

@balaji Pointed out that encryption can be enabled in badger using the rotate tool. I wrote a test to confirm this Add a test for rotate tool by jarifibrahim · Pull Request #1343 · dgraph-io/badger · GitHub.

So the badger encryption blog can be updated to show that encryption can be enabled on an unencrypted DB using the rotate tool.

Topic		Replies	Views
Encryption at Rest - Enterprise features Documentation	0	456	August 29, 2020
Encryption at Rest in Dgraph and Badger - Dgraph Blog Blog	6	828	May 18, 2020
Documentation about how Badger actually stores Dgraph data on disk Badger	4	1778	August 9, 2020
Encrypted Backups and Restores Dev eng	2	1046	May 4, 2020
Binary backup of badger files in Dgraph Dgraph	6	752	January 31, 2023

Enabling Encyption on an Unencrypted Alpha

Related topics