github.com/google/fleetspeak@v0.1.15-0.20240426164851-4f31f62c1aea/fleetspeak/src/client/signer/signer.go (about)

     1  // Copyright 2017 Google Inc.
     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  //     https://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  // Package signer defines an interface to add additional signatures to
    16  // communications with the Fleetspeak server.
    17  package signer
    18  
    19  import fspb "github.com/google/fleetspeak/fleetspeak/src/common/proto/fleetspeak"
    20  
    21  // A Signer is given a chance to sign all data sent to the server.
    22  type Signer interface {
    23  	// SignContact attempts to produce a signature of data which
    24  	// will be included when sending it to the server.
    25  	//
    26  	// SignContact may return nil if the intended certificate is currently
    27  	// unavailable. Otherwise it should return a proto with all fields set.
    28  	SignContact(data []byte) *fspb.Signature
    29  }