Skip to content
Permalink
Browse files

Update README.md

  • Loading branch information...
siimsuu1 committed Jan 10, 2019
1 parent 25b9775 commit b02a1a0dfb5ffdd65b90cb28069538312539170c
Showing with 22 additions and 12 deletions.
  1. +22 −12 README.md
@@ -5,9 +5,10 @@
DigiDoc4j is a Java library for digitally signing documents and creating digital signature containers of signed documents.

# Features
* Creating BDOC, ASiC-E and DDOC containers
* Digitally signing containers in XAdES format
* Creating BDOC, ASiC-E containers
* Validating BDOC, ASiC-E and DDOC containers
* Creating, signing, timestamping and validating ASiC-S containers
* Creating and validating detached XadES

# How to use it
* Take a look at the [examples](https://github.com/open-eid/digidoc4j/wiki/Examples-of-using-it)
@@ -16,23 +17,31 @@ DigiDoc4j is a Java library for digitally signing documents and creating digital
* Download the latest [release](https://github.com/open-eid/digidoc4j/releases)
* See the [library development guide](https://github.com/open-eid/digidoc4j/wiki/Development). Your contribution and pull requests are more than welcome

# BDOC (ASiC-E) container format
* Has **.bdoc** or **.asice** extension
# BDOC (ASiC-E - Associated Signature Container Extended) container format
* Has **.bdoc**, **.asice** or **.sce** extension
* BDOC is a new digital signature format developed in 2014 to replace the old, DDOC (DigiDoc) digital signature format.
* The benefits of the new format include the higher security level, the long-term integrity of the signed documents, as well as the better compliance with international standards.
* BDOC container is based on **ASiC-E** standard.
* Signatures are stored in **XAdES** format.
* Supports two signature formats: **BDOC-TM** and **BDOC-TS**
* **BDOC-TM** signature format has **time-mark** ensuring long-term provability of the authenticity of the signature.
* This format has been used as a default digital signature format in Estonia since 2015.
* It is based on **XAdES baseline LT** signature format.
* Recommended extension is **.bdoc**
* This format has been used as a default digital signature format in Estonia since 2015.
* It is based on **XAdES baseline LT** signature format.
* Recommended extension is **.bdoc**
* **BDOC-TS** signature format has **time-stamp**.
* In contrast to the BDOC-TM format, long-term provability of the authenticity of the signature is ensured by time-stamps.
* It is based on **XAdES baseline LT** signature format and uses RFC3161 based time-stamps which makes it highly compliant in international context.
* To ensure better compliance with international standards, it's recommended to sign documents with the **BDOC-TS time-stamp** signature profile.
* Recommended extension is **.asice**
* In contrast to the BDOC-TM format, long-term provability of the authenticity of the signature is ensured by time-stamps.
* It is based on **XAdES baseline LT** signature format and uses RFC3161 based time-stamps which makes it highly compliant in international context.
* To ensure better compliance with international standards, it's recommended to sign documents with the **BDOC-TS time-stamp** signature profile.
* Recommended extension is **.asice**
* **.bdoc** or **.asice** file is in fact a ZIP container with the signed files, the signatures and the protocol control information and can basically be opened by any program that recognizes the ZIP format.
* It is recommended not to use special characters in the data file’s name, i.e. it is suggested to use only the characters that are categorized as “unreserved” according to RFC3986 (http://tools.ietf.org/html/rfc3986).

# ASiC-S (ASiC-E - Associated Signature Container Simple) container format
* Has **.asics** or **.scs** extension
* Container associates one data file with either:
- one signature file containing one or more detached digital signature(s) that apply to it; or
- one time assertion file containing a time assertion that apply to it.
* This format is used for timestamping the old DDOC containers in order to prove the inviolability of documents.

# DDOC container format
* Has **.ddoc** extension
@@ -42,6 +51,7 @@ DigiDoc4j is a Java library for digitally signing documents and creating digital
* The DigiDoc container includes the source files (the files that were signed) as well as the signatures that are related to the signed file(s)
* Every signature contains the certificate, validity confirmation and the validity confirmation service certificate.


# Documentation
* [DigiDoc4j API](http://open-eid.github.io/digidoc4j/)
* [Examples](https://github.com/open-eid/digidoc4j/wiki/Examples-of-using-it)
@@ -67,7 +77,7 @@ You can use the library as a Maven dependency from the Maven Central (http://mvn
<dependency>
<groupId>org.digidoc4j</groupId>
<artifactId>digidoc4j</artifactId>
<version>1.x.x</version>
<version>3.x.x</version>
</dependency>
```

0 comments on commit b02a1a0

Please sign in to comment.
You can’t perform that action at this time.