aboutsummaryrefslogtreecommitdiffstats
path: root/doc/gpgme.texi
diff options
context:
space:
mode:
authorWerner Koch <[email protected]>2015-08-30 17:04:44 +0000
committerWerner Koch <[email protected]>2015-08-30 17:04:44 +0000
commitc4b6b35bfa98e478f1d13f4ce3e664771f2604c2 (patch)
tree103c0bba4e50e1b49446e0203b38d46bf75cd94d /doc/gpgme.texi
parentPost release updates (diff)
downloadgpgme-c4b6b35bfa98e478f1d13f4ce3e664771f2604c2.tar.gz
gpgme-c4b6b35bfa98e478f1d13f4ce3e664771f2604c2.zip
Add gpgme_pubkey_algo_string
* src/gpgme.h.in (GPGME_PK_EDDSA): New. (gpgme_pubkey_algo_string): New. * src/conversion.c (_gpgme_map_pk_algo): Add new algo. * src/gpgme.c (gpgme_pubkey_algo_string): New. (gpgme_pubkey_algo_name): Reformat. Signed-off-by: Werner Koch <[email protected]>
Diffstat (limited to 'doc/gpgme.texi')
-rw-r--r--doc/gpgme.texi21
1 files changed, 17 insertions, 4 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index c02a30f3..a764ce42 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -1161,6 +1161,9 @@ Algorithm as defined by FIPS 186-2 and RFC-6637.
This value indicates ECDH, the Eliptic Curve Diffie-Hellmann
encryption algorithm as defined by RFC-6637.
+@item GPGME_PK_EDDSA
+This value indicates the EdDSA algorithm.
+
@end table
@end deftp
@@ -1174,6 +1177,14 @@ If @var{algo} is not a valid public key algorithm, @code{NULL} is
returned.
@end deftypefun
+@deftypefun {char *} gpgme_pubkey_algo_string (@w{gpgme_subkey_t @var{key}})
+The function @code{gpgme_pubkey_algo_string} is a convenience function
+to build and return an algorithm string in the same way GnuPG does
+(e.g. ``rsa2048'' or ``ed25519''). The caller must free the result
+using @code{gpgme_free}. On error (e.g. invalid argument or memory
+exhausted), the function returns NULL and sets @code{ERRNO}.
+@end deftypefun
+
@node Hash Algorithms
@section Hash Algorithms
@@ -1954,9 +1965,11 @@ case, the data object @var{dh} is destroyed.
@deftypefun void gpgme_free (@w{void *@var{buffer}})
The function @code{gpgme_free} releases the memory returned by
-@code{gpgme_data_release_and_get_mem}. It should be used instead of
-the system libraries @code{free} function in case different allocators
-are used in a single program.
+@code{gpgme_data_release_and_get_mem} and
+@code{gpgme_pubkey_algo_string}. It should be used instead of the
+system libraries @code{free} function in case different allocators are
+used by a program. This is often the case if gpgme is used under
+Windows as a DLL.
@end deftypefun
@@ -2838,7 +2851,7 @@ True if the secret key is stored on a smart card.
The serial number of a smart card holding this key or @code{NULL}.
@item char *curve
-For ECC algoritms the name of the curve.
+For ECC algorithms the name of the curve.
@end table
@end deftp