plugins: rename decoder -> handler

Give the diverse nature functionality implemented by the pluggable
interfaces (especially on the evidence side), the term "decoder" is too
specific. Use the more broad "handler" instead.

Signed-off-by: Sergei Trofimov <[email protected]>

Author: setrofim

Makefile

@@ -5,7 +5,7 @@ export TOPDIR := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
 
 SUBDIR += builtin
 SUBDIR += config
-SUBDIR += decoder
+SUBDIR += handler
 SUBDIR += kvstore
 SUBDIR += log
 SUBDIR += plugin

builtin/schemes.gen.go

@@ -10,11 +10,11 @@ import (
 )
 
 var plugins = []plugin.IPluggable{
-	&scheme1.EvidenceDecoder{},
-	&scheme1.EndorsementDecoder{},
-	&scheme2.EvidenceDecoder{},
-	&scheme3.EvidenceDecoder{},
-	&scheme3.EndorsementDecoder{},
-	&scheme4.EvidenceDecoder{},
-	&scheme4.EndorsementDecoder{},
+	&scheme1.EvidenceHandler{},
+	&scheme1.EndorsementHandler{},
+	&scheme2.EvidenceHandler{},
+	&scheme3.EvidenceHandler{},
+	&scheme3.EndorsementHandler{},
+	&scheme4.EvidenceHandler{},
+	&scheme4.EndorsementHandler{},
 }

decoder/README.md

@@ -0,0 +1,6 @@
+This package defines [`IEvidinceHandler`](ievidecehandler.go) and
+[`IEndorsementHandler`](iendorsementhandler.go) [pluggable](../plugin/README.md)
+interfaces and associated RPC channels. These are used to add new attestation
+scheme sort to Veraison services. Additionally, the package defines a [couple
+of wrappers](plugin.go) around `plugin.RegisterImplementation` for registering
+implementations of these two interfaces.

decoder/iendorsementdecoder.go

@@ -1,11 +1,11 @@
 syntax = "proto3";
-package endorsement_decoder_response;
+package endorsement_handler_response;
 
-option go_package = "github.com/veraison/services/decoder";
+option go_package = "github.com/veraison/services/handler";
 
 import "vts.proto";
 
-message EndorsementDecoderResponse {
+message EndorsementHandlerResponse {
     repeated proto.Endorsement referenceValues = 1;
     repeated proto.Endorsement trustAnchors = 2;
 }

decoder/plugin.go

@@ -1,6 +1,6 @@
 // Copyright 2022-2023 Contributors to the Veraison project.
 // SPDX-License-Identifier: Apache-2.0
-package decoder
+package handler
 
 import (
 	"fmt"
@@ -16,7 +16,7 @@ import (
   (plugin-side)
 */
 
-var EndorsementDecoderRPC = &plugin.RPCChannel[IEndorsementDecoder]{
+var EndorsementHandlerRPC = &plugin.RPCChannel[IEndorsementHandler]{
 	GetClient: getEndorsementClient,
 	GetServer: geEndorsementtServer,
 }
@@ -25,15 +25,15 @@ func getEndorsementClient(c *rpc.Client) interface{} {
 	return &EndorsementRPCClient{client: c}
 }
 
-func geEndorsementtServer(i IEndorsementDecoder) interface{} {
+func geEndorsementtServer(i IEndorsementHandler) interface{} {
 	return &EndorsementRPCServer{Impl: i}
 }
 
 type EndorsementRPCServer struct {
-	Impl IEndorsementDecoder
+	Impl IEndorsementHandler
 }
 
-func (s *EndorsementRPCServer) Init(params EndorsementDecoderParams, unused interface{}) error {
+func (s *EndorsementRPCServer) Init(params EndorsementHandlerParams, unused interface{}) error {
 	return s.Impl.Init(params)
 }
 
@@ -79,7 +79,7 @@ type EndorsementRPCClient struct {
 	client *rpc.Client
 }
 
-func (c EndorsementRPCClient) Init(params EndorsementDecoderParams) error {
+func (c EndorsementRPCClient) Init(params EndorsementHandlerParams) error {
 	var unused interface{}
 
 	return c.client.Call("Plugin.Init", params, &unused)
@@ -139,10 +139,10 @@ func (c EndorsementRPCClient) GetSupportedMediaTypes() []string {
 	return resp
 }
 
-func (c EndorsementRPCClient) Decode(data []byte) (*EndorsementDecoderResponse, error) {
+func (c EndorsementRPCClient) Decode(data []byte) (*EndorsementHandlerResponse, error) {
 	var (
 		err  error
-		resp EndorsementDecoderResponse
+		resp EndorsementHandlerResponse
 		j    []byte
 	)
 

decoder/Makefile handler/Makefile

@@ -1,6 +1,6 @@
 // Copyright 2022-2023 Contributors to the Veraison project.
 // SPDX-License-Identifier: Apache-2.0
-package decoder
+package handler
 
 import (
 	"encoding/json"
@@ -13,7 +13,7 @@ import (
 	"github.com/veraison/services/proto"
 )
 
-var EvidenceDecoderRPC = &plugin.RPCChannel[IEvidenceDecoder]{
+var EvidenceHandlerRPC = &plugin.RPCChannel[IEvidenceHandler]{
 	GetClient: getClient,
 	GetServer: getServer,
 }
@@ -22,12 +22,12 @@ func getClient(c *rpc.Client) interface{} {
 	return &RPCClient{client: c}
 }
 
-func getServer(i IEvidenceDecoder) interface{} {
+func getServer(i IEvidenceHandler) interface{} {
 	return &RPCServer{Impl: i}
 }
 
 type RPCServer struct {
-	Impl IEvidenceDecoder
+	Impl IEvidenceHandler
 }
 
 func (s *RPCServer) GetName(args interface{}, resp *string) error {

handler/README.md

@@ -1,13 +1,13 @@
 // Copyright 2022-2023 Contributors to the Veraison project.
 // SPDX-License-Identifier: Apache-2.0
-package decoder
+package handler
 
 import "go.uber.org/zap"
 
 type IDecoderManager interface {
 	Init(dir string, logger *zap.SugaredLogger) error
 	Close() error
-	Dispatch(mediaType string, data []byte) (*EndorsementDecoderResponse, error)
+	Dispatch(mediaType string, data []byte) (*EndorsementHandlerResponse, error)
 	IsSupportedMediaType(mediaType string) bool
 	GetSupportedMediaTypes() []string
 }

decoder/endorsement_response.pb.go handler/endorsement_response.pb.go

@@ -0,0 +1,27 @@
+// Copyright 2022-2023 Contributors to the Veraison project.
+// SPDX-License-Identifier: Apache-2.0
+package handler
+
+import (
+	"github.com/veraison/services/plugin"
+)
+
+// EndorsementHandlerParams are passed to IEvidenceHandler.Init() They are
+// implementation-specific.
+type EndorsementHandlerParams map[string]interface{}
+
+// IEndorsementHandler defines the interface to functionality for working with
+// attestation scheme specific endorsement provisioning tokens (typically,
+// CoRIM's).
+type IEndorsementHandler interface {
+	plugin.IPluggable
+
+	// Init() initializes the handler.
+	Init(params EndorsementHandlerParams) error
+
+	// Close the decoder, finalizing any state it may contain.
+	Close() error
+
+	// Decode the endorsements from the provided []byte.
+	Decode([]byte) (*EndorsementHandlerResponse, error)
+}