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 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
177 "https://pcsclite.apdu.fr/files/"
178 name "-" version ".tar.bz2"))
181 "14l7irs1nsh8b036ag4cfy8wryyysch78scz5dw6xxqwqgnpjvfp"))))
182 (build-system gnu-build-system)
184 `(#:configure-flags '("--enable-usbdropdir=/var/lib/pcsc/drivers"
185 "--disable-libsystemd")))
187 `(("perl" ,perl) ; for pod2man
188 ("pkg-config" ,pkg-config)))
190 `(("libudev" ,eudev)))
191 (home-page "https://pcsclite.apdu.fr/")
192 (synopsis "Middleware to access a smart card using PC/SC")
194 "pcsc-lite provides an interface to communicate with smartcards and
195 readers using the SCard API. pcsc-lite is used to connect to the PC/SC daemon
196 from a client application and provide access to the desired reader.")
197 (license (list license:bsd-3 ; pcsc-lite
198 license:isc ; src/strlcat.c src/strlcpy.c
199 license:gpl3+)))) ; src/spy/*
201 (define-public ykclient
208 "https://developers.yubico.com/yubico-c-client/Releases/"
209 name "-" version ".tar.gz"))
212 "05jhx9waj3pl120ddnwap1v3bjrnbfhvf3lxs2xmhpcmwzpwsqgl"))))
213 (build-system gnu-build-system)
215 ;; There's just one test, and it requires network access to access
216 ;; yubico.com, so skip it.
217 (arguments '(#:tests? #f))
219 (native-inputs `(("pkg-config" ,pkg-config)
220 ("help2man" ,help2man)))
221 (inputs `(("curl" ,curl)))
222 (synopsis "C library to validate one-time-password YubiKeys")
224 "YubiKey C Client Library (libykclient) is a C library used to validate a
225 one-time-password (OTP) YubiKey against Yubico’s servers. See the Yubico
226 website for more information about Yubico and the YubiKey.")
227 (home-page "https://developers.yubico.com/yubico-c-client/")
228 (license license:bsd-2)))
230 (define-public opensc
237 "https://github.com/OpenSC/OpenSC/releases/download/"
238 version "/opensc-" version ".tar.gz"))
241 "09jqzl18z5qfrf4vf2nvbpdm3mphpgfkl3ww1clkaxh2z56hwnic"))))
242 (build-system gnu-build-system)
245 (modify-phases %standard-phases
246 ;; By setting an absolute path here, we arrange for OpenSC to
247 ;; successfully dlopen libpcsclite.so.1 by default. The user can
248 ;; still override this if they want to, by specifying a custom OpenSC
249 ;; configuration file at runtime.
250 (add-after 'unpack 'set-default-libpcsclite.so.1-path
251 (lambda* (#:key inputs #:allow-other-keys)
252 (let ((libpcsclite (string-append (assoc-ref inputs "pcsc-lite")
253 "/lib/libpcsclite.so.1")))
254 (substitute* "configure"
255 (("DEFAULT_PCSC_PROVIDER=\"libpcsclite\\.so\\.1\"")
257 "DEFAULT_PCSC_PROVIDER=\"" libpcsclite "\"")))
259 (add-before 'check 'disable-broken-test
261 ;; XXX: This test is fixed in git, remove this phase for >= 0.19.
262 (substitute* "doc/tools/Makefile"
263 (("TESTS = test-manpage.sh") "TESTS = "))
266 `(("readline" ,readline)
268 ("pcsc-lite" ,pcsc-lite)
271 `(("libxslt" ,libxslt)
272 ("docbook-xsl" ,docbook-xsl)
273 ("pkg-config" ,pkg-config)))
274 (home-page "https://github.com/OpenSC/OpenSC/wiki")
275 (synopsis "Tools and libraries related to smart cards")
277 "OpenSC is a set of software tools and libraries to work with smart
278 cards, with the focus on smart cards with cryptographic capabilities. OpenSC
279 facilitate the use of smart cards in security applications such as
280 authentication, encryption and digital signatures. OpenSC implements the PKCS
281 #15 standard and the PKCS #11 API.")
282 (license license:lgpl2.1+)))
284 (define-public yubico-piv-tool
286 (name "yubico-piv-tool")
291 "https://developers.yubico.com/yubico-piv-tool/Releases/"
292 name "-" version ".tar.gz"))
295 "10xgdc51xvszkxmsvqnbjs8ixxz7rfnfahh3wn8glllynmszbhwi"))))
296 (build-system gnu-build-system)
298 `(("gengetopt" ,gengetopt)
300 ("pcsc-lite" ,pcsc-lite)
301 ("openssl" ,openssl)))
303 `(("doxygen" ,doxygen)
304 ("graphviz" ,graphviz)
305 ("help2man" ,help2man)
307 ("texlive-bin" ,texlive-bin)
308 ("pkg-config" ,pkg-config)))
309 (home-page "https://developers.yubico.com/yubico-piv-tool/")
310 (synopsis "Interact with the PIV application on a YubiKey")
312 "The Yubico PIV tool is used for interacting with the Privilege and
313 Identification Card (PIV) application on a YubiKey. With it you may generate
314 keys on the device, import keys and certificates, create certificate requests,
315 and other operations. It includes a library and a command-line tool.")
316 ;; The file ykcs11/pkcs11.h also declares an additional, very short free
317 ;; license for that one file. Please see it for details. The vast
318 ;; majority of files are licensed under bsd-2.
319 (license license:bsd-2)))
321 (define-public yubikey-personalization
323 (name "yubikey-personalization")
328 "https://developers.yubico.com/" name
329 "/Releases/ykpers-" version ".tar.gz"))
332 "0jhvnavjrpwzmmjcw486df5s48j53njqgyz36yz3dskbaz3kwlfr"))))
333 (build-system gnu-build-system)
335 '(#:configure-flags (list (string-append "--with-udevrulesdir="
336 (assoc-ref %outputs "out")
337 "/lib/udev/rules.d"))))
341 ;; The library "libyubikey" is also known as "yubico-c".
342 ("libyubikey" ,libyubikey)))
344 `(("pkg-config" ,pkg-config)
346 (home-page "https://developers.yubico.com/yubikey-personalization/")
347 (synopsis "Library and tools to personalize YubiKeys")
349 "The YubiKey Personalization package contains a C library and command
350 line tools for personalizing YubiKeys. You can use these to set an AES key,
351 retrieve a YubiKey's serial number, and so forth.")
352 (license license:bsd-2)))
354 (define-public python-pyscard
356 (name "python-pyscard")
360 ;; The maintainer publishes releases on various sites, but
361 ;; SourceForge is apparently the only one with a signed release.
363 "mirror://sourceforge/pyscard/pyscard/pyscard%20"
364 version "/pyscard-" version ".tar.gz"))
367 "082cjkbxadaz2jb4rbhr0mkrirzlqyqhcf3r823qb0q1k50ybgg6"))))
368 (build-system python-build-system)
371 (modify-phases %standard-phases
372 ;; Tell pyscard where to find the PCSC include directory.
373 (add-after 'unpack 'patch-platform-include-dirs
374 (lambda* (#:key inputs #:allow-other-keys)
375 (let ((pcsc-include-dir (string-append
376 (assoc-ref inputs "pcsc-lite")
378 (substitute* "setup.py"
379 (("platform_include_dirs = \\[.*?\\]")
381 "platform_include_dirs = ['" pcsc-include-dir "']")))
383 ;; pyscard wants to dlopen libpcsclite, so tell it where it is.
384 (add-after 'unpack 'patch-dlopen
385 (lambda* (#:key inputs #:allow-other-keys)
386 (substitute* "smartcard/scard/winscarddll.c"
387 (("lib = \"libpcsclite\\.so\\.1\";")
390 (string-append (assoc-ref inputs "pcsc-lite")
391 "/lib/libpcsclite.so.1"))))
394 `(("pcsc-lite" ,pcsc-lite)))
397 (home-page "https://github.com/LudovicRousseau/pyscard")
398 (synopsis "Smart card library for Python")
400 "The pyscard smart card library is a framework for building smart card
401 aware applications in Python. The smart card module is built on top of the
402 PCSC API Python wrapper module.")
403 (license license:lgpl2.1+)))
405 (define-public python2-pyscard
406 (package-with-python2 python-pyscard))
408 (define-public libu2f-host
416 "https://developers.yubico.com"
417 "/libu2f-host/Releases/libu2f-host-" version ".tar.xz"))
420 "0vrivl1dwql6nfi48z6dy56fwy2z13d7abgahgrs2mcmqng7hra2"))))
421 (build-system gnu-build-system)
424 (list "--enable-gtk-doc"
425 (string-append "--with-udevrulesdir="
426 (assoc-ref %outputs "out")
427 "/lib/udev/rules.d"))
429 (modify-phases %standard-phases
430 (add-after 'unpack 'patch-docbook-xml
431 (lambda* (#:key inputs #:allow-other-keys)
432 ;; Avoid a network connection attempt during the build.
433 (substitute* "gtk-doc/u2f-host-docs.xml"
434 (("http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd")
435 (string-append (assoc-ref inputs "docbook-xml")
436 "/xml/dtd/docbook/docbookx.dtd")))
442 `(("help2man" ,help2man)
443 ("gengetopt" ,gengetopt)
444 ("pkg-config" ,pkg-config)
446 ("docbook-xml" ,docbook-xml-4.3)
448 (home-page "https://developers.yubico.com/libu2f-host/")
449 ;; TRANSLATORS: The U2F protocol has a "server side" and a "host side".
450 (synopsis "U2F host-side C library and tool")
452 "Libu2f-host provides a C library and command-line tool that implements
453 the host-side of the Universal 2nd Factor (U2F) protocol. There are APIs to
454 talk to a U2F device and perform the U2F Register and U2F Authenticate
456 ;; Most files are LGPLv2.1+, but some files are GPLv3+.
457 (license (list license:lgpl2.1+ license:gpl3+))))
459 (define-public libu2f-server
461 (name "libu2f-server")
467 (url "https://github.com/Yubico/libu2f-server.git")
468 (commit (string-append "libu2f-server-" version))))
469 (file-name (git-file-name name version))
472 "1nmsfq372zza5y6j13ydincjf324bwfcjg950vykh166xkp6wiic"))))
473 (build-system gnu-build-system)
476 (list "--enable-gtk-doc"
480 ("libressl" ,libressl)))
482 `(("autoconf" ,autoconf)
483 ("automake" ,automake)
486 ("gengetopt" ,gengetopt)
487 ("help2man" ,help2man)
488 ("pkg-config" ,pkg-config)
491 (home-page "https://developers.yubico.com/libu2f-server/")
492 ;; TRANSLATORS: The U2F protocol has a "server side" and a "host side".
493 (synopsis "U2F server-side C library")
495 "This is a C library that implements the server-side of the
496 @dfn{Universal 2nd Factor} (U2F) protocol. More precisely, it provides an API
497 for generating the JSON blobs required by U2F devices to perform the U2F
498 Registration and U2F Authentication operations, and functionality for
499 verifying the cryptographic operations.")
500 (license license:bsd-2)))
502 (define-public pam-u2f
510 (url "https://github.com/Yubico/pam-u2f.git")
511 (commit (string-append "pam_u2f-" version))))
512 (file-name (git-file-name name version))
515 "04d9davyi33gqbvga1rvh9fijp6f16mx2xmnn4n61rnhcn2jac98"))))
516 (build-system gnu-build-system)
519 (list (string-append "--with-pam-dir="
520 (assoc-ref %outputs "out") "/lib/security"))))
522 `(("libu2f-host" ,libu2f-host)
523 ("libu2f-server" ,libu2f-server)
524 ("linux-pam" ,linux-pam)))
526 `(("autoconf" ,autoconf)
527 ("automake" ,automake)
529 ("asciidoc" ,asciidoc)
530 ("pkg-config" ,pkg-config)))
531 (home-page "https://developers.yubico.com/pam-u2f/")
532 (synopsis "PAM module for U2F authentication")
534 "This package provides a module implementing PAM over U2F, providing an
535 easy way to integrate the YubiKey (or other U2F compliant authenticators) into
536 your existing infrastructure.")
537 (license license:bsd-2)))
539 (define-public python-fido2
541 (name "python-fido2")
547 "https://github.com/Yubico/python-fido2/releases/download/"
548 version "/fido2-" version ".tar.gz"))
551 "1pl8d2pr6jzqj4y9qiaddhjgnl92kikjxy0bgzm2jshkzzic8mp3"))
553 ;; Remove bundled dependency.
554 #~(delete-file "fido2/public_suffix_list.dat"))))
555 (build-system python-build-system)
558 (modify-phases %standard-phases
559 (add-after 'unpack 'install-public-suffix-list
560 (lambda* (#:key inputs #:allow-other-keys)
562 (string-append (assoc-ref inputs "public-suffix-list")
563 "/share/public-suffix-list-"
564 ,(package-version public-suffix-list)
565 "/public_suffix_list.dat")
566 "fido2/public_suffix_list.dat")
569 `(("python-cryptography" ,python-cryptography)
570 ("python-six" ,python-six)))
572 `(("python-mock" ,python-mock)
573 ("python-pyfakefs" ,python-pyfakefs)
574 ("public-suffix-list" ,public-suffix-list)))
575 (home-page "https://github.com/Yubico/python-fido2")
576 (synopsis "Python library for communicating with FIDO devices over USB")
578 "This Python library provides functionality for communicating with a Fast
579 IDentity Online (FIDO) device over Universal Serial Bus (USB) as well as
580 verifying attestation and assertion signatures. It aims to support the FIDO
581 Universal 2nd Factor (U2F) and FIDO 2.0 protocols for communicating with a USB
582 authenticator via the Client-to-Authenticator Protocol (CTAP 1 and 2). In
583 addition to this low-level device access, classes defined in the
584 @code{fido2.client} and @code{fido2.server} modules implement higher level
585 operations which are useful when interfacing with an Authenticator, or when
586 implementing a Relying Party.")
587 ;; python-fido2 contains some derivative files originally from pyu2f
588 ;; (https://github.com/google/pyu2f). These files are licensed under the
589 ;; Apache License, version 2.0. The maintainers have customized these
590 ;; files for internal use, so they are not really a bundled dependency.
591 (license (list license:bsd-2 license:asl2.0))))
593 (define-public python2-fido2
594 (package-with-python2 python-fido2))
596 (define-public python-yubikey-manager
598 (name "python-yubikey-manager")
603 "https://developers.yubico.com/yubikey-manager/Releases"
604 "/yubikey-manager-" version ".tar.gz"))
607 "11rsmcaj60k3y5m5gdhr2nbbz0w5dm3m04klyxz0fh5hnpcmr7fm"))))
608 (build-system python-build-system)
610 `(("python-six" ,python-six)
611 ("python-pyscard" ,python-pyscard)
612 ("python-pyusb" ,python-pyusb)
613 ("python-click" ,python-click)
614 ("python-cryptography" ,python-cryptography)
615 ("python-pyopenssl" ,python-pyopenssl)
616 ("python-fido2" ,python-fido2)))
618 `(("yubikey-personalization" ,yubikey-personalization)
619 ("pcsc-lite" ,pcsc-lite)
623 ("python-mock" ,python-mock)))
624 (home-page "https://developers.yubico.com/yubikey-manager/")
625 (synopsis "Command line tool and library for configuring a YubiKey")
627 "Python library and command line tool for configuring a YubiKey. Note
628 that after installing this package, you might still need to add appropriate
629 udev rules to your system configuration to be able to configure the YubiKey as
630 an unprivileged user.")
631 (license license:bsd-2)))
633 (define-public python2-yubikey-manager
634 (package-with-python2 python-yubikey-manager))