summaryrefslogtreecommitdiff
path: root/lib/privkey_raw.c
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 /lib/privkey_raw.c
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>
Diffstat (limited to 'lib/privkey_raw.c')
-rw-r--r--lib/privkey_raw.c5
1 files changed, 4 insertions, 1 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.