MySQL 8.3.0
Source Code Documentation
keyring.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2016, 2023, Oracle and/or its affiliates.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License, version 2.0,
6 as published by the Free Software Foundation.
7
8 This program is also distributed with certain software (including
9 but not limited to OpenSSL) that is licensed under separate terms,
10 as designated in a particular file or component or in included license
11 documentation. The authors of MySQL hereby grant you an additional
12 permission to link the program and your derivative works with the
13 separately licensed software that they have included with MySQL.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23*/
24
25#ifndef MYSQL_HARNESS_KEYRING_INCLUDED
26#define MYSQL_HARNESS_KEYRING_INCLUDED
27
28#include <stdexcept>
29#include <string>
30#include "harness_export.h"
31
32namespace mysql_harness {
33
34/**
35 * Keyring interface.
36 *
37 * Keyrings are responsible for storage and retrieval of sensitive data
38 * (such as login credentials).
39 */
40class HARNESS_EXPORT Keyring {
41 public:
42 explicit Keyring() = default;
43 explicit Keyring(const Keyring &) = default;
44 Keyring &operator=(const Keyring &) = default;
45 virtual ~Keyring() = default;
46
47 /**
48 * Stores an attribute value in an entry.
49 *
50 * @param[in] uid Entry id.
51 * @param[in] attribute Attribute id.
52 * @param[in] value Attribute value.
53 */
54 virtual void store(const std::string &uid, const std::string &attribute,
55 const std::string &value) = 0;
56
57 /**
58 * Retrieves attribute value from an entry.
59 *
60 * @param[in] uid Entry id.
61 * @param[in] attribute Attribute id.
62 *
63 * @return Attribute value.
64 *
65 * @exception std::out_of_range Attribute not found.
66 */
67 virtual std::string fetch(const std::string &uid,
68 const std::string &attribute) const = 0;
69
70 /**
71 * Removes an entry.
72 *
73 * @param[in] uid Entry id.
74 *
75 * @returns success
76 * @retval true uid removed
77 * @retval false uid not removed
78 */
79 virtual bool remove(const std::string &uid) = 0;
80
81 /**
82 * Removes an attribute from an entry.
83 *
84 * @param[in] uid Entry id.
85 * @param[in] attribute Attribute id.
86 *
87 * @returns success
88 * @retval true uid removed
89 * @retval false uid not removed
90 */
91 virtual bool remove_attribute(const std::string &uid,
92 const std::string &attribute) = 0;
93};
94
95} // namespace mysql_harness
96
97#endif // MYSQL_HARNESS_KEYRING_INCLUDED
Keyring interface.
Definition: keyring.h:40
Keyring & operator=(const Keyring &)=default
virtual bool remove(const std::string &uid)=0
Removes an entry.
virtual ~Keyring()=default
Keyring(const Keyring &)=default
virtual std::string fetch(const std::string &uid, const std::string &attribute) const =0
Retrieves attribute value from an entry.
virtual void store(const std::string &uid, const std::string &attribute, const std::string &value)=0
Stores an attribute value in an entry.
virtual bool remove_attribute(const std::string &uid, const std::string &attribute)=0
Removes an attribute from an entry.
Definition: common.h:41