krb5_get_in_tkt(3)

1KRB5_GET_IN_TKT(3)       BSD Library Functions Manual       KRB5_GET_IN_TKT(3)
2

NAME

4     krb5_get_in_tkt, krb5_get_in_cred, krb5_get_in_tkt_with_password,
5     krb5_get_in_tkt_with_keytab, krb5_get_in_tkt_with_skey,
6     krb5_free_kdc_rep, krb5_password_key_proc — deprecated initial authenti‐
7     cation functions
8

LIBRARY

10     Kerberos 5 Library (libkrb5, -lkrb5)
11

SYNOPSIS

13     #include <krb5.h>
14
15     krb5_error_code
16     krb5_get_in_tkt(krb5_context context, krb5_flags options,
17         const krb5_addresses *addrs, const krb5_enctype *etypes,
18         const krb5_preauthtype *ptypes, krb5_key_proc key_proc,
19         krb5_const_pointer keyseed, krb5_decrypt_proc decrypt_proc,
20         krb5_const_pointer decryptarg, krb5_creds *creds, krb5_ccache ccache,
21         krb5_kdc_rep *ret_as_reply);
22
23     krb5_error_code
24     krb5_get_in_cred(krb5_context context, krb5_flags options,
25         const krb5_addresses *addrs, const krb5_enctype *etypes,
26         const krb5_preauthtype *ptypes, const krb5_preauthdata *preauth,
27         krb5_key_proc key_proc, krb5_const_pointer keyseed,
28         krb5_decrypt_proc decrypt_proc, krb5_const_pointer decryptarg,
29         krb5_creds *creds, krb5_kdc_rep *ret_as_reply);
30
31     krb5_error_code
32     krb5_get_in_tkt_with_password(krb5_context context, krb5_flags options,
33         krb5_addresses *addrs, const krb5_enctype *etypes,
34         const krb5_preauthtype *pre_auth_types, const char *password,
35         krb5_ccache ccache, krb5_creds *creds, krb5_kdc_rep *ret_as_reply);
36
37     krb5_error_code
38     krb5_get_in_tkt_with_keytab(krb5_context context, krb5_flags options,
39         krb5_addresses *addrs, const krb5_enctype *etypes,
40         const krb5_preauthtype *pre_auth_types, krb5_keytab keytab,
41         krb5_ccache ccache, krb5_creds *creds, krb5_kdc_rep *ret_as_reply);
42
43     krb5_error_code
44     krb5_get_in_tkt_with_skey(krb5_context context, krb5_flags options,
45         krb5_addresses *addrs, const krb5_enctype *etypes,
46         const krb5_preauthtype *pre_auth_types, const krb5_keyblock *key,
47         krb5_ccache ccache, krb5_creds *creds, krb5_kdc_rep *ret_as_reply);
48
49     krb5_error_code
50     krb5_free_kdc_rep(krb5_context context, krb5_kdc_rep *rep);
51
52     krb5_error_code
53     krb5_password_key_proc(krb5_context context, krb5_enctype type,
54         krb5_salt salt, krb5_const_pointer keyseed, krb5_keyblock **key);
55

DESCRIPTION

57     All the functions in this manual page are deprecated in the MIT implemen‐
58     tation, and will soon be deprecated in Heimdal too, don't use them.
59
60     Getting initial credential ticket for a principal.  krb5_get_in_cred is
61     the function all other krb5_get_in function uses to fetch tickets.  The
62     other krb5_get_in function are more specialized and therefor somewhat
63     easier to use.
64
65     If your need is only to verify a user and password, consider using
66     krb5_verify_user(3) instead, it have a much simpler interface.
67
68     krb5_get_in_tkt and krb5_get_in_cred fetches initial credential, queries
69     after key using the key_proc argument.  The differences between the two
70     function is that krb5_get_in_tkt stores the credential in a krb5_creds
71     while krb5_get_in_cred stores the credential in a krb5_ccache.
72
73     krb5_get_in_tkt_with_password, krb5_get_in_tkt_with_keytab, and
74     krb5_get_in_tkt_with_skey does the same work as krb5_get_in_cred but are
75     more specialized.
76
77     krb5_get_in_tkt_with_password uses the clients password to authenticate.
78     If the password argument is NULL the user user queried with the default
79     password query function.
80
81     krb5_get_in_tkt_with_keytab searches the given keytab for a service entry
82     for the client principal.  If the keytab is NULL the default keytab is
83     used.
84
85     krb5_get_in_tkt_with_skey uses a key to get the initial credential.
86
87     There are some common arguments to the krb5_get_in functions, these are:
88
89     options are the KDC_OPT flags.
90
91     etypes is a NULL terminated array of encryption types that the client
92     approves.
93
94     addrs a list of the addresses that the initial ticket.  If it is NULL the
95     list will be generated by the library.
96
97     pre_auth_types a NULL terminated array of pre-authentication types.  If
98     pre_auth_types is NULL the function will try without pre-authentication
99     and return those pre-authentication that the KDC returned.
100
101     ret_as_reply will (if not NULL) be filled in with the response of the KDC
102     and should be free with krb5_free_kdc_rep().
103
104     key_proc is a pointer to a function that should return a key salted
105     appropriately.  Using NULL will use the default password query function.
106
107     decrypt_proc Using NULL will use the default decryption function.
108
109     decryptarg will be passed to the decryption function decrypt_proc.
110
111     creds creds should be filled in with the template for a credential that
112     should be requested.  The client and server elements of the creds struc‐
113     ture must be filled in.  Upon return of the function it will be contain
114     the content of the requested credential (krb5_get_in_cred), or it will be
115     freed with krb5_free_creds(3) (all the other krb5_get_in functions).
116
117     ccache will store the credential in the credential cache ccache.  The
118     credential cache will not be initialized, thats up the the caller.
119
120     krb5_password_key_proc is a library function that is suitable using as
121     the krb5_key_proc argument to krb5_get_in_cred or krb5_get_in_tkt.
122     keyseed should be a pointer to a NUL terminated string or NULL.
123     krb5_password_key_proc will query the user for the pass on the console if
124     the password isn't given as the argument keyseed.
125
126     krb5_free_kdc_rep() frees the content of rep.
127

NAME

LIBRARY

SYNOPSIS

DESCRIPTION

SEE ALSO