include/crypto/cipher.h

7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * You should have received a copy of the GNU Lesser General Public
35  * The QCryptoCipher object provides a way to perform encryption
36  * and decryption of data, with a standard API, regardless of the
37  * algorithm used. It further isolates the calling code from the
38  * details of the specific underlying implementation, whether
88  * @alg: the cipher algorithm
89  * @mode: the cipher mode
91  * Determine if @alg cipher algorithm in @mode is supported by the
94  * Returns: true if the algorithm is supported, false otherwise
101  * @alg: the cipher algorithm
103  * Get the required data block size in bytes. When
104  * encrypting data, it must be a multiple of the
107  * Returns: the block size in bytes
114  * @alg: the cipher algorithm
116  * Get the required key size in bytes.
118  * Returns: the key size in bytes
125  * @alg: the cipher algorithm
126  * @mode: the cipher mode
128  * Get the required initialization vector size
131  * Returns: the IV size in bytes, or 0 if no IV is permitted
139  * @alg: the cipher algorithm
140  * @mode: the cipher usage mode
141  * @key: the private key bytes
142  * @nkey: the length of @key
146  * data with the algorithm @alg in the usage mode @mode.
148  * The @key parameter provides the bytes representing
149  * the encryption/decryption key to use. The @nkey parameter
150  * specifies the length of @key in bytes. Each algorithm has
152  * a key of the incorrect length.
154  * The returned cipher object must be released with
166  * @cipher: the cipher object
168  * Release the memory associated with @cipher that
177  * @cipher: the cipher object
178  * @in: buffer holding the plain text input data
179  * @out: buffer to fill with the cipher text output data
180  * @len: the length of @in and @out buffers
183  * Encrypts the plain text stored in @in, filling
184  * @out with the resulting ciphered text. Both the
185  * @in and @out buffers must have the same size,
199  * @cipher: the cipher object
200  * @in: buffer holding the cipher text input data
201  * @out: buffer to fill with the plain text output data
202  * @len: the length of @in and @out buffers
205  * Decrypts the cipher text stored in @in, filling
206  * @out with the resulting plain text. Both the
207  * @in and @out buffers must have the same size,
220  * @cipher: the cipher object
221  * @iv: the initialization vector or counter (CTR mode) bytes
222  * @niv: the length of @iv
225  * If the @cipher object is setup to use a mode that requires
226  * initialization vectors or counter, this sets the @niv
227  * bytes. The @iv data should have the same length as the
228  * cipher key used when originally constructing the cipher
230  * or counter if the cipher mode does not require one.