Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
L
libzmq
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
libzmq
Commits
baf32a19
Commit
baf32a19
authored
8 years ago
by
Luca Boccassi
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Problem: no documentation for zmq_curve_public
Solution: add manpage
parent
dc39ceb3
Show whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
72 additions
and
3 deletions
+72
-3
Makefile.am
doc/Makefile.am
+1
-1
zmq.txt
doc/zmq.txt
+3
-0
zmq_curve_public.txt
doc/zmq_curve_public.txt
+62
-0
zmq_setsockopt.txt
doc/zmq_setsockopt.txt
+4
-2
zmq_z85_decode.txt
doc/zmq_z85_decode.txt
+1
-0
zmq_z85_encode.txt
doc/zmq_z85_encode.txt
+1
-0
No files found.
doc/Makefile.am
View file @
baf32a19
...
...
@@ -14,7 +14,7 @@ MAN3 = zmq_bind.3 zmq_unbind.3 zmq_connect.3 zmq_disconnect.3 zmq_close.3 \
zmq_errno.3 zmq_strerror.3 zmq_version.3
\
zmq_sendmsg.3 zmq_recvmsg.3
\
zmq_proxy.3 zmq_proxy_steerable.3
\
zmq_z85_encode.3 zmq_z85_decode.3 zmq_curve_keypair.3
\
zmq_z85_encode.3 zmq_z85_decode.3 zmq_curve_keypair.3
zmq_curve_public.3
\
zmq_has.3
\
zmq_atomic_counter_new.3 zmq_atomic_counter_set.3
\
zmq_atomic_counter_inc.3 zmq_atomic_counter_dec.3
\
...
...
This diff is collapsed.
Click to expand it.
doc/zmq.txt
View file @
baf32a19
...
...
@@ -199,6 +199,9 @@ Elliptic curve authentication and encryption::
Generate a CURVE keypair in armored text format::
linkzmq:zmq_curve_keypair[3]
Derive a CURVE public key from a secret key:
linkzmq:zmq_curve_public[3]
Converting keys to/from armoured text strings::
linkzmq:zmq_z85_decode[3]
linkzmq:zmq_z85_encode[3]
...
...
This diff is collapsed.
Click to expand it.
doc/zmq_curve_public.txt
0 → 100644
View file @
baf32a19
zmq_curve_public(3)
===================
NAME
----
zmq_curve_public - derive the public key from a private key
SYNOPSIS
--------
*int zmq_curve_public (char *z85_public_key, char *z85_secret_key);*
DESCRIPTION
-----------
The _zmq_curve_public()_ function shall derive the public key from a
private key. The caller provides two buffers, each at least 41 octets
large. In z85_secret_key the caller shall provide the private key, and
the function will store the public key in z85_public_key. The keys are
encoded using linkzmq:zmq_z85_encode[3].
RETURN VALUE
------------
The _zmq_curve_public()_ 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
-------
.Deriving the public key from a CURVE private key
----
char public_key [41];
char secret_key [41];
int rc = zmq_curve_keypair (public_key, secret_key);
assert (rc == 0);
char derived_public[41];
rc = zmq_curve_public (derived_public, secret_key);
assert (rc == 0);
assert (!strcmp (derived_public, public_key));
----
SEE ALSO
--------
linkzmq:zmq_z85_decode[3]
linkzmq:zmq_z85_encode[3]
linkzmq:zmq_curve_keypair[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>.
This diff is collapsed.
Click to expand it.
doc/zmq_setsockopt.txt
View file @
baf32a19
...
...
@@ -132,7 +132,8 @@ sockets, see linkzmq:zmq_curve[7]. You can provide the key as 32 binary
bytes, or as a 40-character string encoded in the Z85 encoding format and
terminated in a null byte. The public key must always be used with the
matching secret key. To generate a public/secret key pair, use
linkzmq:zmq_curve_keypair[3].
linkzmq:zmq_curve_keypair[3]. To derive the public key from a secret key,
use linkzmq:zmq_curve_public[3].
NOTE: an option value size of 40 is supported for backwards compatibility,
though is deprecated.
...
...
@@ -150,7 +151,8 @@ Sets the socket's long term secret key. You must set this on both CURVE
client and server sockets, see linkzmq:zmq_curve[7]. You can provide the
key as 32 binary bytes, or as a 40-character string encoded in the Z85
encoding format and terminated in a null byte. To generate a public/secret
key pair, use linkzmq:zmq_curve_keypair[3].
key pair, use linkzmq:zmq_curve_keypair[3]. To derive the public key from
a secret key, use linkzmq:zmq_curve_public[3].
NOTE: an option value size of 40 is supported for backwards compatibility,
though is deprecated.
...
...
This diff is collapsed.
Click to expand it.
doc/zmq_z85_decode.txt
View file @
baf32a19
...
...
@@ -41,6 +41,7 @@ SEE ALSO
--------
linkzmq:zmq_z85_decode[3]
linkzmq:zmq_curve_keypair[3]
linkzmq:zmq_curve_public[3]
linkzmq:zmq_curve[7]
...
...
This diff is collapsed.
Click to expand it.
doc/zmq_z85_encode.txt
View file @
baf32a19
...
...
@@ -48,6 +48,7 @@ SEE ALSO
--------
linkzmq:zmq_z85_decode[3]
linkzmq:zmq_curve_keypair[3]
linkzmq:zmq_curve_public[3]
linkzmq:zmq_curve[7]
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment