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
|
// Copyright 2024 Google LLC
//
// 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.
// Package key defines interfaces for Key and Parameters types.
package key
// Parameters represents key parameters.
type Parameters interface {
// HasIDRequirement tells whether the key has an ID requirement, that is, if a
// key generated with these parameters must have a given ID.
//
// In Tink, certain keys change their behavior depending on the key ID (e.g.,
// an AEAD object may add a prefix containing the big endian encoding of the
// key id to the ciphertext). In this case, such a key should require a unique
// id in key.IDRequirement() and return true.
HasIDRequirement() bool
// Equal compares this parameters object with other.
Equal(other Parameters) bool
}
// Key represents a Tink key.
//
// A Tink key is a cryptographic function, that is, it contains all the
// information necessary to perform cryptographic operations. Keys are meant to
// be grouped in keysets, from which primitives can be obtained.
type Key interface {
// Parameters returns the parameters of this key.
Parameters() Parameters
// IDRequirement returns required to indicate if this key requires an
// identifier. If it does, id will contain that identifier.
//
// An ID requirement is an identifier that may change the behavior of the
// function this key represents. If the key is in a keyset and
// the key has an ID requirement, this matches the keyset key ID.
//
// As an invariant, required will be true if and only if
// Parameters.HasIDRequirement(). If not required, the returned ID
// is zero and unusable.
IDRequirement() (idRequirement uint32, required bool)
// Equal compares this key object with other.
Equal(other Key) bool
}
|
