forked from square/keysync
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is a first pass at implementing an encrypted backup feature for keysync. This writes an AES-GCM encrypted tar file to a configured disk location, containing the secrets keysync has written out to the regular secrets location. The Keyrestore program is updated to take these encrypted files and restore them. This is useful if you want to avoid writing plaintext secrets to disk, but want a way to reboot or recover servers without Keywhiz running (eg, in an outage scenario). Right now a fixed AES key is used. It is loaded after syncing completes, so you can use a key stored in Keywhiz. Recovering that key is left as an exercise to the reader, or future improvements to this tool.
- Loading branch information
1 parent
6d9361f
commit 1576878
Showing
23 changed files
with
735 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| fixtures/clients/client[1-4] | ||
| testing/secrets | ||
| keysync | ||
| keyrestore | ||
| /keysync | ||
| /cmd/keysync/keysync | ||
| /keyrestore | ||
| /cmd/keyrestore/keyrestore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // package backup handles reading and writing encrypted .tar files from the secretsDirectory to | ||
| // a backupPath using the key backupKey. | ||
| package backup | ||
|
|
||
| import ( | ||
| "encoding/hex" | ||
| "io/ioutil" | ||
|
|
||
| "github.com/square/keysync/output" | ||
|
|
||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| type Backup interface { | ||
| Backup() error | ||
| Restore() error | ||
| } | ||
|
|
||
| type FileBackup struct { | ||
| SecretsDirectory string | ||
| BackupPath string | ||
| KeyPath string | ||
| Chown bool | ||
| EnforceFS output.Filesystem | ||
| } | ||
|
|
||
| // Backup is intended to be implemented by FileBackup | ||
| var _ Backup = &FileBackup{} | ||
|
|
||
| func (b *FileBackup) loadKey() ([]byte, error) { | ||
| keyhex, err := ioutil.ReadFile(b.KeyPath) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| key := make([]byte, hex.DecodedLen(len(keyhex))) | ||
| if _, err := hex.Decode(key, keyhex); err != nil { | ||
| return nil, err | ||
| } | ||
| return key, nil | ||
| } | ||
|
|
||
| // Backup loads all files in b.SecretsDirectory, tars, compresses, then encrypts with b.BackupKey | ||
| // The content is written to b.BackupPath | ||
| func (b *FileBackup) Backup() error { | ||
| tarball, err := createTar(b.SecretsDirectory) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| key, err := b.loadKey() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Encrypt it | ||
| encrypted, err := encrypt(tarball, key) | ||
| if err != nil { | ||
| return errors.Wrap(err, "error encrypting backup") | ||
| } | ||
|
|
||
| // We always write as r-- --- ---, aka 0400 | ||
| // UID/GID in this struct are ignored as chownFiles: false | ||
| perms := output.FileInfo{Mode: 0400} | ||
| // Write it out, and if it errored, wrapped the error | ||
| _, err = output.WriteFileAtomically(b.BackupPath, false, perms, 0, encrypted) | ||
| return err | ||
| } | ||
|
|
||
| // Restore opens b.BackupPath, decrypts with b.BackupKey, and writes contents to b.SecretsDirectory | ||
| func (b *FileBackup) Restore() error { | ||
| ciphertext, err := ioutil.ReadFile(b.BackupPath) | ||
| if err != nil { | ||
| return errors.Wrap(err, "error reading backup") | ||
| } | ||
|
|
||
| key, err := b.loadKey() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| tarball, err := decrypt(ciphertext, key) | ||
| if err != nil { | ||
| return errors.Wrap(err, "error decrypting backup") | ||
| } | ||
|
|
||
| if err := extractTar(tarball, b.Chown, b.SecretsDirectory, b.EnforceFS); err != nil { | ||
| return errors.Wrap(err, "Error extracting tarball") | ||
| } | ||
|
|
||
| return nil | ||
| } |
Oops, something went wrong.