Skip to content

Commit 15aa2a6

Browse files
vdemeestervdemeester
committed
Implement configurable detach key
Implement configurable detach keys (for `attach`, exec`, `run` and `start`) using the client-side configuration - Adds a `--detach-keys` flag to `attach`, `exec`, `run` and `start` commands. - Adds a new configuration field (in `~/.docker/config.json`) to configure the default escape keys for docker client. Signed-off-by: Vincent Demeester <[email protected]>
1 parent eb551ba commit 15aa2a6

27 files changed

Lines changed: 583 additions & 61 deletions

‎api/client/attach.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
1818
cmd := Cli.Subcmd("attach", []string{"CONTAINER"}, Cli.DockerCommands["attach"].Description, true)
1919
noStdin := cmd.Bool([]string{"-no-stdin"}, false, "Do not attach STDIN")
2020
proxy := cmd.Bool([]string{"-sig-proxy"}, true, "Proxy all received signals to the process")
21+
detachKeys := cmd.String([]string{"-detach-keys"}, "", "Override the key sequence for detaching a container")
2122

2223
cmd.Require(flag.Exact, 1)
2324

@@ -46,12 +47,17 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
4647
}
4748
}
4849

50+
if *detachKeys != "" {
51+
cli.configFile.DetachKeys = *detachKeys
52+
}
53+
4954
options := types.ContainerAttachOptions{
5055
ContainerID: cmd.Arg(0),
5156
Stream: true,
5257
Stdin: !*noStdin && c.Config.OpenStdin,
5358
Stdout: true,
5459
Stderr: true,
60+
DetachKeys: cli.configFile.DetachKeys,
5561
}
5662

5763
var in io.ReadCloser

‎api/client/exec.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,21 @@ import (
1616
// Usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...]
1717
func (cli *DockerCli) CmdExec(args ...string) error {
1818
cmd := Cli.Subcmd("exec", []string{"CONTAINER COMMAND [ARG...]"}, Cli.DockerCommands["exec"].Description, true)
19+
detachKeys := cmd.String([]string{"-detach-keys"}, "", "Override the key sequence for detaching a container")
1920

2021
execConfig, err := runconfig.ParseExec(cmd, args)
2122
// just in case the ParseExec does not exit
2223
if execConfig.Container == "" || err != nil {
2324
return Cli.StatusError{StatusCode: 1}
2425
}
2526

27+
if *detachKeys != "" {
28+
cli.configFile.DetachKeys = *detachKeys
29+
}
30+
31+
// Send client escape keys
32+
execConfig.DetachKeys = cli.configFile.DetachKeys
33+
2634
response, err := cli.client.ContainerExecCreate(*execConfig)
2735
if err != nil {
2836
return err

‎api/client/lib/container_attach.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ func (cli *Client) ContainerAttach(options types.ContainerAttachOptions) (types.
2424
if options.Stderr {
2525
query.Set("stderr", "1")
2626
}
27+
if options.DetachKeys != "" {
28+
query.Set("detachKeys", options.DetachKeys)
29+
}
2730

2831
headers := map[string][]string{"Content-Type": {"text/plain"}}
2932
return cli.postHijacked("/containers/"+options.ContainerID+"/attach", query, nil, headers)

‎api/client/run.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ func (cli *DockerCli) CmdRun(args ...string) error {
7474
flDetach = cmd.Bool([]string{"d", "-detach"}, false, "Run container in background and print container ID")
7575
flSigProxy = cmd.Bool([]string{"-sig-proxy"}, true, "Proxy received signals to the process")
7676
flName = cmd.String([]string{"-name"}, "", "Assign a name to the container")
77+
flDetachKeys = cmd.String([]string{"-detach-keys"}, "", "Override the key sequence for detaching a container")
7778
flAttach *opts.ListOpts
7879

7980
ErrConflictAttachDetach = fmt.Errorf("Conflicting options: -a and -d")
@@ -188,12 +189,17 @@ func (cli *DockerCli) CmdRun(args ...string) error {
188189
}
189190
}
190191

192+
if *flDetachKeys != "" {
193+
cli.configFile.DetachKeys = *flDetachKeys
194+
}
195+
191196
options := types.ContainerAttachOptions{
192197
ContainerID: createResponse.ID,
193198
Stream: true,
194199
Stdin: config.AttachStdin,
195200
Stdout: config.AttachStdout,
196201
Stderr: config.AttachStderr,
202+
DetachKeys: cli.configFile.DetachKeys,
197203
}
198204

199205
resp, err := cli.client.ContainerAttach(options)

‎api/client/start.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ func (cli *DockerCli) CmdStart(args ...string) error {
4949
cmd := Cli.Subcmd("start", []string{"CONTAINER [CONTAINER...]"}, Cli.DockerCommands["start"].Description, true)
5050
attach := cmd.Bool([]string{"a", "-attach"}, false, "Attach STDOUT/STDERR and forward signals")
5151
openStdin := cmd.Bool([]string{"i", "-interactive"}, false, "Attach container's STDIN")
52+
detachKeys := cmd.String([]string{"-detach-keys"}, "", "Override the key sequence for detaching a container")
5253
cmd.Require(flag.Min, 1)
5354

5455
cmd.ParseFlags(args, true)
@@ -72,12 +73,17 @@ func (cli *DockerCli) CmdStart(args ...string) error {
7273
defer signal.StopCatch(sigc)
7374
}
7475

76+
if *detachKeys != "" {
77+
cli.configFile.DetachKeys = *detachKeys
78+
}
79+
7580
options := types.ContainerAttachOptions{
7681
ContainerID: containerID,
7782
Stream: true,
7883
Stdin: *openStdin && c.Config.OpenStdin,
7984
Stdout: true,
8085
Stderr: true,
86+
DetachKeys: cli.configFile.DetachKeys,
8187
}
8288

8389
var in io.ReadCloser

‎api/server/router/container/container_routes.go‎

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import (
1919
derr "github.com/docker/docker/errors"
2020
"github.com/docker/docker/pkg/ioutils"
2121
"github.com/docker/docker/pkg/signal"
22+
"github.com/docker/docker/pkg/term"
2223
"github.com/docker/docker/runconfig"
2324
"github.com/docker/docker/utils"
2425
"golang.org/x/net/context"
@@ -420,21 +421,32 @@ func (s *containerRouter) postContainersResize(ctx context.Context, w http.Respo
420421
}
421422

422423
func (s *containerRouter) postContainersAttach(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
423-
if err := httputils.ParseForm(r); err != nil {
424+
err := httputils.ParseForm(r)
425+
if err != nil {
424426
return err
425427
}
426428
containerName := vars["name"]
427429

428430
_, upgrade := r.Header["Upgrade"]
429431

432+
keys := []byte{}
433+
detachKeys := r.FormValue("detachKeys")
434+
if detachKeys != "" {
435+
keys, err = term.ToBytes(detachKeys)
436+
if err != nil {
437+
logrus.Warnf("Invalid escape keys provided (%s) using default : ctrl-p ctrl-q", detachKeys)
438+
}
439+
}
440+
430441
attachWithLogsConfig := &daemon.ContainerAttachWithLogsConfig{
431-
Hijacker: w.(http.Hijacker),
432-
Upgrade: upgrade,
433-
UseStdin: httputils.BoolValue(r, "stdin"),
434-
UseStdout: httputils.BoolValue(r, "stdout"),
435-
UseStderr: httputils.BoolValue(r, "stderr"),
436-
Logs: httputils.BoolValue(r, "logs"),
437-
Stream: httputils.BoolValue(r, "stream"),
442+
Hijacker: w.(http.Hijacker),
443+
Upgrade: upgrade,
444+
UseStdin: httputils.BoolValue(r, "stdin"),
445+
UseStdout: httputils.BoolValue(r, "stdout"),
446+
UseStderr: httputils.BoolValue(r, "stderr"),
447+
Logs: httputils.BoolValue(r, "logs"),
448+
Stream: httputils.BoolValue(r, "stream"),
449+
DetachKeys: keys,
438450
}
439451

440452
return s.backend.ContainerAttachWithLogs(containerName, attachWithLogsConfig)
@@ -450,15 +462,26 @@ func (s *containerRouter) wsContainersAttach(ctx context.Context, w http.Respons
450462
return derr.ErrorCodeNoSuchContainer.WithArgs(containerName)
451463
}
452464

465+
var keys []byte
466+
var err error
467+
detachKeys := r.FormValue("detachKeys")
468+
if detachKeys != "" {
469+
keys, err = term.ToBytes(detachKeys)
470+
if err != nil {
471+
logrus.Warnf("Invalid escape keys provided (%s) using default : ctrl-p ctrl-q", detachKeys)
472+
}
473+
}
474+
453475
h := websocket.Handler(func(ws *websocket.Conn) {
454476
defer ws.Close()
455477

456478
wsAttachWithLogsConfig := &daemon.ContainerWsAttachWithLogsConfig{
457-
InStream: ws,
458-
OutStream: ws,
459-
ErrStream: ws,
460-
Logs: httputils.BoolValue(r, "logs"),
461-
Stream: httputils.BoolValue(r, "stream"),
479+
InStream: ws,
480+
OutStream: ws,
481+
ErrStream: ws,
482+
Logs: httputils.BoolValue(r, "logs"),
483+
Stream: httputils.BoolValue(r, "stream"),
484+
DetachKeys: keys,
462485
}
463486

464487
if err := s.backend.ContainerWsAttachWithLogs(containerName, wsAttachWithLogsConfig); err != nil {

‎api/types/client.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ type ContainerAttachOptions struct {
1717
Stdin bool
1818
Stdout bool
1919
Stderr bool
20+
DetachKeys string
2021
}
2122

2223
// ContainerCommitOptions holds parameters to commit changes into a container.

‎api/types/configs.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,6 @@ type ExecConfig struct {
4545
AttachStderr bool // Attach the standard output
4646
AttachStdout bool // Attach the standard error
4747
Detach bool // Execute in detach mode
48+
DetachKeys string // Escape keys for detach
4849
Cmd []string // Execution commands and args
4950
}

‎cliconfig/config.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ type ConfigFile struct {
5151
HTTPHeaders map[string]string `json:"HttpHeaders,omitempty"`
5252
PsFormat string `json:"psFormat,omitempty"`
5353
ImagesFormat string `json:"imagesFormat,omitempty"`
54+
DetachKeys string `json:"detachKeys,omitempty"`
5455
filename string // Note: not serialized - for internal use only
5556
}
5657

‎container/container.go‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -329,13 +329,13 @@ func (container *Container) GetExecIDs() []string {
329329

330330
// Attach connects to the container's TTY, delegating to standard
331331
// streams or websockets depending on the configuration.
332-
func (container *Container) Attach(stdin io.ReadCloser, stdout io.Writer, stderr io.Writer) chan error {
333-
return AttachStreams(container.StreamConfig, container.Config.OpenStdin, container.Config.StdinOnce, container.Config.Tty, stdin, stdout, stderr)
332+
func (container *Container) Attach(stdin io.ReadCloser, stdout io.Writer, stderr io.Writer, keys []byte) chan error {
333+
return AttachStreams(container.StreamConfig, container.Config.OpenStdin, container.Config.StdinOnce, container.Config.Tty, stdin, stdout, stderr, keys)
334334
}
335335

336336
// AttachStreams connects streams to a TTY.
337337
// Used by exec too. Should this move somewhere else?
338-
func AttachStreams(streamConfig *runconfig.StreamConfig, openStdin, stdinOnce, tty bool, stdin io.ReadCloser, stdout io.Writer, stderr io.Writer) chan error {
338+
func AttachStreams(streamConfig *runconfig.StreamConfig, openStdin, stdinOnce, tty bool, stdin io.ReadCloser, stdout io.Writer, stderr io.Writer, keys []byte) chan error {
339339
var (
340340
cStdout, cStderr io.ReadCloser
341341
cStdin io.WriteCloser
@@ -382,7 +382,7 @@ func AttachStreams(streamConfig *runconfig.StreamConfig, openStdin, stdinOnce, t
382382

383383
var err error
384384
if tty {
385-
_, err = copyEscapable(cStdin, stdin)
385+
_, err = copyEscapable(cStdin, stdin, keys)
386386
} else {
387387
_, err = io.Copy(cStdin, stdin)
388388

@@ -438,22 +438,27 @@ func AttachStreams(streamConfig *runconfig.StreamConfig, openStdin, stdinOnce, t
438438
}
439439

440440
// Code c/c from io.Copy() modified to handle escape sequence
441-
func copyEscapable(dst io.Writer, src io.ReadCloser) (written int64, err error) {
441+
func copyEscapable(dst io.Writer, src io.ReadCloser, keys []byte) (written int64, err error) {
442+
if len(keys) == 0 {
443+
// Default keys : ctrl-p ctrl-q
444+
keys = []byte{16, 17}
445+
}
442446
buf := make([]byte, 32*1024)
443447
for {
444448
nr, er := src.Read(buf)
445449
if nr > 0 {
446450
// ---- Docker addition
447-
// char 16 is C-p
448-
if nr == 1 && buf[0] == 16 {
449-
nr, er = src.Read(buf)
450-
// char 17 is C-q
451-
if nr == 1 && buf[0] == 17 {
451+
for i, key := range keys {
452+
if nr != 1 || buf[0] != key {
453+
break
454+
}
455+
if i == len(keys)-1 {
452456
if err := src.Close(); err != nil {
453457
return 0, err
454458
}
455459
return 0, nil
456460
}
461+
nr, er = src.Read(buf)
457462
}
458463
// ---- End of docker
459464
nw, ew := dst.Write(buf[0:nr])

0 commit comments

Comments
 (0)