mirror of
https://github.com/grafana/grafana.git
synced 2025-09-27 20:34:04 +08:00

* CLI: Adjust 're-encrypt-data-keys' command * CLI: Adjust 're-encrypt' command * Multiple improvements on re-encrypt secrets migration * Another bunch of code improvements * Lint fixes
282 lines
9.0 KiB
Go
282 lines
9.0 KiB
Go
package secretsmigrations
|
|
|
|
import (
|
|
"context"
|
|
"encoding/base64"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
|
|
"github.com/grafana/grafana/pkg/cmd/grafana-cli/runner"
|
|
"github.com/grafana/grafana/pkg/cmd/grafana-cli/utils"
|
|
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
|
"github.com/grafana/grafana/pkg/services/ngalert/notifier"
|
|
"github.com/grafana/grafana/pkg/services/secrets"
|
|
"github.com/grafana/grafana/pkg/services/secrets/manager"
|
|
"github.com/grafana/grafana/pkg/services/sqlstore"
|
|
"xorm.io/xorm"
|
|
)
|
|
|
|
func (s simpleSecret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.Session) {
|
|
var rows []struct {
|
|
Id int
|
|
Secret []byte
|
|
}
|
|
|
|
if err := sess.Table(s.tableName).Select(fmt.Sprintf("id, %s as secret", s.columnName)).Find(&rows); err != nil {
|
|
logger.Warn("Could not find any secret to re-encrypt", "table", s.tableName)
|
|
return
|
|
}
|
|
|
|
var anyFailure bool
|
|
|
|
for _, row := range rows {
|
|
if len(row.Secret) == 0 {
|
|
continue
|
|
}
|
|
|
|
decrypted, err := secretsSrv.Decrypt(context.Background(), row.Secret)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not decrypt secret while re-encrypting it", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
encrypted, err := secretsSrv.EncryptWithDBSession(context.Background(), decrypted, secrets.WithoutScope(), sess)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not encrypt secret while re-encrypting it", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
updateSQL := fmt.Sprintf("UPDATE %s SET %s = ?, updated = ? WHERE id = ?", s.tableName, s.columnName)
|
|
if _, err = sess.Exec(updateSQL, encrypted, nowInUTC(), row.Id); err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not update secret while re-encrypting it", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
}
|
|
|
|
if anyFailure {
|
|
logger.Warn(fmt.Sprintf("Column %s from %s has been re-encrypted with errors", s.columnName, s.tableName))
|
|
} else {
|
|
logger.Info(fmt.Sprintf("Column %s from %s has been re-encrypted successfully", s.columnName, s.tableName))
|
|
}
|
|
}
|
|
|
|
func (s b64Secret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.Session) {
|
|
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 {
|
|
logger.Warn("Could not find any secret to re-encrypt", "table", s.tableName)
|
|
return
|
|
}
|
|
|
|
var anyFailure bool
|
|
|
|
for _, row := range rows {
|
|
if len(row.Secret) == 0 {
|
|
continue
|
|
}
|
|
|
|
decoded, err := base64.StdEncoding.DecodeString(row.Secret)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not decode base64-encoded secret while re-encrypting it", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
decrypted, err := secretsSrv.Decrypt(context.Background(), decoded)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not decrypt secret while re-encrypting it", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
encrypted, err := secretsSrv.EncryptWithDBSession(context.Background(), decrypted, secrets.WithoutScope(), sess)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not encrypt secret while re-encrypting it", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
encoded := base64.StdEncoding.EncodeToString(encrypted)
|
|
updateSQL := fmt.Sprintf("UPDATE %s SET %s = ? WHERE id = ?", s.tableName, s.columnName)
|
|
_, err = sess.Exec(updateSQL, encoded, row.Id)
|
|
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not update secret while re-encrypting it", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
}
|
|
|
|
if anyFailure {
|
|
logger.Warn(fmt.Sprintf("Column %s from %s has been re-encrypted with errors", s.columnName, s.tableName))
|
|
} else {
|
|
logger.Info(fmt.Sprintf("Column %s from %s has been re-encrypted successfully", s.columnName, s.tableName))
|
|
}
|
|
}
|
|
|
|
func (s jsonSecret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.Session) {
|
|
var rows []struct {
|
|
Id int
|
|
SecureJsonData map[string][]byte
|
|
}
|
|
|
|
if err := sess.Table(s.tableName).Cols("id", "secure_json_data").Find(&rows); err != nil {
|
|
logger.Warn("Could not find any secret to re-encrypt", "table", s.tableName)
|
|
return
|
|
}
|
|
|
|
var anyFailure bool
|
|
|
|
for _, row := range rows {
|
|
if len(row.SecureJsonData) == 0 {
|
|
continue
|
|
}
|
|
|
|
decrypted, err := secretsSrv.DecryptJsonData(context.Background(), row.SecureJsonData)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not decrypt secrets while re-encrypting them", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
toUpdate := struct {
|
|
SecureJsonData map[string][]byte
|
|
Updated string
|
|
}{Updated: nowInUTC()}
|
|
|
|
toUpdate.SecureJsonData, err = secretsSrv.EncryptJsonDataWithDBSession(context.Background(), decrypted, secrets.WithoutScope(), sess)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not re-encrypt secrets", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
if _, err := sess.Table(s.tableName).Where("id = ?", row.Id).Update(toUpdate); err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not update secrets while re-encrypting them", "table", s.tableName, "id", row.Id, "error", err)
|
|
continue
|
|
}
|
|
}
|
|
|
|
if anyFailure {
|
|
logger.Warn(fmt.Sprintf("Secure json data secrets from %s have been re-encrypted with errors", s.tableName))
|
|
} else {
|
|
logger.Info(fmt.Sprintf("Secure json data secrets from %s have been re-encrypted successfully", s.tableName))
|
|
}
|
|
}
|
|
|
|
func (s alertingSecret) reencrypt(secretsSrv *manager.SecretsService, sess *xorm.Session) {
|
|
var results []struct {
|
|
Id int
|
|
AlertmanagerConfiguration string
|
|
}
|
|
|
|
selectSQL := "SELECT id, alertmanager_configuration FROM alert_configuration"
|
|
if err := sess.SQL(selectSQL).Find(&results); err != nil {
|
|
logger.Warn("Could not find any alert_configuration secret to re-encrypt")
|
|
return
|
|
}
|
|
|
|
var anyFailure bool
|
|
|
|
for _, result := range results {
|
|
result := result
|
|
postableUserConfig, err := notifier.Load([]byte(result.AlertmanagerConfiguration))
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not load alert_configuration while re-encrypting it", "id", result.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
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 {
|
|
anyFailure = true
|
|
logger.Warn("Could not decode base64-encoded alert_configuration secret", "id", result.Id, "key", k, "error", err)
|
|
continue
|
|
}
|
|
|
|
decrypted, err := secretsSrv.Decrypt(context.Background(), decoded)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not decrypt alert_configuration secret", "id", result.Id, "key", k, "error", err)
|
|
continue
|
|
}
|
|
|
|
reencrypted, err := secretsSrv.EncryptWithDBSession(context.Background(), decrypted, secrets.WithoutScope(), sess)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not re-encrypt alert_configuration secret", "id", result.Id, "key", k, "error", err)
|
|
continue
|
|
}
|
|
|
|
gmr.SecureSettings[k] = base64.StdEncoding.EncodeToString(reencrypted)
|
|
}
|
|
}
|
|
}
|
|
|
|
marshalled, err := json.Marshal(postableUserConfig)
|
|
if err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not marshal alert_configuration while re-encrypting it", "id", result.Id, "error", err)
|
|
continue
|
|
}
|
|
|
|
result.AlertmanagerConfiguration = string(marshalled)
|
|
if _, err := sess.Table("alert_configuration").Where("id = ?", result.Id).Update(&result); err != nil {
|
|
anyFailure = true
|
|
logger.Warn("Could not update alert_configuration secret while re-encrypting it", "id", result.Id, "error", err)
|
|
continue
|
|
}
|
|
}
|
|
|
|
if anyFailure {
|
|
logger.Warn("Alerting configuration secrets have been re-encrypted with errors")
|
|
} else {
|
|
logger.Info("Alerting configuration secrets have been re-encrypted successfully")
|
|
}
|
|
}
|
|
|
|
func ReEncryptSecrets(_ utils.CommandLine, runner runner.Runner) error {
|
|
if !runner.Features.IsEnabled(featuremgmt.FlagEnvelopeEncryption) {
|
|
logger.Warn("Envelope encryption is not enabled, quitting...")
|
|
return nil
|
|
}
|
|
|
|
toMigrate := []interface {
|
|
reencrypt(*manager.SecretsService, *xorm.Session)
|
|
}{
|
|
simpleSecret{tableName: "dashboard_snapshot", columnName: "dashboard_encrypted"},
|
|
b64Secret{simpleSecret{tableName: "user_auth", columnName: "o_auth_access_token"}},
|
|
b64Secret{simpleSecret{tableName: "user_auth", columnName: "o_auth_refresh_token"}},
|
|
b64Secret{simpleSecret{tableName: "user_auth", columnName: "o_auth_token_type"}},
|
|
jsonSecret{tableName: "data_source"},
|
|
jsonSecret{tableName: "plugin_setting"},
|
|
alertingSecret{},
|
|
}
|
|
|
|
return runner.SQLStore.WithTransactionalDbSession(context.Background(), func(sess *sqlstore.DBSession) (err error) {
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
err = errors.New(fmt.Sprint(r))
|
|
logger.Error("Secrets re-encryption failed, rolling back transaction...", "error", err)
|
|
}
|
|
}()
|
|
|
|
for _, m := range toMigrate {
|
|
m.reencrypt(runner.SecretsService, sess.Session)
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|