blob: 58d27448182e4e570c7f248f262bcd3b5ffeb9ea (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
// Copyright 2017 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
///////////////////////////////////////////////////////////////////////////////
#ifndef TINK_KEY_MANAGER_H_
#define TINK_KEY_MANAGER_H_
#include <memory>
#include <string>
#include "absl/memory/memory.h"
#include "absl/strings/str_cat.h"
#include "tink/util/errors.h"
#include "tink/util/protobuf_helper.h"
#include "tink/util/status.h"
#include "tink/util/statusor.h"
#include "proto/tink.pb.h"
namespace crypto {
namespace tink {
// Auxiliary containers for methods that generate or extract key material.
// These methods are grouped separately, as their functionality
// is independent of the primitive of the corresponding KeyManager.
class KeyFactory {
public:
// Helper function which creates a factory which always fails with a specified
// status.
static std::unique_ptr<KeyFactory> AlwaysFailingFactory(
const crypto::tink::util::Status& status);
// Generates a new random key, based on the specified 'key_format'.
virtual crypto::tink::util::StatusOr<
std::unique_ptr<portable_proto::MessageLite>>
NewKey(const portable_proto::MessageLite& key_format) const = 0;
// Generates a new random key, based on the specified 'serialized_key_format'.
virtual crypto::tink::util::StatusOr<
std::unique_ptr<portable_proto::MessageLite>>
NewKey(absl::string_view serialized_key_format) const = 0;
// Generates a new random key, based on the specified 'serialized_key_format',
// and wraps it in a KeyData-proto.
virtual crypto::tink::util::StatusOr<
std::unique_ptr<google::crypto::tink::KeyData>>
NewKeyData(absl::string_view serialized_key_format) const = 0;
virtual ~KeyFactory() = default;
};
class PrivateKeyFactory : public virtual KeyFactory {
public:
// Returns public key data extracted from the given serialized_private_key.
virtual crypto::tink::util::StatusOr<
std::unique_ptr<google::crypto::tink::KeyData>>
GetPublicKeyData(absl::string_view serialized_private_key) const = 0;
~PrivateKeyFactory() override = default;
};
/**
* KeyManager "understands" keys of a specific key types: it can
* generate keys of a supported type and create primitives for
* supported keys. A key type is identified by the global name of the
* protocol buffer that holds the corresponding key material, and is
* given by type_url-field of KeyData-protocol buffer.
*
* - P: the primitive implemented by keys understood by this manager
*/
class KeyManagerBase {
public:
// Returns the type_url identifying the key type handled by this manager.
virtual const std::string& get_key_type() const = 0;
// Returns the version of this key manager.
virtual uint32_t get_version() const = 0;
// Returns a factory that generates keys of the key type
// handled by this manager.
virtual const KeyFactory& get_key_factory() const = 0;
bool DoesSupport(absl::string_view key_type) const {
return (key_type == get_key_type());
}
virtual ~KeyManagerBase() = default;
};
template <class P>
class KeyManager : public KeyManagerBase {
public:
// Constructs an instance of P for the given 'key_data'.
virtual crypto::tink::util::StatusOr<std::unique_ptr<P>> GetPrimitive(
const google::crypto::tink::KeyData& key_data) const = 0;
// Constructs an instance of P for the given 'key'.
virtual crypto::tink::util::StatusOr<std::unique_ptr<P>> GetPrimitive(
const portable_proto::MessageLite& key) const = 0;
};
} // namespace tink
} // namespace crypto
#endif // TINK_KEY_MANAGER_H_
|
