mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-13 18:55:10 +01:00
576e3ca5e0
* Removed redundant Z85 code and include files from project * Simplified use of headers in test cases (now they all just use testutil.hpp) * Export zmq_z85_encode() and zmq_z85_decode() in API * Added man pages for these two functions
51 lines
1009 B
Plaintext
51 lines
1009 B
Plaintext
zmq_z85_decode(3)
|
|
=================
|
|
|
|
|
|
NAME
|
|
----
|
|
zmq_z85_decode - decode a binary key from Z85 printable text
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
*uint8_t *zmq_z85_decode (uint8_t *dest, char *string);*
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
The _zmq_z85_decode()_ function shall decode 'string' into 'dest'.
|
|
The length of 'string' shall be divisible by 5. 'dest' must be large
|
|
enough for the decoded value (0.8 x strlen (string)).
|
|
|
|
The encoding shall follow the ZMQ RFC 32 specification.
|
|
|
|
|
|
RETURN VALUE
|
|
------------
|
|
The _zmq_z85_decode()_ function shall return 'dest' if successful, else it
|
|
shall return NULL.
|
|
|
|
|
|
EXAMPLE
|
|
-------
|
|
.Decoding a CURVE key
|
|
----
|
|
#include <sodium.h>
|
|
char decoded [] = "rq:rM>}U?@Lns47E1%kR.o@n%FcmmsL/@{H8]yf7";
|
|
uint8_t public_key [32];
|
|
zmq_z85_decode (public_key, decoded);
|
|
----
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
linkzmq:zmq_z85_decode[3]
|
|
linkzmq:zmq_curve[7]
|
|
|
|
|
|
AUTHORS
|
|
-------
|
|
This page was written by the 0MQ community. To make a change please
|
|
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.
|