From: Lukasz Pawelczyk <l.pawelczyk@samsung.com>
Date: Fri, 19 Jun 2020 15:32:18 +0000 (+0200)
Subject: Clarify bit_length for yaca_key_generate
X-Git-Tag: accepted/tizen/6.0/unified/20201030.115321~7
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F55%2F236955%2F2;p=platform%2Fcore%2Fsecurity%2Fyaca.git

Clarify bit_length for yaca_key_generate

Add info about symmetric keys and fix DH prime length that has to be
>= 256 (OpenSSL requires that).

Change-Id: Ic5704d88a103a30dd5c8742a87f4e08e2f54c5f7
---

diff --git a/api/yaca/yaca_key.h b/api/yaca/yaca_key.h
index 7ac0642..8abf4d1 100644
--- a/api/yaca/yaca_key.h
+++ b/api/yaca/yaca_key.h
@@ -185,11 +185,13 @@ int yaca_key_export(const yaca_key_h key, yaca_key_format_e key_fmt, yaca_key_fi
  * @remarks This function is used to generate symmetric keys, private asymmetric keys
  *          or key generation parameters for key types that support them (DSA, DH and EC).
  * @remarks Supported key lengths:
+ *          - SYMMETRIC/IV: >= 8bits
+ *          - DES: 64, 128 or 192bits
  *          - RSA: length >= 512bits
  *          - DSA: length >= 512bits, multiple of 64
  *          - DH: a value taken from #yaca_key_bit_length_dh_rfc_e or
  *                (YACA_KEY_LENGTH_DH_GENERATOR_* | prime_length_in_bits),
- *                where prime_length_in_bits can be any positive number
+ *                where prime_length_in_bits has to be >= 256
  *          - EC: a value taken from #yaca_key_bit_length_ec_e
  * @remarks The @a key should be released using yaca_key_destroy().
  * @param[in] key_type Type of the key to be generated