2016-09-08 13:11:39 -04:00
|
|
|
package registry
|
|
|
|
|
|
|
|
import (
|
2023-09-09 18:27:44 -04:00
|
|
|
"context"
|
2016-09-08 13:11:39 -04:00
|
|
|
"fmt"
|
|
|
|
|
2017-04-17 18:07:56 -04:00
|
|
|
"github.com/docker/cli/cli"
|
|
|
|
"github.com/docker/cli/cli/command"
|
2022-02-26 14:10:38 -05:00
|
|
|
"github.com/docker/cli/cli/config/credentials"
|
2024-07-08 08:50:12 -04:00
|
|
|
"github.com/docker/cli/cli/internal/oauth/manager"
|
2016-09-08 13:11:39 -04:00
|
|
|
"github.com/docker/docker/registry"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
)
|
|
|
|
|
2016-12-19 01:45:48 -05:00
|
|
|
// NewLogoutCommand creates a new `docker logout` command
|
2017-05-03 17:58:52 -04:00
|
|
|
func NewLogoutCommand(dockerCli command.Cli) *cobra.Command {
|
2016-09-08 13:11:39 -04:00
|
|
|
cmd := &cobra.Command{
|
|
|
|
Use: "logout [SERVER]",
|
2022-04-01 09:32:55 -04:00
|
|
|
Short: "Log out from a registry",
|
|
|
|
Long: "Log out from a registry.\nIf no server is specified, the default is defined by the daemon.",
|
2016-09-08 13:11:39 -04:00
|
|
|
Args: cli.RequiresMaxArgs(1),
|
|
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
|
|
var serverAddress string
|
|
|
|
if len(args) > 0 {
|
|
|
|
serverAddress = args[0]
|
|
|
|
}
|
2023-09-09 18:27:44 -04:00
|
|
|
return runLogout(cmd.Context(), dockerCli, serverAddress)
|
2016-09-08 13:11:39 -04:00
|
|
|
},
|
2022-03-30 03:37:08 -04:00
|
|
|
Annotations: map[string]string{
|
|
|
|
"category-top": "9",
|
|
|
|
},
|
2022-05-12 07:18:48 -04:00
|
|
|
// TODO (thaJeztah) add completion for registries we have authentication stored for
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
return cmd
|
|
|
|
}
|
|
|
|
|
2024-07-08 08:50:12 -04:00
|
|
|
func runLogout(ctx context.Context, dockerCli command.Cli, serverAddress string) error {
|
2016-09-08 13:11:39 -04:00
|
|
|
var isDefaultRegistry bool
|
|
|
|
|
|
|
|
if serverAddress == "" {
|
registry: don't call "/info" API endpoint to get default registry
The CLI currenly calls the `/info` endpoint to get the address
of the default registry to use.
This functionality was added as part of the initial Windows implementation
of the engine. For legal reasons, Microsoft Windows (and thus Docker images
based on Windows) were not allowed to be distributed through non-Microsoft
infrastructure. As a temporary solution, a dedicated "registry-win-tp3.docker.io"
registry was created to serve Windows images.
As a result, the default registry was no longer "fixed", so a helper function
(`ElectAuthServer`) was added to allow the CLI to get the correct registry
address from the daemon. (docker/docker PR's/issues 18019, 19891, 19973)
Using separate registries was not an ideal solution, and a more permanent
solution was created by introducing "foreign image layers" in the distribution
spec, after which the "registry-win-tp3.docker.io" ceased to exist, and
removed from the engine through docker/docker PR 21100.
However, the `ElectAuthServer` was left in place, quoting from that PR;
> make the client check which default registry the daemon uses is still
> more correct than leaving it up to the client, even if it won't technically
> matter after this PR. There may be some backward compatibility scenarios
> where `ElectAuthServer` [sic] is still helpful.
That comment was 5 years ago, and given that the engine and cli are
released in tandem, and the default registry is not configurable, we
can save the extra roundtrip to the daemon by using a fixed value.
This patch deprecates the `ElectAuthServer` function, and makes it
return the default registry without calling (potentially expensie)
`/info` API endpoint.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-28 20:00:50 -04:00
|
|
|
serverAddress = registry.IndexServer
|
2016-09-08 13:11:39 -04:00
|
|
|
isDefaultRegistry = true
|
|
|
|
}
|
|
|
|
|
|
|
|
var (
|
2020-06-15 08:01:17 -04:00
|
|
|
regsToLogout = []string{serverAddress}
|
2016-09-08 13:11:39 -04:00
|
|
|
hostnameAddress = serverAddress
|
|
|
|
)
|
|
|
|
if !isDefaultRegistry {
|
2022-02-26 14:10:38 -05:00
|
|
|
hostnameAddress = credentials.ConvertToHostname(serverAddress)
|
2016-10-29 03:03:26 -04:00
|
|
|
// the tries below are kept for backward compatibility where a user could have
|
2016-09-08 13:11:39 -04:00
|
|
|
// saved the registry in one of the following format.
|
2020-06-15 08:01:17 -04:00
|
|
|
regsToLogout = append(regsToLogout, hostnameAddress, "http://"+hostnameAddress, "https://"+hostnameAddress)
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
|
|
|
|
2024-07-08 08:50:12 -04:00
|
|
|
if isDefaultRegistry {
|
|
|
|
store := dockerCli.ConfigFile().GetCredentialsStore(registry.IndexServer)
|
|
|
|
if err := manager.NewManager(store).Logout(ctx); err != nil {
|
|
|
|
fmt.Fprintf(dockerCli.Err(), "WARNING: %v\n", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-09-08 13:11:39 -04:00
|
|
|
fmt.Fprintf(dockerCli.Out(), "Removing login credentials for %s\n", hostnameAddress)
|
2020-06-15 08:01:17 -04:00
|
|
|
errs := make(map[string]error)
|
2016-09-08 13:11:39 -04:00
|
|
|
for _, r := range regsToLogout {
|
2017-06-21 17:20:49 -04:00
|
|
|
if err := dockerCli.ConfigFile().GetCredentialsStore(r).Erase(r); err != nil {
|
2020-06-15 08:01:17 -04:00
|
|
|
errs[r] = err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// if at least one removal succeeded, report success. Otherwise report errors
|
|
|
|
if len(errs) == len(regsToLogout) {
|
|
|
|
fmt.Fprintln(dockerCli.Err(), "WARNING: could not erase credentials:")
|
|
|
|
for k, v := range errs {
|
|
|
|
fmt.Fprintf(dockerCli.Err(), "%s: %s\n", k, v)
|
2016-09-08 13:11:39 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|