README.gost: Abstract rewritten, outdated text at the end of file is removed

[openssl-gost/engine.git] / README.gost

diff --git a/README.gost b/README.gost
index 3a48d9568db125d636571deb2e11cb0ec672dcda..4d7c0ff565f24cf57f6f1186afaa6c6e243afef4 100644 (file)
--- a/README.gost
+++ b/README.gost
@@ -1,21 +1,31 @@
-GOST ENGINE
+OPENSSL GOST ENGINE
 
-This engine provides implementation of Russian cryptography standard.
-This is also an example of adding new cryptoalgorithms into OpenSSL
-without changing its core. If OpenSSL is compiled with dynamic engine
-support, new algorithms can be added even without recompilation of
-OpenSSL and applications which use it.
+An implementation of Russian cryptography standards for OpenSSL.
+
+Since v.1.0.0 OpenSSL provides facilities for creating external
+dynamically loaded cryptographic engines (OpenSSL should be built
+with dynamic engine support to be able to use it).
+
+This engine provides an implementation of various Russian cryptographic
+algorithms, known generally as GOST cryptographic algorithms (see detailed
+list below). These algorithms, can be used both via OpenSSL command line
+tools and via high-level libopenssl calls.
+
+OpenSSL GOST Engine also includes gostsum и gost12sum command line tools,
+for generating and checking GOST R34.11-94 and GOST R34.11-2012 hash sums.
+They have the same purposes and behavior as well known sha1sum and md5sum
+utilities.
 
 ALGORITHMS SUPPORTED
 
-GOST R 34.10-94 and GOST R 34.10-2001 - digital signature algorithms.
+GOST R 34.10-2001 and GOST R 34.10-2012 - digital signature algorithms.
    Also support key exchange based on public keys. See RFC 4357 for
    details of VKO key exchange algorithm. These algorithms use
    256 bit private keys. Public keys are 1024 bit for 94 and 512 bit for
    2001 (which is elliptic-curve based). Key exchange algorithms
    (VKO R 34.10) are supported on these keys too.
    
-GOST R 34.11-94  Message digest algorithm. 256-bit hash value
+GOST R 34.11-2012  Message digest algorithm. 256- and 512-bit hash values.
 
 GOST 28147-89 - Symmetric cipher  with 256-bit key. Various modes are
    defined in the standard, but only CFB and CNT modes are implemented
@@ -32,6 +42,8 @@ GOST 28147-89 MAC mode. Message authentication code. While most MAC
 
        It is implemented as combination of EVP_PKEY type and EVP_MD type.
 
+GOST R 34.13–2015 - Symmetric cypher Grasshopper ("Kuznechik")
+
 USAGE OF THESE ALGORITHMS
 
 This engine is designed to allow usage of this algorithms in the
@@ -79,6 +91,12 @@ And section which describes configuration of the engine should contain
        default_algorithms = ALL
        CRYPT_PARAMS = id-Gost28147-89-CryptoPro-A-ParamSet
 
+BouncyCastle cryptoprovider has some problems with private key parsing from PrivateKeyInfo,
+so if you want to use old private key representation format, which supported by BC,
+you must add:
+  PK_PARAMS = LEGACY_PK_WRAP
+to [gost_section]
+
 Where engine_id parameter specifies name of engine (should be "gost").
 dynamic_path is a location of the loadable shared library implementing the
 engine. If the engine is compiled statically or is located in the OpenSSL
@@ -301,22 +319,3 @@ requires UKM to be derived from shared secret.
 
 If UKM is not set by this control command, encrypt operation would
 generate random UKM.
-
-
-This sources include implementation of GOST 28147-89 and GOST R 34.11-94
-which are completely indepentent from OpenSSL and can be used separately
-(files gost89.c, gost89.h, gosthash.c, gosthash.h) Utility gostsum (file
-gostsum.c) is provided as example of such separate usage. This is
-program, simular to md5sum and sha1sum utilities, but calculates GOST R
-34.11-94 hash.
-
-Makefile doesn't include rule for compiling gostsum.
-Use command
-
-$(CC) -o gostsum gostsum.c gost89.c gosthash.c
-where $(CC) is name of your C compiler.
-
-Implementations of GOST R 34.10-xx, including VKO algorithms heavily
-depends on OpenSSL BIGNUM and Elliptic Curve libraries.
-
-