mirror of
https://github.com/zeromq/libzmq.git
synced 2024-12-13 10:52:56 +01:00
b6ca9b2983
* migrate from the old, unmaintained "asciidoc-py" tool to the new "asciidoctor" generator * migrate from asciidoc-py syntax to the modern Asciidoc syntax (especially page titles and section titles) * remove the need of "xmlto" utility to create the manpage output; use asciidoctor for that * add HTML output support to the doc/Makefile by using asciidoctor * change API documentation files extension from .txt to .adoc to make it more explicit that they are Asciidoc-encoded (as a bonus several IDE plugins will autodetect the .adoc format as Asciidoc) * remove asciidoc.conf: asciidoctor does not support that; this also required replacing the macro linkzmq into all documentation pages * add a new Github action CI do deploy to Github Pages the static HTMLs produced by Asciidoctors * removed references to the "xmlto" and "a2x" tools from the build and packaging systems: Asciidoctor can convert the documentation directly to e.g. pdf (via extended converters) and anyway there was no code/target for using "xmlto" and "a2x" tools anyway
48 lines
1.2 KiB
Plaintext
48 lines
1.2 KiB
Plaintext
= zmq_curve_keypair(3)
|
|
|
|
|
|
== NAME
|
|
zmq_curve_keypair - generate a new CURVE keypair
|
|
|
|
|
|
== SYNOPSIS
|
|
*int zmq_curve_keypair (char *z85_public_key, char *z85_secret_key);*
|
|
|
|
|
|
== DESCRIPTION
|
|
The _zmq_curve_keypair()_ function shall return a newly generated random
|
|
keypair consisting of a public key and a secret key. The caller provides
|
|
two buffers, each at least 41 octets large, in which this method will
|
|
store the keys. The keys are encoded using xref:zmq_z85_encode.adoc[zmq_z85_encode].
|
|
|
|
|
|
== RETURN VALUE
|
|
The _zmq_curve_keypair()_ function shall return 0 if successful, else it
|
|
shall return `-1` and set 'errno' to one of the values defined below.
|
|
|
|
|
|
== ERRORS
|
|
*ENOTSUP*::
|
|
The libzmq library was not built with cryptographic support (libsodium).
|
|
|
|
|
|
== EXAMPLE
|
|
.Generating a new CURVE keypair
|
|
----
|
|
char public_key [41];
|
|
char secret_key [41];
|
|
int rc = zmq_curve_keypair (public_key, secret_key);
|
|
assert (rc == 0);
|
|
----
|
|
|
|
|
|
== SEE ALSO
|
|
xref:zmq_z85_encode.adoc[zmq_z85_encode]
|
|
xref:zmq_z85_decode.adoc[zmq_z85_decode]
|
|
xref:zmq_curve.adoc[zmq_curve]
|
|
|
|
|
|
== 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>.
|