-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Synchronous CLI command for root CA rotation #48
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,128 @@ | ||
package swarm | ||
|
||
import ( | ||
"fmt" | ||
"io" | ||
"strings" | ||
|
||
"golang.org/x/net/context" | ||
|
||
"io/ioutil" | ||
|
||
"github.com/docker/cli/cli" | ||
"github.com/docker/cli/cli/command" | ||
"github.com/docker/cli/cli/command/swarm/progress" | ||
"github.com/docker/docker/api/types/swarm" | ||
"github.com/docker/docker/pkg/jsonmessage" | ||
"github.com/spf13/cobra" | ||
"github.com/spf13/pflag" | ||
) | ||
|
||
type caOptions struct { | ||
swarmOptions | ||
rootCACert PEMFile | ||
rootCAKey PEMFile | ||
rotate bool | ||
detach bool | ||
quiet bool | ||
} | ||
|
||
func newRotateCACommand(dockerCli command.Cli) *cobra.Command { | ||
opts := caOptions{} | ||
|
||
cmd := &cobra.Command{ | ||
Use: "ca [OPTIONS]", | ||
Short: "Manage root CA", | ||
Args: cli.NoArgs, | ||
RunE: func(cmd *cobra.Command, args []string) error { | ||
return runRotateCA(dockerCli, cmd.Flags(), opts) | ||
}, | ||
Tags: map[string]string{"version": "1.30"}, | ||
} | ||
|
||
flags := cmd.Flags() | ||
addSwarmCAFlags(flags, &opts.swarmOptions) | ||
flags.BoolVar(&opts.rotate, flagRotate, false, "Rotate the swarm CA - if no certificate or key are provided, new ones will be generated") | ||
flags.Var(&opts.rootCACert, flagCACert, "Path to the PEM-formatted root CA certificate to use for the new cluster") | ||
flags.Var(&opts.rootCAKey, flagCAKey, "Path to the PEM-formatted root CA key to use for the new cluster") | ||
|
||
flags.BoolVarP(&opts.detach, "detach", "d", false, "Exit immediately instead of waiting for the root rotation to converge") | ||
flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Suppress progress output") | ||
return cmd | ||
} | ||
|
||
func runRotateCA(dockerCli command.Cli, flags *pflag.FlagSet, opts caOptions) error { | ||
client := dockerCli.Client() | ||
ctx := context.Background() | ||
|
||
swarmInspect, err := client.SwarmInspect(ctx) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
if !opts.rotate { | ||
if swarmInspect.ClusterInfo.TLSInfo.TrustRoot == "" { | ||
fmt.Fprintln(dockerCli.Out(), "No CA information available") | ||
} else { | ||
fmt.Fprintln(dockerCli.Out(), strings.TrimSpace(swarmInspect.ClusterInfo.TLSInfo.TrustRoot)) | ||
} | ||
return nil | ||
} | ||
|
||
genRootCA := true | ||
spec := &swarmInspect.Spec | ||
opts.mergeSwarmSpec(spec, flags) | ||
if flags.Changed(flagCACert) { | ||
spec.CAConfig.SigningCACert = opts.rootCACert.Contents() | ||
genRootCA = false | ||
} | ||
if flags.Changed(flagCAKey) { | ||
spec.CAConfig.SigningCAKey = opts.rootCAKey.Contents() | ||
genRootCA = false | ||
} | ||
if genRootCA { | ||
spec.CAConfig.ForceRotate++ | ||
spec.CAConfig.SigningCACert = "" | ||
spec.CAConfig.SigningCAKey = "" | ||
} | ||
|
||
if err := client.SwarmUpdate(ctx, swarmInspect.Version, swarmInspect.Spec, swarm.UpdateFlags{}); err != nil { | ||
return err | ||
} | ||
|
||
if opts.detach { | ||
return nil | ||
} | ||
|
||
errChan := make(chan error, 1) | ||
pipeReader, pipeWriter := io.Pipe() | ||
|
||
go func() { | ||
errChan <- progress.RootRotationProgress(ctx, client, pipeWriter) | ||
}() | ||
|
||
if opts.quiet { | ||
go io.Copy(ioutil.Discard, pipeReader) | ||
return <-errChan | ||
} | ||
|
||
err = jsonmessage.DisplayJSONMessagesToStream(pipeReader, dockerCli.Out(), nil) | ||
if err == nil { | ||
err = <-errChan | ||
} | ||
if err != nil { | ||
return err | ||
} | ||
|
||
swarmInspect, err = client.SwarmInspect(ctx) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
if swarmInspect.ClusterInfo.TLSInfo.TrustRoot == "" { | ||
fmt.Fprintln(dockerCli.Out(), "No CA information available") | ||
} else { | ||
fmt.Fprintln(dockerCli.Out(), strings.TrimSpace(swarmInspect.ClusterInfo.TLSInfo.TrustRoot)) | ||
} | ||
return nil | ||
} |
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,121 @@ | ||
package progress | ||
|
||
import ( | ||
"bytes" | ||
"io" | ||
"os" | ||
"os/signal" | ||
"time" | ||
|
||
"golang.org/x/net/context" | ||
|
||
"github.com/docker/docker/api/types" | ||
"github.com/docker/docker/api/types/swarm" | ||
"github.com/docker/docker/client" | ||
"github.com/docker/docker/pkg/progress" | ||
"github.com/docker/docker/pkg/streamformatter" | ||
"github.com/opencontainers/go-digest" | ||
) | ||
|
||
const ( | ||
certsRotatedStr = " rotated TLS certificates" | ||
rootsRotatedStr = " rotated CA certificates" | ||
// rootsAction has a single space because rootsRotatedStr is one character shorter than certsRotatedStr. | ||
// This makes sure the progress bar are aligned. | ||
certsAction = "" | ||
rootsAction = " " | ||
) | ||
|
||
// RootRotationProgress outputs progress information for convergence of a root rotation. | ||
func RootRotationProgress(ctx context.Context, dclient client.APIClient, progressWriter io.WriteCloser) error { | ||
defer progressWriter.Close() | ||
|
||
progressOut := streamformatter.NewJSONProgressOutput(progressWriter, false) | ||
|
||
sigint := make(chan os.Signal, 1) | ||
signal.Notify(sigint, os.Interrupt) | ||
defer signal.Stop(sigint) | ||
|
||
// draw 2 progress bars, 1 for nodes with the correct cert, 1 for nodes with the correct trust root | ||
progress.Update(progressOut, "desired root digest", "") | ||
progress.Update(progressOut, certsRotatedStr, certsAction) | ||
progress.Update(progressOut, rootsRotatedStr, rootsAction) | ||
|
||
var done bool | ||
|
||
for { | ||
info, err := dclient.SwarmInspect(ctx) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
if done { | ||
return nil | ||
} | ||
|
||
nodes, err := dclient.NodeList(ctx, types.NodeListOptions{}) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
done = updateProgress(progressOut, info.ClusterInfo.TLSInfo, nodes, info.ClusterInfo.RootRotationInProgress) | ||
|
||
select { | ||
case <-time.After(200 * time.Millisecond): | ||
case <-sigint: | ||
if !done { | ||
progress.Message(progressOut, "", "Operation continuing in background.") | ||
progress.Message(progressOut, "", "Use `swarmctl cluster inspect default` to check progress.") | ||
} | ||
return nil | ||
} | ||
} | ||
} | ||
|
||
func updateProgress(progressOut progress.Output, desiredTLSInfo swarm.TLSInfo, nodes []swarm.Node, rootRotationInProgress bool) bool { | ||
// write the current desired root cert's digest, because the desired root certs might be too long | ||
progressOut.WriteProgress(progress.Progress{ | ||
ID: "desired root digest", | ||
Action: digest.FromBytes([]byte(desiredTLSInfo.TrustRoot)).String(), | ||
}) | ||
|
||
// If we had reached a converged state, check if we are still converged. | ||
var certsRight, trustRootsRight int64 | ||
for _, n := range nodes { | ||
if bytes.Equal(n.Description.TLSInfo.CertIssuerPublicKey, desiredTLSInfo.CertIssuerPublicKey) && | ||
bytes.Equal(n.Description.TLSInfo.CertIssuerSubject, desiredTLSInfo.CertIssuerSubject) { | ||
certsRight++ | ||
} | ||
|
||
if n.Description.TLSInfo.TrustRoot == desiredTLSInfo.TrustRoot { | ||
trustRootsRight++ | ||
} | ||
} | ||
|
||
total := int64(len(nodes)) | ||
progressOut.WriteProgress(progress.Progress{ | ||
ID: certsRotatedStr, | ||
Action: certsAction, | ||
Current: certsRight, | ||
Total: total, | ||
Units: "nodes", | ||
}) | ||
|
||
rootsProgress := progress.Progress{ | ||
ID: rootsRotatedStr, | ||
Action: rootsAction, | ||
Current: trustRootsRight, | ||
Total: total, | ||
Units: "nodes", | ||
} | ||
|
||
if certsRight == total && !rootRotationInProgress { | ||
progressOut.WriteProgress(rootsProgress) | ||
return certsRight == total && trustRootsRight == total | ||
} | ||
|
||
// we still have certs that need renewing, so display that there are zero roots rotated yet | ||
rootsProgress.Current = 0 | ||
progressOut.WriteProgress(rootsProgress) | ||
return false | ||
} |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add
like we have on cli/command/system/prune.go#L31, so that the command is hidden when talking to an older daemon, and produces an error that it requires a newer daemon