xref: /aosp_15_r20/external/tink/go/keyset/json_io.go (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang// Copyright 2019 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 (
20*e7b1675dSTing-Kang Chang	"io"
21*e7b1675dSTing-Kang Chang
22*e7b1675dSTing-Kang Chang	"google.golang.org/protobuf/encoding/protojson"
23*e7b1675dSTing-Kang Chang	"google.golang.org/protobuf/proto"
24*e7b1675dSTing-Kang Chang
25*e7b1675dSTing-Kang Chang	tinkpb "github.com/google/tink/go/proto/tink_go_proto"
26*e7b1675dSTing-Kang Chang)
27*e7b1675dSTing-Kang Chang
28*e7b1675dSTing-Kang Chang// JSONReader deserializes a keyset from json format.
29*e7b1675dSTing-Kang Changtype JSONReader struct {
30*e7b1675dSTing-Kang Chang	r io.Reader
31*e7b1675dSTing-Kang Chang	j *protojson.UnmarshalOptions
32*e7b1675dSTing-Kang Chang}
33*e7b1675dSTing-Kang Chang
34*e7b1675dSTing-Kang Chang// NewJSONReader returns new JSONReader that will read from r.
35*e7b1675dSTing-Kang Changfunc NewJSONReader(r io.Reader) *JSONReader {
36*e7b1675dSTing-Kang Chang	return &JSONReader{
37*e7b1675dSTing-Kang Chang		r: r,
38*e7b1675dSTing-Kang Chang		j: &protojson.UnmarshalOptions{},
39*e7b1675dSTing-Kang Chang	}
40*e7b1675dSTing-Kang Chang}
41*e7b1675dSTing-Kang Chang
42*e7b1675dSTing-Kang Chang// Read parses a (cleartext) keyset from the underlying io.Reader.
43*e7b1675dSTing-Kang Changfunc (bkr *JSONReader) Read() (*tinkpb.Keyset, error) {
44*e7b1675dSTing-Kang Chang	keyset := &tinkpb.Keyset{}
45*e7b1675dSTing-Kang Chang
46*e7b1675dSTing-Kang Chang	if err := bkr.readJSON(bkr.r, keyset); err != nil {
47*e7b1675dSTing-Kang Chang		return nil, err
48*e7b1675dSTing-Kang Chang	}
49*e7b1675dSTing-Kang Chang	return keyset, nil
50*e7b1675dSTing-Kang Chang}
51*e7b1675dSTing-Kang Chang
52*e7b1675dSTing-Kang Chang// ReadEncrypted parses an EncryptedKeyset from the underlying io.Reader.
53*e7b1675dSTing-Kang Changfunc (bkr *JSONReader) ReadEncrypted() (*tinkpb.EncryptedKeyset, error) {
54*e7b1675dSTing-Kang Chang	keyset := &tinkpb.EncryptedKeyset{}
55*e7b1675dSTing-Kang Chang
56*e7b1675dSTing-Kang Chang	if err := bkr.readJSON(bkr.r, keyset); err != nil {
57*e7b1675dSTing-Kang Chang		return nil, err
58*e7b1675dSTing-Kang Chang	}
59*e7b1675dSTing-Kang Chang	return keyset, nil
60*e7b1675dSTing-Kang Chang}
61*e7b1675dSTing-Kang Chang
62*e7b1675dSTing-Kang Changfunc (bkr *JSONReader) readJSON(r io.Reader, msg proto.Message) error {
63*e7b1675dSTing-Kang Chang	b, err := io.ReadAll(r)
64*e7b1675dSTing-Kang Chang	if err != nil {
65*e7b1675dSTing-Kang Chang		return err
66*e7b1675dSTing-Kang Chang	}
67*e7b1675dSTing-Kang Chang	return bkr.j.Unmarshal(b, msg)
68*e7b1675dSTing-Kang Chang}
69*e7b1675dSTing-Kang Chang
70*e7b1675dSTing-Kang Chang// JSONWriter serializes a keyset into json format.
71*e7b1675dSTing-Kang Changtype JSONWriter struct {
72*e7b1675dSTing-Kang Chang	w io.Writer
73*e7b1675dSTing-Kang Chang	j *protojson.MarshalOptions
74*e7b1675dSTing-Kang Chang}
75*e7b1675dSTing-Kang Chang
76*e7b1675dSTing-Kang Chang// NewJSONWriter returns a new JSONWriter that will write to w.
77*e7b1675dSTing-Kang Changfunc NewJSONWriter(w io.Writer) *JSONWriter {
78*e7b1675dSTing-Kang Chang	return &JSONWriter{
79*e7b1675dSTing-Kang Chang		w: w,
80*e7b1675dSTing-Kang Chang		j: &protojson.MarshalOptions{
81*e7b1675dSTing-Kang Chang			EmitUnpopulated: true,
82*e7b1675dSTing-Kang Chang			Indent:          "",
83*e7b1675dSTing-Kang Chang		},
84*e7b1675dSTing-Kang Chang	}
85*e7b1675dSTing-Kang Chang}
86*e7b1675dSTing-Kang Chang
87*e7b1675dSTing-Kang Chang// Write writes the keyset to the underlying io.Writer.
88*e7b1675dSTing-Kang Changfunc (bkw *JSONWriter) Write(keyset *tinkpb.Keyset) error {
89*e7b1675dSTing-Kang Chang	return bkw.writeJSON(bkw.w, keyset)
90*e7b1675dSTing-Kang Chang}
91*e7b1675dSTing-Kang Chang
92*e7b1675dSTing-Kang Chang// WriteEncrypted writes the encrypted keyset to the underlying io.Writer.
93*e7b1675dSTing-Kang Changfunc (bkw *JSONWriter) WriteEncrypted(keyset *tinkpb.EncryptedKeyset) error {
94*e7b1675dSTing-Kang Chang	return bkw.writeJSON(bkw.w, keyset)
95*e7b1675dSTing-Kang Chang}
96*e7b1675dSTing-Kang Chang
97*e7b1675dSTing-Kang Changfunc (bkw *JSONWriter) writeJSON(w io.Writer, msg proto.Message) error {
98*e7b1675dSTing-Kang Chang	b, err := bkw.j.Marshal(msg)
99*e7b1675dSTing-Kang Chang	if err != nil {
100*e7b1675dSTing-Kang Chang		return err
101*e7b1675dSTing-Kang Chang	}
102*e7b1675dSTing-Kang Chang	_, err = w.Write(b)
103*e7b1675dSTing-Kang Chang	return err
104*e7b1675dSTing-Kang Chang}
105