xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_c_make_checksum.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_c_make_checksum -  Compute a checksum (operates on keyblock).
2===================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_c_make_checksum(krb5_context context, krb5_cksumtype cksumtype, const krb5_keyblock * key, krb5_keyusage usage, const krb5_data * input, krb5_checksum * cksum)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **cksumtype** - Checksum type (0 for mandatory type)
16
17	          **[in]** **key** - Encryption key for a keyed checksum
18
19	          **[in]** **usage** - Key usage (see KRB5_KEYUSAGE macros)
20
21	          **[in]** **input** - Input data
22
23	          **[out]** **cksum** - Generated checksum
24
25
26..
27
28
29:retval:
30         -   0   Success; otherwise - Kerberos error codes
31
32
33..
34
35
36
37
38
39
40
41This function computes a checksum of type *cksumtype* over *input* , using *key* if the checksum type is a keyed checksum. If *cksumtype* is 0 and *key* is non-null, the checksum type will be the mandatory-to-implement checksum type for the key's encryption type. The actual checksum key will be derived from *key* and *usage* if key derivation is specified for the checksum type. The newly created *cksum* must be released by calling krb5_free_checksum_contents() when it is no longer needed.
42
43
44
45
46
47
48
49
50
51
52..
53
54.. seealso::
55         krb5_c_verify_checksum()
56
57
58
59
60
61
62.. note::
63
64	 This function is similar to krb5_k_make_checksum(), but operates on keyblock *key* .
65
66
67
68
69