Skip to content

Commit c6ad82b

Browse files
Merge pull request #12 from open-eid/doc
Update documentation
2 parents 40672b6 + 7a53f0f commit c6ad82b

File tree

7 files changed

+12
-21
lines changed

7 files changed

+12
-21
lines changed

ID_software_architecture_files/ID_software_architecture_files_2_5.eap renamed to ID_software_architecture_files/ID_software_architecture_files_2_6.eap

1.63 MB
Binary file not shown.

ID_software_architecture_files/docs/index.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ARCHITECTURE OF ID-SOFTWARE
22

3-
Document version: 2.5
4-
Software version: 22.05
5-
Last updated: 4.5.2022
3+
Document version: 2.6
4+
Software version: 23.03
5+
Last updated: 8.2.2023
66

77

88
# Introduction
@@ -15,7 +15,7 @@ Main sources for information about ID-software are [www.id.ee](https://www.id.ee
1515

1616
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.
1717

18-
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 **version 22.05**. Latest version numbers of the various ID-software components are provided at [https://www.id.ee/en/article/information-on-the-latest-software-versions/](https://www.id.ee/en/article/information-on-the-latest-software-versions/).
18+
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 **version 23.03**. Latest version numbers of the various ID-software components are provided at [https://www.id.ee/en/article/information-on-the-latest-software-versions/](https://www.id.ee/en/article/information-on-the-latest-software-versions/).
1919

2020
The document is targeted for:
2121

@@ -32,9 +32,9 @@ The document is targeted for:
3232

3333
The software is being developed and tested by:
3434

35-
* **RaulWalter** (RW, [https://www.raulwalter.com](https://www.raulwalter.com)) as the main contractor during 2019-2022;
36-
* **Nortal** ([https://nortal.com](https://nortal.com)) during 2019-2020;
37-
* **TTT** ([https://www.testijad.ee](https://www.testijad.ee)) during 2019-2022;
35+
* **RaulWalter** (RW, [https://www.raulwalter.com](https://www.raulwalter.com)) as the main contractor during 2019-2023;
36+
* **Nortal** ([https://nortal.com](https://nortal.com)) during 2019-2023;
37+
* **TTT** ([https://www.testijad.ee](https://www.testijad.ee)) during 2019-2023;
3838
* SK ID Solutions (SK, [https://www.skidsolutions.eu/en](https://www.skidsolutions.eu/en));
3939
* Aktors ([http://www.aktors.ee/wp/](http://www.aktors.ee/wp/));
4040
* CGI Estonia ([https://www.cgi.ee/et](https://www.cgi.ee/et)).
@@ -267,8 +267,7 @@ Note that not all of the external base libraries are included in the component m
267267
| DigiDoc4 Client base libraries | Libdigidocpp (and its base libraries), etc. See [DigiDoc4 Client interfaces](#_DigiDoc4_Client_interfaces). | - |
268268
| Mobile-ID (MID) REST service | REST service that is used by DigiDoc4 Client for signature creation with Mobile-ID. See also [https://github.com/sk-eid/mid](https://github.com/sk-eid/mid). | SK |
269269
| Smart-ID (SID) REST service | REST service that is used by DigiDoc4 Client for signature creation with Smart-ID. See also [https://github.com/SK-EID/smart-id-documentation](https://github.com/SK-EID/smart-id-documentation). | SK |
270-
| LDAP directory | Directory of active certificates issued by SK (as the CA in Estonia). The directory is used by DigiDoc4 Client for finding authentication certificate (and the respective public key) of the recipient of the encrypted document. See also [https://www.skidsolutions.eu/en/repository/ldap/ldap-kataloogi-kasutamine/](https://www.skidsolutions.eu/en/repository/ldap/ldap-kataloogi-kasutamine/). | SK |
271-
| ID-card owner’s photo repository | Repository where the Estonian national ID-cards photos’ are kept. ID-card’s owner can download the photo after the user has been authenticated with PIN1 code. | RIA |
270+
| LDAP directory | Directory of active certificates issued by SK (as the CA in Estonia). The directory is used by DigiDoc4 Client for finding authentication certificate (and the respective public key) of the recipient of the encrypted document. See also [https://www.skidsolutions.eu/en/repository/ldap/](https://www.skidsolutions.eu/en/repository/ldap/). | SK |
272271
| Central configuration repository | Described in chap. [Central configuration service](#_comp_central_conf). | RIA |
273272
| Central configuration client | Described in chap. [Central configuration service](#_comp_central_conf). | RIA |
274273
| Libdigidocpp | Described in chap. [Software libraries](#_comp_libraries). | RIA |
@@ -303,13 +302,12 @@ Required:
303302

304303
* [ID-updater interface](#windows-updating-mechanism) (Windows only)
305304
* [Central configuration client interface](#_comp_central_conf_client_interfaces)
306-
* [ID-card owners’ photo repository interface](#_ID-card_owners’_photo)
307305
* [Mobile-ID (MID) REST service](#_MID_REST_service)
308306
* [Smart-ID (MID) REST service](#_SID_REST_service)
309307
* [LDAP directory interface](#_LDAP_directory_interface)
310308
* Interfaces with base libraries:
311309
* [Libdigidocpp library’s API](#_Libdigidocpp_library’s_interfaces) – for handling documents in supported digital signature formats (BDOC, DDOC and PDF)
312-
* External base libraries: Qt5, libldap, openssl
310+
* External base libraries: Qt6, libldap, openssl
313311
* Interfaces with cryptographic token’s drivers (described in chap. [Drivers](#_comp_drivers))
314312
* PKCS#11 interface
315313
* CNG interface
@@ -700,7 +698,7 @@ The following chapter describes automatic updating mechanisms of different ID-so
700698
| ID-updater | Service that is periodically checks if newer versions of related ID-software components are available for download, initiates the download and installation if necessary. Uses [Central configuration service](#_comp_central_conf) for determining the latest available software versions. | RIA |
701699
| MS Update | Microsoft Update – see Microsoft’s documentation for more information. | Microsoft |
702700
| Windows Store | See [https://microsoftedge.microsoft.com/addons/detail/gnmckgbandlkacikdndelhfghdejfido](https://microsoftedge.microsoft.com/addons/detail/gnmckgbandlkacikdndelhfghdejfido). | Microsoft |
703-
| Chrome Web Store | See [https://chrome.google.com/webstore/detail/token-signing/ncibgoaomkmdpilpocfeponihegamlic](https://chrome.google.com/webstore/detail/token-signing/ncibgoaomkmdpilpocfeponihegamlic). | Google |
701+
| Chrome Web Store | See [https://chrome.google.com/webstore/detail/web-eid/ncibgoaomkmdpilpocfeponihegamlic](https://chrome.google.com/webstore/detail/web-eid/ncibgoaomkmdpilpocfeponihegamlic). | Google |
704702
| Firefox Web Store | See [https://addons.mozilla.org/en-US/firefox/addon/web-eid-webextension/](https://addons.mozilla.org/en-US/firefox/addon/web-eid-webextension/). | Firefox |
705703

706704
**Table: Updating mechanisms in Windows**
@@ -714,7 +712,7 @@ The following chapter describes automatic updating mechanisms of different ID-so
714712
| - | - | - |
715713
| ID-updater | Described in chap. [Windows updating mechanism](#_Windows_updating_mechanism). | RIA |
716714
| Apple App Store | See Apple App Store documentation. | Apple |
717-
| Chrome Web Store** | See [https://chrome.google.com/webstore/detail/token-signing/ncibgoaomkmdpilpocfeponihegamlic](https://chrome.google.com/webstore/detail/token-signing/ncibgoaomkmdpilpocfeponihegamlic). | Google |
715+
| Chrome Web Store** | See [https://chrome.google.com/webstore/detail/web-eid/ncibgoaomkmdpilpocfeponihegamlic](https://chrome.google.com/webstore/detail/web-eid/ncibgoaomkmdpilpocfeponihegamlic). | Google |
718716
| Firefox Web Store | See [https://addons.mozilla.org/en-US/firefox/addon/web-eid-webextension/](https://addons.mozilla.org/en-US/firefox/addon/web-eid-webextension/). | Firefox |
719717

720718
**Table: Updating mechanisms in macOS**
@@ -728,7 +726,7 @@ The following chapter describes automatic updating mechanisms of different ID-so
728726
| - | - | - |
729727
| Ubuntu package updates | Managed and maintained by RIA. The binary packages are released for installation and updating to [https://installer.id.ee/media/ubuntu/](https://installer.id.ee/media/ubuntu/) repository. | RIA |
730728
| Packages updates for other distros | Managed by the open-source community. Packages are built, added and updated in Estobuntu and Fedora distributions by the package maintainers. | - |
731-
| Chrome Web Store | See [https://chrome.google.com/webstore/detail/token-signing/ncibgoaomkmdpilpocfeponihegamlic](https://chrome.google.com/webstore/detail/token-signing/ncibgoaomkmdpilpocfeponihegamlic). | Google |
729+
| Chrome Web Store | See [https://chrome.google.com/webstore/detail/web-eid/ncibgoaomkmdpilpocfeponihegamlic](https://chrome.google.com/webstore/detail/web-eid/ncibgoaomkmdpilpocfeponihegamlic). | Google |
732730
| Firefox Web Store | See [https://addons.mozilla.org/en-US/firefox/addon/web-eid-webextension/](https://addons.mozilla.org/en-US/firefox/addon/web-eid-webextension/). | Firefox |
733731

734732
**Table: Updating mechanisms in Linux**
@@ -872,13 +870,6 @@ The following chapter describes interfaces that different ID-software components
872870
* Accessible from: [https://siva.eesti.ee/V3/validate](https://siva.eesti.ee/V3/validate)
873871
* Documentation: [http://open-eid.github.io/SiVa/](http://open-eid.github.io/SiVa/)
874872

875-
<a name="_ID-card_owners’_photo"></a>
876-
#### ID-card owners’ photo repository interface
877-
878-
* User: DigiDoc4 Client
879-
* Accessible with: HTTPS protocol
880-
* Accessible from: [https://sisene.www.eesti.ee/idportaal/portaal.idpilt](https://sisene.www.eesti.ee/idportaal/portaal.idpilt)
881-
882873

883874

884875
# Deployment model
-1.93 KB
Loading
169 Bytes
Loading
170 Bytes
Loading
-2.22 KB
Loading
-2.29 KB
Loading

0 commit comments

Comments
 (0)