diff options
author | Jussi Kivilinna <jussi.kivilinna@iki.fi> | 2023-04-20 19:14:25 +0300 |
---|---|---|
committer | Jussi Kivilinna <jussi.kivilinna@iki.fi> | 2023-04-20 19:14:25 +0300 |
commit | f3ca9fa4f7e0aee1bb5012c419deb7b927da844d (patch) | |
tree | 65f1ee6bff54f790cb084e0c717a1c9a43045ef9 /doc/gcrypt.texi | |
parent | 7146b69b490595d654228bae8c3fb5d1525e3b60 (diff) | |
download | libgcrypt-f3ca9fa4f7e0aee1bb5012c419deb7b927da844d.tar.gz |
doc: add documentation for GCRYCTL_SET_ALLOW_WEAK_KEY
* doc/gcrypt.texi: Add 'GCRYCTL_SET_ALLOW_WEAK_KEY' under
'gcry_cipher_ctl'.
--
GnuPG-bug-id: 6451
Signed-off-by: Jussi Kivilinna <jussi.kivilinna@iki.fi>
Diffstat (limited to 'doc/gcrypt.texi')
-rw-r--r-- | doc/gcrypt.texi | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/gcrypt.texi b/doc/gcrypt.texi index 3719cd83..bf7bd556 100644 --- a/doc/gcrypt.texi +++ b/doc/gcrypt.texi @@ -2183,6 +2183,28 @@ handle @var{h}. Please see the comments in the source code (@code{src/global.c}) for details. @end deftypefun +@c begin constants for gcry_cipher_ctl +@table @code + +@item GCRYCTL_SET_ALLOW_WEAK_KEY: + +This may be used to allow use of weak keys for certain block ciphers. +@var{buffer} must be given as @code{NULL}. To allow weak keys for +a cipher context @var{h}, set @var{buflen} to '1'. To disallow weak +keys, set @var{buflen} to '0'. + +Default setting for a cipher context is to disallow weak keys. + +Note that even if weak keys are allowed, @code{gcry_cipher_setkey} will +return error code @code{GPG_ERR_WEAK_KEY} if a weak key is detected. +However, the cipher context is configured with the weak key and can +proceed with encryption/decryption. When weak keys are disallowed, +error code @code{GPG_ERR_WEAK_KEY} is returned and the cipher context +is cannot be used for encryption/decryption. + +@end table +@c end constants for gcry_cipher_info + @deftypefun gcry_error_t gcry_cipher_info (gcry_cipher_hd_t @var{h}, @ int @var{what}, void *@var{buffer}, size_t *@var{nbytes}) |