gnu/packages/spice.scm

   1 ;;; GNU Guix --- Functional package management for GNU
   2 ;;; Copyright © 2016 David Craven <david@craven.ch>
   3 ;;; Copyright © 2018–2021 Tobias Geerinckx-Rice <me@tobias.gr>
   4 ;;; Copyright © 2019 Rutger Helling <rhelling@mykolab.com>
   5 ;;; Copyright © 2019, 2020 Marius Bakke <mbakke@fastmail.com>
   6 ;;;
   7 ;;; This file is part of GNU Guix.
   8 ;;;
   9 ;;; GNU Guix is free software; you can redistribute it and/or modify it
  10 ;;; under the terms of the GNU General Public License as published by
  11 ;;; the Free Software Foundation; either version 3 of the License, or (at
  12 ;;; your option) any later version.
  13 ;;;
  14 ;;; GNU Guix is distributed in the hope that it will be useful, but
  15 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;;; GNU General Public License for more details.
  18 ;;;
  19 ;;; You should have received a copy of the GNU General Public License
  20 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 (define-module (gnu packages spice)
  23   #:use-module (gnu packages)
  24   #:use-module (gnu packages autotools)
  25   #:use-module (gnu packages base)
  26   #:use-module (gnu packages compression)
  27   #:use-module (gnu packages cyrus-sasl)
  28   #:use-module (gnu packages gl)
  29   #:use-module (gnu packages glib)
  30   #:use-module (gnu packages gnome)
  31   #:use-module (gnu packages gstreamer)
  32   #:use-module (gnu packages gtk)
  33   #:use-module (gnu packages image)
  34   #:use-module (gnu packages libusb)
  35   #:use-module (gnu packages linux)
  36   #:use-module (gnu packages nss)
  37   #:use-module (gnu packages pkg-config)
  38   #:use-module (gnu packages pulseaudio)
  39   #:use-module (gnu packages python)
  40   #:use-module (gnu packages security-token)
  41   #:use-module (gnu packages tls)
  42   #:use-module (gnu packages xorg)
  43   #:use-module (gnu packages xdisorg)
  44   #:use-module (gnu packages xiph)
  45   #:use-module (gnu packages xml)
  46   #:use-module (guix build-system gnu)
  47   #:use-module (guix build-system meson)
  48   #:use-module (guix download)
  49   #:use-module (guix packages)
  50   #:use-module ((guix licenses) #:prefix license:)
  51   #:use-module (guix utils))
  52
  53 (define-public usbredir
  54   (package
  55     (name "usbredir")
  56     (home-page "https://spice-space.org")
  57     (version "0.9.0")
  58     (source (origin
  59               (method url-fetch)
  60               (uri (string-append home-page "/download/" name "/" name "-"
  61                                   version ".tar.xz"))
  62               (sha256
  63                (base32
  64                 "19jnpzlanq0a1m5lmlcsp50wxf7icxvpvclx7hnf0zxw8azngqd3"))))
  65     (build-system gnu-build-system)
  66     (propagated-inputs
  67      `(("libusb" ,libusb)))
  68     (native-inputs
  69      `(("autoconf" ,autoconf)
  70        ("automake" ,automake)
  71        ("libtool" ,libtool)
  72        ("pkg-config" ,pkg-config)))
  73     (synopsis "Tools for sending USB device traffic over a network")
  74     (description
  75      "Usbredir is a network protocol for sending USB device traffic over a
  76 network connection.  It can be used to redirect traffic from a USB device to a
  77 different (virtual) machine than the one to which the USB device is attached.")
  78     (license (list license:gpl2+ license:lgpl2.0+ license:lgpl2.1+))))
  79
  80 (define-public virglrenderer
  81   (package
  82     (name "virglrenderer")
  83     (version "0.6.0")
  84     (source (origin
  85               (method url-fetch)
  86               (uri (string-append
  87                 "https://www.freedesktop.org/software/virgl/"
  88                 "virglrenderer-" version ".tar.bz2"))
  89               (patches (search-patches "virglrenderer-CVE-2017-6386.patch"))
  90               (sha256
  91                (base32
  92                 "06kf0q4l52gzx5p63l8850hff8pmhp7xv1hk8zgx2apbw18y6jd5"))))
  93     (build-system gnu-build-system)
  94     (inputs
  95       `(("libepoxy" ,libepoxy)
  96         ("mesa" ,mesa)
  97         ("udev" ,eudev)))
  98     (native-inputs
  99       `(("pkg-config" ,pkg-config)))
 100     (synopsis "Virtual 3D GPU library")
 101     (description "A virtual 3D GPU library that enables a virtualized operating
 102 system to use the host GPU to accelerate 3D rendering.")
 103     (home-page "https://virgil3d.github.io")
 104     (license (list license:expat license:bsd-3))))
 105
 106 (define-public spice-protocol
 107   (package
 108     (name "spice-protocol")
 109     (version "0.14.3")
 110     (source (origin
 111               (method url-fetch)
 112               (uri (string-append
 113                 "https://www.spice-space.org/download/releases/"
 114                 "spice-protocol-" version ".tar.xz"))
 115               (sha256
 116                (base32
 117                 "0yj8k7gcirrsf21w0q6146n5g4nzn2pqky4p90n5760m5ayfb1pr"))))
 118     (build-system meson-build-system)
 119     (arguments
 120      `(#:phases
 121        (modify-phases %standard-phases
 122          (add-after 'unpack 'install-documentation
 123            (lambda* (#:key outputs #:allow-other-keys)
 124              (let* ((out (assoc-ref outputs "out"))
 125                     (doc (string-append out "/share/doc/"
 126                                         ,name "-" ,version)))
 127                (install-file "COPYING" doc)
 128                #t))))))
 129     (synopsis "Protocol headers for the SPICE protocol")
 130     (description "SPICE (the Simple Protocol for Independent Computing
 131 Environments) is a remote-display system built for virtual environments
 132 which allows users to view a desktop computing environment.")
 133     (home-page "https://www.spice-space.org")
 134     (license (list license:bsd-3 license:lgpl2.1+))))
 135
 136 (define-public spice-gtk
 137   (package
 138     (name "spice-gtk")
 139     (version "0.37")
 140     (source (origin
 141               (method url-fetch)
 142               (uri (string-append
 143                 "https://spice-space.org/download/gtk/"
 144                 "spice-gtk-" version ".tar.bz2"))
 145               (sha256
 146                (base32
 147                 "1drvj8y35gnxbnrxsipwi15yh0vs9ixzv4wslz6r3lra8w3bfa0z"))))
 148     (build-system gnu-build-system)
 149     (propagated-inputs
 150       `(("gstreamer" ,gstreamer)
 151         ("gst-plugins-base" ,gst-plugins-base)
 152         ("gst-plugins-good" ,gst-plugins-good)
 153         ("spice-protocol" ,spice-protocol)
 154
 155         ;; These are required by the pkg-config files.
 156         ("gtk+" ,gtk+)
 157         ("pixman" ,pixman)
 158         ("openssl" ,openssl)))
 159     (inputs
 160       `(("glib-networking" ,glib-networking)
 161         ("gobject-introspection" ,gobject-introspection)
 162         ("json-glib" ,json-glib)
 163         ("libepoxy" ,libepoxy)
 164         ("libjpeg" ,libjpeg-turbo)
 165         ("libxcb" ,libxcb)
 166         ("lz4" ,lz4)
 167         ("mesa" ,mesa)
 168         ("pulseaudio" ,pulseaudio)
 169         ("python" ,python)
 170         ("opus" ,opus)
 171         ("usbredir" ,usbredir)))
 172     (native-inputs
 173       `(("glib:bin" ,glib "bin")
 174         ("intltool" ,intltool)
 175         ("pkg-config" ,pkg-config)
 176         ("vala" ,vala)))
 177     (arguments
 178       `(#:configure-flags
 179         '("--enable-gstaudio"
 180           "--enable-gstvideo"
 181           "--enable-pulse"
 182           "--enable-vala"
 183           "--enable-introspection")
 184         #:phases
 185          (modify-phases %standard-phases
 186            (add-before 'check 'disable-session-test
 187              (lambda _
 188                ;; XXX: Disable session tests, because they require USB support,
 189                ;; which is not available in the build container.
 190                (substitute* "tests/Makefile"
 191                  (("test-session\\$\\(EXEEXT\\) ") ""))
 192                #t))
 193            (add-after 'install 'patch-la-files
 194              (lambda* (#:key inputs outputs #:allow-other-keys)
 195                (let ((out (assoc-ref outputs "out"))
 196                      (libjpeg (assoc-ref inputs "libjpeg")))
 197                  ;; Add an absolute reference for libjpeg in the .la files
 198                  ;; so it does not have to be propagated.
 199                  (substitute* (find-files (string-append out "/lib") "\\.la$")
 200                    (("-ljpeg")
 201                     (string-append "-L" libjpeg "/lib -ljpeg")))
 202                  #t)))
 203            (add-after
 204             'install 'wrap-spicy
 205             (lambda* (#:key inputs outputs #:allow-other-keys)
 206               (let ((out             (assoc-ref outputs "out"))
 207                     (gst-plugin-path (getenv "GST_PLUGIN_SYSTEM_PATH")))
 208                 (wrap-program (string-append out "/bin/spicy")
 209                   `("GST_PLUGIN_SYSTEM_PATH" ":" prefix (,gst-plugin-path))))
 210               #t)))))
 211     (synopsis "Gtk client and libraries for SPICE remote desktop servers")
 212     (description "Gtk client and libraries for SPICE remote desktop servers.")
 213     (home-page "https://www.spice-space.org")
 214     (license (list license:lgpl2.1+ license:lgpl2.0+))))
 215
 216 (define-public spice
 217   (package
 218     (name "spice")
 219     (version "0.14.3")
 220     (source (origin
 221               (method url-fetch)
 222               (uri (string-append
 223                 "https://www.spice-space.org/download/releases/"
 224                 "spice-server/spice-" version ".tar.bz2"))
 225               (sha256
 226                (base32
 227                 "05512vkfayw18ypg4acqbbpr72nsnsz9bj7k8c2wyrvnl3j4n7am"))))
 228     (build-system gnu-build-system)
 229     (propagated-inputs
 230       `(("openssl" ,openssl)
 231         ("pixman" ,pixman)
 232         ("spice-protocol" ,spice-protocol)))
 233     (inputs
 234       `(("cyrus-sasl" ,cyrus-sasl)
 235         ("glib" ,glib)
 236         ("libjpeg-turbo" ,libjpeg-turbo)
 237         ("libcacard" ,libcacard)        ; smartcard support
 238         ("lz4" ,lz4)
 239         ("opus" ,opus)
 240         ("orc" ,orc)
 241         ("zlib" ,zlib)))
 242     (native-inputs
 243       `(("pkg-config" ,pkg-config)
 244         ("python" ,python)
 245         ("spice-gtk" ,spice-gtk)
 246
 247         ;; These are needed for the server listen tests.
 248         ("glib-networking" ,glib-networking)
 249         ("gsettings-desktop-schemas" ,gsettings-desktop-schemas)))
 250     (arguments
 251       `(#:configure-flags
 252         '("--enable-lz4"
 253           "--enable-automated-tests")
 254
 255         ;; Several tests appear to be opening the same sockets concurrently.
 256         #:parallel-tests? #f))
 257     (synopsis "Server implementation of the SPICE protocol")
 258     (description "SPICE is a remote display system built for virtual
 259 environments which allows you to view a computing @code{desktop} environment
 260 not only on the machine where it is running, but from anywhere on the
 261 Internet and from a wide variety of machine architectures.")
 262     (home-page "https://www.spice-space.org")
 263     (license (list license:lgpl2.1+ license:lgpl2.0+))))
 264
 265 (define-public spice-vdagent
 266   (package
 267     (name "spice-vdagent")
 268     (version "0.20.0")
 269     (source (origin
 270               (method url-fetch)
 271               (uri (string-append
 272                 "http://www.spice-space.org/download/releases/"
 273                 "spice-vdagent-" version ".tar.bz2"))
 274               (sha256
 275                (base32
 276                 "0n9k2kna2gd1zi6jv45zsp2jlv439nz5l5jjijirxqaycwi74srf"))))
 277     (build-system gnu-build-system)
 278     (arguments
 279      `(#:configure-flags
 280        '("--localstatedir=/var")
 281        #:phases
 282        (modify-phases %standard-phases
 283          (add-after 'unpack 'patch-makefile.in
 284            (lambda _
 285              (substitute* "Makefile.in"
 286                (((string-append "\\$\\(mkdir_p\\) \\$\\(DESTDIR\\)"
 287                                 "\\$\\(localstatedir\\)/run/spice-vdagentd"))
 288                  "-$(mkdir_p) $(DESTDIR)$(localstatedir)/run/spice-vdagentd"))
 289              #t))
 290          (add-after 'unpack 'patch-spice-vdagent.desktop
 291            (lambda* (#:key outputs #:allow-other-keys)
 292             (substitute* "data/spice-vdagent.desktop"
 293               (("Exec=/usr/bin/spice-vdagent")
 294                (string-append "Exec=" (assoc-ref outputs "out")
 295                               "/bin/spice-vdagent")))
 296              #t)))))
 297     (inputs
 298       `(("alsa-lib" ,alsa-lib)
 299         ("dbus" ,dbus)
 300         ("glib" ,glib)
 301         ("libdrm" ,libdrm)
 302         ("libpciaccess" ,libpciaccess)
 303         ("libx11" ,libx11)
 304         ("libxext" ,libxext)
 305         ("libxfixes" ,libxfixes)
 306         ("libxinerama" ,libxinerama)
 307         ("libxrandr" ,libxrandr)
 308         ("spice-protocol" ,spice-protocol)))
 309     (native-inputs
 310       `(("pkg-config" ,pkg-config)))
 311     (synopsis "Spice agent for Linux")
 312     (description "Spice-vdagent enables sharing the clipboard and guest display
 313 resolution scaling on graphical console window resize.")
 314     (home-page "https://www.spice-space.org")
 315     (license license:gpl3+)))
 316
 317 (define-public libcacard
 318   (package
 319     (name "libcacard")
 320     (version "2.7.0")
 321     (source (origin
 322               (method url-fetch)
 323               (uri (string-append
 324                     "https://gitlab.freedesktop.org/spice/libcacard/uploads/"
 325                     "56cb2499198e78e560a1d4c716cd8ab1"
 326                     "/libcacard-" version ".tar.xz"))
 327               (sha256
 328                (base32
 329                 "0vyvkk4b6xjwq1ccggql13c1x7g4y90clpkqw28257azgn2a1c8n"))))
 330     (build-system gnu-build-system)
 331     (arguments
 332      '(#:tests? #f                      ; TODO Tests require gnutls built with
 333                                         ; p11-kit
 334        #:phases
 335        (modify-phases %standard-phases
 336          (add-after 'unpack 'patch-tests
 337            (lambda* (#:key inputs #:allow-other-keys)
 338              (substitute* "tests/setup-softhsm2.sh"
 339                (("\\/usr\\/lib64\\/pkcs11\\/libsofthsm2\\.so")
 340                 (string-append (assoc-ref inputs "softhsm")
 341                                "/lib/softhsm/libsofthsm2.so")))
 342              #t)))))
 343     (propagated-inputs
 344      `(("glib" ,glib)                   ; Requires: in the pkg-config file
 345        ("nss" ,nss)))                   ; Requires.private: in the pkg-config
 346                                         ; file
 347     (native-inputs
 348      `(("openssl" ,openssl)
 349        ("nss" ,nss "bin")
 350        ("opensc" ,opensc)
 351        ("softhsm" ,softhsm)
 352        ("gnutls" ,gnutls)
 353        ("pkg-config" ,pkg-config)
 354        ("which" ,which)))
 355     (synopsis "Emulate and share smart cards with virtual machines")
 356     (description
 357      "The @acronym{CAC,Common Access Card} library can be used to emulate and
 358 share smart cards from client system to local or remote virtual machines.")
 359     (home-page "https://gitlab.freedesktop.org/spice/libcacard")
 360     (license license:lgpl2.1+)))
 361
 362 (define-public virt-viewer
 363   (package
 364     (name "virt-viewer")
 365     (version "7.0")
 366     (source (origin
 367               (method url-fetch)
 368               (uri (string-append
 369                 "https://virt-manager.org/download/sources/virt-viewer/"
 370                 "virt-viewer-" version ".tar.gz"))
 371               (sha256
 372                (base32
 373                 "00y9vi69sja4pkrfnvrkwsscm41bqrjzvp8aijb20pvg6ymczhj7"))))
 374     (build-system gnu-build-system)
 375     (inputs
 376       `(("gtk+" ,gtk+)
 377         ("gtk-vnc" ,gtk-vnc)
 378         ("libcap" ,libcap)
 379         ("libxml2" ,libxml2)
 380         ("spice-gtk" ,spice-gtk)))
 381     (native-inputs
 382       `(("glib:bin" ,glib "bin")
 383         ("intltool" ,intltool)
 384         ("pkg-config" ,pkg-config)))
 385     (arguments
 386       `(#:configure-flags
 387         '("--with-spice-gtk")
 388         #:phases
 389          (modify-phases %standard-phases
 390            (add-after
 391             'install 'wrap-remote-viewer
 392             (lambda* (#:key inputs outputs #:allow-other-keys)
 393               (let ((out             (assoc-ref outputs "out"))
 394                     (gst-plugin-path (getenv "GST_PLUGIN_SYSTEM_PATH")))
 395                 (wrap-program (string-append out "/bin/remote-viewer")
 396                   `("GST_PLUGIN_SYSTEM_PATH" ":" prefix (,gst-plugin-path))))
 397               #t)))))
 398     (synopsis "Graphical console client for virtual machines")
 399     (description "Graphical console client for virtual machines using SPICE or
 400 VNC.")
 401     (home-page "https://virt-manager.org")
 402     (license license:gpl2+)))