1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2012, 2013, 2014, 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2013, 2014 Andreas Enge <andreas@enge.fr>
4 ;;; Copyright © 2014, 2015, 2016 Mark H Weaver <mhw@netris.org>
5 ;;; Copyright © 2015, 2016 Efraim Flashner <efraim@flashner.co.il>
6 ;;; Copyright © 2016 Leo Famulari <leo@famulari.name>
7 ;;; Copyright © 2016 Nicolas Goaziou <mail@nicolasgoaziou.fr>
8 ;;; Copyright © 2016 Christopher Allan Webber <cwebber@dustycloud.org>
9 ;;; Copyright © 2017 Tobias Geerinckx-Rice <me@tobias.gr>
10 ;;; Copyright © 2017 Stefan Reichör <stefan@xsteve.at>
11 ;;; Copyright © 2017 Ricardo Wurmus <rekado@elephly.net>
13 ;;; This file is part of GNU Guix.
15 ;;; GNU Guix is free software; you can redistribute it and/or modify it
16 ;;; under the terms of the GNU General Public License as published by
17 ;;; the Free Software Foundation; either version 3 of the License, or (at
18 ;;; your option) any later version.
20 ;;; GNU Guix is distributed in the hope that it will be useful, but
21 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;;; GNU General Public License for more details.
25 ;;; You should have received a copy of the GNU General Public License
26 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
28 (define-module (gnu packages ssh)
29 #:use-module (gnu packages)
30 #:use-module (gnu packages autotools)
31 #:use-module (gnu packages base)
32 #:autoload (gnu packages boost) (boost)
33 #:use-module (gnu packages compression)
34 #:use-module (gnu packages crypto)
35 #:use-module (gnu packages elf)
36 #:use-module (gnu packages gnupg)
37 #:use-module (gnu packages gperf)
38 #:use-module (gnu packages groff)
39 #:use-module (gnu packages guile)
40 #:use-module (gnu packages linux)
41 #:use-module (gnu packages logging)
42 #:use-module (gnu packages m4)
43 #:use-module (gnu packages multiprecision)
44 #:use-module (gnu packages ncurses)
45 #:use-module (gnu packages nettle)
46 #:use-module (gnu packages kerberos)
47 #:use-module (gnu packages perl)
48 #:use-module (gnu packages pkg-config)
49 #:use-module (gnu packages popt)
50 #:autoload (gnu packages protobuf) (protobuf)
51 #:use-module (gnu packages readline)
52 #:use-module (gnu packages texinfo)
53 #:use-module (gnu packages tls)
54 #:use-module (gnu packages xorg)
55 #:use-module (guix build-system cmake)
56 #:use-module (guix build-system gnu)
57 #:use-module (guix download)
58 #:use-module (guix git-download)
59 #:use-module ((guix licenses) #:prefix license:)
60 #:use-module (guix packages)
61 #:use-module (srfi srfi-1))
70 "https://red.libssh.org/attachments/download/218/libssh-"
74 "15bh6dm9c50ndddzh3gqcgw7axp3ghrspjpkb1z3dr90vkanvs2l"))
75 (patches (search-patches "libssh-hostname-parser-bug.patch"))))
76 (build-system cmake-build-system)
77 (outputs '("out" "debug"))
79 '(#:configure-flags '("-DWITH_GCRYPT=ON")
81 ;; TODO: Add 'CMockery' and '-DWITH_TESTING=ON' for the test suite.
83 (inputs `(("zlib" ,zlib)
84 ("libgcrypt" ,libgcrypt)))
85 (synopsis "SSH client library")
87 "libssh is a C library implementing the SSHv2 and SSHv1 protocol for
88 client and server implementations. With libssh, you can remotely execute
89 programs, transfer files, and use a secure and transparent tunnel for your
90 remote applications.")
91 (home-page "https://www.libssh.org")
92 (license license:lgpl2.1+)))
94 (define-public libssh2
101 "https://www.libssh2.org/download/libssh2-"
105 "1m3n8spv79qhjq4yi0wgly5s5rc8783jb1pyra9bkx1md0plxwrr"))
107 (search-patches "libssh2-fix-build-failure-with-gcrypt.patch"))))
108 (build-system gnu-build-system)
109 ;; The installed libssh2.pc file does not include paths to libgcrypt and
110 ;; zlib libraries, so we need to propagate the inputs.
111 (propagated-inputs `(("libgcrypt" ,libgcrypt)
113 (arguments '(#:configure-flags `("--with-libgcrypt")
114 #:phases (modify-phases %standard-phases
115 (add-before 'configure 'autoreconf
117 (zero? (system* "autoreconf" "-v")))))))
118 (native-inputs `(("autoconf" ,autoconf)
119 ("automake" ,automake)))
120 (synopsis "Client-side C library implementing the SSH2 protocol")
122 "libssh2 is a library intended to allow software developers access to
123 the SSH-2 protocol in an easy-to-use self-contained package. It can be built
124 into an application to perform many different tasks when communicating with
125 a server that supports the SSH-2 protocol.")
126 (license license:bsd-3)
127 (home-page "http://www.libssh2.org/")))
129 (define-public openssh
135 (uri (string-append "mirror://openbsd/OpenSSH/portable/"
136 name "-" version ".tar.gz"))
139 "08qpsb8mrzcx8wgvz9insiyvq7sbg26yj5nvl2m5n57yvppcl8x3"))))
140 (build-system gnu-build-system)
141 (native-inputs `(("groff" ,groff)))
142 (inputs `(("openssl" ,openssl)
144 ("mit-krb5" ,mit-krb5)
146 ("xauth" ,xauth))) ;for 'ssh -X' and 'ssh -Y'
148 `(#:test-target "tests"
149 #:configure-flags `("--sysconfdir=/etc/ssh"
151 ;; Default value of 'PATH' used by sshd.
152 "--with-default-path=/run/current-system/profile/bin"
154 ;; configure needs to find krb5-config
155 ,(string-append "--with-kerberos5="
156 (assoc-ref %build-inputs "mit-krb5")
159 ;; Enable PAM support in sshd.
163 (modify-phases %standard-phases
164 (add-after 'configure 'reset-/var/empty
165 (lambda* (#:key outputs #:allow-other-keys)
166 (let ((out (assoc-ref outputs "out")))
167 (substitute* "Makefile"
168 (("PRIVSEP_PATH=/var/empty")
169 (string-append "PRIVSEP_PATH=" out "/var/empty")))
171 (add-before 'check 'patch-tests
173 ;; remove 't-exec' regress target which requires user 'sshd'
174 (substitute* "regress/Makefile"
175 (("^(REGRESS_TARGETS=.*) t-exec(.*)" all pre post)
176 (string-append pre post)))
179 (lambda* (#:key outputs (make-flags '()) #:allow-other-keys)
180 ;; install without host keys and system configuration files
181 (and (zero? (apply system* "make" "install-nosysconf" make-flags))
183 (install-file "contrib/ssh-copy-id"
184 (string-append (assoc-ref outputs "out")
186 (chmod (string-append (assoc-ref outputs "out")
187 "/bin/ssh-copy-id") #o555)
188 (install-file "contrib/ssh-copy-id.1"
189 (string-append (assoc-ref outputs "out")
192 (synopsis "Client and server for the secure shell (ssh) protocol")
194 "The SSH2 protocol implemented in OpenSSH is standardised by the
195 IETF secsh working group and is specified in several RFCs and drafts.
196 It is composed of three layered components:
198 The transport layer provides algorithm negotiation and a key exchange.
199 The key exchange includes server authentication and results in a
200 cryptographically secured connection: it provides integrity, confidentiality
201 and optional compression.
203 The user authentication layer uses the established connection and relies on
204 the services provided by the transport layer. It provides several mechanisms
205 for user authentication. These include traditional password authentication
206 as well as public-key or host-based authentication mechanisms.
208 The connection layer multiplexes many different concurrent channels over the
209 authenticated connection and allows tunneling of login sessions and
210 TCP-forwarding. It provides a flow control service for these channels.
211 Additionally, various channel-specific options can be negotiated.")
212 (license (license:non-copyleft "file://LICENSE"
213 "See LICENSE in the distribution."))
214 (home-page "http://www.openssh.org/")))
216 (define-public guile-ssh
220 (home-page "https://github.com/artyom-poptsov/guile-ssh")
222 ;; ftp://memory-heap.org/software/guile-ssh/guile-ssh-VERSION.tar.gz
223 ;; exists, but the server appears to be too slow and unreliable.
224 ;; Also, using this URL allows the GitHub updater to work.
226 (uri (string-append home-page "/archive/v"
228 (file-name (string-append name "-" version ".tar.gz"))
231 "1w0k5s09xj5xycb7lbp5b7rm0xncclms3jwl98lwj8fxwngi1s90"))))
232 (build-system gnu-build-system)
233 (outputs '("out" "debug"))
235 '(#:phases (modify-phases %standard-phases
236 (add-after 'unpack 'autoreconf
237 (lambda* (#:key inputs #:allow-other-keys)
238 (zero? (system* "autoreconf" "-vfi"))))
239 (add-before 'build 'fix-libguile-ssh-file-name
240 (lambda* (#:key outputs #:allow-other-keys)
241 ;; Build and install libguile-ssh.so so that we can use
242 ;; its absolute file name in .scm files, before we build
244 (and (zero? (system* "make" "install"
247 (parallel-job-count))))
248 (let* ((out (assoc-ref outputs "out"))
249 (libdir (string-append out "/lib")))
250 (substitute* (find-files "." "\\.scm$")
251 (("\"libguile-ssh\"")
252 (string-append "\"" libdir "/libguile-ssh\"")))
255 ;; Tests are not parallel-safe.
256 #:parallel-tests? #f))
257 (native-inputs `(("autoconf" ,autoconf)
258 ("automake" ,automake)
261 ("pkg-config" ,pkg-config)
263 (inputs `(("guile" ,guile-2.2)
265 ("libgcrypt" ,libgcrypt)))
266 (synopsis "Guile bindings to libssh")
268 "Guile-SSH is a library that provides access to the SSH protocol for
269 programs written in GNU Guile interpreter. It is a wrapper to the underlying
271 (license license:gpl3+)))
273 (define-public guile2.2-ssh
274 (deprecated-package "guile2.2-ssh" guile-ssh))
276 (define-public guile2.0-ssh
279 (name "guile2.0-ssh")
280 (inputs `(("guile" ,guile-2.0)
281 ,@(alist-delete "guile" (package-inputs guile-ssh))))))
283 (define-public corkscrew
290 ;; The agroman.net domain name expired on 2017-03-23, and the original
291 ;; "http://www.agroman.net/corkscrew/corkscrew-2.0.tar.gz" now returns
292 ;; bogus HTML. Perhaps it will yet return. Until then, use a mirror.
293 (uri (string-append "https://downloads.openwrt.org/sources/"
294 "corkscrew-" version ".tar.gz"))
296 "1gmhas4va6gd70i2x2mpxpwpgww6413mji29mg282jms3jscn3qd"))))
297 (build-system gnu-build-system)
299 ;; Replace configure phase as the ./configure script does not link
300 ;; CONFIG_SHELL and SHELL passed as parameters
302 (modify-phases %standard-phases
304 (lambda* (#:key outputs inputs system build target
305 #:allow-other-keys #:rest args)
306 (let* ((configure (assoc-ref %standard-phases 'configure))
307 (prefix (assoc-ref outputs "out"))
308 (bash (which "bash"))
309 ;; Set --build and --host flags as the provided config.guess
310 ;; is not able to detect them
311 (flags `(,(string-append "--prefix=" prefix)
312 ,(string-append "--build=" build)
313 ,(string-append "--host=" (or target build)))))
314 (setenv "CONFIG_SHELL" bash)
315 (zero? (apply system* bash
316 (string-append "." "/configure")
318 (add-after 'install 'install-documentation
319 (lambda* (#:key outputs #:allow-other-keys)
320 (let* ((out (assoc-ref outputs "out"))
321 (doc (string-append out "/share/doc/corkscrew")))
322 (install-file "README" doc)
324 (home-page "http://www.agroman.net/corkscrew")
325 (synopsis "SSH tunneling through HTTP(S) proxies")
327 "Corkscrew tunnels SSH connections through most HTTP and HTTPS proxies.
328 Proxy authentication is only supported through the plain-text HTTP basic
329 authentication scheme.")
330 (license license:gpl2+)))
338 (uri (string-append "https://mosh.org/mosh-" version ".tar.gz"))
341 "05hjhlp6lk8yjcy59zywpf0r6s0h0b9zxq0lw66dh9x8vxrhaq6s"))))
342 (build-system gnu-build-system)
345 (modify-phases %standard-phases
346 (add-after 'install 'wrap
347 (lambda* (#:key outputs #:allow-other-keys)
348 ;; Make sure 'mosh' can find 'mosh-client' and
350 (let* ((out (assoc-ref outputs "out"))
351 (bin (string-append out "/bin")))
352 (wrap-program (string-append bin "/mosh")
353 `("PATH" ":" prefix (,bin)))))))))
355 `(("pkg-config" ,pkg-config)))
357 `(("openssl" ,openssl)
359 ("perl-io-tty" ,perl-io-tty)
362 ("protobuf" ,protobuf)
363 ("boost-headers" ,boost)))
364 (home-page "https://mosh.org/")
365 (synopsis "Remote shell tolerant to intermittent connectivity")
367 "Remote terminal application that allows roaming, supports intermittent
368 connectivity, and provides intelligent local echo and line editing of user
369 keystrokes. Mosh is a replacement for SSH. It's more robust and responsive,
370 especially over Wi-Fi, cellular, and long-distance links.")
371 (license license:gpl3+)))
381 "https://github.com/MisterTea/EternalTCP/archive/et-v"
384 (base32 "1n2w2kqbshdmbb0gz4yizyw9gqfls6qm2dnwx1d9c2hz7hmi7521"))))
385 (build-system cmake-build-system)
386 (arguments `(#:tests? #f))
388 `(("pkg-config" ,pkg-config)))
389 (inputs `(("glog" ,glog)
391 ("libsodium" ,libsodium)
392 ("protobuf" ,protobuf)))
393 (synopsis "Remote shell that automatically reconnects")
395 "Eternal Terminal (ET) is a remote shell that automatically reconnects
396 without interrupting the session. Unlike SSH sessions, ET sessions will
397 survive even network outages and IP changes. ET uses a custom protocol over
398 TCP, not the SSH protocol.")
399 (home-page "https://mistertea.github.io/EternalTCP/")
400 (license license:asl2.0)))
402 (define-public dropbear
409 "https://matt.ucc.asn.au/" name "/releases/"
410 name "-" version ".tar.bz2"))
413 "1309cm2aw62n9m3h38prvgsqr8bj85hfasgnvwkd42cp3k5ivg3c"))))
414 (build-system gnu-build-system)
415 (arguments `(#:tests? #f)) ; There is no "make check" or anything similar
416 (inputs `(("zlib" ,zlib)))
417 (synopsis "Small SSH server and client")
418 (description "Dropbear is a relatively small SSH server and
419 client. It runs on a variety of POSIX-based platforms. Dropbear is
420 particularly useful for embedded systems, such as wireless routers.")
421 (home-page "https://matt.ucc.asn.au/dropbear/dropbear.html")
422 (license (license:x11-style "" "See file LICENSE."))))
424 (define-public liboop
431 (uri (string-append "http://download.ofb.net/liboop/liboop-"
435 "0z6rlalhvfca64jpvksppc9bdhs7jwhiw4y35g5ibvh91xp3rn1l"))
436 (patches (search-patches "liboop-mips64-deplibs-fix.patch"))))
437 (build-system gnu-build-system)
438 (home-page "http://www.lysator.liu.se/liboop/")
439 (synopsis "Event loop library")
440 (description "Liboop is a low-level event loop management library for
441 POSIX-based operating systems. It supports the development of modular,
442 multiplexed applications which may respond to events from several sources. It
443 replaces the \"select() loop\" and allows the registration of event handlers
444 for file and network I/O, timers and signals. Since processes use these
445 mechanisms for almost all external communication, liboop can be used as the
446 basis for almost any application.")
447 (license license:lgpl2.1+)))
455 (uri (string-append "mirror://gnu/lsh/lsh-"
459 "1qqjy9zfzgny0rkb27c8c7dfsylvb6n0ld8h3an2r83pmaqr9gwb"))
460 (modules '((guix build utils)))
463 (substitute* "src/testsuite/functions.sh"
465 ;; Avoid host name lookups since they don't work in
469 ;; Make tests more verbose.
472 (substitute* (find-files "src/testsuite" "-test$")
473 (("localhost") "127.0.0.1"))
475 (substitute* "src/testsuite/login-auth-test"
476 (("/bin/cat") "cat"))))))
477 (build-system gnu-build-system)
482 ("psmisc" ,psmisc))) ; for `killall'
484 `(("nettle" ,nettle-2)
485 ("linux-pam" ,linux-pam)
487 ;; 'rl.c' uses the 'CPPFunction' type, which is no longer in
489 ("readline" ,readline-6.2)
495 ;; The server (lshd) invokes xauth when X11 forwarding is requested.
496 ;; This adds 24 MiB (or 27%) to the closure of lsh.
499 '(;; Skip the `configure' test that checks whether /dev/ptmx &
500 ;; co. work as expected, because it relies on impurities (for
501 ;; instance, /dev/pts may be unavailable in chroots.)
502 #:configure-flags '("lsh_cv_sys_unix98_ptys=yes"
504 ;; Use glibc's argp rather than the bundled one.
507 ;; 'lsh_argp.h' checks HAVE_ARGP_PARSE but nothing
509 "CPPFLAGS=-DHAVE_ARGP_PARSE")
511 ;; FIXME: Tests won't run in a chroot, presumably because
512 ;; /etc/profile is missing, and thus clients get an empty $PATH
513 ;; and nothing works.
517 (modify-phases %standard-phases
518 (add-before 'configure 'pre-configure
519 (lambda* (#:key inputs #:allow-other-keys)
520 (let* ((nettle (assoc-ref inputs "nettle"))
521 (sexp-conv (string-append nettle "/bin/sexp-conv")))
522 ;; Remove argp from the list of sub-directories; we don't want
523 ;; to build it, really.
524 (substitute* "src/Makefile.in"
528 ;; Make sure 'lsh' and 'lshd' pick 'sexp-conv' in the right place
530 (substitute* "src/environ.h.in"
531 (("^#define PATH_SEXP_CONV.*")
532 (string-append "#define PATH_SEXP_CONV \""
535 ;; Same for the 'lsh-authorize' script.
536 (substitute* "src/lsh-authorize"
538 (string-append "=" sexp-conv)))
540 ;; Tell lshd where 'xauth' lives. Another option would be to
541 ;; hardcode "/run/current-system/profile/bin/xauth", thereby
542 ;; reducing the closure size, but that wouldn't work on foreign
544 (with-fluids ((%default-port-encoding "ISO-8859-1"))
545 (substitute* "src/server_x11.c"
546 (("define XAUTH_PROGRAM.*")
547 (string-append "define XAUTH_PROGRAM \""
548 (assoc-ref inputs "xauth")
549 "/bin/xauth\"\n")))))
551 ;; Tests rely on $USER being set.
552 (setenv "USER" "guix"))))))
553 (home-page "http://www.lysator.liu.se/~nisse/lsh/")
554 (synopsis "GNU implementation of the Secure Shell (ssh) protocols")
556 "GNU lsh is a free implementation of the SSH version 2 protocol. It is
557 used to create a secure line of communication between two computers,
558 providing shell access to the server system from the client. It provides
559 both the server daemon and the client application, as well as tools for
560 manipulating key files.")
561 (license license:gpl2+)))
563 (define-public sshpass
567 (synopsis "Non-interactive password authentication with SSH")
568 (home-page "https://sourceforge.net/projects/sshpass/")
572 (uri (string-append "mirror://sourceforge/sshpass/sshpass/"
573 version "/sshpass-" version ".tar.gz"))
576 "0q7fblaczb7kwbsz0gdy9267z0sllzgmf0c7z5c9mf88wv74ycn6"))))
577 (build-system gnu-build-system)
578 (description "sshpass is a tool for non-interactivly performing password
579 authentication with SSH's so-called @dfn{interactive keyboard password
581 (license license:gpl2+)))
583 (define-public autossh
591 "http://www.harding.motd.ca/autossh/autossh-"
594 (base32 "0mlicw28vq2jxa0jf0dys5ja75v0fxpjavlq9dpif6bnknji13ly"))))
595 (build-system gnu-build-system)
596 (arguments `(#:tests? #f)) ; There is no "make check" or anything similar
597 (inputs `(("openssh" ,openssh)))
598 (synopsis "Automatically restart SSH sessions and tunnels")
599 (description "autossh is a program to start a copy of @command{ssh} and
600 monitor it, restarting it as necessary should it die or stop passing traffic.")
601 (home-page "http://www.harding.motd.ca/autossh/")
603 ;; Why point to a source file? Well, all the individual files have a
604 ;; copy of this license in their headers, but there's no separate file
605 ;; with that information.
606 (license:non-copyleft "file://autossh.c"))))
615 (uri (string-append "https://storage.googleapis.com/"
616 "google-code-archive-downloads/v2/code.google.com/"
617 "pdsh/pdsh-" version ".tar.bz2"))
619 (base32 "1kvzz01fyaxfqmbh53f4ljfsgvxdykh5jyr6fh4f1bw2ywxr1w2p"))))
620 (build-system gnu-build-system)
625 (modify-phases %standard-phases
626 (add-after 'unpack 'patch-/bin/sh
628 (substitute* '("tests/runtests.sh"
630 "tests/test-modules/pcptest.c")
631 (("/bin/sh") (which "bash")))
634 `(("openssh" ,openssh)
635 ("mit-krb5" ,mit-krb5)
637 (home-page "https://code.google.com/archive/p/pdsh")
638 (synopsis "Parallel distributed shell")
639 (description "Pdsh is a an efficient, multithreaded remote shell client
640 which executes commands on multiple remote hosts in parallel. Pdsh implements
641 dynamically loadable modules for extended functionality such as new remote
642 shell services and remote host selection.")
643 (license license:gpl2+)))