rpc/dial.go

   1 // Simple RPC-like protocol: establish new connection and upload helper
   2
   3 // Copyright (C) 2021  Simon Ruderich
   4 //
   5 // This program is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 package rpc
  19
  20 import (
  21         "bufio"
  22         "bytes"
  23         "crypto/sha512"
  24         "encoding/hex"
  25         "fmt"
  26         "io"
  27         "os/exec"
  28         "strconv"
  29         "strings"
  30
  31         "ruderich.org/simon/safcm"
  32         "ruderich.org/simon/safcm/remote"
  33 )
  34
  35 func (c *Conn) DialSSH(user, host string) error {
  36         if c.events == nil {
  37                 return fmt.Errorf("cannot reuse Conn")
  38         }
  39
  40         remote := host
  41         if user != "" {
  42                 remote = user + "@" + host
  43         }
  44         c.debugf("DialSSH: connecting to %q", remote)
  45
  46         opts := "-eu"
  47         if c.debug {
  48                 // Help debugging by showing executed shell commands
  49                 opts += "x"
  50         }
  51         c.cmd = exec.Command("ssh", remote, "/bin/sh", opts)
  52         c.remote = remote
  53
  54         stdin, err := c.cmd.StdinPipe()
  55         if err != nil {
  56                 return err
  57         }
  58         stdout, err := c.cmd.StdoutPipe()
  59         if err != nil {
  60                 return err
  61         }
  62         err = c.handleStderrAsEvents(c.cmd)
  63         if err != nil {
  64                 return err
  65         }
  66
  67         err = c.cmd.Start()
  68         if err != nil {
  69                 return err
  70         }
  71
  72         err = c.dialSSH(stdin, stdout)
  73         if err != nil {
  74                 c.Kill()
  75                 return err
  76         }
  77         c.conn = safcm.NewGobConn(stdout, stdin)
  78
  79         return nil
  80 }
  81
  82 func (c *Conn) dialSSH(stdin io.Writer, stdout_ io.Reader) error {
  83         stdout := bufio.NewReader(stdout_)
  84
  85         goos, err := connGetGoos(stdin, stdout)
  86         if err != nil {
  87                 return err
  88         }
  89         goarch, err := connGetGoarch(stdin, stdout)
  90         if err != nil {
  91                 return err
  92         }
  93         uid, err := connGetUID(stdin, stdout)
  94         if err != nil {
  95                 return err
  96         }
  97
  98         path := fmt.Sprintf("/tmp/safcm-remote-%d", uid)
  99
 100         c.debugf("DialSSH: probing remote at %q", path)
 101
 102         // Compatibility for different operating systems
 103         var compat string
 104         switch goos {
 105         case "linux":
 106                 compat = `
 107 dir_stat='drwxrwxrwt 0 0'
 108 file_stat="-rwx------ $(id -u) $(id -g)"
 109 compat_stat() {
 110         stat -c '%A %u %g' "$1"
 111 }
 112 compat_sha512sum() {
 113         sha512sum "$1"
 114 }
 115 `
 116         default:
 117                 return fmt.Errorf("internal error: no support for %q", goos)
 118         }
 119
 120         // Use a function so the shell cannot execute the input line-wise.
 121         // This is important because we're also using stdin to send data to
 122         // the script. If the shell executes the input line-wise then our
 123         // script is interpreted as input for `read`.
 124         //
 125         // The target directory must no permit other users to delete our files
 126         // or symlink attacks and arbitrary code execution is possible. For
 127         // /tmp this is guaranteed by the sticky bit. Make sure it has the
 128         // proper permissions.
 129         //
 130         // We cannot use `test -f && test -O` because this is open to TOCTOU
 131         // attacks. `stat` gives use the full file state. If the file is owned
 132         // by us and not a symlink then it's safe to use (assuming sticky or
 133         // directory not writable by others).
 134         //
 135         // `test -e` is only used to prevent error messages if the file
 136         // doesn't exist. It does not guard against any races.
 137         _, err = fmt.Fprintf(stdin, `
 138 %s
 139 f() {
 140         x=%q
 141
 142         dir="$(dirname "$x")"
 143         if ! test "$(compat_stat "$dir")" = "$dir_stat"; then
 144                 echo "unsafe permissions on $dir, aborting" >&2
 145                 exit 1
 146         fi
 147
 148         if test -e "$x" && test "$(compat_stat "$x")" = "$file_stat"; then
 149                 # Report checksum
 150                 compat_sha512sum "$x"
 151         else
 152                 # Empty checksum to request upload
 153                 echo
 154         fi
 155
 156         # Wait for signal to continue
 157         read upload
 158
 159         if test -n "$upload"; then
 160                 tmp="$(mktemp "$x.XXXXXX")"
 161                 # Report filename for upload
 162                 echo "$tmp"
 163
 164                 # Wait for upload to complete
 165                 read unused
 166
 167                 # Safely create new file (ln does not follow symlinks)
 168                 rm -f "$x"
 169                 ln "$tmp" "$x"
 170                 rm "$tmp"
 171                 # Make file executable
 172                 chmod 0700 "$x"
 173         fi
 174
 175         exec "$x" sync
 176 }
 177 f
 178 `, compat, path)
 179         if err != nil {
 180                 return err
 181         }
 182         remoteSum, err := stdout.ReadString('\n')
 183         if err != nil {
 184                 return err
 185         }
 186
 187         // Get embedded helper binary
 188         helper, err := remote.Helpers.ReadFile(
 189                 fmt.Sprintf("helpers/%s-%s", goos, goarch))
 190         if err != nil {
 191                 return fmt.Errorf("remote not built for GOOS/GOARCH %s/%s",
 192                         goos, goarch)
 193         }
 194
 195         var upload bool
 196         if remoteSum == "\n" {
 197                 upload = true
 198                 c.debugf("DialSSH: remote not present or invalid permissions")
 199
 200         } else {
 201                 x := strings.Fields(remoteSum)
 202                 if len(x) < 1 {
 203                         return fmt.Errorf("got unexpected checksum line %q",
 204                                 remoteSum)
 205                 }
 206                 sha := sha512.Sum512(helper)
 207                 hex := hex.EncodeToString(sha[:])
 208                 if hex == x[0] {
 209                         c.debugf("DialSSH: remote checksum matches")
 210                 } else {
 211                         upload = true
 212                         c.debugf("DialSSH: remote checksum does not match")
 213                 }
 214         }
 215
 216         if upload {
 217                 // Notify user that an upload is going to take place.
 218                 c.events <- ConnEvent{
 219                         Type: ConnEventUpload,
 220                 }
 221
 222                 // Tell script we want to upload a new file.
 223                 _, err = fmt.Fprintln(stdin, "upload")
 224                 if err != nil {
 225                         return err
 226                 }
 227                 // Get path to temporary file for upload.
 228                 //
 229                 // Write to the temporary file instead of the final path so
 230                 // that a concurrent run of this function won't use a
 231                 // partially written file. The rm in the script could still
 232                 // cause a missing file but at least no file with unknown
 233                 // content is executed.
 234                 path, err := stdout.ReadString('\n')
 235                 if err != nil {
 236                         return err
 237                 }
 238                 path = strings.TrimSuffix(path, "\n")
 239
 240                 c.debugf("DialSSH: uploading new remote to %q at %q",
 241                         c.remote, path)
 242
 243                 cmd := exec.Command("ssh", c.remote,
 244                         fmt.Sprintf("cat > %q", path))
 245                 cmd.Stdin = bytes.NewReader(helper)
 246                 err = c.handleStderrAsEvents(cmd)
 247                 if err != nil {
 248                         return err
 249                 }
 250                 err = cmd.Run()
 251                 if err != nil {
 252                         return err
 253                 }
 254         }
 255
 256         // Tell script to continue and execute the remote helper
 257         _, err = fmt.Fprintln(stdin, "")
 258         if err != nil {
 259                 return err
 260         }
 261
 262         return nil
 263 }
 264
 265 func connGetGoos(stdin io.Writer, stdout *bufio.Reader) (string, error) {
 266         _, err := fmt.Fprintln(stdin, "uname -o")
 267         if err != nil {
 268                 return "", err
 269         }
 270         x, err := stdout.ReadString('\n')
 271         if err != nil {
 272                 return "", err
 273         }
 274         x = strings.TrimSpace(x)
 275
 276         // NOTE: Adapt helper uploading in dialSSH() when adding new systems
 277         var goos string
 278         switch x {
 279         case "GNU/Linux":
 280                 goos = "linux"
 281         default:
 282                 return "", fmt.Errorf("unsupported OS %q (`uname -o`)", x)
 283         }
 284         return goos, nil
 285 }
 286
 287 func connGetGoarch(stdin io.Writer, stdout *bufio.Reader) (string, error) {
 288         _, err := fmt.Fprintln(stdin, "uname -m")
 289         if err != nil {
 290                 return "", err
 291         }
 292         x, err := stdout.ReadString('\n')
 293         if err != nil {
 294                 return "", err
 295         }
 296         x = strings.TrimSpace(x)
 297
 298         // NOTE: Adapt cmd/safcm-remote/build.sh when adding new architectures
 299         var goarch string
 300         switch x {
 301         case "x86_64":
 302                 goarch = "amd64"
 303         case "armv7l":
 304                 goarch = "armv7l"
 305         default:
 306                 return "", fmt.Errorf("unsupported arch %q (`uname -m`)", x)
 307         }
 308         return goarch, nil
 309 }
 310
 311 func connGetUID(stdin io.Writer, stdout *bufio.Reader) (int, error) {
 312         _, err := fmt.Fprintln(stdin, "id -u")
 313         if err != nil {
 314                 return -1, err
 315         }
 316         x, err := stdout.ReadString('\n')
 317         if err != nil {
 318                 return -1, err
 319         }
 320         x = strings.TrimSpace(x)
 321
 322         uid, err := strconv.Atoi(x)
 323         if err != nil {
 324                 return -1, fmt.Errorf("invalid UID %q (`id -u`)", x)
 325         }
 326         return uid, nil
 327 }