Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT] added reissue account #620

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions .github/workflows/pushes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ permissions:
on:
push:
branches-ignore:
- 'exp'
- 'exp/*'
- 'exp-*'
- 'exp_*'
- 'wip'
- 'wip/*'
- 'wip-*'
- 'wip_*'
- "exp"
- "exp/*"
- "exp-*"
- "exp_*"
- "wip"
- "wip/*"
- "wip-*"
- "wip_*"
pull_request:

jobs:
Expand All @@ -38,13 +38,13 @@ jobs:
# The canonical entry is the only one where we run vet/lint/style checks.
# `experimental: true` entries do not cause the tests to fail.
include:
- go: 'stable'
- go: "stable"
os: ubuntu-latest
canonical: true
- go: 'stable'
- go: "stable"
os: windows-latest
canonical: false
- go: 'stable'
- go: "stable"
os: macos-latest
canonical: false

Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
# From 2.7.6 onwards, we use the vX.Y.Z tag naming pattern.
# Before then, we used non-version tags.
# Going forward, for new releases, we only need to support v.
- 'v[0-9]*'
- "v[0-9]*"

permissions:
# Control the GITHUB_TOKEN permissions; GitHub's docs on which permission scopes control what are a little lacking.
Expand All @@ -21,7 +21,6 @@ jobs:
goreleaser:
runs-on: ubuntu-latest
steps:

- name: Checkout
uses: actions/checkout@v4
with:
Expand All @@ -36,7 +35,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: '1.21'
go-version: "1.21"
check-latest: true

