document deprecation of legacy `~/.dockercfg` config-file by thaJeztah · Pull Request #2526 · docker/cli

thaJeztah · 2020-05-13T23:30:59Z

relates to #2504

The docker CLI up until v1.7.0 used the ~/.dockercfg file to store credentials
after authenticating to a registry (docker login). Docker v1.7.0 replaced this
file with a new CLI configuration file, located in ~/.docker/config.json. When
implementing the new configuration file, the old file (and file-format) was kept
as a fall-back, to assist existing users with migrating to the new file.

Given that the old file format encourages insecure storage of credentials
(credentials are stored unencrypted), and that no version of the CLI since
Docker v1.7.0 has created this file, the file is marked deprecated, and support
for this file will be removed in a future release.

Signed-off-by: Sebastiaan van Stijn github@gone.nl

- What I did

- How I did it

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

thaJeztah · 2020-05-13T23:31:13Z

@silvin-lubecki @tiborvass ptal

thaJeztah · 2020-06-11T10:56:47Z

rebased

thaJeztah · 2020-06-11T19:00:09Z

Discussing in the maintainers meeting with @tonistiigi, and perhaps we should print a warning if the CLI falls back to the old config file

thaJeztah · 2020-06-15T08:49:49Z

updated; now printing a warning if we fall back to the deprecated ~/.dockercfg PTAL

codecov-commenter · 2020-06-15T08:58:49Z

Codecov Report

Merging #2526 into master will not change coverage.
The diff coverage is n/a.

@@ Coverage Diff @@## master #2526 +/- ##
=======================================
Coverage 58.13% 58.13% =======================================
Files 295 295 Lines 21207 21207 =======================================
Hits 12328 12328 Misses 7970 7970 Partials 909 909

thaJeztah · 2020-06-15T17:49:53Z

 	if err != nil {
 fmt.Fprintf(stderr, "WARNING: Error loading config file: %v\n", err)
 	}
+	if filepath.Base(configFile.Filename) == oldConfigfile {


🤦 this doesn't work; I originally had it set the filename to ~/.dockercfg, but when loading from a legacy file, I think we write to the new file. Let me double check this

AkihiroSuda · 2020-06-17T12:25:49Z

 }

+// TODO remove this temporary hack, which is used to warn about the deprecated ~/.dockercfg file
+var printLegacyFileWarning bool


