Skip to content

Commit 40672b6

Browse files
Update site
1 parent a43d192 commit 40672b6

File tree

10 files changed

+27
-32
lines changed

10 files changed

+27
-32
lines changed

index.html

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -126,15 +126,15 @@
126126
<div class="col-md-9" role="main">
127127

128128
<h1 id="architecture-of-id-software">ARCHITECTURE OF ID-SOFTWARE</h1>
129-
<p>Document version: 2.4<br />
130-
Software version: 22.01<br />
131-
Last updated: 11.11.2021 </p>
129+
<p>Document version: 2.5<br />
130+
Software version: 22.05<br />
131+
Last updated: 4.5.2022 </p>
132132
<h1 id="introduction">Introduction</h1>
133133
<p>The purpose of this document is to describe the architecture of ID-software.</p>
134134
<p><strong>ID-software</strong> is a collection of software components offering support for PKI-based functionality, i.e. operations with different cryptographic tokens (e.g. eID cards), handling digitally signed documents, file encryption/decryption and signing and authentication in web environment. The ID-software comprises end-user applications, software libraries, web components, drivers for communicating with the cryptographic tokens and other complementary components.</p>
135135
<p>Main sources for information about ID-software are <a href="https://www.id.ee/en/">www.id.ee</a>, <a href="https://github.com/open-eid">Open-EID GitHub repository</a> and <a href="https://github.com/web-eid">Web-eID GitHub repository</a>.</p>
136136
<p>This document covers description of ID-software and its components, their deployment in different environments, provided and required interfaces. The document does not include components that have reached the end of their support nor the components that have not yet been released.</p>
137-
<p>The document is based on the latest released state of the ID-software components. At the time of writing, the latest released version of ID-software is <strong>version 22.01</strong>. Latest version numbers of the various ID-software components are provided at <a href="https://www.id.ee/en/article/information-on-the-latest-software-versions/">https://www.id.ee/en/article/information-on-the-latest-software-versions/</a>.</p>
137+
<p>The document is based on the latest released state of the ID-software components. At the time of writing, the latest released version of ID-software is <strong>version 22.05</strong>. Latest version numbers of the various ID-software components are provided at <a href="https://www.id.ee/en/article/information-on-the-latest-software-versions/">https://www.id.ee/en/article/information-on-the-latest-software-versions/</a>.</p>
138138
<p>The document is targeted for:</p>
139139
<ul>
140140
<li>Owners/managers of the software;</li>
@@ -281,7 +281,7 @@ <h1 id="background">Background</h1>
281281
<td>MIT</td>
282282
</tr>
283283
<tr>
284-
<th>firefox-pkcs11-loader</th>
284+
<th>firefox-pkcs11-loader (4)</th>
285285
<td>-</td>
286286
<td>-</td>
287287
<td>-</td>
@@ -331,7 +331,8 @@ <h1 id="background">Background</h1>
331331
<p>Remarks:</p>
332332
<p>(1) - The functionality is provided via base components.<br />
333333
(2) - The component is used only once for setting the proper parameters for authentication in Firefox browser.<br />
334-
(3) - PADES handling is not supported. </p>
334+
(3) - PADES handling is not supported.<br />
335+
(4) - Linux only. </p>
335336
<p>The main functions offered by ID-software are described in the following table:</p>
336337
<table>
337338
<thead>
@@ -363,7 +364,7 @@ <h1 id="background">Background</h1>
363364
</tr>
364365
<tr>
365366
<td>Authentication</td>
366-
<td>Authentication with ID-card. The operation is generally done via native operating system/browser components. In case of Estonian ID-cards and Firefox browser, a PKCS#11 module loader script is used for setting the proper parameters for authentication in Firefox browser.</td>
367+
<td>Authentication with ID-card. The operation is generally done via native operating system/browser components. In case of Estonian ID-cards and Firefox browser, a PKCS#11 module loader script is used for setting the proper parameters for authentication in Firefox browser on Linux.</td>
367368
</tr>
368369
</tbody>
369370
</table>
@@ -425,11 +426,6 @@ <h3 id="digidoc4-client">DigiDoc4 Client</h3>
425426
<td>RIA</td>
426427
</tr>
427428
<tr>
428-
<td>@eesti.ee e-mail checking service</td>
429-
<td>Service that enables to set the properties of e-mail address (@eesti.ee) that is provided for Estonian national ID-card owners by the state. The user must be authenticated with PIN1 code.</td>
430-
<td>RIA</td>
431-
</tr>
432-
<tr>
433429
<td>Central configuration repository</td>
434430
<td>Described in chap. <a href="#_comp_central_conf">Central configuration service</a>.</td>
435431
<td>RIA</td>
@@ -507,7 +503,6 @@ <h4 id="digidoc4-client-interfaces">DigiDoc4 Client interfaces</h4>
507503
<li><a href="#windows-updating-mechanism">ID-updater interface</a> (Windows only)</li>
508504
<li><a href="#_comp_central_conf_client_interfaces">Central configuration client interface</a></li>
509505
<li><a href="#_ID-card_owners’_photo">ID-card owners’ photo repository interface</a></li>
510-
<li><a href="#_Eesti.ee_e-mail_checking">Eesti.ee e-mail checking service interface</a></li>
511506
<li><a href="#_MID_REST_service">Mobile-ID (MID) REST service</a></li>
512507
<li><a href="#_SID_REST_service">Smart-ID (MID) REST service</a></li>
513508
<li><a href="#_LDAP_directory_interface">LDAP directory interface</a></li>
@@ -684,7 +679,7 @@ <h2 id="software-libraries">Software libraries</h2>
684679
</tr>
685680
<tr>
686681
<td>SiVa</td>
687-
<td><em>Si</em>gnature <em>Ve</em>rification Service is an online web service for validating digitally signed documents.<br/>SiVa is used by the DigiDoc4 Client (by libdigidocpp base library) to validate documents in formats that are not natively supported; currently the service is used to validate PDF (ETSI PAdES) documents.<br/>See also <a href="#_SiVa_verification_service">Signature Verification Service interface</a>.</td>
682+
<td><em>Si</em>gnature <em>Ve</em>rification Service is an online web service for validating digitally signed documents.<br/>SiVa is used by the DigiDoc4 Client and RIA DigiDoc (by libdigidocpp base library) to validate documents in formats that are not natively supported; currently the service is used to validate PDF (ETSI PAdES) documents.<br/>See also <a href="#_SiVa_verification_service">Signature Verification Service interface</a>.</td>
688683
<td>RIA</td>
689684
</tr>
690685
<tr>
@@ -929,7 +924,7 @@ <h4 id="web-eid-safari-extensions-interfaces">Web-eID Safari extension’s inter
929924
</li>
930925
</ul>
931926
<h3 id="web-authentication-components">Web authentication components</h3>
932-
<p>Authentication in web browsers is done with the browsers’ and operating systems’ native components. In case of authenticating in Firefox browser then Firefox-pkcs11-loader JavaScript component is used to load the One-Pin OpenSC PKCS#11 driver by the browser.</p>
927+
<p>Authentication in web browsers is done with the browsers’ and operating systems’ native components. In case of authenticating in Firefox browser then Firefox-pkcs11-loader JavaScript component is used to load the One-Pin OpenSC PKCS#11 driver by the browser on Linux.</p>
933928
<p><img alt="cmp Web components for authentication" src="index_files/web_auth.png" title="cmp Web components for authentication" /> </p>
934929
<p><strong>Figure: Web authentication components</strong></p>
935930
<table>
@@ -943,7 +938,7 @@ <h3 id="web-authentication-components">Web authentication components</h3>
943938
<tbody>
944939
<tr>
945940
<td>firefox-pkcs11-loader</td>
946-
<td>A JavaScript component that is used to load the OpenSC PKCS#11 driver to the Firefox browser’s cryptographic devices list during each initialization of the browser. Needed during authentication process with eID-card in Firefox browser in all supported operating systems. Code repository: <a href="https://github.com/open-eid/firefox-pkcs11-loader">https://github.com/open-eid/firefox-pkcs11-loader</a>. Wiki: <a href="https://github.com/open-eid/firefox-pkcs11-loader/wiki">https://github.com/open-eid/firefox-pkcs11-loader/wiki</a>.</td>
941+
<td>A JavaScript component that is used to load the OpenSC PKCS#11 driver to the Firefox browser’s cryptographic devices list during each initialization of the browser. Needed during authentication process with eID-card in Firefox browser in Linux operating systems. Code repository: <a href="https://github.com/open-eid/firefox-pkcs11-loader">https://github.com/open-eid/firefox-pkcs11-loader</a>. Wiki: <a href="https://github.com/open-eid/firefox-pkcs11-loader/wiki">https://github.com/open-eid/firefox-pkcs11-loader/wiki</a>.</td>
947942
<td>RIA</td>
948943
</tr>
949944
<tr>
@@ -974,17 +969,17 @@ <h2 id="drivers">Drivers</h2>
974969
<tbody>
975970
<tr>
976971
<td>OpenSC PKCS#11 driver</td>
977-
<td>A driver for accessing eID-cards. Connects with the card via the operating system’s native PC/SC interface. Used as a default driver for authentication with eID card and signature creation in web browser environment in case of Linux platform. Wiki: <a href="https://github.com/OpenSC/OpenSC/wiki">https://github.com/OpenSC/OpenSC/wiki</a>.</td>
972+
<td>A driver for accessing eID-cards. Connects with the card via the operating system’s native PC/SC interface. Used as a default driver for signature creation in web browser environment and DigiDoc4 Client in case of Linux and macOS platform. Wiki: <a href="https://github.com/OpenSC/OpenSC/wiki">https://github.com/OpenSC/OpenSC/wiki</a>.</td>
978973
<td>OpenSC</td>
979974
</tr>
980975
<tr>
981976
<td>One-pin OpenSC PKCS#11 driver</td>
982-
<td>Version of OpenSC PKCS#11 driver that only enables authentication functionality. Used as a default driver for authentication with eID card in browser environment in case of Windows platform. Wiki: <a href="https://github.com/OpenSC/OpenSC/wiki">https://github.com/OpenSC/OpenSC/wiki</a>.</td>
977+
<td>Version of OpenSC PKCS#11 driver that only enables authentication functionality. Used as a default driver for authentication with eID card in Firefox browser environment in case of Linux platform. Wiki: <a href="https://github.com/OpenSC/OpenSC/wiki">https://github.com/OpenSC/OpenSC/wiki</a>.</td>
983978
<td>OpenSC</td>
984979
</tr>
985980
<tr>
986981
<td>Minidriver</td>
987-
<td>Used as a default driver for accessing Estonian eID-cards via CNG interface for signature creation in web browser environment in case of Windows platform. Used as a default driver for authentication with eID card in Chrome and Edge browsers in case of Windows platform. Code repository: <a href="https://github.com/open-eid/minidriver">https://github.com/open-eid/minidriver</a>. Wiki: <a href="https://github.com/open-eid/minidriver/wiki">https://github.com/open-eid/minidriver/wiki</a>.</td>
982+
<td>Used as a default driver for accessing Estonian eID-cards via CNG interface for signature creation in web browser environment in case of Windows platform. Used as a default driver for authentication with eID card in browser environment in case of Windows platform. Code repository: <a href="https://github.com/open-eid/minidriver">https://github.com/open-eid/minidriver</a>. Wiki: <a href="https://github.com/open-eid/minidriver/wiki">https://github.com/open-eid/minidriver/wiki</a>.</td>
988983
<td>RIA/ IDEMIA</td>
989984
</tr>
990985
<tr>
@@ -1368,7 +1363,7 @@ <h4 id="smart-id-rest-service">Smart-ID REST service</h4>
13681363
<ul>
13691364
<li>User: DigiDoc4 Client, RIA DigiDoc</li>
13701365
<li>Accessible with: REST over HTTPS</li>
1371-
<li>Accessible from: <a href="https://dd-sid.ria.ee/v1">https://dd-sid.ria.ee/v1</a>, <a href="https://rp-api.smart-id.com/v1">https://rp-api.smart-id.com/v1</a></li>
1366+
<li>Accessible from: <a href="https://dd-sid.ria.ee/v2">https://dd-sid.ria.ee/v2</a>, <a href="https://rp-api.smart-id.com/v2">https://rp-api.smart-id.com/v2</a></li>
13721367
<li>Documentation: <a href="https://github.com/SK-EID/smart-id-documentation">https://github.com/SK-EID/smart-id-documentation</a></li>
13731368
</ul>
13741369
<p><a name="_LDAP_directory_interface"></a></p>
@@ -1427,13 +1422,6 @@ <h4 id="id-card-owners-photo-repository-interface">ID-card owners’ photo repos
14271422
<li>Accessible with: HTTPS protocol</li>
14281423
<li>Accessible from: <a href="https://sisene.www.eesti.ee/idportaal/portaal.idpilt">https://sisene.www.eesti.ee/idportaal/portaal.idpilt</a></li>
14291424
</ul>
1430-
<p><a name="_Eesti.ee_e-mail_checking"></a></p>
1431-
<h4 id="eestiee-e-mail-checking-service-interface">Eesti.ee e-mail checking service interface</h4>
1432-
<ul>
1433-
<li>User: DigiDoc4 Client</li>
1434-
<li>Accessible with: HTTPS</li>
1435-
<li>Accessible from: <a href="https://sisene.www.eesti.ee/idportaal/postisysteem.naita_suunamised">https://sisene.www.eesti.ee/idportaal/postisysteem.naita_suunamised</a></li>
1436-
</ul>
14371425
<h1 id="deployment-model">Deployment model</h1>
14381426
<p>The following subchapters describe physical deployment of ID-software components in collaboration with external components that were depicted in chap. <a href="#component-model">Component model</a> in case of the most common use cases.</p>
14391427
<h2 id="signing-in-web-browser">Signing in web browser</h2>
@@ -1552,6 +1540,6 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
15521540
</html>
15531541

