summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_random_art
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/functions/gnutls_random_art
parentInitial commit. (diff)
downloadgnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz
gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/functions/gnutls_random_art')
-rw-r--r--doc/functions/gnutls_random_art24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/functions/gnutls_random_art b/doc/functions/gnutls_random_art
new file mode 100644
index 0000000..9f85422
--- /dev/null
+++ b/doc/functions/gnutls_random_art
@@ -0,0 +1,24 @@
+
+
+
+
+@deftypefun {int} {gnutls_random_art} (gnutls_random_art_t @var{type}, const char * @var{key_type}, unsigned int @var{key_size}, void * @var{fpr}, size_t @var{fpr_size}, gnutls_datum_t * @var{art})
+@var{type}: The type of the random art (for now only @code{GNUTLS_RANDOM_ART_OPENSSH} is supported)
+
+@var{key_type}: The type of the key (RSA, DSA etc.)
+
+@var{key_size}: The size of the key in bits
+
+@var{fpr}: The fingerprint of the key
+
+@var{fpr_size}: The size of the fingerprint
+
+@var{art}: The returned random art
+
+This function will convert a given fingerprint to an "artistic"
+image. The returned image is allocated using @code{gnutls_malloc()} , is
+null-terminated but art->size will not account the terminating null.
+
+@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS} (0) is returned, otherwise
+an error code is returned.
+@end deftypefun