xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_kt_read_service_key.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_kt_read_service_key -  Retrieve a service key from a key table.
2=====================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_kt_read_service_key(krb5_context context, krb5_pointer keyprocarg, krb5_principal principal, krb5_kvno vno, krb5_enctype enctype, krb5_keyblock ** key)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **keyprocarg** - Name of a key table (NULL to use default name)
16
17	          **[in]** **principal** - Service principal
18
19	          **[in]** **vno** - Key version number (0 for highest available)
20
21	          **[in]** **enctype** - Encryption type (0 for any type)
22
23	          **[out]** **key** - Service key from key table
24
25
26..
27
28
29:retval:
30         -   0   Success
31
32
33:return:
34         -  Kerberos error code if not found or keyprocarg is invalid.
35
36..
37
38
39
40
41
42
43
44Open and search the specified key table for the entry identified by *principal* , *enctype* , and *vno* . If no key is found, return an error code.
45
46
47
48The default key table is used, unless *keyprocarg* is non-null. *keyprocarg* designates a specific key table.
49
50
51
52Use krb5_free_keyblock() to free *key* when it is no longer needed.
53
54
55
56
57
58
59
60
61
62
63..
64
65
66
67
68
69