15541542
<!--
1555-
MkDocs version : 1.2.3
1556-
Build Date UTC : 2022-03-15 14:29:53.531222+00:00
1543+
MkDocs version : 1.3.1
1544+
Build Date UTC : 2022-07-20 11:45:15.634107+00:00
15571545
-->

index_files/comp_digidoc4_eid.png

2.72 KB
Loading

index_files/up_macos.png

-1.8 KB
Loading

index_files/up_win.png

-2.34 KB
Loading

index_files/web_auth.png

1.89 KB
Loading

index_files/web_sign.png

-756 Bytes
Loading

search/main.js

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,15 @@ function joinUrl (base, path) {
2121
return base + "/" + path;
2222
}
2323

24+
function escapeHtml (value) {
25+
return value.replace(/&/g, '&amp;')
26+
.replace(/"/g, '&quot;')
27+
.replace(/</g, '&lt;')
28+
.replace(/>/g, '&gt;');
29+
}
30+
2431
function formatResult (location, title, summary) {
25-
return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ title + '</a></h3><p>' + summary +'</p></article>';
32+
return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>';
2633
}
2734

2835
function displayResults (results) {

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

sitemap.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>None</loc>
5-
<lastmod>2022-03-15</lastmod>
5+
<lastmod>2022-07-20</lastmod>
66
<changefreq>daily</changefreq>
77
</url>
88
</urlset>

sitemap.xml.gz

-1 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)