xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_c_string_to_key.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_c_string_to_key -  Convert a string (such a password) to a key.
2=====================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_c_string_to_key(krb5_context context, krb5_enctype enctype, const krb5_data * string, const krb5_data * salt, krb5_keyblock * key)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **enctype** - Encryption type
16
17	          **[in]** **string** - String to be converted
18
19	          **[in]** **salt** - Salt value
20
21	          **[out]** **key** - Generated key
22
23
24..
25
26
27:retval:
28         -   0   Success; otherwise - Kerberos error codes
29
30
31..
32
33
34
35
36
37
38
39This function converts *string* to a *key* of encryption type *enctype* , using the specified *salt* . The newly created *key* must be released by calling krb5_free_keyblock_contents() when it is no longer needed.
40
41
42
43
44
45
46
47
48
49
50..
51
52
53
54
55
56