xref: /aosp_15_r20/external/tink/go/keyset/reader.go (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1// Copyright 2019 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//      http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15////////////////////////////////////////////////////////////////////////////////
16
17package keyset
18
19import tinkpb "github.com/google/tink/go/proto/tink_go_proto"
20
21// Reader knows how to read a Keyset or an EncryptedKeyset from some source.
22// In order to turn a Reader into a KeysetHandle for use, callers must use
23// insecure.KeysetHandle or by keyset.Read (with encryption).
24type Reader interface {
25	// Read returns a (cleartext) Keyset object from the underlying source.
26	Read() (*tinkpb.Keyset, error)
27
28	// ReadEncrypted returns an EncryptedKeyset object from the underlying source.
29	ReadEncrypted() (*tinkpb.EncryptedKeyset, error)
30}
31