summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDmitry Eremin-Solenikov <dbaryshkov@gmail.com>2018-07-09 18:21:20 +0300
committerNikos Mavrogiannopoulos <nmav@redhat.com>2018-07-10 12:45:36 +0200
commit4cca24907374505de223f36b363cd903d502381b (patch)
treeb5e4e968de62dc0a664b25d9479856e3fe67127d
parent2473836074c4803030aecc609233c915e954a179 (diff)
downloadgnutls-4cca24907374505de223f36b363cd903d502381b.tar.gz
lib: document digest and paramset in gost key import functions
Document behaviour of gnutls_pubkey_import_gost_raw, gnutls_privkey_import_gost_raw and gnutls_x509_privkey_import_gost_raw. Signed-off-by: Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
-rw-r--r--lib/privkey_raw.c5
-rw-r--r--lib/pubkey.c5
-rw-r--r--lib/x509/privkey.c5
3 files changed, 12 insertions, 3 deletions
diff --git a/lib/privkey_raw.c b/lib/privkey_raw.c
index ff3e900394..69c810d140 100644
--- a/lib/privkey_raw.c
+++ b/lib/privkey_raw.c
@@ -476,7 +476,10 @@ error:
*
* This function will convert the given GOST private key's parameters to the
* native #gnutls_privkey_t format. The output will be stored
- * in @key.
+ * in @key. @digest should be one of GNUTLS_DIG_GOSR_94,
+ * GNUTLS_DIG_STREEBOG_256 or GNUTLS_DIG_STREEBOG_512. If @paramset is set to
+ * GNUTLS_GOST_PARAMSET_UNKNOWN default one will be selected depending on
+ * @digest.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
diff --git a/lib/pubkey.c b/lib/pubkey.c
index 1eae075937..162ceaa4a0 100644
--- a/lib/pubkey.c
+++ b/lib/pubkey.c
@@ -1533,7 +1533,10 @@ gnutls_pubkey_import_ecc_x962(gnutls_pubkey_t key,
* @y: holds the y
*
* This function will convert the given GOST public key's parameters to a
- * #gnutls_pubkey_t. The output will be stored in @key.
+ * #gnutls_pubkey_t. The output will be stored in @key. @digest should be
+ * one of GNUTLS_DIG_GOSR_94, GNUTLS_DIG_STREEBOG_256 or
+ * GNUTLS_DIG_STREEBOG_512. If @paramset is set to GNUTLS_GOST_PARAMSET_UNKNOWN
+ * default one will be selected depending on @digest.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
diff --git a/lib/x509/privkey.c b/lib/x509/privkey.c
index 0f098c14e0..b6f54ba326 100644
--- a/lib/x509/privkey.c
+++ b/lib/x509/privkey.c
@@ -1184,7 +1184,10 @@ gnutls_x509_privkey_import_ecc_raw(gnutls_x509_privkey_t key,
*
* This function will convert the given GOST private key's parameters to the
* native #gnutls_x509_privkey_t format. The output will be stored
- * in @key.
+ * in @key. @digest should be one of GNUTLS_DIG_GOSR_94,
+ * GNUTLS_DIG_STREEBOG_256 or GNUTLS_DIG_STREEBOG_512. If @paramset is set to
+ * GNUTLS_GOST_PARAMSET_UNKNOWN default one will be selected depending on
+ * @digest.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.