zmq_z85_decode.txt 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. zmq_z85_decode(3)
  2. =================
  3. NAME
  4. ----
  5. zmq_z85_decode - decode a binary key from Z85 printable text
  6. SYNOPSIS
  7. --------
  8. *uint8_t *zmq_z85_decode (uint8_t *dest, const char *string);*
  9. DESCRIPTION
  10. -----------
  11. The _zmq_z85_decode()_ function shall decode 'string' into 'dest'.
  12. The length of 'string' shall be divisible by 5. 'dest' must be large
  13. enough for the decoded value (0.8 x strlen (string)).
  14. The encoding shall follow the ZMQ RFC 32 specification.
  15. RETURN VALUE
  16. ------------
  17. The _zmq_z85_decode()_ function shall return 'dest' if successful, else it
  18. shall return NULL.
  19. EXAMPLE
  20. -------
  21. .Decoding a CURVE key
  22. ----
  23. const char decoded [] = "rq:rM>}U?@Lns47E1%kR.o@n%FcmmsL/@{H8]yf7";
  24. uint8_t public_key [32];
  25. zmq_z85_decode (public_key, decoded);
  26. ----
  27. SEE ALSO
  28. --------
  29. linkzmq:zmq_z85_decode[3]
  30. linkzmq:zmq_curve_keypair[3]
  31. linkzmq:zmq_curve_public[3]
  32. linkzmq:zmq_curve[7]
  33. AUTHORS
  34. -------
  35. This page was written by the 0MQ community. To make a change please
  36. read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.