xref: /aosp_15_r20/external/tink/go/keyderivation/internal/streamingprf/streaming_prf.go (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1// Copyright 2022 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
17// Package streamingprf provides implementations of streaming pseudorandom
18// function families.
19package streamingprf
20
21import (
22	"io"
23)
24
25// StreamingPRF is the interface used to represent a streaming pseudorandom
26// function family for a specified key.
27//
28// It has the same properties as the PRF primitive.
29type StreamingPRF interface {
30	// Compute computes the PRF selected by the specified key on input and returns
31	// the result via a reader.
32	Compute(input []byte) (io.Reader, error)
33}
34