Blame doc/html/_sources/appdev/refs/api/krb5_k_decrypt_iov.rst.txt

Packit fd8b60
krb5_k_decrypt_iov -  Decrypt data in place supporting AEAD (operates on opaque key). 
Packit fd8b60
======================================================================================
Packit fd8b60
Packit fd8b60
..
Packit fd8b60
Packit fd8b60
.. c:function:: krb5_error_code krb5_k_decrypt_iov(krb5_context context, krb5_key key, krb5_keyusage usage, const krb5_data * cipher_state, krb5_crypto_iov * data, size_t num_data)
Packit fd8b60
Packit fd8b60
..
Packit fd8b60
Packit fd8b60
Packit fd8b60
:param:
Packit fd8b60
Packit fd8b60
	          **[in]** **context** - Library context
Packit fd8b60
Packit fd8b60
	          **[in]** **key** - Encryption key
Packit fd8b60
Packit fd8b60
	          **[in]** **usage** - Key usage (see :data:`KRB5_KEYUSAGE` types)
Packit fd8b60
Packit fd8b60
	          **[in]** **cipher_state** - Cipher state; specify NULL if not needed
Packit fd8b60
Packit fd8b60
	          **[inout]** **data** - IOV array. Modified in-place.
Packit fd8b60
Packit fd8b60
	          **[in]** **num_data** - Size of *data*
Packit fd8b60
Packit fd8b60
Packit fd8b60
..
Packit fd8b60
Packit fd8b60
Packit fd8b60
:retval:
Packit fd8b60
         -   0   Success; otherwise - Kerberos error codes
Packit fd8b60
Packit fd8b60
Packit fd8b60
..
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
This function decrypts the data block *data* and stores the output in-place. The actual decryption key will be derived from *key* and *usage* if key derivation is specified for the encryption type. If non-null, *cipher_state* specifies the beginning state for the decryption operation, and is updated with the state to be passed as input to the next operation. The caller must allocate the right number of krb5_crypto_iov structures before calling into this API.
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
..
Packit fd8b60
Packit fd8b60
.. seealso::
Packit fd8b60
         :c:func:`krb5_k_encrypt_iov()` 
Packit fd8b60
 
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
Packit fd8b60
.. note::
Packit fd8b60
Packit fd8b60
	 On return from a :c:func:`krb5_c_decrypt_iov()` call, the *data->length* in the iov structure are adjusted to reflect actual lengths of the ciphertext used. For example, if the padding length is too large, the length will be reduced. Lengths are never increased.
Packit fd8b60
 
Packit fd8b60
Packit fd8b60
Packit fd8b60