aboutsummaryrefslogtreecommitdiff
path: root/doc/html/_sources/appdev/refs/api/krb5_c_decrypt_iov.txt
blob: 2dc3f1061c2b09ef2a84d63df0ffef32d8dd4268 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
krb5_c_decrypt_iov -  Decrypt data in place supporting AEAD (operates on keyblock). 
====================================================================================

..

.. c:function:: krb5_error_code krb5_c_decrypt_iov(krb5_context context, const krb5_keyblock * keyblock, krb5_keyusage usage, const krb5_data * cipher_state, krb5_crypto_iov * data, size_t num_data)

..


:param:

	          **[in]** **context** - Library context

	          **[in]** **keyblock** - Encryption key

	          **[in]** **usage** - Key usage (see :data:`KRB5_KEYUSAGE` types)

	          **[in]** **cipher_state** - Cipher state; specify NULL if not needed

	          **[inout]** **data** - IOV array. Modified in-place.

	          **[in]** **num_data** - Size of *data*


..


:retval:
         -   0   Success; otherwise - Kerberos error codes


..







This function decrypts the data block *data* and stores the output in-place. The actual decryption key will be derived from *keyblock* 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.










..

.. seealso::
         :c:func:`krb5_c_decrypt_iov()` 
 





.. note::

	 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.

	 This function is similar to :c:func:`krb5_k_decrypt_iov()` , but operates on keyblock *keyblock* .