summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac <arunisaac@systemreboot.net>2018-08-02 05:32:56 +0530
committerArun Isaac <arunisaac@systemreboot.net>2018-08-16 02:46:27 +0530
commitde30205ba0f63eb987097a9f47b6e4fd38cd9044 (patch)
treeccf6ee940595361d42e382a9ebd6c0a72c4f385d
parent3480d6f7219da1970d6e9a8da243274432524220 (diff)
gnu: services: Add pcscd service.
* gnu/services/security-token.scm: New file. * gnu/tests/security-token.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Register new files. * doc/guix.texi (Miscellaneous Services): Document the service.
-rw-r--r--doc/guix.texi31
-rw-r--r--gnu/local.mk2
-rw-r--r--gnu/services/security-token.scm84
-rw-r--r--gnu/tests/security-token.scm71
4 files changed, 188 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index bcb368ce3f..dddf8c89c6 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -20331,6 +20331,37 @@ An association list specifies kernel parameters and their values.
@end table
@end deftp
+@cindex pcscd
+@subsubheading PC/SC Smart Card Daemon Service
+
+The @code{(gnu services security-token)} module provides the following service
+to run @command{pcscd}, the PC/SC Smart Card Daemon. @command{pcscd} is the
+daemon program for pcsc-lite and the MuscleCard framework. It is a resource
+manager that coordinates communications with smart card readers, smart cards
+and cryptographic tokens that are connected to the system.
+
+@defvr {Scheme Variable} pcscd-service-type
+Service type for the @command{pcscd} service. Its value must be a
+@code{pcscd-configuration} object. To run pcscd in the default
+configuration, instantiate it as:
+
+@example
+(service pcscd-service-type)
+@end example
+@end defvr
+
+@deftp {Data Type} pcscd-configuration
+The data type representing the configuration of @command{pcscd}.
+
+@table @asis
+@item @code{pcsc-lite} (default: @code{pcsc-lite})
+The pcsc-lite package that provides pcscd.
+@item @code{usb-drivers} (default: @code{(list ccid)})
+List of packages that provide USB drivers to pcscd. Drivers are expected to be
+under @file{pcsc/drivers} in the store directory of the package.
+@end table
+@end deftp
+
@cindex lirc
@subsubheading Lirc Service
diff --git a/gnu/local.mk b/gnu/local.mk
index e14657c2d1..e3ca237d87 100644
--- a/gnu/local.mk
+++ b/gnu/local.mk
@@ -486,6 +486,7 @@ GNU_SYSTEM_MODULES = \
%D%/services/monitoring.scm \
%D%/services/networking.scm \
%D%/services/nfs.scm \
+ %D%/services/security-token.scm \
%D%/services/shepherd.scm \
%D%/services/sound.scm \
%D%/services/herd.scm \
@@ -540,6 +541,7 @@ GNU_SYSTEM_MODULES = \
%D%/tests/messaging.scm \
%D%/tests/networking.scm \
%D%/tests/rsync.scm \
+ %D%/tests/security-token.scm \
%D%/tests/ssh.scm \
%D%/tests/version-control.scm \
%D%/tests/virtualization.scm \
diff --git a/gnu/services/security-token.scm b/gnu/services/security-token.scm
new file mode 100644
index 0000000000..7e7ea54a50
--- /dev/null
+++ b/gnu/services/security-token.scm
@@ -0,0 +1,84 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2018 Arun Isaac <arunisaac@systemreboot.net>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (gnu services security-token)
+ #:use-module (gnu services)
+ #:use-module (gnu services shepherd)
+ #:use-module (gnu packages admin)
+ #:use-module (gnu packages security-token)
+ #:use-module (gnu system shadow)
+ #:use-module (guix gexp)
+ #:use-module (guix modules)
+ #:use-module (guix records)
+ #:use-module (ice-9 match)
+ #:use-module (srfi srfi-26)
+ #:export (pcscd-configuration
+ pcscd-configuration?
+ pcscd-configuration-pcsc-lite
+ pcscd-configuration-usb-drivers
+ pcscd-service-type))
+
+;;;
+;;; PC/SC Smart Card Daemon
+;;;
+
+(define-record-type* <pcscd-configuration>
+ pcscd-configuration make-pcscd-configuration pcscd-configuration?
+ (pcsc-lite pcscd-configuration-pcsc-lite
+ (default pcsc-lite))
+ (usb-drivers pcscd-configuration-usb-drivers
+ (default (list ccid))))
+
+(define pcscd-shepherd-service
+ (match-lambda
+ (($ <pcscd-configuration> pcsc-lite)
+ (with-imported-modules (source-module-closure
+ '((gnu build shepherd)))
+ (shepherd-service
+ (documentation "PC/SC Smart Card Daemon")
+ (provision '(pcscd))
+ (requirement '(syslogd))
+ (modules '((gnu build shepherd)))
+ (start #~(lambda _
+ (invoke #$(file-append pcsc-lite "/sbin/pcscd"))
+ (call-with-input-file "/var/run/pcscd/pcscd.pid" read)))
+ (stop #~(make-kill-destructor)))))))
+
+(define pcscd-activation
+ (match-lambda
+ (($ <pcscd-configuration> pcsc-lite usb-drivers)
+ #~(begin
+ (use-modules (guix build utils))
+ (mkdir-p "/var/lib")
+ (symlink #$(directory-union
+ "pcsc"
+ (map (cut file-append <> "/pcsc")
+ usb-drivers))
+ "/var/lib/pcsc")))))
+
+(define pcscd-service-type
+ (service-type
+ (name 'pcscd)
+ (description
+ "Run @command{pcscd}, the PC/SC smart card daemon.")
+ (extensions
+ (list (service-extension shepherd-root-service-type
+ (compose list pcscd-shepherd-service))
+ (service-extension activation-service-type
+ pcscd-activation)))
+ (default-value (pcscd-configuration))))
diff --git a/gnu/tests/security-token.scm b/gnu/tests/security-token.scm
new file mode 100644
index 0000000000..1169a4b9fd
--- /dev/null
+++ b/gnu/tests/security-token.scm
@@ -0,0 +1,71 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2018 Arun Isaac <arunisaac@systemreboot.net>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (gnu tests security-token)
+ #:use-module (gnu tests)
+ #:use-module (gnu system vm)
+ #:use-module (gnu services)
+ #:use-module (gnu services security-token)
+ #:use-module (guix gexp)
+ #:export (%test-pcscd))
+
+(define %pcscd-os
+ (simple-operating-system
+ (service pcscd-service-type)))
+
+(define* (run-pcscd-test)
+ "Run tests of 'pcscd-service-type'."
+ (define os
+ (marionette-operating-system
+ %pcscd-os
+ #:imported-modules '((gnu services herd))
+ #:requirements '(pcscd)))
+
+ (define test
+ (with-imported-modules '((gnu build marionette))
+ #~(begin
+ (use-modules (srfi srfi-64)
+ (gnu build marionette))
+ (define marionette
+ (make-marionette (list #$(virtual-machine os))))
+
+ (mkdir #$output)
+ (chdir #$output)
+
+ (test-begin "pcscd")
+
+ (test-assert "pcscd is alive"
+ (marionette-eval
+ '(begin
+ (use-modules (gnu services herd))
+ (live-service-running
+ (find (lambda (live)
+ (memq 'pcscd (live-service-provision live)))
+ (current-services))))
+ marionette))
+
+ (test-end)
+ (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
+
+ (gexp->derivation "pcscd" test))
+
+(define %test-pcscd
+ (system-test
+ (name "pcscd")
+ (description "Test a running pcscd daemon.")
+ (value (run-pcscd-test))))