1
- /* Copyright (c) 2020, 2021 , Oracle and/or its affiliates.
1
+ /* Copyright (c) 2020, 2022 , Oracle and/or its affiliates.
2
2
3
3
This program is free software; you can redistribute it and/or modify
4
4
it under the terms of the GNU General Public License, version 2.0,
46
46
with one name that is considered canonical
47
47
48
48
Credential cache:
49
- A credential cache (or “ccache”) holds Kerberos credentials while they remain
50
- valid and, generally, while the user’s session lasts, so that authenticating
51
- to a service multiple times (e.g., connecting to a web or mail server more
52
- than once) doesn’t require contacting the KDC every time.
49
+ A credential cache (or “ccache”) holds Kerberos credentials while they
50
+ remain valid and, generally, while the user’s session lasts, so that
51
+ authenticating to a service multiple times (e.g., connecting to a web or mail
52
+ server more than once) doesn’t require contacting the KDC every time.
53
53
*/
54
54
namespace auth_ldap_client_kerberos_context {
55
55
class Kerberos {
@@ -63,19 +63,17 @@ class Kerberos {
63
63
3. If user credentials already exist in the cache, it doesn't attempt to get
64
64
it again.
65
65
66
- @return
67
- @retval true Successfully able to obtain and store credentials.
68
- @retval false Failed to obtain and store credentials.
66
+ @retval true Successfully able to obtain and store credentials.
67
+ @retval false Failed to obtain and store credentials.
69
68
*/
70
69
bool obtain_store_credentials ();
71
70
/* *
72
71
This function retrieves default principle from kerberos configuration and
73
72
parses the user name from it. If user name has not been provided in the
74
73
MySQL client, This method can be used to get the user name and use for
75
74
authentication.
76
- @return
77
- @retval true Successfully able to get user name.
78
- @retval false Failed to get user name.
75
+ @retval true Successfully able to get user name.
76
+ @retval false Failed to get user name.
79
77
*/
80
78
bool get_user_name (std::string *name);
81
79
void destroy_credentials ();
@@ -88,10 +86,9 @@ class Kerberos {
88
86
/* *
89
87
This function creates kerberos context, initializes credentials cache and
90
88
user principal.
91
- @return
92
- @retval true All the required kerberos objects like context,
89
+ @retval true All the required kerberos objects like context,
93
90
credentials cache and user principal are initialized correctly.
94
- @retval false Required kerberos objects failed to initialized.
91
+ @retval false Required kerberos objects failed to initialized.
95
92
*/
96
93
bool setup ();
97
94
/* *
0 commit comments