Skip to content

Commit aee260d

Browse files
kencochranedmcgowan
kencochrane
authored and
dmcgowan
committed
Remove email address field from login
This removes the email prompt when you use docker login, and also removes the ability to register via the docker cli. Docker login, will strictly be used for logging into a registry server. Signed-off-by: Ken Cochrane <kencochrane@gmail.com>
1 parent 6a96006 commit aee260d

File tree

18 files changed

+180
-182
lines changed

18 files changed

+180
-182
lines changed

‎api/client/login.go‎

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import (
1717
"github.com/docker/engine-api/types"
1818
)
1919

20-
// CmdLogin logs in or registers a user to a Docker registry service.
20+
// CmdLogin logs in a user to a Docker registry service.
2121
//
2222
// If no server is specified, the user will be logged into or registered to the registry's index server.
2323
//
@@ -28,7 +28,9 @@ func (cli *DockerCli) CmdLogin(args ...string) error {
2828

2929
flUser := cmd.String([]string{"u", "-username"}, "", "Username")
3030
flPassword := cmd.String([]string{"p", "-password"}, "", "Password")
31-
flEmail := cmd.String([]string{"e", "-email"}, "", "Email")
31+
32+
// Deprecated in 1.11: Should be removed in docker 1.13
33+
cmd.String([]string{"#e", "#-email"}, "", "Email")
3234

3335
cmd.ParseFlags(args, true)
3436

@@ -38,13 +40,15 @@ func (cli *DockerCli) CmdLogin(args ...string) error {
3840
}
3941

4042
var serverAddress string
43+
var isDefaultRegistry bool
4144
if len(cmd.Args()) > 0 {
4245
serverAddress = cmd.Arg(0)
4346
} else {
4447
serverAddress = cli.electAuthServer()
48+
isDefaultRegistry = true
4549
}
4650

47-
authConfig, err := cli.configureAuth(*flUser, *flPassword, *flEmail, serverAddress)
51+
authConfig, err := cli.configureAuth(*flUser, *flPassword, serverAddress, isDefaultRegistry)
4852
if err != nil {
4953
return err
5054
}
@@ -77,7 +81,7 @@ func (cli *DockerCli) promptWithDefault(prompt string, configDefault string) {
7781
}
7882
}
7983

