From 597cc5edd624525563e6549dc0057eca2a51c81d Mon Sep 17 00:00:00 2001 From: Micah Anderson Date: Tue, 11 Nov 2014 13:30:46 -0500 Subject: upgrade to new version --- doc/zmq_z85_encode.html | 814 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 814 insertions(+) create mode 100644 doc/zmq_z85_encode.html (limited to 'doc/zmq_z85_encode.html') diff --git a/doc/zmq_z85_encode.html b/doc/zmq_z85_encode.html new file mode 100644 index 0000000..6fa7eec --- /dev/null +++ b/doc/zmq_z85_encode.html @@ -0,0 +1,814 @@ + + + + + +zmq_z85_encode(3) + + + + + +
+
+

SYNOPSIS

+
+

char *zmq_z85_encode (char *dest, uint8_t *data, size_t size);

+
+
+
+

DESCRIPTION

+
+

The zmq_z85_encode() function shall encode the binary block specified +by data and size into a string in dest. The size of the binary block +must be divisible by 4. The dest must have sufficient space for size * 1.25 +plus 1 for a null terminator. A 32-byte CURVE key is encoded as 40 ASCII +characters plus a null terminator.

+

The encoding shall follow the ZMQ RFC 32 specification.

+
+
+
+

RETURN VALUE

+
+

The zmq_z85_encode() function shall return dest if successful, else it +shall return NULL.

+
+
+
+

EXAMPLE

+
+
+
Encoding a CURVE key
+
+
#include <sodium.h>
+uint8_t public_key [32];
+uint8_t secret_key [32];
+int rc = crypto_box_keypair (public_key, secret_key);
+assert (rc == 0);
+char encoded [41];
+zmq_z85_encode (encoded, public_key, 32);
+puts (encoded);
+
+
+
+
+

SEE ALSO

+
+

zmq_z85_decode(3) +zmq_curve_keypair(3) +zmq_curve(7)

+
+
+
+

AUTHORS

+
+

This page was written by the ØMQ community. To make a change please +read the ØMQ Contribution Policy at http://www.zeromq.org/docs:contributing.

+
+
+
+
+ + + -- cgit v1.2.3