- name: Install cosign
Expand Down
242 changes: 242 additions & 0 deletions cmd/reissueaccount.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
/*
* Copyright 2020-2023 The NATS Authors
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package cmd

import (
"fmt"

"github.com/nats-io/nkeys"
"github.com/nats-io/nsc/v2/cmd/store"
"github.com/spf13/cobra"
)

func createReissueAccountCmd() *cobra.Command {
var params reissueAccount
cmd := &cobra.Command{
Use: "account",
Short: "Re-issues all accounts with a new identity and re-signs affected users",
Example: `nsc reissue account`,
Args: MaxArgs(0),
SilenceUsage: false,
Hidden: true,
RunE: func(cmd *cobra.Command, args []string) error {
if err := RunMaybeStorelessAction(cmd, args, &params); err != nil {
return err
}
return nil
},
}
cmd.Flags().BoolVarP(&params.turnIntoSigningKey, "convert-to-signing-key", "", false,
"turn account identity key into signing key (avoids user re-signing)")
params.AccountContextParams.BindFlags(cmd)

return cmd
}

type reissueAccount struct {
AccountContextParams
turnIntoSigningKey bool
}

func (p *reissueAccount) SetDefaults(ctx ActionCtx) error {
return p.AccountContextParams.SetDefaults(ctx)
}

func (p *reissueAccount) PreInteractive(ctx ActionCtx) error {
return nil
}

func (p *reissueAccount) Load(ctx ActionCtx) error {
return nil
}

func (p *reissueAccount) PostInteractive(ctx ActionCtx) error {
return nil
}

func (p *reissueAccount) Validate(ctx ActionCtx) error {
store := ctx.StoreCtx().Store
if store.IsManaged() {
return fmt.Errorf("resign is only supported in non managed stores")
}
return nil
}

func (p *reissueAccount) Run(ctx ActionCtx) (store.Status, error) {
var err error
r := store.NewDetailedReport(true)
s := ctx.StoreCtx().Store
ks := ctx.StoreCtx().KeyStore
accounts, err := s.ListSubContainers(store.Accounts)

// maybe filter to the account name provided
if ctx.CurrentCmd().Flags().Changed("account") {
var buf []string
name := ctx.StoreCtx().Account.Name
for _, n := range accounts {
if n == name {
buf = append(buf, n)
}
}
accounts = buf
}

if err != nil {
return nil, err
}
for _, n := range accounts {
rr := store.NewDetailedReport(false)
r.Add(rr)
ac, err := s.ReadAccountClaim(n)
if err != nil {
rr.AddError("failed to load account %s: %v", n, err)
return r, err
}

akp, err := nkeys.CreateAccount()
if err != nil {
rr.AddError("failed to generate new account identity: %v", err)
return r, err
}
if _, err := ks.Store(akp); err != nil {
rr.AddError("failed to store new account identity: %v", err)
return r, err
}
old := ac.Subject
if ac.Subject, err = akp.PublicKey(); err != nil {
rr.AddError("failed generate account public key: %v", err)
return r, err
}

if p.turnIntoSigningKey {
ac.SigningKeys.Add(old)
}
// if we have access to the existing operator signing key that issued the
// account we are going to use it to re-sign the account
pk := ac.Issuer
sk, err := ks.GetKeyPair(pk)
if sk == nil {
err = fmt.Errorf("failed to find key %q", pk)
}
if err == nil {
_, err = sk.PrivateKey()
}
if err != nil {
rr.AddWarning("failed to obtain find key account signer %q", ac.Issuer)
// if we failed, we are just going to attempt to sign with any operator key
keys, err := ctx.StoreCtx().GetOperatorKeys()
if err != nil {
rr.AddError("failed to read the operator keys: %v", err)
return r, err
}
for _, k := range keys {
pk = k
sk, err = ks.GetKeyPair(k)
if sk == nil {
err = fmt.Errorf("failed to find key %q", pk)
}
if err == nil {
_, err = sk.PrivateKey()
}
if err == nil {
break
}
}
}
if sk == nil {
if err != nil {
rr.AddError("failed to read load any of the operator keys")
return r, err
}
}

token, err := ac.Encode(sk)
if err != nil {
rr.AddError("failed to sign account with %s: %v", pk, err)
return r, err
}

if err := s.StoreRaw([]byte(token)); err != nil {
rr.AddError("failed to store updated account: %v", err)
return r, err
}

rr.AddOK("account %q re-was reissued with new identity: %s", ac.Name, ac.Subject)

users, err := s.ListEntries(store.Accounts, ac.Name, store.Users)
if err != nil {
rr.AddError("failed to list users for account %s: %v", ac.Name, err)
return r, err
}
for _, u := range users {
uc, err := s.ReadUserClaim(ac.Name, u)
if err != nil {
rr.AddError("failed to load user %q account %s: %v", u, ac.Name, err)
return r, err
}
issuer := uc.Issuer
ask, err := ks.GetKeyPair(issuer)
if ask == nil {
err = fmt.Errorf("failed to find key %q", pk)
}
if err == nil {
_, err = ask.PrivateKey()
}
if err != nil {
rr.AddWarning("failed to obtain find key account signing key %q", issuer)
// if we failed, we are just going to attempt to sign with any operator key
keys, err := ctx.StoreCtx().GetAccountKeys(ac.Name)
if err != nil {
r.AddError("failed to read the account keys: %v", err)
return r, err
}
for _, k := range keys {
issuer = k
ask, err = ks.GetKeyPair(k)
if err == nil {
_, err = ask.PrivateKey()
}
if err == nil {
break
}
}
}
if ask == nil {
if err != nil {
rr.AddError("failed to read load any of the operator keys")
return r, err
}
}
uc.IssuerAccount = ""
if issuer != ac.Subject {
uc.IssuerAccount = ac.Subject
}
ut, err := uc.Encode(ask)
if err != nil {
rr.AddError("failed to sign user %q on account %s with %s: %v", u, ac.Name, issuer, err)
return r, err
}
if err := s.StoreRaw([]byte(ut)); err != nil {
rr.AddError("failed to store updated user: %v", err)
return r, err
}

rr.AddOK("user %q re-was reissued", uc.Name)
}

}
return r, nil
}
1 change: 1 addition & 0 deletions cmd/reissueoperator.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ var reIssue = &cobra.Command{
func init() {
GetRootCmd().AddCommand(reIssue)
reIssue.AddCommand(createReIssueOperatorCmd())
reIssue.AddCommand(createReissueAccountCmd())
}

type reIssueOperator struct {
Expand Down
40 changes: 20 additions & 20 deletions dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

This file lists the dependencies used in this repository.

| Dependency | License |
|----------------------------------------------------------|-----------------------------------------|
| go | BSD 3-Clause "New" or "Revised" License |
| github.com/blang/semver | MIT |
| github.com/briandowns/spinner | Apache-2.0 |
| github.com/dustin/go-humanize | MIT |
| github.com/mitchellh/go-homedir | MIT |
| github.com/nats-io/cliprompts/v2 | Apache-2.0 |
| github.com/nats-io/jsm.go | Apache-2.0 |
| github.com/nats-io/jwt/v2 | Apache-2.0 |
| github.com/nats-io/nats-server/v2 | Apache-2.0 |
| github.com/nats-io/nats.go | Apache-2.0 |
| github.com/nats-io/nkeys | Apache-2.0 |
| github.com/nats-io/nuid | Apache-2.0 |
| github.com/rhysd/go-github-selfupdate/selfupdate | MIT |
| github.com/spf13/cobra | Apache-2.0 |
| github.com/spf13/pflag | BSD-3-Clause |
| github.com/stretchr/testify | MIT |
| github.com/xlab/tablewriter | Apache-2.0 |
| golang.org/x/text | BSD-3-Clause |
| Dependency | License |
| ------------------------------------------------ | --------------------------------------- |
| go | BSD 3-Clause "New" or "Revised" License |
| github.com/blang/semver | MIT |
| github.com/briandowns/spinner | Apache-2.0 |
| github.com/dustin/go-humanize | MIT |
| github.com/mitchellh/go-homedir | MIT |
| github.com/nats-io/cliprompts/v2 | Apache-2.0 |
| github.com/nats-io/jsm.go | Apache-2.0 |
| github.com/nats-io/jwt/v2 | Apache-2.0 |
| github.com/nats-io/nats-server/v2 | Apache-2.0 |
| github.com/nats-io/nats.go | Apache-2.0 |
| github.com/nats-io/nkeys | Apache-2.0 |
| github.com/nats-io/nuid | Apache-2.0 |
| github.com/rhysd/go-github-selfupdate/selfupdate | MIT |
| github.com/spf13/cobra | Apache-2.0 |
| github.com/spf13/pflag | BSD-3-Clause |
| github.com/stretchr/testify | MIT |
| github.com/xlab/tablewriter | Apache-2.0 |
| golang.org/x/text | BSD-3-Clause |
Loading