Files
summercms/modules/lagoon/keygen.go
Jakub Zych 9d06a78f62 feat: Artisan checklist for application commands, hints and coverage gate
- migrate, migrate:rollback and deferred:purge gain --pretend and --force;
  they and queue:clear confirm only in production on an interactive
  terminal, so deploys over SSH proceed as before
- result lines: Applied N migrations, Rolled back <id> of <plugin>,
  Cleared N jobs from <queue>
- --json for migrate:status, key:generate, route:list, admin:token:create,
  admin:token:list, admin:token:scopes and websockets:health; -q keeps the
  key and the token
- hints for an empty DSN, an unreachable database, an invalid app.key, a
  missing uploads bucket and an application binary run below its root
- flare and websockets:health return bonfire.Reported after printing
- long help and examples for every application command, greeter:hello and
  blog:publish; cmd/summer TestCommandsDocumented fails on any gap
2026-10-21 13:16:21 +02:00

57 lines
1.9 KiB
Go

package lagoon
import (
"context"
"crypto/rand"
"encoding/base64"
"git.golem15.com/golem15/summercms/modules/bonfire"
)
// GenerateAppKey returns a fresh app.key: 32 random bytes from crypto/rand,
// base64 (standard encoding) encoded, 44 characters. It is the value
// key:generate prints, without the output decoration.
func GenerateAppKey() (string, error) {
key := make([]byte, encryptedKeySize)
if _, err := rand.Read(key); err != nil {
return "", err
}
return base64.StdEncoding.EncodeToString(key), nil
}
// KeyGenerateCommand prints a fresh 32-byte base64 app.key and performs no
// other side effect (D-11). --json prints {"key": "..."}; under -q the bare
// key is printed, because the key is the data the command exists for (D-27).
func KeyGenerateCommand() bonfire.Command {
return bonfire.Command{
Name: "key:generate",
Description: "Print a fresh 32-byte base64 app.key",
Long: `Prints a new random app.key (32 bytes, base64) and changes nothing: put it in
SUMMER_APP__KEY or config/app.yaml yourself. app.key encrypts Encrypted
columns and signs sessions, so changing it on a running application makes
existing encrypted values unreadable; move the old key to app.previous_keys
first. With -q only the key is printed; --json prints {"key": "..."}.`,
Flags: []bonfire.Flag{jsonFlag},
Examples: []bonfire.Example{
{Command: "key:generate", Description: "Print a new key"},
{Command: "key:generate -q", Description: "Print only the key, for scripts: KEY=$(bin/acme key:generate -q)"},
{Command: "key:generate --json", Description: "Print the key as JSON"},
},
Run: func(ctx context.Context, in bonfire.Input, out bonfire.Output) error {
key, err := GenerateAppKey()
if err != nil {
return err
}
switch {
case flagOn(in, "json"):
return printJSON(out, map[string]string{"key": key})
case bonfire.IsQuiet(out):
out.Println(key)
default:
out.Success(key)
}
return nil
},
}
}