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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
|
// License: GPLv3 Copyright: 2022, Kovid Goyal, <kovid at kovidgoyal.net>
package at
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"os"
"reflect"
"strconv"
"strings"
"time"
"unicode/utf16"
"golang.org/x/sys/unix"
"github.com/kovidgoyal/kitty"
"github.com/kovidgoyal/kitty/tools/cli"
"github.com/kovidgoyal/kitty/tools/crypto"
"github.com/kovidgoyal/kitty/tools/tty"
"github.com/kovidgoyal/kitty/tools/tui"
"github.com/kovidgoyal/kitty/tools/tui/loop"
"github.com/kovidgoyal/kitty/tools/utils"
"github.com/kovidgoyal/kitty/tools/utils/base85"
"github.com/kovidgoyal/kitty/tools/utils/shlex"
)
const lowerhex = "0123456789abcdef"
var ProtocolVersion [3]int = [3]int{0, 26, 0}
type password struct {
val string
is_set bool
}
type GlobalOptions struct {
to_network, to_address string
password password
to_address_is_from_env_var bool
already_setup bool
}
var global_options GlobalOptions
func expand_ansi_c_escapes_in_args(args ...string) (escaped_string, error) {
for i, x := range args {
args[i] = shlex.ExpandANSICEscapes(x)
}
return escaped_string(strings.Join(args, " ")), nil
}
func escape_list_of_strings(args []string) []escaped_string {
ans := make([]escaped_string, len(args))
for i, x := range args {
ans[i] = escaped_string(x)
}
return ans
}
func set_payload_string_field(io_data *rc_io_data, field, data string) {
payload_interface := reflect.ValueOf(&io_data.rc.Payload).Elem()
struct_in_interface := reflect.New(payload_interface.Elem().Type()).Elem()
struct_in_interface.Set(payload_interface.Elem()) // copies the payload to struct_in_interface
struct_in_interface.FieldByName(field).SetString(data)
payload_interface.Set(struct_in_interface) // copies struct_in_interface back to payload
}
func get_pubkey(encoded_key string) (encryption_version string, pubkey []byte, err error) {
if encoded_key == "" {
encoded_key = os.Getenv("KITTY_PUBLIC_KEY")
if encoded_key == "" {
err = fmt.Errorf("Password usage requested but KITTY_PUBLIC_KEY environment variable is not available")
return
}
}
encryption_version, encoded_key, found := strings.Cut(encoded_key, ":")
if !found {
err = fmt.Errorf("KITTY_PUBLIC_KEY environment variable does not have a : in it")
return
}
if encryption_version != kitty.RC_ENCRYPTION_PROTOCOL_VERSION {
err = fmt.Errorf("KITTY_PUBLIC_KEY has unknown version, if you are running on a remote system, update kitty on this system")
return
}
pubkey = make([]byte, base85.DecodedLen(len(encoded_key)))
n, err := base85.Decode(pubkey, []byte(encoded_key))
if err == nil {
pubkey = pubkey[:n]
}
return
}
type escaped_string string
func (s escaped_string) MarshalJSON() ([]byte, error) {
// See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON
// we additionally escape all non-ascii chars so they can be safely transmitted inside an escape code
src := utf16.Encode([]rune(s))
buf := make([]byte, 0, len(src)+128)
a := func(x ...byte) {
buf = append(buf, x...)
}
a('"')
for _, r := range src {
if ' ' <= r && r <= 126 {
if r == '\\' || r == '"' {
buf = append(buf, '\\')
}
buf = append(buf, byte(r))
continue
}
switch r {
case '\n':
a('\\', 'n')
case '\t':
a('\\', 't')
case '\r':
a('\\', 'r')
case '\f':
a('\\', 'f')
case '\b':
a('\\', 'b')
default:
a('\\', 'u')
for s := 12; s >= 0; s -= 4 {
a(lowerhex[r>>uint(s)&0xF])
}
}
}
a('"')
return buf, nil
}
func simple_serializer(rc *utils.RemoteControlCmd) (ans []byte, err error) {
return json.Marshal(rc)
}
type serializer_func func(rc *utils.RemoteControlCmd) ([]byte, error)
func create_serializer(password password, encoded_pubkey string, io_data *rc_io_data) (err error) {
io_data.serializer = simple_serializer
if password.is_set {
encryption_version, pubkey, err := get_pubkey(encoded_pubkey)
if err != nil {
return err
}
io_data.serializer = func(rc *utils.RemoteControlCmd) (ans []byte, err error) {
ec, err := crypto.Encrypt_cmd(rc, global_options.password.val, pubkey, encryption_version)
if err != nil {
return
}
return json.Marshal(ec)
}
if io_data.timeout < 120*time.Second {
io_data.timeout = 120 * time.Second
}
}
return nil
}
type ResponseData struct {
as_str string
is_string bool
}
func (self *ResponseData) UnmarshalJSON(data []byte) error {
if bytes.HasPrefix(data, []byte("\"")) {
self.is_string = true
return json.Unmarshal(data, &self.as_str)
}
if bytes.Equal(data, []byte("true")) {
self.as_str = "True"
} else if bytes.Equal(data, []byte("false")) {
self.as_str = "False"
} else {
self.as_str = string(data)
}
return nil
}
type Response struct {
Ok bool `json:"ok"`
Data ResponseData `json:"data"`
Error string `json:"error,omitempty"`
Traceback string `json:"tb,omitempty"`
}
type rc_io_data struct {
cmd *cli.Command
rc *utils.RemoteControlCmd
serializer serializer_func
on_key_event func(lp *loop.Loop, ke *loop.KeyEvent) error
string_response_is_err bool
handle_response func(data []byte) error
timeout time.Duration
multiple_payload_generator func(io_data *rc_io_data) (bool, error)
chunks_done bool
}
func (self *rc_io_data) next_chunk() (chunk []byte, err error) {
if self.chunks_done {
return make([]byte, 0), nil
}
if self.multiple_payload_generator != nil {
is_last, err := self.multiple_payload_generator(self)
if err != nil {
return nil, err
}
if is_last {
self.chunks_done = true
}
return self.serializer(self.rc)
}
self.chunks_done = true
return self.serializer(self.rc)
}
func get_response(do_io func(io_data *rc_io_data) ([]byte, error), io_data *rc_io_data) (ans *Response, err error) {
serialized_response, err := do_io(io_data)
if err != nil {
if errors.Is(err, os.ErrDeadlineExceeded) && io_data.rc.Async != "" {
io_data.rc.Payload = nil
io_data.rc.CancelAsync = true
io_data.multiple_payload_generator = nil
io_data.rc.NoResponse = true
io_data.chunks_done = false
_, _ = do_io(io_data)
err = fmt.Errorf("Timed out waiting for a response from kitty")
}
return nil, err
}
if len(serialized_response) == 0 {
if io_data.rc.NoResponse {
res := Response{Ok: true}
ans = &res
return
}
err = fmt.Errorf("Received empty response from kitty")
return
}
var response Response
err = json.Unmarshal(serialized_response, &response)
if err != nil {
err = fmt.Errorf("Invalid response received from kitty, unmarshalling error: %w", err)
return
}
ans = &response
return
}
var running_shell = false
type exit_error struct {
exit_code int
}
func (m *exit_error) Error() string {
return fmt.Sprintf("Subprocess exit with code: %d", m.exit_code)
}
func send_rc_command(io_data *rc_io_data) (err error) {
err = setup_global_options(io_data.cmd)
if err != nil {
return err
}
wid, err := strconv.Atoi(os.Getenv("KITTY_WINDOW_ID"))
if err == nil && wid > 0 {
io_data.rc.KittyWindowId = uint(wid)
}
err = create_serializer(global_options.password, "", io_data)
if err != nil {
return
}
var response *Response
response, err = get_response(utils.IfElse(global_options.to_network == "", do_tty_io, do_socket_io), io_data)
if err != nil || response == nil {
return
}
if !response.Ok {
if response.Traceback != "" {
fmt.Fprintln(os.Stderr, response.Traceback)
}
return fmt.Errorf("%s", response.Error)
}
if io_data.handle_response != nil {
return io_data.handle_response(utils.UnsafeStringToBytes(response.Data.as_str))
}
if response.Data.is_string && io_data.string_response_is_err {
return fmt.Errorf("%s", response.Data.as_str)
}
if response.Data.as_str != "" {
fmt.Println(strings.TrimRight(response.Data.as_str, "\n \t"))
}
return
}
func get_password(password string, password_file string, password_env string, use_password string) (ans password, err error) {
if use_password == "never" {
return
}
if password != "" {
ans.is_set, ans.val = true, password
}
if !ans.is_set && password_file != "" {
if password_file == "-" {
if tty.IsTerminal(os.Stdin.Fd()) {
p, err := tui.ReadPassword("Password: ", true)
if err != nil {
return ans, err
}
ans.is_set, ans.val = true, p
} else {
var q []byte
q, err = io.ReadAll(os.Stdin)
if err == nil {
ans.is_set, ans.val = true, strings.TrimRight(string(q), " \n\t")
}
ttyf, err := os.Open(tty.Ctermid())
if err == nil {
err = unix.Dup2(int(ttyf.Fd()), int(os.Stdin.Fd())) //nolint ineffassign err is returned indicating duping failed
ttyf.Close()
}
}
} else if strings.HasPrefix(password_file, "fd:") {
var fd int
if fd, err = strconv.Atoi(password_file[3:]); err == nil {
f := os.NewFile(uintptr(fd), password_file)
var q []byte
if q, err = io.ReadAll(f); err == nil {
ans.is_set = true
ans.val = string(q)
}
f.Close()
}
} else {
var q []byte
q, err = os.ReadFile(password_file)
if err == nil {
ans.is_set, ans.val = true, strings.TrimRight(string(q), " \n\t")
} else {
if errors.Is(err, os.ErrNotExist) {
err = nil
}
}
}
if err != nil {
return
}
}
if !ans.is_set && password_env != "" {
ans.val, ans.is_set = os.LookupEnv(password_env)
}
if !ans.is_set && use_password == "always" {
ans.is_set = true
return ans, nil
}
if len(ans.val) > 1024 {
return ans, fmt.Errorf("Specified password is too long")
}
return ans, nil
}
var all_commands []func(*cli.Command) *cli.Command = make([]func(*cli.Command) *cli.Command, 0, 64)
func register_at_cmd(f func(*cli.Command) *cli.Command) {
all_commands = append(all_commands, f)
}
func setup_global_options(cmd *cli.Command) (err error) {
if global_options.already_setup {
return nil
}
err = cmd.GetOptionValues(&rc_global_opts)
if err != nil {
return err
}
if rc_global_opts.To == "" {
rc_global_opts.To = os.Getenv("KITTY_LISTEN_ON")
global_options.to_address_is_from_env_var = true
}
if rc_global_opts.To != "" {
network, address, err := utils.ParseSocketAddress(rc_global_opts.To)
if err != nil {
return err
}
global_options.to_network = network
global_options.to_address = address
}
q, err := get_password(rc_global_opts.Password, rc_global_opts.PasswordFile, rc_global_opts.PasswordEnv, rc_global_opts.UsePassword)
global_options.password = q
global_options.already_setup = true
return err
}
func EntryPoint(tool_root *cli.Command) *cli.Command {
at_root_command := tool_root.AddSubCommand(&cli.Command{
Name: "@",
Usage: "[global options] [sub-command] [sub-command options] [sub-command args]",
ShortDescription: "Control kitty remotely",
HelpText: "Control kitty by sending it commands. Set the allow_remote_control option in :file:`kitty.conf` for this to work. When run without any sub-commands this will start an interactive shell to control kitty.",
Run: shell_main,
})
add_rc_global_opts(at_root_command)
global_options_group := at_root_command.OptionGroups[0]
for _, reg_func := range all_commands {
c := reg_func(at_root_command)
clone := tool_root.AddClone("", c)
clone.Name = "@" + c.Name
clone.Hidden = true
clone.OptionGroups = append(clone.OptionGroups, global_options_group.Clone(clone))
}
return at_root_command
}
|