man7.org > Linux > man-pages

Linux/UNIX system programming training

gnutls_cipher_encrypt3(3) — Linux manual page

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURNS | SINCE | REPORTING BUGS | COPYRIGHT | SEE ALSO | COLOPHON 

gnutls_cipher_encrypt3(3)        gnutls        gnutls_cipher_encrypt3(3)

NAME         top

       gnutls_cipher_encrypt3 - API function

SYNOPSIS         top

       #include <gnutls/crypto.h>

       int gnutls_cipher_encrypt3(gnutls_cipher_hd_t handle, const void
       * ptext, size_t ptext_len, void * ctext, size_t * ctext_len,
       unsigned flags);

ARGUMENTS         top

       gnutls_cipher_hd_t handle
                   is a gnutls_cipher_hd_t type

       const void * ptext
                   the data to encrypt

       size_t ptext_len
                   the length of data to encrypt

       void * ctext
                   the encrypted data

       size_t * ctext_len
                   the length of encrypted data (initially must hold the
                   maximum available size)

       unsigned flags
                   flags for padding

DESCRIPTION         top

       This function will encrypt the given data using the algorithm
       specified by the context. For block ciphers,  ptext_len is
       typically a multiple of the block size. If not, the caller can
       instruct the function to pad the last block according to  flags .
       Currently, the only available padding scheme is
       GNUTLS_CIPHER_PADDING_PKCS7.

       If  ctext is not NULL, it must hold enough space to store
       resulting cipher text. To check the required size, this function
       can be called with  ctext set to NULL. Then  ctext_len will be
       updated without performing actual encryption.

RETURNS         top

       Zero or a negative error code on error.

SINCE         top

       3.7.7

REPORTING BUGS         top

       Report bugs to <bugs@gnutls.org>.
       Home page: https://www.gnutls.org

COPYRIGHT         top

       Copyright © 2001-2023 Free Software Foundation, Inc., and others.
       Copying and distribution of this file, with or without
       modification, are permitted in any medium without royalty
       provided the copyright notice and this notice are preserved.

SEE ALSO         top

       The full documentation for gnutls is maintained as a Texinfo
       manual.  If the /usr/share/doc/gnutls/ directory does not contain
       the HTML form visit

       https://www.gnutls.org/manual/

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at
       ⟨http://www.gnutls.org/⟩.  If you have a bug report for this
       manual page, send it to bugs@gnutls.org.  This page was obtained
       from the tarball gnutls-3.8.5.tar.xz fetched from
       ⟨http://www.gnutls.org/download.html⟩ on 2024-06-14.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

gnutls                            3.8.5        gnutls_cipher_encrypt3(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI