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
|
// 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 secretdata provides access-controlled structs to wrap sensitive
// data.
//
// This package is intended for use in APIs that return secret key material.
//
// This package and build restrictions on insecuresecretdataaccess may be used
// together to restrict access to secret key bytes.
package secretdata
import (
"bytes"
"crypto/rand"
"crypto/subtle"
"github.com/tink-crypto/tink-go/v2/insecuresecretdataaccess"
)
// Bytes is a wrapper around []byte that requires a secret key access token to
// access a copy of the data.
//
// This type ensures immutability of the wrapped bytes.
//
// This type and build restrictions on insecuresecretdataaccess may be used
// together to restrict access to secret key bytes.
type Bytes struct {
data []byte
}
// NewBytesFromRand returns a Bytes value wrapping size bytes of
// cryptographically strong random data.
func NewBytesFromRand(size uint32) (Bytes, error) {
b := Bytes{data: make([]byte, size)}
if _, err := rand.Read(b.data); err != nil {
return Bytes{}, err
}
return b, nil
}
// NewBytesFromData creates a new Bytes populated with data.
//
// This function makes a copy of the data. It requires an
// [insecuresecretdataaccess.Token] value.
func NewBytesFromData(data []byte, token insecuresecretdataaccess.Token) Bytes {
return Bytes{data: bytes.Clone(data)}
}
// Data returns a copy of the wrapped bytes.
//
// It requires an [insecuresecretdataaccess.Token] value to access the data.
func (b Bytes) Data(token insecuresecretdataaccess.Token) []byte { return bytes.Clone(b.data) }
// Len returns the size of the wrapped bytes.
func (b Bytes) Len() int { return len(b.data) }
// Equal returns true if the two Bytes objects are equal.
//
// The comparison is done in constant time. The time taken is a function of the
// length of the wrapped bytes and is independent of the contents. If the two
// wrapped slices are of different lengths, the function returns immediately.
func (b Bytes) Equal(other Bytes) bool {
return subtle.ConstantTimeCompare(b.data, other.data) == 1
}
|
