1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2014 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2016 Efraim Flashner <efraim@flashner.co.il>
4 ;;; Copyright © 2016 Mike Gerwitz <mtg@gnu.org>
5 ;;; Copyright © 2016 Marius Bakke <mbakke@fastmail.com>
6 ;;; Copyright © 2017 Thomas Danckaert <post@thomasdanckaert.be>
7 ;;; Copyright © 2017, 2018, 2019, 2020 Tobias Geerinckx-Rice <me@tobias.gr>
8 ;;; Copyright © 2017, 2019 Ricardo Wurmus <rekado@elephly.net>
9 ;;; Copyright © 2018, 2019 Chris Marusich <cmmarusich@gmail.com>
10 ;;; Copyright © 2018 Arun Isaac <arunisaac@systemreboot.net>
12 ;;; This file is part of GNU Guix.
14 ;;; GNU Guix is free software; you can redistribute it and/or modify it
15 ;;; under the terms of the GNU General Public License as published by
16 ;;; the Free Software Foundation; either version 3 of the License, or (at
17 ;;; your option) any later version.
19 ;;; GNU Guix is distributed in the hope that it will be useful, but
20 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;;; GNU General Public License for more details.
24 ;;; You should have received a copy of the GNU General Public License
25 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
27 (define-module (gnu packages security-token)
28 #:use-module (gnu packages)
29 #:use-module ((guix licenses) #:prefix license:)
30 #:use-module (guix packages)
31 #:use-module (guix download)
32 #:use-module (guix gexp)
33 #:use-module (guix git-download)
34 #:use-module (guix build-system gnu)
35 #:use-module (guix build-system glib-or-gtk)
36 #:use-module (guix build-system python)
37 #:use-module (gnu packages autotools)
38 #:use-module (gnu packages base)
39 #:use-module (gnu packages curl)
40 #:use-module (gnu packages check)
41 #:use-module (gnu packages docbook)
42 #:use-module (gnu packages documentation)
43 #:use-module (gnu packages dns)
44 #:use-module (gnu packages gettext)
45 #:use-module (gnu packages graphviz)
46 #:use-module (gnu packages gtk)
47 #:use-module (gnu packages libusb)
48 #:use-module (gnu packages linux)
49 #:use-module (gnu packages man)
50 #:use-module (gnu packages networking)
51 #:use-module (gnu packages cyrus-sasl)
52 #:use-module (gnu packages popt)
53 #:use-module (gnu packages readline)
54 #:use-module (gnu packages tls)
55 #:use-module (gnu packages tex)
56 #:use-module (gnu packages perl)
57 #:use-module (gnu packages pkg-config)
58 #:use-module (gnu packages python)
59 #:use-module (gnu packages python-crypto)
60 #:use-module (gnu packages python-xyz)
61 #:use-module (gnu packages swig)
62 #:use-module (gnu packages web)
63 #:use-module (gnu packages xml))
72 "https://ccid.apdu.fr/files/"
73 name "-" version ".tar.bz2"))
76 "1xz8ikr6vk73w3xnwb931yq8lqc1zrj8c3v34n6h63irwjvdfj3b"))))
77 (build-system gnu-build-system)
79 `(#:configure-flags (list (string-append "--enable-usbdropdir=" %output
82 (modify-phases %standard-phases
83 (add-after 'unpack 'patch-Makefile
85 (substitute* "src/Makefile.in"
86 (("/bin/echo") (which "echo")))
89 `(("pcsc-lite" ,pcsc-lite) ; only required for headers
91 ("pkg-config" ,pkg-config)))
93 `(("libusb" ,libusb)))
94 (home-page "https://ccid.apdu.fr/")
95 (synopsis "PC/SC driver for USB smart card devices")
97 "This package provides a PC/SC IFD handler implementation for devices
98 compliant with the CCID and ICCD protocols. It supports a wide range of
99 readers and is needed to communicate with such devices through the
100 @command{pcscd} resource manager.")
101 (license license:lgpl2.1+)))
103 (define-public eid-mw
111 (url "https://github.com/Fedict/eid-mw")
112 (commit (string-append "v" version))))
113 (file-name (git-file-name name version))
115 (base32 "0kf147zxsp5ilghr46hjxa2nsikhv8198n04q81qzn9zln69av04"))))
116 (build-system glib-or-gtk-build-system)
118 `(("autoconf" ,autoconf)
119 ("automake" ,automake)
120 ("gettext" ,gnu-gettext)
122 ("pkg-config" ,pkg-config)
128 ("pcsc-lite" ,pcsc-lite)
130 ("libproxy" ,libproxy)
132 ("cyrus-sasl" ,cyrus-sasl)))
135 (modify-phases %standard-phases
136 (add-after 'unpack 'bootstrap
138 ;; configure.ac relies on ‘git --describe’ to get the version.
139 ;; Patch it to just return the real version number directly.
140 (substitute* "scripts/build-aux/genver.sh"
141 (("/bin/sh") (which "sh"))
142 (("^(GITDESC=).*" match) (string-append match ,version "\n")))
143 (invoke "sh" "./bootstrap.sh"))))))
144 (synopsis "Belgian eID Middleware")
145 (description "The Belgian eID Middleware is required to authenticate with
146 online services using the Belgian electronic identity card.")
147 (home-page "https://github.com/Fedict/eid-mw")
148 (license license:lgpl3)))
150 (define-public libyubikey
157 "https://developers.yubico.com/yubico-c/Releases/"
158 name "-" version ".tar.gz"))
161 "009l3k2zyn06dbrlja2d4p2vfnzjhlcqxi88v02mlrnb17mx1v84"))))
162 (build-system gnu-build-system)
163 (synopsis "Development kit for the YubiKey authentication device")
165 "This package contains a C library and command-line tools that make up
166 the low-level development kit for the Yubico YubiKey authentication device.")
167 (home-page "https://developers.yubico.com/yubico-c/")
168 (license license:bsd-2)))
170 (define-public pcsc-lite
176 (uri (string-append "https://pcsclite.apdu.fr/files/"
177 "pcsc-lite-" version ".tar.bz2"))
180 "1ndvvz0fgqwz70pijymsxmx25mzryb0zav1i8jjc067ndryvxdry"))))
181 (build-system gnu-build-system)
183 `(#:configure-flags '("--enable-usbdropdir=/var/lib/pcsc/drivers"
184 "--disable-libsystemd")))
186 `(("perl" ,perl) ; for pod2man
187 ("pkg-config" ,pkg-config)))
189 `(("libudev" ,eudev)))
190 (home-page "https://pcsclite.apdu.fr/")
191 (synopsis "Middleware to access a smart card using PC/SC")
193 "pcsc-lite provides an interface to communicate with smartcards and
194 readers using the SCard API. pcsc-lite is used to connect to the PC/SC daemon
195 from a client application and provide access to the desired reader.")
196 (license (list license:bsd-3 ; pcsc-lite
197 license:isc ; src/strlcat.c src/strlcpy.c
198 license:gpl3+)))) ; src/spy/*
200 (define-public ykclient
207 "https://developers.yubico.com/yubico-c-client/Releases/"
208 name "-" version ".tar.gz"))
211 "05jhx9waj3pl120ddnwap1v3bjrnbfhvf3lxs2xmhpcmwzpwsqgl"))))
212 (build-system gnu-build-system)
214 ;; There's just one test, and it requires network access to access
215 ;; yubico.com, so skip it.
216 (arguments '(#:tests? #f))
218 (native-inputs `(("pkg-config" ,pkg-config)
219 ("help2man" ,help2man)))
220 (inputs `(("curl" ,curl)))
221 (synopsis "C library to validate one-time-password YubiKeys")
223 "YubiKey C Client Library (libykclient) is a C library used to validate a
224 one-time-password (OTP) YubiKey against Yubico’s servers. See the Yubico
225 website for more information about Yubico and the YubiKey.")
226 (home-page "https://developers.yubico.com/yubico-c-client/")
227 (license license:bsd-2)))
229 (define-public opensc
236 "https://github.com/OpenSC/OpenSC/releases/download/"
237 version "/opensc-" version ".tar.gz"))
240 "09jqzl18z5qfrf4vf2nvbpdm3mphpgfkl3ww1clkaxh2z56hwnic"))))
241 (build-system gnu-build-system)
244 (modify-phases %standard-phases
245 ;; By setting an absolute path here, we arrange for OpenSC to
246 ;; successfully dlopen libpcsclite.so.1 by default. The user can
247 ;; still override this if they want to, by specifying a custom OpenSC
248 ;; configuration file at runtime.
249 (add-after 'unpack 'set-default-libpcsclite.so.1-path
250 (lambda* (#:key inputs #:allow-other-keys)
251 (let ((libpcsclite (string-append (assoc-ref inputs "pcsc-lite")
252 "/lib/libpcsclite.so.1")))
253 (substitute* "configure"
254 (("DEFAULT_PCSC_PROVIDER=\"libpcsclite\\.so\\.1\"")
256 "DEFAULT_PCSC_PROVIDER=\"" libpcsclite "\"")))
259 `(("readline" ,readline)
261 ("pcsc-lite" ,pcsc-lite)
264 `(("libxslt" ,libxslt)
265 ("docbook-xsl" ,docbook-xsl)
266 ("pkg-config" ,pkg-config)))
267 (home-page "https://github.com/OpenSC/OpenSC/wiki")
268 (synopsis "Tools and libraries related to smart cards")
270 "OpenSC is a set of software tools and libraries to work with smart
271 cards, with the focus on smart cards with cryptographic capabilities. OpenSC
272 facilitate the use of smart cards in security applications such as
273 authentication, encryption and digital signatures. OpenSC implements the PKCS
274 #15 standard and the PKCS #11 API.")
275 (license license:lgpl2.1+)))
277 (define-public yubico-piv-tool
279 (name "yubico-piv-tool")
284 "https://developers.yubico.com/yubico-piv-tool/Releases/"
285 name "-" version ".tar.gz"))
288 "10xgdc51xvszkxmsvqnbjs8ixxz7rfnfahh3wn8glllynmszbhwi"))))
289 (build-system gnu-build-system)
291 `(("gengetopt" ,gengetopt)
293 ("pcsc-lite" ,pcsc-lite)
294 ("openssl" ,openssl)))
296 `(("doxygen" ,doxygen)
297 ("graphviz" ,graphviz)
298 ("help2man" ,help2man)
300 ("texlive-bin" ,texlive-bin)
301 ("pkg-config" ,pkg-config)))
302 (home-page "https://developers.yubico.com/yubico-piv-tool/")
303 (synopsis "Interact with the PIV application on a YubiKey")
305 "The Yubico PIV tool is used for interacting with the Privilege and
306 Identification Card (PIV) application on a YubiKey. With it you may generate
307 keys on the device, import keys and certificates, create certificate requests,
308 and other operations. It includes a library and a command-line tool.")
309 ;; The file ykcs11/pkcs11.h also declares an additional, very short free
310 ;; license for that one file. Please see it for details. The vast
311 ;; majority of files are licensed under bsd-2.
312 (license license:bsd-2)))
314 (define-public yubikey-personalization
316 (name "yubikey-personalization")
321 "https://developers.yubico.com/" name
322 "/Releases/ykpers-" version ".tar.gz"))
325 "0jhvnavjrpwzmmjcw486df5s48j53njqgyz36yz3dskbaz3kwlfr"))))
326 (build-system gnu-build-system)
328 '(#:configure-flags (list (string-append "--with-udevrulesdir="
329 (assoc-ref %outputs "out")
330 "/lib/udev/rules.d"))))
334 ;; The library "libyubikey" is also known as "yubico-c".
335 ("libyubikey" ,libyubikey)))
337 `(("pkg-config" ,pkg-config)
339 (home-page "https://developers.yubico.com/yubikey-personalization/")
340 (synopsis "Library and tools to personalize YubiKeys")
342 "The YubiKey Personalization package contains a C library and command
343 line tools for personalizing YubiKeys. You can use these to set an AES key,
344 retrieve a YubiKey's serial number, and so forth.")
345 (license license:bsd-2)))
347 (define-public python-pyscard
349 (name "python-pyscard")
353 ;; The maintainer publishes releases on various sites, but
354 ;; SourceForge is apparently the only one with a signed release.
356 "mirror://sourceforge/pyscard/pyscard/pyscard%20"
357 version "/pyscard-" version ".tar.gz"))
360 "082cjkbxadaz2jb4rbhr0mkrirzlqyqhcf3r823qb0q1k50ybgg6"))))
361 (build-system python-build-system)
364 (modify-phases %standard-phases
365 ;; Tell pyscard where to find the PCSC include directory.
366 (add-after 'unpack 'patch-platform-include-dirs
367 (lambda* (#:key inputs #:allow-other-keys)
368 (let ((pcsc-include-dir (string-append
369 (assoc-ref inputs "pcsc-lite")
371 (substitute* "setup.py"
372 (("platform_include_dirs = \\[.*?\\]")
374 "platform_include_dirs = ['" pcsc-include-dir "']")))
376 ;; pyscard wants to dlopen libpcsclite, so tell it where it is.
377 (add-after 'unpack 'patch-dlopen
378 (lambda* (#:key inputs #:allow-other-keys)
379 (substitute* "smartcard/scard/winscarddll.c"
380 (("lib = \"libpcsclite\\.so\\.1\";")
383 (string-append (assoc-ref inputs "pcsc-lite")
384 "/lib/libpcsclite.so.1"))))
387 `(("pcsc-lite" ,pcsc-lite)))
390 (home-page "https://github.com/LudovicRousseau/pyscard")
391 (synopsis "Smart card library for Python")
393 "The pyscard smart card library is a framework for building smart card
394 aware applications in Python. The smart card module is built on top of the
395 PCSC API Python wrapper module.")
396 (license license:lgpl2.1+)))
398 (define-public python2-pyscard
399 (package-with-python2 python-pyscard))
401 (define-public libu2f-host
409 "https://developers.yubico.com"
410 "/libu2f-host/Releases/libu2f-host-" version ".tar.xz"))
413 "0vrivl1dwql6nfi48z6dy56fwy2z13d7abgahgrs2mcmqng7hra2"))))
414 (build-system gnu-build-system)
417 (list "--enable-gtk-doc"
418 (string-append "--with-udevrulesdir="
419 (assoc-ref %outputs "out")
420 "/lib/udev/rules.d"))
422 (modify-phases %standard-phases
423 (add-after 'unpack 'patch-docbook-xml
424 (lambda* (#:key inputs #:allow-other-keys)
425 ;; Avoid a network connection attempt during the build.
426 (substitute* "gtk-doc/u2f-host-docs.xml"
427 (("http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd")
428 (string-append (assoc-ref inputs "docbook-xml")
429 "/xml/dtd/docbook/docbookx.dtd")))
435 `(("help2man" ,help2man)
436 ("gengetopt" ,gengetopt)
437 ("pkg-config" ,pkg-config)
439 ("docbook-xml" ,docbook-xml-4.3)
441 (home-page "https://developers.yubico.com/libu2f-host/")
442 ;; TRANSLATORS: The U2F protocol has a "server side" and a "host side".
443 (synopsis "U2F host-side C library and tool")
445 "Libu2f-host provides a C library and command-line tool that implements
446 the host-side of the Universal 2nd Factor (U2F) protocol. There are APIs to
447 talk to a U2F device and perform the U2F Register and U2F Authenticate
449 ;; Most files are LGPLv2.1+, but some files are GPLv3+.
450 (license (list license:lgpl2.1+ license:gpl3+))))
452 (define-public libu2f-server
454 (name "libu2f-server")
460 (url "https://github.com/Yubico/libu2f-server.git")
461 (commit (string-append "libu2f-server-" version))))
462 (file-name (git-file-name name version))
465 "1nmsfq372zza5y6j13ydincjf324bwfcjg950vykh166xkp6wiic"))))
466 (build-system gnu-build-system)
469 (list "--enable-gtk-doc"
473 ("libressl" ,libressl)))
475 `(("autoconf" ,autoconf)
476 ("automake" ,automake)
479 ("gengetopt" ,gengetopt)
480 ("help2man" ,help2man)
481 ("pkg-config" ,pkg-config)
484 (home-page "https://developers.yubico.com/libu2f-server/")
485 ;; TRANSLATORS: The U2F protocol has a "server side" and a "host side".
486 (synopsis "U2F server-side C library")
488 "This is a C library that implements the server-side of the
489 @dfn{Universal 2nd Factor} (U2F) protocol. More precisely, it provides an API
490 for generating the JSON blobs required by U2F devices to perform the U2F
491 Registration and U2F Authentication operations, and functionality for
492 verifying the cryptographic operations.")
493 (license license:bsd-2)))
495 (define-public pam-u2f
503 (url "https://github.com/Yubico/pam-u2f.git")
504 (commit (string-append "pam_u2f-" version))))
505 (file-name (git-file-name name version))
508 "04d9davyi33gqbvga1rvh9fijp6f16mx2xmnn4n61rnhcn2jac98"))))
509 (build-system gnu-build-system)
512 (list (string-append "--with-pam-dir="
513 (assoc-ref %outputs "out") "/lib/security"))))
515 `(("libu2f-host" ,libu2f-host)
516 ("libu2f-server" ,libu2f-server)
517 ("linux-pam" ,linux-pam)))
519 `(("autoconf" ,autoconf)
520 ("automake" ,automake)
522 ("asciidoc" ,asciidoc)
523 ("pkg-config" ,pkg-config)))
524 (home-page "https://developers.yubico.com/pam-u2f/")
525 (synopsis "PAM module for U2F authentication")
527 "This package provides a module implementing PAM over U2F, providing an
528 easy way to integrate the YubiKey (or other U2F compliant authenticators) into
529 your existing infrastructure.")
530 (license license:bsd-2)))
532 (define-public python-fido2
534 (name "python-fido2")
540 "https://github.com/Yubico/python-fido2/releases/download/"
541 version "/fido2-" version ".tar.gz"))
544 "1pl8d2pr6jzqj4y9qiaddhjgnl92kikjxy0bgzm2jshkzzic8mp3"))
546 ;; Remove bundled dependency.
547 #~(delete-file "fido2/public_suffix_list.dat"))))
548 (build-system python-build-system)
551 (modify-phases %standard-phases
552 (add-after 'unpack 'install-public-suffix-list
553 (lambda* (#:key inputs #:allow-other-keys)
555 (string-append (assoc-ref inputs "public-suffix-list")
556 "/share/public-suffix-list-"
557 ,(package-version public-suffix-list)
558 "/public_suffix_list.dat")
559 "fido2/public_suffix_list.dat")
562 `(("python-cryptography" ,python-cryptography)
563 ("python-six" ,python-six)))
565 `(("python-mock" ,python-mock)
566 ("python-pyfakefs" ,python-pyfakefs)
567 ("public-suffix-list" ,public-suffix-list)))
568 (home-page "https://github.com/Yubico/python-fido2")
569 (synopsis "Python library for communicating with FIDO devices over USB")
571 "This Python library provides functionality for communicating with a Fast
572 IDentity Online (FIDO) device over Universal Serial Bus (USB) as well as
573 verifying attestation and assertion signatures. It aims to support the FIDO
574 Universal 2nd Factor (U2F) and FIDO 2.0 protocols for communicating with a USB
575 authenticator via the Client-to-Authenticator Protocol (CTAP 1 and 2). In
576 addition to this low-level device access, classes defined in the
577 @code{fido2.client} and @code{fido2.server} modules implement higher level
578 operations which are useful when interfacing with an Authenticator, or when
579 implementing a Relying Party.")
580 ;; python-fido2 contains some derivative files originally from pyu2f
581 ;; (https://github.com/google/pyu2f). These files are licensed under the
582 ;; Apache License, version 2.0. The maintainers have customized these
583 ;; files for internal use, so they are not really a bundled dependency.
584 (license (list license:bsd-2 license:asl2.0))))
586 (define-public python2-fido2
587 (package-with-python2 python-fido2))
589 (define-public python-yubikey-manager
591 (name "python-yubikey-manager")
596 "https://developers.yubico.com/yubikey-manager/Releases"
597 "/yubikey-manager-" version ".tar.gz"))
600 "11rsmcaj60k3y5m5gdhr2nbbz0w5dm3m04klyxz0fh5hnpcmr7fm"))))
601 (build-system python-build-system)
603 `(("python-six" ,python-six)
604 ("python-pyscard" ,python-pyscard)
605 ("python-pyusb" ,python-pyusb)
606 ("python-click" ,python-click)
607 ("python-cryptography" ,python-cryptography)
608 ("python-pyopenssl" ,python-pyopenssl)
609 ("python-fido2" ,python-fido2)))
611 `(("yubikey-personalization" ,yubikey-personalization)
612 ("pcsc-lite" ,pcsc-lite)
616 ("python-mock" ,python-mock)))
617 (home-page "https://developers.yubico.com/yubikey-manager/")
618 (synopsis "Command line tool and library for configuring a YubiKey")
620 "Python library and command line tool for configuring a YubiKey. Note
621 that after installing this package, you might still need to add appropriate
622 udev rules to your system configuration to be able to configure the YubiKey as
623 an unprivileged user.")
624 (license license:bsd-2)))
626 (define-public python2-yubikey-manager
627 (package-with-python2 python-yubikey-manager))