stombeur/open-eid

native plugin for the web to make e-ID card reading and signing easier

open-eid

open-eid is a native plugin for the web to make e-ID card reading and signing easier.

Read more

Status

This is a pre-release version 0.2 with the following features

• Read eID card content using URL or Web extension
• Sign content with eID card content using URL or Web extension

The app has been tested on Windows and Mac OS with belgian e-ID cards.

Windows and Mac versions are not synchronized about features or output format.

Using

You can use Open-eID with a simple URL starting with open-eid: followed by your redirection URL.

Signing data is done using open-eid-sign: followed by your redirection URL ending with & message argument containing base64 encoded data to sign.

Sample sign URL: open-eid-sign:https://e-id.eu.org/src/url_test.html?&message=SGVsbG8%3D

The card data or sign result is "sent" to your redirection URL using the "hash" part (right after #).

The data is URI component encoded JSON object with every value escaped/URI component encoded.

Open-eID detects the browser automatically but the result will open in a new window/tab.

The easiest thing to do to capture the data from the origin tab/window is to save the result in LocalStorage and read it from your origin page.

The Web Extension allows you to read the card data without opening a new tab/window but requires users to install both the app and the extension and enable it for each website requesting access to the extension.

The easiest way to use Open-eID is to use the helper function. Just add the following code to head section of your HTML page.

<script type="text/javascript" src="https://e-id.eu.org/release/Open-eID.js"></script>

The openEID.read function can then be called with a callback function.

The callback function has a single parameter as an object containing decoded card data.

openEID.read(function(result) { console.log(result); })

The openEID.sign function can then be called with a message to sign and a callback function.

The callback function has single parameter as an object containing signed data.

openEID.sign(message, function(result) { console.log(result); })

You can test the helper function on the following page

Building

To build open-eid you need the following tools:

Windows

• FreeBasic compiler
• Swelio library (Swelio32.dll)

Mac

• NodeJS
• pkg
• pkcs11js

References

• https://www.freebasic.net/
• https://github.com/perevoznyk/swelio-sdk/
• https://nodejs.org/
• https://www.npmjs.com/package/pkg/
• https://github.com/PeculiarVentures/pkcs11js/
• https://github.com/kjur/jsrsasign/