← Back to branch summary

~ubuntu-branches/ubuntu/trusty/krb5/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/html/_sources/appdev/refs/api/krb5_c_encrypt_iov.txt

  • Committer: Package Import Robot
  • Author(s): Dmitrijs Ledkovs
  • Date: 2013-11-10 02:20:12 UTC
  • mfrom: (53.1.3 trusty-proposed)
  • Revision ID: package-import@ubuntu.com-20131110022012-b8ojkqhcxos55kln
Add alternate dependency on libverto-libevent1 as that's the package
ABI name in ubuntu.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/_sources/appdev/refs/api/krb5_c_encrypt_iov.txt
 
1
krb5_c_encrypt_iov -  Encrypt data in place supporting AEAD (operates on keyblock). 
 
2
====================================================================================
 
3
 
 
4
..
 
5
 
 
6
.. c:function:: krb5_error_code krb5_c_encrypt_iov(krb5_context context, const krb5_keyblock * keyblock, krb5_keyusage usage, const krb5_data * cipher_state, krb5_crypto_iov * data, size_t num_data)
 
7
 
 
8
..
 
9
 
 
10
 
 
11
:param:
 
12
 
 
13
                  **[in]** **context** - Library context
 
14
 
 
15
                  **[in]** **keyblock** - Encryption key
 
16
 
 
17
                  **[in]** **usage** - Key usage (see :data:`KRB5_KEYUSAGE` types)
 
18
 
 
19
                  **[in]** **cipher_state** - Cipher state; specify NULL if not needed
 
20
 
 
21
                  **[inout]** **data** - IOV array. Modified in-place.
 
22
 
 
23
                  **[in]** **num_data** - Size of *data*
 
24
 
 
25
 
 
26
..
 
27
 
 
28
 
 
29
:retval:
 
30
         -   0   Success; otherwise - Kerberos error codes
 
31
 
 
32
 
 
33
..
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
This function encrypts the data block *data* and stores the output in-place. The actual encryption 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 encryption 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.
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
 
50
 
 
51
 
 
52
..
 
53
 
 
54
.. seealso::
 
55
         :c:func:`krb5_c_decrypt_iov()` 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
.. note::
 
63
 
 
64
         On return from a :c:func:`krb5_c_encrypt_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.
 
65
 
 
66
         This function is similar to :c:func:`krb5_k_encrypt_iov()` , but operates on keyblock *keyblock* .
 
67
 
 
68
 
 
69
 
 
70