blob: 62b99d9b7a20e8bdb1273b04f64900a8047ad817 [file] [log] [blame]
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
// Package insecurecleartextkeyset provides methods to read or write cleartext
// keyset material.
// This package contains dangerous functions, and is separate from the rest of
// Tink so that its usage can be restricted and audited.
package insecurecleartextkeyset
import (
tinkpb ""
var (
// KeysetHandle creates a keyset.Handle from cleartext key material.
KeysetHandle = internal.KeysetHandle.(func(*tinkpb.Keyset) *keyset.Handle)
// KeysetMaterial returns the key material contained in a keyset.Handle.
KeysetMaterial = internal.KeysetMaterial.(func(*keyset.Handle) *tinkpb.Keyset)
errInvalidKeyset = errors.New("insecurecleartextkeyset: invalid keyset")
errInvalidHandle = errors.New("insecurecleartextkeyset: invalid handle")
errInvalidReader = errors.New("insecurecleartextkeyset: invalid reader")
errInvalidWriter = errors.New("insecurecleartextkeyset: invalid writer")
// Read creates a keyset.Handle from a a cleartext keyset obtained via r.
func Read(r keyset.Reader) (*keyset.Handle, error) {
if r == nil {
return nil, errInvalidReader
ks, err := r.Read()
if err != nil || ks == nil || len(ks.Key) == 0 {
return nil, errInvalidKeyset
return KeysetHandle(ks), nil
// Write exports the keyset from h to the given writer w without encrypting it.
// Storing secret key material in an unencrypted fashion is dangerous. If
// feasible, you should use func keyset.Handle.Write() instead.
func Write(h *keyset.Handle, w keyset.Writer) error {
if h == nil {
return errInvalidHandle
if w == nil {
return errInvalidWriter
return w.Write(KeysetMaterial(h))