MySQL 8.0.31
Source Code Documentation
mysql_keyring_native_key_id.h
Go to the documentation of this file.
1/* Copyright (c) 2018, 2022, 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 also distributed 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 included with MySQL.
13
14This program is distributed in the hope that it will be useful,
15but WITHOUT ANY WARRANTY; without even the implied warranty of
16MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17GNU General Public License, version 2.0, for more details.
18
19You should have received a copy of the GNU General Public License
20along with this program; if not, write to the Free Software
21Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22
23#ifndef MYSQL_KEYRING_NATIVE_KEY_ID_H
24#define MYSQL_KEYRING_NATIVE_KEY_ID_H
25
26/**
27 @file
28 implementation for mysql_keyring_native_key_id service
29 */
30
32
33/**
34 @ingroup group_components_services_inventory
35
36 A service to read native keybackend id
37
38 Typically there'll be just one implementation of this by the main
39 application.
40*/
41BEGIN_SERVICE_DEFINITION(mysql_keyring_native_key_id)
42/**
43 Read a backend key id
44
45 @param key_id the mysql key id
46 @param user_id the mysql user id
47 @param out backend_key_id a buffer to store the backend key id in
48 @param inout key_len: on input the size of the buffer in backend_key_id, on
49 output: the number of chars returned in the buffer
50 @return Status of performed operation
51 @retval false success (valid password)
52 @retval true failure (invalid password)
53
54 @sa my_host_application_signal
55*/
56DECLARE_BOOL_METHOD(get_backend_key_id,
57 (const char *key_id, const char *user_id,
58 char *backend_key_id, size_t max_key_len));
59
60END_SERVICE_DEFINITION(mysql_keyring_native_key_id)
61
62#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:90
#define BEGIN_SERVICE_DEFINITION(name)
Declares a new Service.
Definition: service.h:85
#define DECLARE_BOOL_METHOD(name, args)
Declares a method that returns bool as a part of the Service definition.
Definition: service.h:111