MySQL 8.4.0
Source Code Documentation
mysql_keyring_native_key_id.h
Go to the documentation of this file.
1/* Copyright (c) 2018, 2024, Oracle and/or its affiliates.
2
3This program is free software; you can redistribute it and/or modify
4it under the terms of the GNU General Public License, version 2.0,
5as published by the Free Software Foundation.
6
7This program is designed to work with certain software (including
8but not limited to OpenSSL) that is licensed under separate terms,
9as designated in a particular file or component or in included license
10documentation. The authors of MySQL hereby grant you an additional
11permission to link the program and your derivative works with the
12separately licensed software that they have either included with
13the program or referenced in the documentation.
14
15This program is distributed in the hope that it will be useful,
16but WITHOUT ANY WARRANTY; without even the implied warranty of
17MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18GNU General Public License, version 2.0, for more details.
19
20You should have received a copy of the GNU General Public License
21along with this program; if not, write to the Free Software
22Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef MYSQL_KEYRING_NATIVE_KEY_ID_H
25#define MYSQL_KEYRING_NATIVE_KEY_ID_H
26
27/**
28 @file
29 implementation for mysql_keyring_native_key_id service
30 */
31
33
34/**
35 @ingroup group_components_services_inventory
36
37 A service to read native keybackend id
38
39 Typically there'll be just one implementation of this by the main
40 application.
41*/
42BEGIN_SERVICE_DEFINITION(mysql_keyring_native_key_id)
43/**
44 Read a backend key id
45
46 @param key_id the mysql key id
47 @param user_id the mysql user id
48 @param out backend_key_id a buffer to store the backend key id in
49 @param inout key_len: on input the size of the buffer in backend_key_id, on
50 output: the number of chars returned in the buffer
51 @return Status of performed operation
52 @retval false success (valid password)
53 @retval true failure (invalid password)
54
55 @sa my_host_application_signal
56*/
57DECLARE_BOOL_METHOD(get_backend_key_id,
58 (const char *key_id, const char *user_id,
59 char *backend_key_id, size_t max_key_len));
60
61END_SERVICE_DEFINITION(mysql_keyring_native_key_id)
62
63#endif /* MYSQL_KEYRING_NATIVE_KEY_ID_H */
#define END_SERVICE_DEFINITION(name)
A macro to end the last Service definition started with the BEGIN_SERVICE_DEFINITION macro.
Definition: service.h:91
#define BEGIN_SERVICE_DEFINITION(name)
Declares a new Service.
Definition: service.h:86
#define DECLARE_BOOL_METHOD(name, args)
Declares a method that returns bool as a part of the Service definition.
Definition: service.h:112