1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2016, 2017 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2017 Clément Lassieur <clement@lassieur.org>
5 ;;; This file is part of GNU Guix.
7 ;;; GNU Guix is free software; you can redistribute it and/or modify it
8 ;;; under the terms of the GNU General Public License as published by
9 ;;; the Free Software Foundation; either version 3 of the License, or (at
10 ;;; your option) any later version.
12 ;;; GNU Guix is distributed in the hope that it will be useful, but
13 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;;; GNU General Public License for more details.
17 ;;; You should have received a copy of the GNU General Public License
18 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
20 (define-module (gnu tests ssh)
21 #:use-module (gnu tests)
22 #:use-module (gnu system)
23 #:use-module (gnu system vm)
24 #:use-module (gnu services)
25 #:use-module (gnu services ssh)
26 #:use-module (gnu services networking)
27 #:use-module (gnu packages ssh)
28 #:use-module (guix gexp)
29 #:use-module (guix store)
30 #:export (%test-openssh
33 (define* (run-ssh-test name ssh-service pid-file #:key (sftp? #f))
34 "Run a test of an OS running SSH-SERVICE, which writes its PID to PID-FILE.
35 SSH-SERVICE must be configured to listen on port 22 and to allow for root and
36 empty-password logins.
38 When SFTP? is true, run an SFTP server test."
40 (marionette-operating-system
41 (simple-operating-system (dhcp-client-service) ssh-service)
42 #:imported-modules '((gnu services herd)
47 (port-forwardings '((2222 . 22)))))
50 (with-imported-modules '((gnu build marionette))
52 (eval-when (expand load eval)
53 ;; Prepare to use Guile-SSH.
55 (cons (string-append #+guile-ssh "/share/guile/site/"
59 (use-modules (gnu build marionette)
69 ;; Enable TCP forwarding of the guest's port 22.
70 (make-marionette (list #$vm)))
72 (define (make-session-for-test)
73 "Make a session with predefined parameters for a test."
74 (make-session #:user "root"
77 #:log-verbosity 'protocol))
79 (define (call-with-connected-session proc)
80 "Call the one-argument procedure PROC with a freshly created and
81 connected SSH session object, return the result of the procedure call. The
82 session is disconnected when the PROC is finished."
83 (let ((session (make-session-for-test)))
86 (let ((result (connect! session)))
87 (unless (equal? result 'ok)
88 (error "Could not connect to a server"
90 (lambda () (proc session))
91 (lambda () (disconnect! session)))))
93 (define (call-with-connected-session/auth proc)
94 "Make an authenticated session. We should be able to connect as
95 root with an empty password."
96 (call-with-connected-session
98 ;; Try the simple authentication methods. Dropbear requires
99 ;; 'none' when there are no passwords, whereas OpenSSH accepts
100 ;; 'password' with an empty password.
101 (let loop ((methods (list (cut userauth-password! <> "")
102 (cut userauth-none! <>))))
105 (error "all the authentication methods failed"))
107 (match (pk 'auth (auth session))
116 (test-begin "ssh-daemon")
118 ;; Wait for sshd to be up and running.
119 (test-eq "service running"
123 (use-modules (gnu services herd))
124 (start-service 'ssh-daemon)
128 ;; Check sshd's PID file.
129 (test-equal "sshd PID"
130 (wait-for-file #$pid-file marionette)
133 (use-modules (gnu services herd)
136 (live-service-running
139 (live-service-provision live)))
140 (current-services))))
143 ;; Connect to the guest over SSH. Make sure we can run a shell
145 (test-equal "shell command"
147 (call-with-connected-session/auth
149 ;; FIXME: 'get-server-public-key' segfaults.
150 ;; (get-server-public-key session)
151 (let ((channel (make-channel session)))
152 (channel-open-session channel)
153 (channel-request-exec channel "echo hello > /root/witness")
154 (and (zero? (channel-get-exit-status channel))
155 (wait-for-file "/root/witness" marionette))))))
157 ;; Connect to the guest over SFTP. Make sure we can write and
158 ;; read a file there.
161 (test-equal "SFTP file writing and reading"
163 (call-with-connected-session/auth
165 (let ((sftp-session (make-sftp-session session))
166 (witness "/root/sftp-witness"))
167 (call-with-remote-output-file sftp-session witness
168 (cut display "hello" <>))
169 (call-with-remote-input-file sftp-session witness
173 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
175 (gexp->derivation name test))
177 (define %test-openssh
180 (description "Connect to a running OpenSSH daemon.")
181 (value (run-ssh-test name
182 ;; Allow root logins with an empty password to
184 (service openssh-service-type
185 (openssh-configuration
186 (permit-root-login #t)
187 (allow-empty-passwords? #t)))
191 (define %test-dropbear
194 (description "Connect to a running Dropbear SSH daemon.")
195 (value (run-ssh-test name
196 (service dropbear-service-type
197 (dropbear-configuration
199 (allow-empty-passwords? #t)))
200 "/var/run/dropbear.pid"))))