'\" t
.\"     Title: kcapi_kpp_ssgen
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: April 2024
.\"    Manual: Programming Interface
.\"    Source: libkcapi Manual 1.4.0
.\"  Language: English
.\"
.TH "KCAPI_KPP_SSGEN" "3" "April 2024" "libkcapi Manual 1\&.4\&.0" "Programming Interface"
.\" -----------------------------------------------------------------
.\" * 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"
kcapi_kpp_ssgen \- generate a shared secret
.SH "SYNOPSIS"
.HP \w'ssize_t\ kcapi_kpp_ssgen('u
.BI "ssize_t kcapi_kpp_ssgen(struct\ kcapi_handle\ *\ " "handle" ", const\ uint8_t\ *\ " "pubkey" ", size_t\ " "pubkeylen" ", uint8_t\ *\ " "ss" ", size_t\ " "sslen" ", int\ " "access" ");"
.SH "ARGUMENTS"
.PP
\fIhandle\fR
.RS 4
[in] cipher handle
.RE
.PP
\fIpubkey\fR
.RS 4
[in] public key of peer that shall be used to generate the shared secret with
.RE
.PP
\fIpubkeylen\fR
.RS 4
[in] length of the public key buffer
.RE
.PP
\fIss\fR
.RS 4
[out] generated shared secret
.RE
.PP
\fIsslen\fR
.RS 4
[in] length of key buffer
.RE
.PP
\fIaccess\fR
.RS 4
[in] kernel access type (KCAPI_ACCESS_HEURISTIC \- use internal heuristic for fastest kernel access; KCAPI_ACCESS_VMSPLICE \- use vmsplice access; KCAPI_ACCESS_SENDMSG \- sendmsg access)
.RE
.SH "DESCRIPTION"
.PP
\fIreturn\fR
number of bytes returned by the shared secret generation operation upon success; a negative errno\-style error code if an error occurred
.SH "AUTHOR"
.PP
\fBStephan Mueller\fR <\&smueller@chronox.de\&>
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br