-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
vnc.go
336 lines (297 loc) · 9.67 KB
/
vnc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/*
* This file is part of the KubeVirt project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright 2017, 2018 Red Hat, Inc.
*
*/
package vnc
import (
"encoding/json"
"errors"
"fmt"
"io"
"net"
"os"
"os/exec"
"os/signal"
"path/filepath"
"runtime"
"time"
"github.com/spf13/cobra"
"k8s.io/client-go/tools/clientcmd"
kvcorev1 "kubevirt.io/client-go/generated/kubevirt/clientset/versioned/typed/core/v1"
"kubevirt.io/client-go/kubecli"
"kubevirt.io/client-go/log"
"kubevirt.io/kubevirt/pkg/virtctl/templates"
"kubevirt.io/kubevirt/pkg/virtctl/vnc/screenshot"
)
const (
LISTEN_TIMEOUT = 60 * time.Second
//#### Tiger VNC ####
//# https://github.com/TigerVNC/tigervnc/releases
// Compatible with multiple Tiger VNC versions
MACOS_TIGER_VNC_PATTERN = `/Applications/TigerVNC Viewer*.app/Contents/MacOS/TigerVNC Viewer`
//#### Chicken VNC ####
//# https://sourceforge.net/projects/chicken/
MACOS_CHICKEN_VNC = "/Applications/Chicken.app/Contents/MacOS/Chicken"
//#### Real VNC ####
//# https://www.realvnc.com/en/connect/download/viewer/macos/
MACOS_REAL_VNC = "/Applications/VNC Viewer.app/Contents/MacOS/vncviewer"
REMOTE_VIEWER = "remote-viewer"
TIGER_VNC = "vncviewer"
)
var listenAddressFmt string
var listenAddress = "127.0.0.1"
var proxyOnly bool
var customPort = 0
func NewCommand(clientConfig clientcmd.ClientConfig) *cobra.Command {
log.InitializeLogging("vnc")
cmd := &cobra.Command{
Use: "vnc (VMI)",
Short: "Open a vnc connection to a virtual machine instance.",
Example: usage(),
Args: templates.ExactArgs("vnc", 1),
RunE: func(cmd *cobra.Command, args []string) error {
c := VNC{clientConfig: clientConfig}
return c.Run(cmd, args)
},
}
cmd.Flags().StringVar(&listenAddress, "address", listenAddress, "--address=127.0.0.1: Setting this will change the listening address of the VNC server. Example: --address=0.0.0.0 will make the server listen on all interfaces.")
cmd.Flags().BoolVar(&proxyOnly, "proxy-only", proxyOnly, "--proxy-only=false: Setting this true will run only the virtctl vnc proxy and show the port where VNC viewers can connect")
cmd.Flags().IntVar(&customPort, "port", customPort,
"--port=0: Assigning a port value to this will try to run the proxy on the given port if the port is accessible; If unassigned, the proxy will run on a random port")
cmd.SetUsageTemplate(templates.UsageTemplate())
cmd.AddCommand(screenshot.NewScreenshotCommand(clientConfig))
return cmd
}
type VNC struct {
clientConfig clientcmd.ClientConfig
}
func (o *VNC) Run(cmd *cobra.Command, args []string) error {
namespace, _, err := o.clientConfig.Namespace()
if err != nil {
return err
}
vmi := args[0]
virtCli, err := kubecli.GetKubevirtClientFromClientConfig(o.clientConfig)
if err != nil {
return err
}
// setup connection with VM
vnc, err := virtCli.VirtualMachineInstance(namespace).VNC(vmi)
if err != nil {
return fmt.Errorf("Can't access VMI %s: %s", vmi, err.Error())
}
// Format the listening address to account for the port (ex: 127.0.0.0:5900)
// Set listenAddress to localhost if proxy-only flag is not set
if !proxyOnly {
listenAddress = "127.0.0.1"
log.Log.V(2).Infof("--proxy-only is set to false, listening on %s\n", listenAddress)
}
listenAddressFmt = listenAddress + ":%d"
lnAddr, err := net.ResolveTCPAddr("tcp", fmt.Sprintf(listenAddressFmt, customPort))
if err != nil {
return fmt.Errorf("Can't resolve the address: %s", err.Error())
}
// The local tcp server is used to proxy the podExec websock connection to vnc client
ln, err := net.ListenTCP("tcp", lnAddr)
if err != nil {
return fmt.Errorf("Can't listen on unix socket: %s", err.Error())
}
// End of pre-flight checks. Everything looks good, we can start
// the goroutines and let the data flow
// -> pipeInWriter -> pipeInReader
// remote-viewer -> unix sock connection
// <- pipeOutReader <- pipeOutWriter
pipeInReader, pipeInWriter := io.Pipe()
pipeOutReader, pipeOutWriter := io.Pipe()
k8ResChan := make(chan error)
listenResChan := make(chan error)
viewResChan := make(chan error)
stopChan := make(chan struct{}, 1)
doneChan := make(chan struct{}, 1)
writeStop := make(chan error)
readStop := make(chan error)
go func() {
// transfer data from/to the VM
k8ResChan <- vnc.Stream(kvcorev1.StreamOptions{
In: pipeInReader,
Out: pipeOutWriter,
})
}()
// wait for vnc client to connect to our local proxy server
go func() {
start := time.Now()
log.Log.Infof("connection timeout: %v", LISTEN_TIMEOUT)
// Don't set deadline if only proxy is running and VNC is to be connected manually
if !proxyOnly {
// exit early if spawning vnc client fails
ln.SetDeadline(time.Now().Add(LISTEN_TIMEOUT))
}
fd, err := ln.Accept()
if err != nil {
log.Log.V(2).Infof("Failed to accept unix sock connection. %s", err.Error())
listenResChan <- err
}
defer fd.Close()
log.Log.V(2).Infof("VNC Client connected in %v", time.Now().Sub(start))
templates.PrintWarningForPausedVMI(virtCli, vmi, namespace)
// write to FD <- pipeOutReader
go func() {
_, err := io.Copy(fd, pipeOutReader)
readStop <- err
}()
// read from FD -> pipeInWriter
go func() {
_, err := io.Copy(pipeInWriter, fd)
writeStop <- err
}()
// don't terminate until vnc client is done
<-doneChan
listenResChan <- err
}()
port := ln.Addr().(*net.TCPAddr).Port
if proxyOnly {
defer close(doneChan)
optionString, err := json.Marshal(struct {
Port int `json:"port"`
}{port})
if err != nil {
return fmt.Errorf("Error encountered: %s", err.Error())
}
fmt.Fprintln(cmd.OutOrStdout(), string(optionString))
} else {
// execute VNC Viewer
go checkAndRunVNCViewer(doneChan, viewResChan, port)
}
go func() {
defer close(stopChan)
interrupt := make(chan os.Signal, 1)
signal.Notify(interrupt, os.Interrupt)
<-interrupt
}()
select {
case <-stopChan:
case err = <-readStop:
case err = <-writeStop:
case err = <-k8ResChan:
case err = <-viewResChan:
case err = <-listenResChan:
}
if err != nil {
return fmt.Errorf("Error encountered: %s", err.Error())
}
return nil
}
func checkAndRunVNCViewer(doneChan chan struct{}, viewResChan chan error, port int) {
defer close(doneChan)
var err error
args := []string{}
vncBin := ""
osType := runtime.GOOS
switch osType {
case "darwin":
if matches, err := filepath.Glob(MACOS_TIGER_VNC_PATTERN); err == nil && len(matches) > 0 {
// Always use the latest version
vncBin = matches[len(matches)-1]
args = tigerVncArgs(port)
} else if err == filepath.ErrBadPattern {
viewResChan <- err
return
} else if _, err := os.Stat(MACOS_CHICKEN_VNC); err == nil {
vncBin = MACOS_CHICKEN_VNC
args = chickenVncArgs(port)
} else if !errors.Is(err, os.ErrNotExist) {
viewResChan <- err
return
} else if _, err := os.Stat(MACOS_REAL_VNC); err == nil {
vncBin = MACOS_REAL_VNC
args = realVncArgs(port)
} else if !errors.Is(err, os.ErrNotExist) {
viewResChan <- err
return
} else if _, err := exec.LookPath(REMOTE_VIEWER); err == nil {
// fall back to user supplied script/binary in path
vncBin = REMOTE_VIEWER
args = remoteViewerArgs(port)
} else if !errors.Is(err, os.ErrNotExist) {
viewResChan <- err
return
}
case "linux", "windows":
if _, err := exec.LookPath(REMOTE_VIEWER); err == nil {
vncBin = REMOTE_VIEWER
args = remoteViewerArgs(port)
} else if _, err := exec.LookPath(TIGER_VNC); err == nil {
vncBin = TIGER_VNC
args = tigerVncArgs(port)
} else {
viewResChan <- fmt.Errorf("could not find %s or %s binary in $PATH",
REMOTE_VIEWER, TIGER_VNC)
viewResChan <- err
return
}
default:
viewResChan <- fmt.Errorf("virtctl does not support VNC on %v", osType)
return
}
if vncBin == "" {
log.Log.Errorf("No supported VNC app found in %s", osType)
err = fmt.Errorf("No supported VNC app found in %s", osType)
} else {
log.Log.V(4).Infof("Executing commandline: '%s %v'", vncBin, args)
// #nosec No risk for attacket injection. vncBin and args include predefined strings
cmnd := exec.Command(vncBin, args...)
output, err := cmnd.CombinedOutput()
if err != nil {
log.Log.Errorf("%s execution failed: %v, output: %v", vncBin, err, string(output))
} else {
log.Log.V(2).Infof("%v output: %v", vncBin, string(output))
}
}
viewResChan <- err
}
func tigerVncArgs(port int) (args []string) {
args = append(args, fmt.Sprintf(listenAddressFmt, port))
if log.Log.Verbosity(4) {
args = append(args, "Log=*:stderr:100")
}
return
}
func chickenVncArgs(port int) (args []string) {
args = append(args, fmt.Sprintf(listenAddressFmt, port))
return
}
func realVncArgs(port int) (args []string) {
args = append(args, fmt.Sprintf(listenAddressFmt, port))
args = append(args, "-WarnUnencrypted=0")
args = append(args, "-Shared=0")
args = append(args, "-ShareFiles=0")
if log.Log.Verbosity(4) {
args = append(args, "-log=*:stderr:100")
}
return
}
func remoteViewerArgs(port int) (args []string) {
args = append(args, fmt.Sprintf("vnc://127.0.0.1:%d", port))
if log.Log.Verbosity(4) {
args = append(args, "--debug")
}
return
}
func usage() string {
return ` # Connect to 'testvmi' via remote-viewer:
{{ProgramName}} vnc testvmi`
}