Ah, 🤦 I was thinking about that initially (and check if there's multiple paths to this code). Yeah, let me add one

thaJeztah · 2020-06-17T12:58:31Z

@AkihiroSuda updated; PTAL

thaJeztah · 2020-06-17T13:38:33Z

hmmm.. why is this failing 🤔

=== Failed
=== FAIL: cli/config TestOldJSONFallbackDeprecationWarning (0.01s)
config_test.go:245: assertion failed: --- expected
+++ configFile
{*configfile.ConfigFile}.Filename:
-: "/tmp/TestOldJSONFallbackDeprecationWarning-734712734/.docker/config.json"
+: "/root/.docker/config.json"

Perhaps DOCKER_CONFIG is set? 🤔

silvin-lubecki

LGTM

thaJeztah · 2020-06-25T15:02:14Z

🤦 I know what's happening. The initial value for configDir is set once;

cli/cli/config/config.go

Line 43 in a03c2c6

initConfigDir.Do(setConfigDir)

, but because the unit tests run in a single suite, it means the first test that hits that part of the code will set its value, and tests after it will ignore any new values of HOME or CONFIG_DIR for the "default" value.

The docker CLI up until v1.7.0 used the `~/.dockercfg` file to store credentials after authenticating to a registry (`docker login`). Docker v1.7.0 replaced this file with a new CLI configuration file, located in `~/.docker/config.json`. When implementing the new configuration file, the old file (and file-format) was kept as a fall-back, to assist existing users with migrating to the new file. Given that the old file format encourages insecure storage of credentials (credentials are stored unencrypted), and that no version of the CLI since Docker v1.7.0 has created this file, the file is marked deprecated, and support for this file will be removed in a future release. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah · 2020-08-03T09:47:39Z

Having some issues getting the deprecation warning working properly; I'll have a look at that separately. I removed the code changes from this PR, and it's now back to only the deprecation documentation changes

thaJeztah · 2020-08-05T07:40:40Z

Bringing this one in; I'll have another look if I have some time to get the warning working in #2666

thaJeztah added impact/deprecation kind/docs status/3-docs-review process/cherry-pick labels May 13, 2020

silvin-lubecki reviewed May 14, 2020
View reviewed changes

Comment threaddocs/deprecated.md

thaJeztah force-pushed the deprecate_old_config branch from 5e0c7a0 to aadfe59Compare June 11, 2020 10:56

thaJeztah added this to the 20.03.0 milestone Jun 11, 2020

thaJeztah force-pushed the deprecate_old_config branch from aadfe59 to 6f37302Compare June 15, 2020 08:49

thaJeztah force-pushed the deprecate_old_config branch from 6f37302 to 21e06edCompare June 15, 2020 08:50

thaJeztah commented Jun 15, 2020
View reviewed changes

thaJeztah force-pushed the deprecate_old_config branch from 21e06ed to f94ebf2Compare June 17, 2020 12:20

AkihiroSuda requested changes Jun 17, 2020
View reviewed changes

thaJeztah force-pushed the deprecate_old_config branch 2 times, most recently from d6bd321 to f12d448Compare June 17, 2020 12:57

thaJeztah force-pushed the deprecate_old_config branch 2 times, most recently from 2cbeb64 to 0961028Compare June 17, 2020 13:39

silvin-lubecki approved these changes Jun 25, 2020
View reviewed changes

thaJeztah force-pushed the deprecate_old_config branch from 84c14e0 to 4e4c4aaCompare June 25, 2020 13:22

thaJeztah force-pushed the deprecate_old_config branch from 4e4c4aa to bfd6882Compare June 25, 2020 15:55

thaJeztah force-pushed the deprecate_old_config branch 2 times, most recently from 069f04e to 35df132Compare July 16, 2020 10:02

thaJeztah force-pushed the deprecate_old_config branch from 35df132 to 3c0a167Compare August 3, 2020 09:46

thaJeztah mentioned this pull request Aug 3, 2020
config: print deprecation warning when falling back to ~/.dockercfg #2666
Merged

thaJeztah removed the process/cherry-pick label Aug 5, 2020

thaJeztah merged commit ac2ebac into docker:masterAug 5, 2020

thaJeztah deleted the deprecate_old_config branch August 5, 2020 07:40

thaJeztah mentioned this pull request Mar 8, 2021
[20.10 backport] config: print deprecation warning when falling back to ~/.dockercfg #3000
Merged

Uh oh!

Conversation

thaJeztah commented May 13, 2020

Uh oh!

thaJeztah commented May 13, 2020

Uh oh!

Uh oh!

thaJeztah commented Jun 11, 2020

Uh oh!

thaJeztah commented Jun 11, 2020

Uh oh!

thaJeztah commented Jun 15, 2020

Uh oh!

codecov-commenter commented Jun 15, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

thaJeztahJun 15, 2020

Choose a reason for hiding this comment

Uh oh!

AkihiroSudaJun 17, 2020

Choose a reason for hiding this comment

Uh oh!

thaJeztahJun 17, 2020

Choose a reason for hiding this comment

Uh oh!

thaJeztah commented Jun 17, 2020

Uh oh!

thaJeztah commented Jun 17, 2020

Uh oh!

silvin-lubecki left a comment

Choose a reason for hiding this comment

Uh oh!

thaJeztah commented Jun 25, 2020

Uh oh!

thaJeztah commented Aug 3, 2020

Uh oh!

thaJeztah commented Aug 5, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Jun 15, 2020•
edited
Loading