diff --git a/pkg/cmd/grafana-cli/commands/commands.go b/pkg/cmd/grafana-cli/commands/commands.go index 9ae1f6e7f52..53730ec033d 100644 --- a/pkg/cmd/grafana-cli/commands/commands.go +++ b/pkg/cmd/grafana-cli/commands/commands.go @@ -183,6 +183,11 @@ var adminCommands = []*cli.Command{ Usage: "Re-encrypts secrets by decrypting and re-encrypting them with the currently configured encryption. Returns ok unless there is an error. Safe to execute multiple times.", Action: runRunnerCommand(secretsmigrations.ReEncryptSecrets), }, + { + Name: "rollback", + Usage: "Rolls back secrets to legacy encryption. Returns ok unless there is an error. Safe to execute multiple times.", + Action: runRunnerCommand(secretsmigrations.RollBackSecrets), + }, }, }, } diff --git a/pkg/cmd/grafana-cli/commands/secretsmigrations/reencrypt_secrets.go b/pkg/cmd/grafana-cli/commands/secretsmigrations/reencrypt_secrets.go index f175d4464d9..067a5d10d36 100644 --- a/pkg/cmd/grafana-cli/commands/secretsmigrations/reencrypt_secrets.go +++ b/pkg/cmd/grafana-cli/commands/secretsmigrations/reencrypt_secrets.go @@ -17,12 +17,6 @@ import ( "xorm.io/xorm" ) -type simpleSecret struct { - tableName string - columnName string - isBase64Encoded bool -} - func (s simpleSecret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.Session) error { var rows []struct { Id int @@ -76,10 +70,6 @@ func (s simpleSecret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.S return nil } -type jsonSecret struct { - tableName string -} - func (s jsonSecret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.Session) error { var rows []struct { Id int @@ -119,8 +109,6 @@ func (s jsonSecret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.Ses return nil } -type alertingSecret struct{} - func (s alertingSecret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.Session) error { var results []struct { Id int diff --git a/pkg/cmd/grafana-cli/commands/secretsmigrations/rollback_secrets.go b/pkg/cmd/grafana-cli/commands/secretsmigrations/rollback_secrets.go new file mode 100644 index 00000000000..619cbfb8f6e --- /dev/null +++ b/pkg/cmd/grafana-cli/commands/secretsmigrations/rollback_secrets.go @@ -0,0 +1,220 @@ +package secretsmigrations + +import ( + "context" + "encoding/base64" + "encoding/json" + "fmt" + + "github.com/grafana/grafana/pkg/services/featuremgmt" + + "github.com/grafana/grafana/pkg/cmd/grafana-cli/logger" + "github.com/grafana/grafana/pkg/cmd/grafana-cli/runner" + "github.com/grafana/grafana/pkg/cmd/grafana-cli/utils" + "github.com/grafana/grafana/pkg/services/encryption" + "github.com/grafana/grafana/pkg/services/ngalert/notifier" + "github.com/grafana/grafana/pkg/services/secrets/manager" + "github.com/grafana/grafana/pkg/services/sqlstore" + "xorm.io/xorm" +) + +func (s simpleSecret) rollback( + secretsSrv *manager.SecretsService, + encryptionSrv encryption.Internal, + sess *xorm.Session, + secretKey string, +) error { + var rows []struct { + Id int + Secret string + } + + if err := sess.Table(s.tableName).Select(fmt.Sprintf("id, %s as secret", s.columnName)).Find(&rows); err != nil { + return err + } + + for _, row := range rows { + if len(row.Secret) == 0 { + continue + } + + var ( + err error + decoded = []byte(row.Secret) + ) + + if s.isBase64Encoded { + decoded, err = base64.StdEncoding.DecodeString(row.Secret) + if err != nil { + return err + } + } + + decrypted, err := secretsSrv.Decrypt(context.Background(), decoded) + if err != nil { + return err + } + + encrypted, err := encryptionSrv.Encrypt(context.Background(), decrypted, secretKey) + if err != nil { + return err + } + + encoded := string(encrypted) + if s.isBase64Encoded { + encoded = base64.StdEncoding.EncodeToString(encrypted) + } + + updateSQL := fmt.Sprintf("UPDATE %s SET %s = ? WHERE id = ?", s.tableName, s.columnName) + if _, err := sess.Exec(updateSQL, encoded, row.Id); err != nil { + return err + } + } + + logger.Infof("Column %s from %s have been rolled back successfully\n", s.columnName, s.tableName) + + return nil +} + +func (s jsonSecret) rollback( + secretsSrv *manager.SecretsService, + encryptionSrv encryption.Internal, + sess *xorm.Session, + secretKey string, +) error { + var rows []struct { + Id int + SecureJsonData map[string][]byte + } + + if err := sess.Table(s.tableName).Cols("id", "secure_json_data").Find(&rows); err != nil { + return err + } + + for _, row := range rows { + if len(row.SecureJsonData) == 0 { + continue + } + + decrypted, err := secretsSrv.DecryptJsonData(context.Background(), row.SecureJsonData) + if err != nil { + return err + } + + var toUpdate struct { + SecureJsonData map[string][]byte + } + + toUpdate.SecureJsonData, err = encryptionSrv.EncryptJsonData(context.Background(), decrypted, secretKey) + if err != nil { + return err + } + + if _, err := sess.Table(s.tableName).Where("id = ?", row.Id).Update(toUpdate); err != nil { + return err + } + } + + logger.Infof("Secure json data from %s have been rolled back successfully\n", s.tableName) + + return nil +} + +func (s alertingSecret) rollback( + secretsSrv *manager.SecretsService, + encryptionSrv encryption.Internal, + sess *xorm.Session, + secretKey string, +) error { + var results []struct { + Id int + AlertmanagerConfiguration string + } + + selectSQL := "SELECT id, alertmanager_configuration FROM alert_configuration" + if err := sess.SQL(selectSQL).Find(&results); err != nil { + return err + } + + for _, result := range results { + result := result + postableUserConfig, err := notifier.Load([]byte(result.AlertmanagerConfiguration)) + if err != nil { + return err + } + + for _, receiver := range postableUserConfig.AlertmanagerConfig.Receivers { + for _, gmr := range receiver.GrafanaManagedReceivers { + for k, v := range gmr.SecureSettings { + decoded, err := base64.StdEncoding.DecodeString(v) + if err != nil { + return err + } + + decrypted, err := secretsSrv.Decrypt(context.Background(), decoded) + if err != nil { + return err + } + + reencrypted, err := encryptionSrv.Encrypt(context.Background(), decrypted, secretKey) + if err != nil { + return err + } + + gmr.SecureSettings[k] = base64.StdEncoding.EncodeToString(reencrypted) + } + } + } + + marshalled, err := json.Marshal(postableUserConfig) + if err != nil { + return err + } + + result.AlertmanagerConfiguration = string(marshalled) + if _, err := sess.Table("alert_configuration").Where("id = ?", result.Id).Update(&result); err != nil { + return err + } + } + + logger.Info("Alerting secrets have rolled re-encrypted successfully\n") + + return nil +} + +func RollBackSecrets(_ utils.CommandLine, runner runner.Runner) error { + if !runner.Features.IsEnabled(featuremgmt.FlagEnvelopeEncryption) { + logger.Warn("Envelope encryption is not enabled, quitting...") + return nil + } + + toMigrate := []interface { + rollback(*manager.SecretsService, encryption.Internal, *xorm.Session, string) error + }{ + simpleSecret{tableName: "dashboard_snapshot", columnName: "dashboard_encrypted", isBase64Encoded: false}, + simpleSecret{tableName: "user_auth", columnName: "o_auth_access_token", isBase64Encoded: true}, + simpleSecret{tableName: "user_auth", columnName: "o_auth_refresh_token", isBase64Encoded: true}, + simpleSecret{tableName: "user_auth", columnName: "o_auth_token_type", isBase64Encoded: true}, + jsonSecret{tableName: "data_source"}, + jsonSecret{tableName: "plugin_setting"}, + alertingSecret{}, + } + + return runner.SQLStore.WithDbSession(context.Background(), func(sess *sqlstore.DBSession) error { + for _, m := range toMigrate { + if err := m.rollback( + runner.SecretsService, + runner.EncryptionService, + sess.Session, + runner.Cfg.SecretKey); err != nil { + return err + } + } + + if _, err := sess.Exec("DELETE FROM data_keys"); err != nil { + logger.Warn("Error while cleaning up data keys table...", "err", err) + } + + return nil + }) +} diff --git a/pkg/cmd/grafana-cli/commands/secretsmigrations/types.go b/pkg/cmd/grafana-cli/commands/secretsmigrations/types.go new file mode 100644 index 00000000000..b272983f26d --- /dev/null +++ b/pkg/cmd/grafana-cli/commands/secretsmigrations/types.go @@ -0,0 +1,13 @@ +package secretsmigrations + +type simpleSecret struct { + tableName string + columnName string + isBase64Encoded bool +} + +type jsonSecret struct { + tableName string +} + +type alertingSecret struct{}