'\" t
.\"     Title: kcapi_cipher_enc_aes_ctr
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: November 2020
.\"    Manual: Programming Interface
.\"    Source: libkcapi Manual 1.2.1
.\"  Language: English
.\"
.TH "KCAPI_CIPHER_ENC_AES" "3" "November 2020" "libkcapi Manual 1\&.2\&.1" "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_cipher_enc_aes_ctr \- Convenience function for AES CTR encryption
.SH "SYNOPSIS"
.HP \w'int32_t\ kcapi_cipher_enc_aes_ctr('u
.BI "int32_t kcapi_cipher_enc_aes_ctr(const\ uint8_t\ *\ " "key" ", uint32_t\ " "keylen" ", const\ uint8_t\ *\ " "in" ", uint32_t\ " "inlen" ", const\ uint8_t\ *\ " "ctr" ", uint8_t\ *\ " "out" ", uint32_t\ " "outlen" ");"
.SH "ARGUMENTS"
.PP
\fIkey\fR
.RS 4
[in] key buffer
.RE
.PP
\fIkeylen\fR
.RS 4
[in] length of key buffer
.RE
.PP
\fIin\fR
.RS 4
[in] plaintext data buffer
.RE
.PP
\fIinlen\fR
.RS 4
[in] length of in buffer
.RE
.PP
\fIctr\fR
.RS 4
[in] start counter value to be used for cipher operation
.RE
.PP
\fIout\fR
.RS 4
[out] ciphertext data buffer
.RE
.PP
\fIoutlen\fR
.RS 4
[in] length of out buffer
.RE
.SH "DESCRIPTION"
.PP
The convenience function performs an AES counter mode encryption operation using the provided key, the given input buffer and the given IV\&. The output is stored in the out buffer\&.
.PP
The input buffer can be of arbitrary length\&.
.PP
The output buffer must be at least as large as the input buffer\&.
.PP
The start counter can contain all zeros (not a NULL buffer!) and must be exactly 16 bytes in size\&.
.PP
The AES type (AES\-128, AES\-192 or AES\-256) is determined by the size of the given key\&. If the key is 16 bytes long, AES\-128 is used\&. A 24 byte key implies AES\-192 and a 32 byte key implies AES\-256\&.
.PP
\fIreturn\fR
number of bytes generated 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