Commit | Line | Data |
---|---|---|
987a29ba | 1 | ;;; GNU Guix --- Functional package management for GNU |
76832d34 | 2 | ;;; Copyright © 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org> |
987a29ba LC |
3 | ;;; |
4 | ;;; This file is part of GNU Guix. | |
5 | ;;; | |
6 | ;;; GNU Guix is free software; you can redistribute it and/or modify it | |
7 | ;;; under the terms of the GNU General Public License as published by | |
8 | ;;; the Free Software Foundation; either version 3 of the License, or (at | |
9 | ;;; your option) any later version. | |
10 | ;;; | |
11 | ;;; GNU Guix is distributed in the hope that it will be useful, but | |
12 | ;;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | ;;; GNU General Public License for more details. | |
15 | ;;; | |
16 | ;;; You should have received a copy of the GNU General Public License | |
17 | ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. | |
18 | ||
19 | (define-module (guix ssh) | |
20 | #:use-module (guix store) | |
af15fe13 | 21 | #:use-module (guix inferior) |
52d174d6 | 22 | #:use-module (guix i18n) |
896fec47 | 23 | #:use-module ((guix utils) #:select (&fix-hint)) |
3033d59a | 24 | #:use-module (gcrypt pk-crypto) |
615c5298 LC |
25 | #:use-module (ssh session) |
26 | #:use-module (ssh auth) | |
27 | #:use-module (ssh key) | |
987a29ba LC |
28 | #:use-module (ssh channel) |
29 | #:use-module (ssh popen) | |
30 | #:use-module (ssh session) | |
0e3c8528 | 31 | #:use-module (srfi srfi-1) |
987a29ba | 32 | #:use-module (srfi srfi-11) |
d06d54e3 | 33 | #:use-module (srfi srfi-26) |
13164a21 LC |
34 | #:use-module (srfi srfi-34) |
35 | #:use-module (srfi srfi-35) | |
987a29ba | 36 | #:use-module (ice-9 match) |
416a7c69 | 37 | #:use-module (ice-9 format) |
13164a21 | 38 | #:use-module (ice-9 binary-ports) |
615c5298 | 39 | #:export (open-ssh-session |
114dcb42 LC |
40 | authenticate-server* |
41 | ||
af15fe13 | 42 | remote-inferior |
e5378337 | 43 | remote-daemon-channel |
615c5298 | 44 | connect-to-remote-daemon |
2c8e04f1 | 45 | remote-system |
3033d59a | 46 | remote-authorize-signing-key |
987a29ba LC |
47 | send-files |
48 | retrieve-files | |
d06d54e3 | 49 | retrieve-files* |
4eb0f9ae LC |
50 | remote-store-host |
51 | ||
52 | report-guile-error | |
53 | report-module-error)) | |
987a29ba LC |
54 | |
55 | ;;; Commentary: | |
56 | ;;; | |
57 | ;;; This module provides tools to support communication with remote stores | |
58 | ;;; over SSH, using Guile-SSH. | |
59 | ;;; | |
60 | ;;; Code: | |
61 | ||
615c5298 LC |
62 | (define %compression |
63 | "zlib@openssh.com,zlib") | |
64 | ||
114dcb42 LC |
65 | (define (host-key->type+key host-key) |
66 | "Destructure HOST-KEY, an OpenSSH host key string, and return two values: | |
67 | its key type as a symbol, and the actual base64-encoded string." | |
68 | (define (type->symbol type) | |
69 | (and (string-prefix? "ssh-" type) | |
70 | (string->symbol (string-drop type 4)))) | |
71 | ||
72 | (match (string-tokenize host-key) | |
73 | ((type key x) | |
74 | (values (type->symbol type) key)) | |
75 | ((type key) | |
76 | (values (type->symbol type) key)))) | |
77 | ||
78 | (define (authenticate-server* session key) | |
79 | "Make sure the server for SESSION has the given KEY, where KEY is a string | |
80 | such as \"ssh-ed25519 AAAAC3Nz… root@example.org\". Raise an exception if the | |
81 | actual key does not match." | |
82 | (let-values (((server) (get-server-public-key session)) | |
83 | ((type key) (host-key->type+key key))) | |
84 | (unless (and (or (not (get-key-type server)) | |
85 | (eq? (get-key-type server) type)) | |
86 | (string=? (public-key->string server) key)) | |
87 | ;; Key mismatch: something's wrong. XXX: It could be that the server | |
88 | ;; provided its Ed25519 key when we where expecting its RSA key. XXX: | |
89 | ;; Guile-SSH 0.10.1 doesn't know about ed25519 keys and 'get-key-type' | |
90 | ;; returns #f in that case. | |
91 | (raise (condition | |
92 | (&message | |
93 | (message (format #f (G_ "server at '~a' returned host key \ | |
94 | '~a' of type '~a' instead of '~a' of type '~a'~%") | |
95 | (session-get session 'host) | |
96 | (public-key->string server) | |
97 | (get-key-type server) | |
98 | key type)))))))) | |
99 | ||
a9b09ed7 | 100 | (define* (open-ssh-session host #:key user port identity |
2b868284 | 101 | host-key |
81c5873a LC |
102 | (compression %compression) |
103 | (timeout 3600)) | |
a9b09ed7 JK |
104 | "Open an SSH session for HOST and return it. IDENTITY specifies the file |
105 | name of a private key to use for authenticating with the host. When USER, | |
106 | PORT, or IDENTITY are #f, use default values or whatever '~/.ssh/config' | |
2b868284 LC |
107 | specifies; otherwise use them. |
108 | ||
109 | When HOST-KEY is true, it must be a string like \"ssh-ed25519 AAAAC3Nz… | |
110 | root@example.org\"; the server is authenticated and an error is raised if its | |
111 | host key is different from HOST-KEY. | |
112 | ||
113 | Install TIMEOUT as the maximum time in seconds after which a read or write | |
114 | operation on a channel of the returned session is considered as failing. | |
81c5873a LC |
115 | |
116 | Throw an error on failure." | |
615c5298 | 117 | (let ((session (make-session #:user user |
a9b09ed7 | 118 | #:identity identity |
615c5298 LC |
119 | #:host host |
120 | #:port port | |
121 | #:timeout 10 ;seconds | |
122 | ;; #:log-verbosity 'protocol | |
123 | ||
2b868284 LC |
124 | ;; Prevent libssh from reading |
125 | ;; ~/.ssh/known_hosts when the caller provides | |
126 | ;; a HOST-KEY to match against. | |
127 | #:knownhosts (and host-key "/dev/null") | |
128 | ||
615c5298 LC |
129 | ;; We need lightweight compression when |
130 | ;; exchanging full archives. | |
131 | #:compression compression | |
132 | #:compression-level 3))) | |
133 | ||
134 | ;; Honor ~/.ssh/config. | |
135 | (session-parse-config! session) | |
136 | ||
137 | (match (connect! session) | |
138 | ('ok | |
2b868284 LC |
139 | (if host-key |
140 | ;; Make sure the server's key is what we expect. | |
141 | (authenticate-server* session host-key) | |
142 | ||
143 | ;; Authenticate against ~/.ssh/known_hosts. | |
144 | (match (authenticate-server session) | |
145 | ('ok #f) | |
146 | (reason | |
147 | (raise (condition | |
148 | (&message | |
149 | (message (format #f (G_ "failed to authenticate \ | |
f5c18018 | 150 | server at '~a': ~a") |
2b868284 LC |
151 | (session-get session 'host) |
152 | reason)))))))) | |
f5c18018 | 153 | |
615c5298 LC |
154 | ;; Use public key authentication, via the SSH agent if it's available. |
155 | (match (userauth-public-key/auto! session) | |
156 | ('success | |
81c5873a | 157 | (session-set! session 'timeout timeout) |
615c5298 LC |
158 | session) |
159 | (x | |
160 | (disconnect! session) | |
161 | (raise (condition | |
162 | (&message | |
69daee23 | 163 | (message (format #f (G_ "SSH authentication failed for '~a': ~a~%") |
615c5298 LC |
164 | host (get-error session))))))))) |
165 | (x | |
166 | ;; Connection failed or timeout expired. | |
167 | (raise (condition | |
168 | (&message | |
69daee23 | 169 | (message (format #f (G_ "SSH connection to '~a' failed: ~a~%") |
615c5298 LC |
170 | host (get-error session)))))))))) |
171 | ||
5ea7537b JK |
172 | (define* (remote-inferior session #:optional become-command) |
173 | "Return a remote inferior for the given SESSION. If BECOME-COMMAND is | |
174 | given, use that to invoke the remote Guile REPL." | |
175 | (let* ((repl-command (append (or become-command '()) | |
176 | '("guix" "repl" "-t" "machine"))) | |
177 | (pipe (apply open-remote-pipe* session OPEN_BOTH repl-command))) | |
5ea7537b | 178 | (when (eof-object? (peek-char pipe)) |
e09c7f4a LC |
179 | (let ((status (channel-get-exit-status pipe))) |
180 | (close-port pipe) | |
181 | (raise (condition | |
182 | (&message | |
183 | (message (format #f (G_ "remote command '~{~a~^ ~}' failed \ | |
184 | with status ~a") | |
185 | repl-command status))))))) | |
af15fe13 LC |
186 | (port->inferior pipe))) |
187 | ||
5ea7537b | 188 | (define* (inferior-remote-eval exp session #:optional become-command) |
ed7b4437 | 189 | "Evaluate EXP in a new inferior running in SESSION, and close the inferior |
5ea7537b JK |
190 | right away. If BECOME-COMMAND is given, use that to invoke the remote Guile |
191 | REPL." | |
192 | (let ((inferior (remote-inferior session become-command))) | |
ed7b4437 LC |
193 | (dynamic-wind |
194 | (const #t) | |
195 | (lambda () | |
196 | (inferior-eval exp inferior)) | |
197 | (lambda () | |
198 | ;; Close INFERIOR right away to prevent finalization from happening in | |
199 | ;; another thread at the wrong time (see | |
200 | ;; <https://bugs.gnu.org/26976>.) | |
201 | (close-inferior inferior))))) | |
202 | ||
e5378337 LC |
203 | (define* (remote-daemon-channel session |
204 | #:optional | |
205 | (socket-name | |
206 | "/var/guix/daemon-socket/socket")) | |
207 | "Return an input/output port (an SSH channel) to the daemon at SESSION." | |
987a29ba LC |
208 | (define redirect |
209 | ;; Code run in SESSION to redirect the remote process' stdin/stdout to the | |
210 | ;; daemon's socket, à la socat. The SSH protocol supports forwarding to | |
211 | ;; Unix-domain sockets but libssh doesn't have an API for that, hence this | |
212 | ;; hack. | |
213 | `(begin | |
17af5d51 | 214 | (use-modules (ice-9 match) (rnrs io ports) |
0dcf675c | 215 | (rnrs bytevectors)) |
987a29ba | 216 | |
8446dc5a LC |
217 | (let ((sock (socket AF_UNIX SOCK_STREAM 0)) |
218 | (stdin (current-input-port)) | |
219 | (stdout (current-output-port)) | |
220 | (select* (lambda (read write except) | |
221 | ;; This is a workaround for | |
222 | ;; <https://bugs.gnu.org/30365> in Guile < 2.2.4: | |
223 | ;; since 'select' sometimes returns non-empty sets for | |
224 | ;; no good reason, call 'select' a second time with a | |
225 | ;; zero timeout to filter out incorrect replies. | |
226 | (match (select read write except) | |
227 | ((read write except) | |
228 | (select read write except 0)))))) | |
76832d34 | 229 | (setvbuf stdout 'none) |
0dcf675c LC |
230 | |
231 | ;; Use buffered ports so that 'get-bytevector-some' returns up to the | |
232 | ;; whole buffer like read(2) would--see <https://bugs.gnu.org/30066>. | |
76832d34 LC |
233 | (setvbuf stdin 'block 65536) |
234 | (setvbuf sock 'block 65536) | |
0dcf675c | 235 | |
987a29ba LC |
236 | (connect sock AF_UNIX ,socket-name) |
237 | ||
238 | (let loop () | |
8446dc5a | 239 | (match (select* (list stdin sock) '() '()) |
55f40fdb | 240 | ((reads () ()) |
987a29ba | 241 | (when (memq stdin reads) |
0dcf675c LC |
242 | (match (get-bytevector-some stdin) |
243 | ((? eof-object?) | |
987a29ba | 244 | (primitive-exit 0)) |
0dcf675c LC |
245 | (bv |
246 | (put-bytevector sock bv) | |
247 | (force-output sock)))) | |
987a29ba | 248 | (when (memq sock reads) |
0dcf675c LC |
249 | (match (get-bytevector-some sock) |
250 | ((? eof-object?) | |
987a29ba | 251 | (primitive-exit 0)) |
0dcf675c LC |
252 | (bv |
253 | (put-bytevector stdout bv)))) | |
987a29ba LC |
254 | (loop)) |
255 | (_ | |
256 | (primitive-exit 1))))))) | |
257 | ||
e5378337 LC |
258 | (open-remote-pipe* session OPEN_BOTH |
259 | ;; Sort-of shell-quote REDIRECT. | |
260 | "guile" "-c" | |
261 | (object->string | |
262 | (object->string redirect)))) | |
263 | ||
264 | (define* (connect-to-remote-daemon session | |
265 | #:optional | |
266 | (socket-name | |
267 | "/var/guix/daemon-socket/socket")) | |
268 | "Connect to the remote build daemon listening on SOCKET-NAME over SESSION, | |
de9fbe9c | 269 | an SSH session. Return a <store-connection> object." |
2e4d8339 | 270 | (open-connection #:port (remote-daemon-channel session socket-name))) |
e5378337 | 271 | |
987a29ba LC |
272 | |
273 | (define (store-import-channel session) | |
274 | "Return an output port to which archives to be exported to SESSION's store | |
275 | can be written." | |
276 | ;; Using the 'import-paths' RPC on a remote store would be slow because it | |
277 | ;; makes a round trip every time 32 KiB have been transferred. This | |
278 | ;; procedure instead opens a separate channel to use the remote | |
279 | ;; 'import-paths' procedure, which consumes all the data in a single round | |
de9d8f0e LC |
280 | ;; trip. This optimizes the successful case at the expense of error |
281 | ;; conditions: errors can only be reported once all the input has been | |
282 | ;; consumed. | |
987a29ba LC |
283 | (define import |
284 | `(begin | |
de9d8f0e LC |
285 | (use-modules (guix) (srfi srfi-34) |
286 | (rnrs io ports) (rnrs bytevectors)) | |
987a29ba | 287 | |
de9d8f0e LC |
288 | (define (consume-input port) |
289 | (let ((bv (make-bytevector 32768))) | |
290 | (let loop () | |
291 | (let ((n (get-bytevector-n! port bv 0 | |
292 | (bytevector-length bv)))) | |
293 | (unless (eof-object? n) | |
294 | (loop)))))) | |
987a29ba | 295 | |
de9d8f0e LC |
296 | ;; Upon completion, write an sexp that denotes the status. |
297 | (write | |
298 | (catch #t | |
299 | (lambda () | |
300 | (guard (c ((nix-protocol-error? c) | |
301 | ;; Consume all the input since the only time we can | |
302 | ;; report the error is after everything has been | |
303 | ;; consumed. | |
304 | (consume-input (current-input-port)) | |
305 | (list 'protocol-error (nix-protocol-error-message c)))) | |
306 | (with-store store | |
76832d34 | 307 | (setvbuf (current-input-port) 'none) |
de9d8f0e LC |
308 | (import-paths store (current-input-port)) |
309 | '(success)))) | |
310 | (lambda args | |
311 | (cons 'error args)))))) | |
987a29ba | 312 | |
de9d8f0e LC |
313 | (open-remote-pipe session |
314 | (string-join | |
315 | `("guile" "-c" | |
316 | ,(object->string (object->string import)))) | |
317 | OPEN_BOTH)) | |
987a29ba | 318 | |
e9629e82 LC |
319 | (define* (store-export-channel session files |
320 | #:key recursive?) | |
987a29ba | 321 | "Return an input port from which an export of FILES from SESSION's store can |
e9629e82 | 322 | be read. When RECURSIVE? is true, the closure of FILES is exported." |
987a29ba LC |
323 | ;; Same as above: this is more efficient than calling 'export-paths' on a |
324 | ;; remote store. | |
325 | (define export | |
326 | `(begin | |
896fec47 LC |
327 | (eval-when (load expand eval) |
328 | (unless (resolve-module '(guix) #:ensure #f) | |
329 | (write `(module-error)) | |
330 | (exit 7))) | |
331 | ||
332 | (use-modules (guix) (srfi srfi-1) | |
333 | (srfi srfi-26) (srfi srfi-34)) | |
334 | ||
335 | (guard (c ((nix-connection-error? c) | |
336 | (write `(connection-error ,(nix-connection-error-file c) | |
337 | ,(nix-connection-error-code c)))) | |
338 | ((nix-protocol-error? c) | |
339 | (write `(protocol-error ,(nix-protocol-error-status c) | |
340 | ,(nix-protocol-error-message c)))) | |
341 | (else | |
342 | (write `(exception)))) | |
343 | (with-store store | |
344 | (let* ((files ',files) | |
345 | (invalid (remove (cut valid-path? store <>) | |
346 | files))) | |
347 | (unless (null? invalid) | |
348 | (write `(invalid-items ,invalid)) | |
349 | (exit 1)) | |
350 | ||
0e3c8528 LC |
351 | ;; TODO: When RECURSIVE? is true, we could send the list of store |
352 | ;; items in the closure so that the other end can filter out | |
353 | ;; those it already has. | |
354 | ||
896fec47 LC |
355 | (write '(exporting)) ;we're ready |
356 | (force-output) | |
357 | ||
76832d34 | 358 | (setvbuf (current-output-port) 'none) |
896fec47 LC |
359 | (export-paths store files (current-output-port) |
360 | #:recursive? ,recursive?)))))) | |
987a29ba LC |
361 | |
362 | (open-remote-input-pipe session | |
363 | (string-join | |
364 | `("guile" "-c" | |
365 | ,(object->string | |
366 | (object->string export)))))) | |
367 | ||
2c8e04f1 JK |
368 | (define (remote-system session) |
369 | "Return the system type as expected by Nix, usually ARCHITECTURE-KERNEL, of | |
370 | the machine on the other end of SESSION." | |
371 | (inferior-remote-eval '(begin (use-modules (guix utils)) (%current-system)) | |
372 | session)) | |
3033d59a | 373 | |
4cc5e520 | 374 | (define* (remote-authorize-signing-key key session #:optional become-command) |
3033d59a JK |
375 | "Send KEY, a canonical sexp containing a public key, over SESSION and add it |
376 | to the system ACL file if it has not yet been authorized." | |
377 | (inferior-remote-eval | |
378 | `(begin | |
379 | (use-modules (guix build utils) | |
380 | (guix pki) | |
381 | (guix utils) | |
382 | (gcrypt pk-crypto) | |
383 | (srfi srfi-26)) | |
384 | ||
385 | (define acl (current-acl)) | |
386 | (define key (string->canonical-sexp ,(canonical-sexp->string key))) | |
387 | ||
388 | (unless (authorized-key? key) | |
389 | (let ((acl (public-keys->acl (cons key (acl->public-keys acl))))) | |
390 | (mkdir-p (dirname %acl-file)) | |
391 | (with-atomic-file-output %acl-file | |
392 | (cut write-acl acl <>))))) | |
4cc5e520 JK |
393 | session |
394 | become-command)) | |
2c8e04f1 | 395 | |
987a29ba | 396 | (define* (send-files local files remote |
e9629e82 LC |
397 | #:key |
398 | recursive? | |
399 | (log-port (current-error-port))) | |
987a29ba | 400 | "Send the subset of FILES from LOCAL (a local store) that's missing to |
23973e4f LC |
401 | REMOTE, a remote store. When RECURSIVE? is true, send the closure of FILES. |
402 | Return the list of store items actually sent." | |
987a29ba | 403 | ;; Compute the subset of FILES missing on SESSION and send them. |
e9629e82 | 404 | (let* ((files (if recursive? (requisites local files) files)) |
de9fbe9c | 405 | (session (channel-get-session (store-connection-socket remote))) |
ed7b4437 LC |
406 | (missing (inferior-remote-eval |
407 | `(begin | |
408 | (use-modules (guix) | |
409 | (srfi srfi-1) (srfi srfi-26)) | |
987a29ba | 410 | |
ed7b4437 LC |
411 | (with-store store |
412 | (remove (cut valid-path? store <>) | |
413 | ',files))) | |
414 | session)) | |
987a29ba | 415 | (count (length missing)) |
b90d97ec LC |
416 | (sizes (map (lambda (item) |
417 | (path-info-nar-size (query-path-info local item))) | |
418 | missing)) | |
987a29ba | 419 | (port (store-import-channel session))) |
b90d97ec LC |
420 | (format log-port (N_ "sending ~a store item (~h MiB) to '~a'...~%" |
421 | "sending ~a store items (~h MiB) to '~a'...~%" count) | |
422 | count | |
423 | (inexact->exact (round (/ (reduce + 0 sizes) (expt 2. 20)))) | |
424 | (session-get session 'host)) | |
987a29ba LC |
425 | |
426 | ;; Send MISSING in topological order. | |
427 | (export-paths local missing port) | |
428 | ||
429 | ;; Tell the remote process that we're done. (In theory the end-of-archive | |
430 | ;; mark of 'export-paths' would be enough, but in practice it's not.) | |
431 | (channel-send-eof port) | |
432 | ||
de9d8f0e | 433 | ;; Wait for completion of the remote process and read the status sexp from |
63fd9f08 LC |
434 | ;; PORT. Wait for the exit status only when 'read' completed; otherwise, |
435 | ;; we might wait forever if the other end is stuck. | |
de9d8f0e | 436 | (let* ((result (false-if-exception (read port))) |
63fd9f08 LC |
437 | (status (and result |
438 | (zero? (channel-get-exit-status port))))) | |
987a29ba | 439 | (close-port port) |
de9d8f0e LC |
440 | (match result |
441 | (('success . _) | |
442 | missing) | |
443 | (('protocol-error message) | |
444 | (raise (condition | |
f9e8a123 | 445 | (&store-protocol-error (message message) (status 42))))) |
de9d8f0e LC |
446 | (('error key args ...) |
447 | (raise (condition | |
f9e8a123 | 448 | (&store-protocol-error |
de9d8f0e LC |
449 | (message (call-with-output-string |
450 | (lambda (port) | |
451 | (print-exception port #f key args)))) | |
452 | (status 43))))) | |
453 | (_ | |
454 | (raise (condition | |
f9e8a123 | 455 | (&store-protocol-error |
de9d8f0e LC |
456 | (message "unknown error while sending files over SSH") |
457 | (status 44))))))))) | |
987a29ba LC |
458 | |
459 | (define (remote-store-session remote) | |
460 | "Return the SSH channel beneath REMOTE, a remote store as returned by | |
461 | 'connect-to-remote-daemon', or #f." | |
de9fbe9c | 462 | (channel-get-session (store-connection-socket remote))) |
987a29ba LC |
463 | |
464 | (define (remote-store-host remote) | |
465 | "Return the name of the host REMOTE is connected to, where REMOTE is a | |
466 | remote store as returned by 'connect-to-remote-daemon'." | |
467 | (match (remote-store-session remote) | |
468 | (#f #f) | |
469 | ((? session? session) | |
470 | (session-get session 'host)))) | |
471 | ||
e9629e82 LC |
472 | (define* (file-retrieval-port files remote |
473 | #:key recursive?) | |
987a29ba LC |
474 | "Return an input port from which to retrieve FILES (a list of store items) |
475 | from REMOTE, along with the number of items to retrieve (lower than or equal | |
476 | to the length of FILES.)" | |
e9629e82 LC |
477 | (values (store-export-channel (remote-store-session remote) files |
478 | #:recursive? recursive?) | |
479 | (length files))) ;XXX: inaccurate when RECURSIVE? is true | |
987a29ba | 480 | |
896fec47 LC |
481 | (define-syntax raise-error |
482 | (syntax-rules (=>) | |
483 | ((_ fmt args ... (=> hint-fmt hint-args ...)) | |
484 | (raise (condition | |
485 | (&message | |
486 | (message (format #f fmt args ...))) | |
487 | (&fix-hint | |
488 | (hint (format #f hint-fmt hint-args ...)))))) | |
489 | ((_ fmt args ...) | |
490 | (raise (condition | |
491 | (&message | |
492 | (message (format #f fmt args ...)))))))) | |
493 | ||
d06d54e3 LC |
494 | (define* (retrieve-files* files remote |
495 | #:key recursive? (log-port (current-error-port)) | |
496 | (import (const #f))) | |
497 | "Pass IMPORT an input port from which to read the sequence of FILES coming | |
498 | from REMOTE. When RECURSIVE? is true, retrieve the closure of FILES." | |
987a29ba | 499 | (let-values (((port count) |
e9629e82 LC |
500 | (file-retrieval-port files remote |
501 | #:recursive? recursive?))) | |
896fec47 LC |
502 | (match (read port) ;read the initial status |
503 | (('exporting) | |
504 | (format #t (N_ "retrieving ~a store item from '~a'...~%" | |
505 | "retrieving ~a store items from '~a'...~%" count) | |
506 | count (remote-store-host remote)) | |
507 | ||
d06d54e3 LC |
508 | (dynamic-wind |
509 | (const #t) | |
510 | (lambda () | |
511 | (import port)) | |
512 | (lambda () | |
513 | (close-port port)))) | |
896fec47 | 514 | ((? eof-object?) |
4eb0f9ae | 515 | (report-guile-error (remote-store-host remote))) |
896fec47 | 516 | (('module-error . _) |
4eb0f9ae | 517 | (report-module-error (remote-store-host remote))) |
896fec47 LC |
518 | (('connection-error file code . _) |
519 | (raise-error (G_ "failed to connect to '~A' on remote host '~A': ~a") | |
520 | file (remote-store-host remote) (strerror code))) | |
521 | (('invalid-items items . _) | |
522 | (raise-error (N_ "no such item on remote host '~A':~{ ~a~}" | |
523 | "no such items on remote host '~A':~{ ~a~}" | |
524 | (length items)) | |
525 | (remote-store-host remote) items)) | |
526 | (('protocol-error status message . _) | |
527 | (raise-error (G_ "protocol error on remote host '~A': ~a") | |
528 | (remote-store-host remote) message)) | |
529 | (_ | |
530 | (raise-error (G_ "failed to retrieve store items from '~a'") | |
531 | (remote-store-host remote)))))) | |
987a29ba | 532 | |
d06d54e3 LC |
533 | (define* (retrieve-files local files remote |
534 | #:key recursive? (log-port (current-error-port))) | |
535 | "Retrieve FILES from REMOTE and import them using the 'import-paths' RPC on | |
536 | LOCAL. When RECURSIVE? is true, retrieve the closure of FILES." | |
0e3c8528 LC |
537 | (retrieve-files* (remove (cut valid-path? local <>) files) |
538 | remote | |
d06d54e3 LC |
539 | #:recursive? recursive? |
540 | #:log-port log-port | |
541 | #:import (lambda (port) | |
542 | (import-paths local port)))) | |
543 | ||
4eb0f9ae LC |
544 | \f |
545 | ;;; | |
546 | ;;; Error reporting. | |
547 | ;;; | |
548 | ||
549 | (define (report-guile-error host) | |
550 | (raise-error (G_ "failed to start Guile on remote host '~A'") host | |
551 | (=> (G_ "Make sure @command{guile} can be found in | |
552 | @code{$PATH} on the remote host. Run @command{ssh ~A guile --version} to | |
553 | check.") | |
554 | host))) | |
555 | ||
556 | (define (report-module-error host) | |
557 | "Report an error about missing Guix modules on HOST." | |
558 | ;; TRANSLATORS: Leave "Guile" untranslated. | |
559 | (raise-error (G_ "Guile modules not found on remote host '~A'") host | |
560 | (=> (G_ "Make sure @code{GUILE_LOAD_PATH} includes Guix' | |
561 | own module directory. Run @command{ssh ~A env | grep GUILE_LOAD_PATH} to | |
562 | check.") | |
563 | host))) | |
564 | ||
987a29ba | 565 | ;;; ssh.scm ends here |