You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
69 lines
2.4 KiB
69 lines
2.4 KiB
'\" t
|
|
.\" Title: zmq_curve_keypair
|
|
.\" Author: [see the "AUTHORS" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|
.\" Date: 09/14/2016
|
|
.\" Manual: 0MQ Manual
|
|
.\" Source: 0MQ 4.1.5
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ZMQ_CURVE_KEYPAIR" "3" "09/14/2016" "0MQ 4\&.1\&.5" "0MQ Manual"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
zmq_curve_keypair \- generate a new CURVE keypair
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
\fBint zmq_curve_keypair (char *z85_public_key, char *z85_secret_key);\fR
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
The \fIzmq_curve_keypair()\fR 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 \fBzmq_z85_encode\fR(3)\&.
|
|
.SH "RETURN VALUE"
|
|
.sp
|
|
The \fIzmq_curve_keypair()\fR function shall return 0 if successful, else it shall return \-1 and set \fIerrno\fR to one of the values defined below\&.
|
|
.SH "ERRORS"
|
|
.PP
|
|
\fBENOTSUP\fR
|
|
.RS 4
|
|
The libzmq library was not built with cryptographic support (libsodium)\&.
|
|
.RE
|
|
.SH "EXAMPLE"
|
|
.PP
|
|
\fBGenerating a new CURVE keypair\fR.
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
char public_key [41];
|
|
char secret_key [41];
|
|
int rc = zmq_curve_keypair (public_key, secret_key);
|
|
assert (rc == 0);
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBzmq_z85_decode\fR(3) \fBzmq_z85_encode\fR(3) \fBzmq_curve\fR(7)
|
|
.SH "AUTHORS"
|
|
.sp
|
|
This page was written by the 0MQ community\&. To make a change please read the 0MQ Contribution Policy at \m[blue]\fBhttp://www\&.zeromq\&.org/docs:contributing\fR\m[]\&.
|
|
|