irmago is an IRMA implementation in Go. It contains multiple libraries and applications:
- The commandline tool
irma, which contains an IRMA server; subcommands for manipulating IRMA schemes, generating IRMA issuer public/private keypairs, performing test IRMA sessions on the command line; and more.
- The Go library
irmaserverproviding a HTTP server that handles IRMA session with the IRMA mobile app, and functions for starting and managing IRMA sessions.
- The root package
irmacontains generic IRMA functionality used by all other components below, such as parsing IRMA schemes, parsing IRMA metadata attributes, and structs representing messages of the IRMA protocol.
- The Go package
irmaclientis a library that serves as the client in the IRMA protocol; it can receive and disclose IRMA attributes and store and read them from storage. It also implements the keyshare protocol and handles registering to keyshare servers. The IRMA mobile app uses
Technical documentation of all components of
irmago and more can be found at https://irma.app/docs.
git clone https://github.com/privacybydesign/irmago
irmago and its subpackages use Go modules for their dependencies. The
go command will automatically download dependencies when needed.
To install the
irma command line tool:
go install ./irma
Running the unit tests
The tests can be run using:
go test -v -p 1 --tags=local_tests ./...
- The option
./...makes sure all tests are run. You can also limit the number of tests by only running the tests from a single directory or even from a single file, for example only running all tests in the directory
./internal/sessiontest. When you only want to execute one single test, for example the
TestDisclosureSessiontest, you can do this by adding the option
- The option
-p 1is necessary to prevent parallel execution of tests. Most tests use file manipulation and therefore tests can interfere.
The command above only runs the local tests. These tests cover all regular use cases. The tests that are dependent on the irma_keyshare_server are skipped. These tests are only relevant for client implementations, like the IRMA app.
If you do want to also run the tests using a keyshare server, you have to run your own local instance. How to set up a keyshare server suitable for these tests is described below. After this is done, the tests can be added by removing the
--tags=local_tests parameter from the command.
IRMA Keyshare Server
An irma_keyshare_server suitable for testing
irmago can be set up in the following way:
Copy or symlink the
testdata/to the configuration of the Keyshare server.
- Note that a
gradle appRunwon't automatically use the new
irma_configurationfolder if it was already built with an old one. For this, use
- Note that a
Add the keyshare user used in the unit tests to the keyshare database by a command like this:
mysql -uirma -pirma irma_keyshare < keyshareuser.sql
check_user_enabledis set to false in the Keyshare server configuration. Other options are already setup correctly in the example configuration.