Newer
Older
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
117
118
119
120
121
122
123
124
125
126
// 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.
//
////////////////////////////////////////////////////////////////////////////////
goog.module('tink.KeyManager');
const PbKeyData = goog.require('proto.google.crypto.tink.KeyData');
const PbMessage = goog.require('jspb.Message');
/**
* An auxiliary container for methods that generate new keys.
* Those methods are separate from KeyManager as their functionality is
* independent of the primitive of the corresponding KeyManager.
*
* @record
*/
class KeyFactory {
/**
* Generates a new random key according to 'keyFormat'.
*
* @param {!PbMessage|!Uint8Array} keyFormat is either a KeyFormat
* proto or a serialized KeyFormat proto
* @return {!PbMessage|!Promise<!PbMessage>} the new generated key
*/
newKey(keyFormat) {}
/**
* Generates a new random key based on the "serialized_key_format" and returns
* it as a KeyData proto.
*
* @param {!Uint8Array} serializedKeyFormat
* @return {!PbKeyData|!Promise<!PbKeyData>}
*/
newKeyData(serializedKeyFormat) {}
}
/**
* @record
* @extends {KeyFactory}
*/
class PrivateKeyFactory {
/**
* Returns a public key data extracted from the given serialized private key.
*
* @param {!Uint8Array} serializedPrivateKey
* @return {!PbKeyData}
*/
getPublicKeyData(serializedPrivateKey) {}
}
/**
* A KeyManager "understands" keys of a specific key type: it can generate keys
* of the 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 typeUrl-field of
* KeyData-protocol buffer.
*
* The template parameter P denotes the primitive corresponding to the keys
* handled by this manager.
*
* @template P
* @record
*/
class KeyManager {
/**
* Constructs an instance of primitive P for a given key.
*
* @param {!Object} primitiveType
* @param {!PbKeyData|!PbMessage} key is either a KeyData proto or a supported
* key proto
* @return {!Promise.<!P>}
*/
getPrimitive(primitiveType, key) {}
/**
* Returns true if this KeyManager supports keyType.
*
* @param {string} keyType
* @return {boolean}
*/
doesSupport(keyType) {}
/**
* Returns the URL which identifies the keys managed by this KeyManager.
*
* @return {string}
*/
getKeyType() {}
/**
* Returns the type of primitive which can be generated by this KeyManager.
*
* This function is specific for javascript to allow verifying that
* the primitive returned by getPrimitive function implements certain
* primitive interface (e.g. that the primitive is AEAD).
*
* @return {!Object}
*/
getPrimitiveType() {}
/**
* Returns the version of this KeyManager.
*
* @return {number}
*/
getVersion() {}
/**
* Returns a factory that generates keys of the key type handled by this
* manager.
*
* @return {!KeyFactory}
*/
getKeyFactory() {}
}
goog.exportSymbol('tink.KeyManager', KeyManager);
goog.exportSymbol('tink.KeyFactory', KeyFactory);
goog.exportSymbol('tink.PrivateKeyFactory', PrivateKeyFactory);