80-
func (cli *DockerCli) configureAuth(flUser, flPassword, flEmail, serverAddress string) (types.AuthConfig, error) {
84+
func (cli *DockerCli) configureAuth(flUser, flPassword, serverAddress string, isDefaultRegistry bool) (types.AuthConfig, error) {
8185
authconfig, err := getCredentials(cli.configFile, serverAddress)
8286
if err != nil {
8387
return authconfig, err
@@ -86,6 +90,10 @@ func (cli *DockerCli) configureAuth(flUser, flPassword, flEmail, serverAddress s
8690
authconfig.Username = strings.TrimSpace(authconfig.Username)
8791

8892
if flUser = strings.TrimSpace(flUser); flUser == "" {
93+
if isDefaultRegistry {
94+
// if this is a defauly registry (docker hub), then display the following message.
95+
fmt.Fprintln(cli.out, "Login with your Docker ID to push and pull images from Docker Hub. If you don't have a Docker ID, head over to https://hub.docker.com to create one.")
96+
}
8997
cli.promptWithDefault("Username", authconfig.Username)
9098
flUser = readInput(cli.in, cli.out)
9199
flUser = strings.TrimSpace(flUser)
@@ -115,29 +123,8 @@ func (cli *DockerCli) configureAuth(flUser, flPassword, flEmail, serverAddress s
115123
}
116124
}
117125

118-
// Assume that a different username means they may not want to use
119-
// the email from the config file, so prompt it
120-
if flUser != authconfig.Username {
121-
if flEmail == "" {
122-
cli.promptWithDefault("Email", authconfig.Email)
123-
flEmail = readInput(cli.in, cli.out)
124-
if flEmail == "" {
125-
flEmail = authconfig.Email
126-
}
127-
}
128-
} else {
129-
// However, if they don't override the username use the
130-
// email from the cmd line if specified. IOW, allow
131-
// then to change/override them. And if not specified, just
132-
// use what's in the config file
133-
if flEmail == "" {
134-
flEmail = authconfig.Email
135-
}
136-
}
137-
138126
authconfig.Username = flUser
139127
authconfig.Password = flPassword
140-
authconfig.Email = flEmail
141128
authconfig.ServerAddress = serverAddress
142129

143130
return authconfig, nil

‎api/client/utils.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func (cli *DockerCli) registryAuthenticationPrivilegedFunc(index *registrytypes.
4848
return func() (string, error) {
4949
fmt.Fprintf(cli.out, "\nPlease login prior to %s:\n", cmdName)
5050
indexServer := registry.GetAuthConfigKey(index)
51-
authConfig, err := cli.configureAuth("", "", "", indexServer)
51+
authConfig, err := cli.configureAuth("", "", indexServer, false)
5252
if err != nil {
5353
return "", err
5454
}

‎cliconfig/config.go‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,6 @@ func (configFile *ConfigFile) LegacyLoadFromReader(configData io.Reader) error {
8888
if err != nil {
8989
return err
9090
}
91-
origEmail := strings.Split(arr[1], " = ")
92-
if len(origEmail) != 2 {
93-
return fmt.Errorf("Invalid Auth config file")
94-
}
95-
authConfig.Email = origEmail[1]
9691
authConfig.ServerAddress = defaultIndexserver
9792
configFile.AuthConfigs[defaultIndexserver] = authConfig
9893
} else {

‎cliconfig/config_test.go‎

Lines changed: 102 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,9 @@ func TestOldInvalidsAuth(t *testing.T) {
111111
invalids := map[string]string{
112112
`username = test`: "The Auth config file is empty",
113113
`username
114-
password
115-
email`: "Invalid Auth config file",
114+
password`: "Invalid Auth config file",
116115
`username = test
117116
email`: "Invalid auth configuration file",
118-
`username = am9lam9lOmhlbGxv
119-
email`: "Invalid Auth config file",
120117
}
121118

122119
tmpHome, err := ioutil.TempDir("", "config-test")
@@ -164,7 +161,7 @@ func TestOldValidAuth(t *testing.T) {
164161

165162
fn := filepath.Join(tmpHome, oldConfigfile)
166163
js := `username = am9lam9lOmhlbGxv
167-
email = user@example.com`
164+
email = user@example.com`
168165
if err := ioutil.WriteFile(fn, []byte(js), 0600); err != nil {
169166
t.Fatal(err)
170167
}
@@ -176,15 +173,23 @@ email = user@example.com`
176173

177174
// defaultIndexserver is https://index.docker.io/v1/
178175
ac := config.AuthConfigs["https://index.docker.io/v1/"]
179-
if ac.Email != "user@example.com" || ac.Username != "joejoe" || ac.Password != "hello" {
176+
if ac.Username != "joejoe" || ac.Password != "hello" {
180177
t.Fatalf("Missing data from parsing:\n%q", config)
181178
}
182179

183180
// Now save it and make sure it shows up in new form
184181
configStr := saveConfigAndValidateNewFormat(t, config, tmpHome)
185182

186-
if !strings.Contains(configStr, "user@example.com") {
187-
t.Fatalf("Should have save in new form: %s", configStr)
183+
expConfStr := `{
184+
"auths": {
185+
"https://index.docker.io/v1/": {
186+
"auth": "am9lam9lOmhlbGxv"
187+
}
188+
}
189+
}`
190+
191+
if configStr != expConfStr {
192+
t.Fatalf("Should have save in new form: \n%s\n not \n%s", configStr, expConfStr)
188193
}
189194
}
190195

@@ -239,15 +244,24 @@ func TestOldJson(t *testing.T) {
239244
}
240245

241246
ac := config.AuthConfigs["https://index.docker.io/v1/"]
242-
if ac.Email != "user@example.com" || ac.Username != "joejoe" || ac.Password != "hello" {
247+
if ac.Username != "joejoe" || ac.Password != "hello" {
243248
t.Fatalf("Missing data from parsing:\n%q", config)
244249
}
245250

246251
// Now save it and make sure it shows up in new form
247252
configStr := saveConfigAndValidateNewFormat(t, config, tmpHome)
248253

249-
if !strings.Contains(configStr, "user@example.com") {
250-
t.Fatalf("Should have save in new form: %s", configStr)
254+
expConfStr := `{
255+
"auths": {
256+
"https://index.docker.io/v1/": {
257+
"auth": "am9lam9lOmhlbGxv",
258+
"email": "user@example.com"
259+
}
260+
}
261+
}`
262+
263+
if configStr != expConfStr {
264+
t.Fatalf("Should have save in new form: \n'%s'\n not \n'%s'\n", configStr, expConfStr)
251265
}
252266
}
253267

@@ -259,7 +273,7 @@ func TestNewJson(t *testing.T) {
259273
defer os.RemoveAll(tmpHome)
260274

261275
fn := filepath.Join(tmpHome, ConfigFileName)
262-
js := ` { "auths": { "https://index.docker.io/v1/": { "auth": "am9lam9lOmhlbGxv", "email": "user@example.com" } } }`
276+
js := ` { "auths": { "https://index.docker.io/v1/": { "auth": "am9lam9lOmhlbGxv" } } }`
263277
if err := ioutil.WriteFile(fn, []byte(js), 0600); err != nil {
264278
t.Fatal(err)
265279
}
@@ -270,15 +284,62 @@ func TestNewJson(t *testing.T) {
270284
}
271285

272286
ac := config.AuthConfigs["https://index.docker.io/v1/"]
273-
if ac.Email != "user@example.com" || ac.Username != "joejoe" || ac.Password != "hello" {
287+
if ac.Username != "joejoe" || ac.Password != "hello" {
274288
t.Fatalf("Missing data from parsing:\n%q", config)
275289
}
276290

277291
// Now save it and make sure it shows up in new form
278292
configStr := saveConfigAndValidateNewFormat(t, config, tmpHome)
279293

280-
if !strings.Contains(configStr, "user@example.com") {
281-
t.Fatalf("Should have save in new form: %s", configStr)
294+
expConfStr := `{
295+
"auths": {
296+
"https://index.docker.io/v1/": {
297+
"auth": "am9lam9lOmhlbGxv"
298+
}
299+
}
300+
}`
301+
302+
if configStr != expConfStr {
303+
t.Fatalf("Should have save in new form: \n%s\n not \n%s", configStr, expConfStr)
304+
}
305+
}
306+
307+
func TestNewJsonNoEmail(t *testing.T) {
308+
tmpHome, err := ioutil.TempDir("", "config-test")
309+
if err != nil {
310+
t.Fatal(err)
311+
}
312+
defer os.RemoveAll(tmpHome)
313+
314+
fn := filepath.Join(tmpHome, ConfigFileName)
315+
js := ` { "auths": { "https://index.docker.io/v1/": { "auth": "am9lam9lOmhlbGxv" } } }`
316+
if err := ioutil.WriteFile(fn, []byte(js), 0600); err != nil {
317+
t.Fatal(err)
318+
}
319+
320+
config, err := Load(tmpHome)
321+
if err != nil {
322+
t.Fatalf("Failed loading on empty json file: %q", err)
323+
}
324+
325+
ac := config.AuthConfigs["https://index.docker.io/v1/"]
326+
if ac.Username != "joejoe" || ac.Password != "hello" {
327+
t.Fatalf("Missing data from parsing:\n%q", config)
328+
}
329+
330+
// Now save it and make sure it shows up in new form
331+
configStr := saveConfigAndValidateNewFormat(t, config, tmpHome)
332+
333+
expConfStr := `{
334+
"auths": {
335+
"https://index.docker.io/v1/": {
336+
"auth": "am9lam9lOmhlbGxv"
337+
}
338+
}
339+
}`
340+
341+
if configStr != expConfStr {
342+
t.Fatalf("Should have save in new form: \n%s\n not \n%s", configStr, expConfStr)
282343
}
283344
}
284345

@@ -366,7 +427,7 @@ func TestJsonReaderNoFile(t *testing.T) {
366427
}
367428

368429
ac := config.AuthConfigs["https://index.docker.io/v1/"]
369-
if ac.Email != "user@example.com" || ac.Username != "joejoe" || ac.Password != "hello" {
430+
if ac.Username != "joejoe" || ac.Password != "hello" {
370431
t.Fatalf("Missing data from parsing:\n%q", config)
371432
}
372433

@@ -381,7 +442,7 @@ func TestOldJsonReaderNoFile(t *testing.T) {
381442
}
382443

383444
ac := config.AuthConfigs["https://index.docker.io/v1/"]
384-
if ac.Email != "user@example.com" || ac.Username != "joejoe" || ac.Password != "hello" {
445+
if ac.Username != "joejoe" || ac.Password != "hello" {
385446
t.Fatalf("Missing data from parsing:\n%q", config)
386447
}
387448
}
@@ -404,7 +465,7 @@ func TestJsonWithPsFormatNoFile(t *testing.T) {
404465

405466
func TestJsonSaveWithNoFile(t *testing.T) {
406467
js := `{
407-
"auths": { "https://index.docker.io/v1/": { "auth": "am9lam9lOmhlbGxv", "email": "user@example.com" } },
468+
"auths": { "https://index.docker.io/v1/": { "auth": "am9lam9lOmhlbGxv" } },
408469
"psFormat": "table {{.ID}}\\t{{.Label \"com.docker.label.cpu\"}}"
409470
}`
410471
config, err := LoadFromReader(strings.NewReader(js))
@@ -426,9 +487,16 @@ func TestJsonSaveWithNoFile(t *testing.T) {
426487
t.Fatalf("Failed saving to file: %q", err)
427488
}
428489
buf, err := ioutil.ReadFile(filepath.Join(tmpHome, ConfigFileName))
429-
if !strings.Contains(string(buf), `"auths":`) ||
430-
!strings.Contains(string(buf), "user@example.com") {
431-
t.Fatalf("Should have save in new form: %s", string(buf))
490+
expConfStr := `{
491+
"auths": {
492+
"https://index.docker.io/v1/": {
493+
"auth": "am9lam9lOmhlbGxv"
494+
}
495+
},
496+
"psFormat": "table {{.ID}}\\t{{.Label \"com.docker.label.cpu\"}}"
497+
}`
498+
if string(buf) != expConfStr {
499+
t.Fatalf("Should have save in new form: \n%s\nnot \n%s", string(buf), expConfStr)
432500
}
433501
}
434502

@@ -454,14 +522,23 @@ func TestLegacyJsonSaveWithNoFile(t *testing.T) {
454522
t.Fatalf("Failed saving to file: %q", err)
455523
}
456524
buf, err := ioutil.ReadFile(filepath.Join(tmpHome, ConfigFileName))
457-
if !strings.Contains(string(buf), `"auths":`) ||
458-
!strings.Contains(string(buf), "user@example.com") {
459-
t.Fatalf("Should have save in new form: %s", string(buf))
525+
526+
expConfStr := `{
527+
"auths": {
528+
"https://index.docker.io/v1/": {
529+
"auth": "am9lam9lOmhlbGxv",
530+
"email": "user@example.com"
531+
}
532+
}
533+
}`
534+
535+
if string(buf) != expConfStr {
536+
t.Fatalf("Should have save in new form: \n%s\n not \n%s", string(buf), expConfStr)
460537
}
461538
}
462539

463540
func TestEncodeAuth(t *testing.T) {
464-
newAuthConfig := &types.AuthConfig{Username: "ken", Password: "test", Email: "test@example.com"}
541+
newAuthConfig := &types.AuthConfig{Username: "ken", Password: "test"}
465542
authStr := encodeAuth(newAuthConfig)
466543
decAuthConfig := &types.AuthConfig{}
467544
var err error

‎contrib/completion/bash/docker‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -811,7 +811,7 @@ _docker_daemon() {
811811
return
812812
;;
813813
esac
814-
814+
815815
local key=$(__docker_map_key_of_current_option '--storage-opt')
816816
case "$key" in
817817
dm.@(blkdiscard|override_udev_sync_check|use_deferred_@(removal|deletion)))
@@ -1205,14 +1205,14 @@ _docker_load() {
12051205

12061206
_docker_login() {
12071207
case "$prev" in
1208-
--email|-e|--password|-p|--username|-u)
1208+
--password|-p|--username|-u)
12091209
return
12101210
;;
12111211
esac
12121212

12131213
case "$cur" in
12141214
-*)
1215-
COMPREPLY=( $( compgen -W "--email -e --help --password -p --username -u" -- "$cur" ) )
1215+
COMPREPLY=( $( compgen -W "--help --password -p --username -u" -- "$cur" ) )
12161216
;;
12171217
esac
12181218
}

‎contrib/completion/fish/docker.fish‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from load' -l help -d 'Print
221221
complete -c docker -A -f -n '__fish_seen_subcommand_from load' -s i -l input -d 'Read from a tar archive file, instead of STDIN'
222222

223223
# login
224-
complete -c docker -f -n '__fish_docker_no_subcommand' -a login -d 'Register or log in to a Docker registry server'
225-
complete -c docker -A -f -n '__fish_seen_subcommand_from login' -s e -l email -d 'Email'
224+
complete -c docker -f -n '__fish_docker_no_subcommand' -a login -d 'Log in to a Docker registry server'
226225
complete -c docker -A -f -n '__fish_seen_subcommand_from login' -l help -d 'Print usage'
227226
complete -c docker -A -f -n '__fish_seen_subcommand_from login' -s p -l password -d 'Password'
228227
complete -c docker -A -f -n '__fish_seen_subcommand_from login' -s u -l username -d 'Username'
@@ -399,5 +398,3 @@ complete -c docker -f -n '__fish_docker_no_subcommand' -a version -d 'Show the D
399398
complete -c docker -f -n '__fish_docker_no_subcommand' -a wait -d 'Block until a container stops, then print its exit code'
400399
complete -c docker -A -f -n '__fish_seen_subcommand_from wait' -l help -d 'Print usage'
401400
complete -c docker -A -f -n '__fish_seen_subcommand_from wait' -a '(__fish_print_docker_containers running)' -d "Container"
402-
403-

‎contrib/completion/zsh/_docker‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -812,7 +812,6 @@ __docker_subcommand() {
812812
(login)
813813
_arguments $(__docker_arguments) \
814814
$opts_help \
815-
"($help -e --email)"{-e=,--email=}"[Email]:email: " \
816815
"($help -p --password)"{-p=,--password=}"[Password]:password: " \
817816
"($help -u --user)"{-u=,--user=}"[Username]:username: " \
818817
"($help -)1:server: " && ret=0

‎docs/deprecated.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ weight=80
1414

1515
The following list of features are deprecated in Engine.
1616

17+
### `-e` and `--email` flags on `docker login`
18+
**Deprecated In Release: v1.11**
19+
20+
**Target For Removal In Release: v1.13**
21+
22+
The docker login command is removing the ability to automatically register for an account with the target registry if the given username doesn't exist. Due to this change, the email flag is no longer required, and will be deprecated.
23+
1724
### Ambiguous event fields in API
1825
**Deprecated In Release: v1.10**
1926

0 commit comments

Comments
 (0)