xref: /aosp_15_r20/external/tink/go/keyset/option.go (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang// Copyright 2022 Google LLC
2*e7b1675dSTing-Kang Chang//
3*e7b1675dSTing-Kang Chang// Licensed under the Apache License, Version 2.0 (the "License");
4*e7b1675dSTing-Kang Chang// you may not use this file except in compliance with the License.
5*e7b1675dSTing-Kang Chang// You may obtain a copy of the License at
6*e7b1675dSTing-Kang Chang//
7*e7b1675dSTing-Kang Chang//      http://www.apache.org/licenses/LICENSE-2.0
8*e7b1675dSTing-Kang Chang//
9*e7b1675dSTing-Kang Chang// Unless required by applicable law or agreed to in writing, software
10*e7b1675dSTing-Kang Chang// distributed under the License is distributed on an "AS IS" BASIS,
11*e7b1675dSTing-Kang Chang// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*e7b1675dSTing-Kang Chang// See the License for the specific language governing permissions and
13*e7b1675dSTing-Kang Chang// limitations under the License.
14*e7b1675dSTing-Kang Chang//
15*e7b1675dSTing-Kang Chang////////////////////////////////////////////////////////////////////////////////
16*e7b1675dSTing-Kang Chang
17*e7b1675dSTing-Kang Changpackage keyset
18*e7b1675dSTing-Kang Chang
19*e7b1675dSTing-Kang Changimport "fmt"
20*e7b1675dSTing-Kang Chang
21*e7b1675dSTing-Kang Chang// Option is used to pass options for a keyset handle.
22*e7b1675dSTing-Kang Changtype Option interface {
23*e7b1675dSTing-Kang Chang	set(k *Handle) error
24*e7b1675dSTing-Kang Chang}
25*e7b1675dSTing-Kang Chang
26*e7b1675dSTing-Kang Changtype option func(*Handle) error
27*e7b1675dSTing-Kang Chang
28*e7b1675dSTing-Kang Changfunc (o option) set(h *Handle) error { return o(h) }
29*e7b1675dSTing-Kang Chang
30*e7b1675dSTing-Kang Chang// WithAnnotations adds monitoring annotations to a keyset handle.
31*e7b1675dSTing-Kang Changfunc WithAnnotations(annotations map[string]string) Option {
32*e7b1675dSTing-Kang Chang	return option(func(h *Handle) error {
33*e7b1675dSTing-Kang Chang		if h.annotations != nil {
34*e7b1675dSTing-Kang Chang			return fmt.Errorf("keyset already contains annotations")
35*e7b1675dSTing-Kang Chang		}
36*e7b1675dSTing-Kang Chang		h.annotations = annotations
37*e7b1675dSTing-Kang Chang		return nil
38*e7b1675dSTing-Kang Chang	})
39*e7b1675dSTing-Kang Chang}
40*e7b1675dSTing-Kang Chang
41*e7b1675dSTing-Kang Changfunc applyOptions(h *Handle, opts ...Option) error {
42*e7b1675dSTing-Kang Chang	for _, opt := range opts {
43*e7b1675dSTing-Kang Chang		if err := opt.set(h); err != nil {
44*e7b1675dSTing-Kang Chang			return err
45*e7b1675dSTing-Kang Chang		}
46*e7b1675dSTing-Kang Chang	}
47*e7b1675dSTing-Kang Chang	return nil
48*e7b1675dSTing-Kang Chang}
49