2016-03-23 18:09:46 +01:00
|
|
|
package plugin
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bufio"
|
2018-01-25 20:32:05 +01:00
|
|
|
"context"
|
2017-08-11 19:19:46 +02:00
|
|
|
"crypto/subtle"
|
|
|
|
"crypto/tls"
|
2016-03-23 18:09:46 +01:00
|
|
|
"errors"
|
|
|
|
"fmt"
|
2017-08-11 19:19:46 +02:00
|
|
|
"hash"
|
2016-03-23 18:09:46 +01:00
|
|
|
"io"
|
|
|
|
"io/ioutil"
|
|
|
|
"net"
|
|
|
|
"os"
|
|
|
|
"os/exec"
|
|
|
|
"path/filepath"
|
|
|
|
"strconv"
|
|
|
|
"strings"
|
|
|
|
"sync"
|
|
|
|
"sync/atomic"
|
|
|
|
"time"
|
|
|
|
"unicode"
|
2017-08-11 19:19:46 +02:00
|
|
|
|
|
|
|
hclog "github.com/hashicorp/go-hclog"
|
2016-03-23 18:09:46 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
// If this is 1, then we've called CleanupClients. This can be used
|
|
|
|
// by plugin RPC implementations to change error behavior since you
|
|
|
|
// can expected network connection errors at this point. This should be
|
|
|
|
// read by using sync/atomic.
|
|
|
|
var Killed uint32 = 0
|
|
|
|
|
|
|
|
// This is a slice of the "managed" clients which are cleaned up when
|
|
|
|
// calling Cleanup
|
|
|
|
var managedClients = make([]*Client, 0, 5)
|
2017-02-17 17:32:21 +01:00
|
|
|
var managedClientsLock sync.Mutex
|
2016-03-23 18:09:46 +01:00
|
|
|
|
|
|
|
// Error types
|
|
|
|
var (
|
|
|
|
// ErrProcessNotFound is returned when a client is instantiated to
|
|
|
|
// reattach to an existing process and it isn't found.
|
|
|
|
ErrProcessNotFound = errors.New("Reattachment process not found")
|
2017-08-11 19:19:46 +02:00
|
|
|
|
|
|
|
// ErrChecksumsDoNotMatch is returned when binary's checksum doesn't match
|
|
|
|
// the one provided in the SecureConfig.
|
|
|
|
ErrChecksumsDoNotMatch = errors.New("checksums did not match")
|
|
|
|
|
|
|
|
// ErrSecureNoChecksum is returned when an empty checksum is provided to the
|
|
|
|
// SecureConfig.
|
|
|
|
ErrSecureConfigNoChecksum = errors.New("no checksum provided")
|
|
|
|
|
|
|
|
// ErrSecureNoHash is returned when a nil Hash object is provided to the
|
|
|
|
// SecureConfig.
|
|
|
|
ErrSecureConfigNoHash = errors.New("no hash implementation provided")
|
|
|
|
|
|
|
|
// ErrSecureConfigAndReattach is returned when both Reattach and
|
|
|
|
// SecureConfig are set.
|
|
|
|
ErrSecureConfigAndReattach = errors.New("only one of Reattach or SecureConfig can be set")
|
2016-03-23 18:09:46 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
// Client handles the lifecycle of a plugin application. It launches
|
|
|
|
// plugins, connects to them, dispenses interface implementations, and handles
|
|
|
|
// killing the process.
|
|
|
|
//
|
|
|
|
// Plugin hosts should use one Client for each plugin executable. To
|
|
|
|
// dispense a plugin type, use the `Client.Client` function, and then
|
|
|
|
// cal `Dispense`. This awkward API is mostly historical but is used to split
|
|
|
|
// the client that deals with subprocess management and the client that
|
|
|
|
// does RPC management.
|
|
|
|
//
|
|
|
|
// See NewClient and ClientConfig for using a Client.
|
|
|
|
type Client struct {
|
2018-09-25 20:19:23 +02:00
|
|
|
config *ClientConfig
|
|
|
|
exited bool
|
|
|
|
doneLogging chan struct{}
|
|
|
|
l sync.Mutex
|
|
|
|
address net.Addr
|
|
|
|
process *os.Process
|
|
|
|
client ClientProtocol
|
|
|
|
protocol Protocol
|
|
|
|
logger hclog.Logger
|
|
|
|
doneCtx context.Context
|
|
|
|
negotiatedVersion int
|
|
|
|
}
|
|
|
|
|
|
|
|
// NegotiatedVersion returns the protocol version negotiated with the server.
|
|
|
|
// This is only valid after Start() is called.
|
|
|
|
func (c *Client) NegotiatedVersion() int {
|
|
|
|
return c.negotiatedVersion
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// ClientConfig is the configuration used to initialize a new
|
|
|
|
// plugin client. After being used to initialize a plugin client,
|
|
|
|
// that configuration must not be modified again.
|
|
|
|
type ClientConfig struct {
|
|
|
|
// HandshakeConfig is the configuration that must match servers.
|
|
|
|
HandshakeConfig
|
|
|
|
|
|
|
|
// Plugins are the plugins that can be consumed.
|
2018-09-25 20:19:23 +02:00
|
|
|
// The implied version of this PluginSet is the Handshake.ProtocolVersion.
|
|
|
|
Plugins PluginSet
|
|
|
|
|
|
|
|
// VersionedPlugins is a map of PluginSets for specific protocol versions.
|
|
|
|
// These can be used to negotiate a compatible version between client and
|
|
|
|
// server. If this is set, Handshake.ProtocolVersion is not required.
|
|
|
|
VersionedPlugins map[int]PluginSet
|
2016-03-23 18:09:46 +01:00
|
|
|
|
|
|
|
// One of the following must be set, but not both.
|
|
|
|
//
|
|
|
|
// Cmd is the unstarted subprocess for starting the plugin. If this is
|
|
|
|
// set, then the Client starts the plugin process on its own and connects
|
|
|
|
// to it.
|
|
|
|
//
|
|
|
|
// Reattach is configuration for reattaching to an existing plugin process
|
|
|
|
// that is already running. This isn't common.
|
|
|
|
Cmd *exec.Cmd
|
|
|
|
Reattach *ReattachConfig
|
|
|
|
|
2017-08-11 19:19:46 +02:00
|
|
|
// SecureConfig is configuration for verifying the integrity of the
|
|
|
|
// executable. It can not be used with Reattach.
|
|
|
|
SecureConfig *SecureConfig
|
|
|
|
|
|
|
|
// TLSConfig is used to enable TLS on the RPC client.
|
|
|
|
TLSConfig *tls.Config
|
|
|
|
|
2016-03-23 18:09:46 +01:00
|
|
|
// Managed represents if the client should be managed by the
|
|
|
|
// plugin package or not. If true, then by calling CleanupClients,
|
|
|
|
// it will automatically be cleaned up. Otherwise, the client
|
|
|
|
// user is fully responsible for making sure to Kill all plugin
|
|
|
|
// clients. By default the client is _not_ managed.
|
|
|
|
Managed bool
|
|
|
|
|
|
|
|
// The minimum and maximum port to use for communicating with
|
|
|
|
// the subprocess. If not set, this defaults to 10,000 and 25,000
|
|
|
|
// respectively.
|
|
|
|
MinPort, MaxPort uint
|
|
|
|
|
|
|
|
// StartTimeout is the timeout to wait for the plugin to say it
|
|
|
|
// has started successfully.
|
|
|
|
StartTimeout time.Duration
|
|
|
|
|
|
|
|
// If non-nil, then the stderr of the client will be written to here
|
|
|
|
// (as well as the log). This is the original os.Stderr of the subprocess.
|
|
|
|
// This isn't the output of synced stderr.
|
|
|
|
Stderr io.Writer
|
|
|
|
|
|
|
|
// SyncStdout, SyncStderr can be set to override the
|
|
|
|
// respective os.Std* values in the plugin. Care should be taken to
|
|
|
|
// avoid races here. If these are nil, then this will automatically be
|
|
|
|
// hooked up to os.Stdin, Stdout, and Stderr, respectively.
|
|
|
|
//
|
|
|
|
// If the default values (nil) are used, then this package will not
|
|
|
|
// sync any of these streams.
|
|
|
|
SyncStdout io.Writer
|
|
|
|
SyncStderr io.Writer
|
2017-08-11 19:19:46 +02:00
|
|
|
|
|
|
|
// AllowedProtocols is a list of allowed protocols. If this isn't set,
|
|
|
|
// then only netrpc is allowed. This is so that older go-plugin systems
|
|
|
|
// can show friendly errors if they see a plugin with an unknown
|
|
|
|
// protocol.
|
|
|
|
//
|
|
|
|
// By setting this, you can cause an error immediately on plugin start
|
|
|
|
// if an unsupported protocol is used with a good error message.
|
|
|
|
//
|
|
|
|
// If this isn't set at all (nil value), then only net/rpc is accepted.
|
|
|
|
// This is done for legacy reasons. You must explicitly opt-in to
|
|
|
|
// new protocols.
|
|
|
|
AllowedProtocols []Protocol
|
|
|
|
|
|
|
|
// Logger is the logger that the client will used. If none is provided,
|
|
|
|
// it will default to hclog's default logger.
|
|
|
|
Logger hclog.Logger
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// ReattachConfig is used to configure a client to reattach to an
|
|
|
|
// already-running plugin process. You can retrieve this information by
|
|
|
|
// calling ReattachConfig on Client.
|
|
|
|
type ReattachConfig struct {
|
2017-08-11 19:19:46 +02:00
|
|
|
Protocol Protocol
|
|
|
|
Addr net.Addr
|
|
|
|
Pid int
|
|
|
|
}
|
|
|
|
|
|
|
|
// SecureConfig is used to configure a client to verify the integrity of an
|
|
|
|
// executable before running. It does this by verifying the checksum is
|
|
|
|
// expected. Hash is used to specify the hashing method to use when checksumming
|
|
|
|
// the file. The configuration is verified by the client by calling the
|
|
|
|
// SecureConfig.Check() function.
|
|
|
|
//
|
|
|
|
// The host process should ensure the checksum was provided by a trusted and
|
|
|
|
// authoritative source. The binary should be installed in such a way that it
|
|
|
|
// can not be modified by an unauthorized user between the time of this check
|
|
|
|
// and the time of execution.
|
|
|
|
type SecureConfig struct {
|
|
|
|
Checksum []byte
|
|
|
|
Hash hash.Hash
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check takes the filepath to an executable and returns true if the checksum of
|
|
|
|
// the file matches the checksum provided in the SecureConfig.
|
|
|
|
func (s *SecureConfig) Check(filePath string) (bool, error) {
|
|
|
|
if len(s.Checksum) == 0 {
|
|
|
|
return false, ErrSecureConfigNoChecksum
|
|
|
|
}
|
|
|
|
|
|
|
|
if s.Hash == nil {
|
|
|
|
return false, ErrSecureConfigNoHash
|
|
|
|
}
|
|
|
|
|
|
|
|
file, err := os.Open(filePath)
|
|
|
|
if err != nil {
|
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
defer file.Close()
|
|
|
|
|
|
|
|
_, err = io.Copy(s.Hash, file)
|
|
|
|
if err != nil {
|
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
|
|
|
|
sum := s.Hash.Sum(nil)
|
|
|
|
|
|
|
|
return subtle.ConstantTimeCompare(sum, s.Checksum) == 1, nil
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// This makes sure all the managed subprocesses are killed and properly
|
|
|
|
// logged. This should be called before the parent process running the
|
|
|
|
// plugins exits.
|
|
|
|
//
|
|
|
|
// This must only be called _once_.
|
|
|
|
func CleanupClients() {
|
|
|
|
// Set the killed to true so that we don't get unexpected panics
|
|
|
|
atomic.StoreUint32(&Killed, 1)
|
|
|
|
|
|
|
|
// Kill all the managed clients in parallel and use a WaitGroup
|
|
|
|
// to wait for them all to finish up.
|
|
|
|
var wg sync.WaitGroup
|
2017-02-17 17:32:21 +01:00
|
|
|
managedClientsLock.Lock()
|
2016-03-23 18:09:46 +01:00
|
|
|
for _, client := range managedClients {
|
|
|
|
wg.Add(1)
|
|
|
|
|
|
|
|
go func(client *Client) {
|
|
|
|
client.Kill()
|
|
|
|
wg.Done()
|
|
|
|
}(client)
|
|
|
|
}
|
2017-02-17 17:32:21 +01:00
|
|
|
managedClientsLock.Unlock()
|
2016-03-23 18:09:46 +01:00
|
|
|
|
|
|
|
wg.Wait()
|
|
|
|
}
|
|
|
|
|
|
|
|
// Creates a new plugin client which manages the lifecycle of an external
|
|
|
|
// plugin and gets the address for the RPC connection.
|
|
|
|
//
|
|
|
|
// The client must be cleaned up at some point by calling Kill(). If
|
|
|
|
// the client is a managed client (created with NewManagedClient) you
|
|
|
|
// can just call CleanupClients at the end of your program and they will
|
|
|
|
// be properly cleaned.
|
|
|
|
func NewClient(config *ClientConfig) (c *Client) {
|
|
|
|
if config.MinPort == 0 && config.MaxPort == 0 {
|
|
|
|
config.MinPort = 10000
|
|
|
|
config.MaxPort = 25000
|
|
|
|
}
|
|
|
|
|
|
|
|
if config.StartTimeout == 0 {
|
|
|
|
config.StartTimeout = 1 * time.Minute
|
|
|
|
}
|
|
|
|
|
|
|
|
if config.Stderr == nil {
|
|
|
|
config.Stderr = ioutil.Discard
|
|
|
|
}
|
|
|
|
|
|
|
|
if config.SyncStdout == nil {
|
|
|
|
config.SyncStdout = ioutil.Discard
|
|
|
|
}
|
|
|
|
if config.SyncStderr == nil {
|
|
|
|
config.SyncStderr = ioutil.Discard
|
|
|
|
}
|
|
|
|
|
2017-08-11 19:19:46 +02:00
|
|
|
if config.AllowedProtocols == nil {
|
|
|
|
config.AllowedProtocols = []Protocol{ProtocolNetRPC}
|
|
|
|
}
|
|
|
|
|
|
|
|
if config.Logger == nil {
|
2017-08-16 17:25:28 +02:00
|
|
|
config.Logger = hclog.New(&hclog.LoggerOptions{
|
|
|
|
Output: hclog.DefaultOutput,
|
|
|
|
Level: hclog.Trace,
|
|
|
|
Name: "plugin",
|
|
|
|
})
|
2017-08-11 19:19:46 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
c = &Client{
|
|
|
|
config: config,
|
|
|
|
logger: config.Logger,
|
|
|
|
}
|
2016-03-23 18:09:46 +01:00
|
|
|
if config.Managed {
|
2017-02-17 17:32:21 +01:00
|
|
|
managedClientsLock.Lock()
|
2016-03-23 18:09:46 +01:00
|
|
|
managedClients = append(managedClients, c)
|
2017-02-17 17:32:21 +01:00
|
|
|
managedClientsLock.Unlock()
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2017-08-11 19:19:46 +02:00
|
|
|
// Client returns the protocol client for this connection.
|
2016-03-23 18:09:46 +01:00
|
|
|
//
|
2017-08-11 19:19:46 +02:00
|
|
|
// Subsequent calls to this will return the same client.
|
|
|
|
func (c *Client) Client() (ClientProtocol, error) {
|
|
|
|
_, err := c.Start()
|
2016-03-23 18:09:46 +01:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
c.l.Lock()
|
|
|
|
defer c.l.Unlock()
|
|
|
|
|
|
|
|
if c.client != nil {
|
|
|
|
return c.client, nil
|
|
|
|
}
|
|
|
|
|
2017-08-11 19:19:46 +02:00
|
|
|
switch c.protocol {
|
|
|
|
case ProtocolNetRPC:
|
|
|
|
c.client, err = newRPCClient(c)
|
2016-03-23 18:09:46 +01:00
|
|
|
|
2017-08-11 19:19:46 +02:00
|
|
|
case ProtocolGRPC:
|
2018-01-25 20:32:05 +01:00
|
|
|
c.client, err = newGRPCClient(c.doneCtx, c)
|
2017-08-11 19:19:46 +02:00
|
|
|
|
|
|
|
default:
|
|
|
|
return nil, fmt.Errorf("unknown server protocol: %s", c.protocol)
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if err != nil {
|
|
|
|
c.client = nil
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return c.client, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Tells whether or not the underlying process has exited.
|
|
|
|
func (c *Client) Exited() bool {
|
|
|
|
c.l.Lock()
|
|
|
|
defer c.l.Unlock()
|
|
|
|
return c.exited
|
|
|
|
}
|
|
|
|
|
|
|
|
// End the executing subprocess (if it is running) and perform any cleanup
|
|
|
|
// tasks necessary such as capturing any remaining logs and so on.
|
|
|
|
//
|
|
|
|
// This method blocks until the process successfully exits.
|
|
|
|
//
|
|
|
|
// This method can safely be called multiple times.
|
|
|
|
func (c *Client) Kill() {
|
2017-02-17 17:32:21 +01:00
|
|
|
// Grab a lock to read some private fields.
|
|
|
|
c.l.Lock()
|
|
|
|
process := c.process
|
|
|
|
addr := c.address
|
|
|
|
doneCh := c.doneLogging
|
|
|
|
c.l.Unlock()
|
|
|
|
|
|
|
|
// If there is no process, we never started anything. Nothing to kill.
|
|
|
|
if process == nil {
|
2016-03-23 18:09:46 +01:00
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2017-02-17 17:32:21 +01:00
|
|
|
// We need to check for address here. It is possible that the plugin
|
|
|
|
// started (process != nil) but has no address (addr == nil) if the
|
|
|
|
// plugin failed at startup. If we do have an address, we need to close
|
|
|
|
// the plugin net connections.
|
|
|
|
graceful := false
|
|
|
|
if addr != nil {
|
|
|
|
// Close the client to cleanly exit the process.
|
|
|
|
client, err := c.Client()
|
|
|
|
if err == nil {
|
|
|
|
err = client.Close()
|
|
|
|
|
|
|
|
// If there is no error, then we attempt to wait for a graceful
|
|
|
|
// exit. If there was an error, we assume that graceful cleanup
|
|
|
|
// won't happen and just force kill.
|
|
|
|
graceful = err == nil
|
|
|
|
if err != nil {
|
|
|
|
// If there was an error just log it. We're going to force
|
|
|
|
// kill in a moment anyways.
|
2017-08-11 19:19:46 +02:00
|
|
|
c.logger.Warn("error closing client during Kill", "err", err)
|
2017-02-17 17:32:21 +01:00
|
|
|
}
|
|
|
|
}
|
2017-01-20 02:10:17 +01:00
|
|
|
}
|
2017-02-17 17:32:21 +01:00
|
|
|
|
|
|
|
// If we're attempting a graceful exit, then we wait for a short period
|
|
|
|
// of time to allow that to happen. To wait for this we just wait on the
|
|
|
|
// doneCh which would be closed if the process exits.
|
|
|
|
if graceful {
|
|
|
|
select {
|
|
|
|
case <-doneCh:
|
|
|
|
return
|
|
|
|
case <-time.After(250 * time.Millisecond):
|
|
|
|
}
|
2017-01-20 02:10:17 +01:00
|
|
|
}
|
2016-03-23 18:09:46 +01:00
|
|
|
|
2017-02-17 17:32:21 +01:00
|
|
|
// If graceful exiting failed, just kill it
|
|
|
|
process.Kill()
|
|
|
|
|
2016-03-23 18:09:46 +01:00
|
|
|
// Wait for the client to finish logging so we have a complete log
|
2017-02-17 17:32:21 +01:00
|
|
|
<-doneCh
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Starts the underlying subprocess, communicating with it to negotiate
|
|
|
|
// a port for RPC connections, and returning the address to connect via RPC.
|
|
|
|
//
|
|
|
|
// This method is safe to call multiple times. Subsequent calls have no effect.
|
|
|
|
// Once a client has been started once, it cannot be started again, even if
|
|
|
|
// it was killed.
|
|
|
|
func (c *Client) Start() (addr net.Addr, err error) {
|
|
|
|
c.l.Lock()
|
|
|
|
defer c.l.Unlock()
|
|
|
|
|
|
|
|
if c.address != nil {
|
|
|
|
return c.address, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// If one of cmd or reattach isn't set, then it is an error. We wrap
|
|
|
|
// this in a {} for scoping reasons, and hopeful that the escape
|
|
|
|
// analysis will pop the stock here.
|
|
|
|
{
|
|
|
|
cmdSet := c.config.Cmd != nil
|
|
|
|
attachSet := c.config.Reattach != nil
|
2017-08-11 19:19:46 +02:00
|
|
|
secureSet := c.config.SecureConfig != nil
|
2016-03-23 18:09:46 +01:00
|
|
|
if cmdSet == attachSet {
|
|
|
|
return nil, fmt.Errorf("Only one of Cmd or Reattach must be set")
|
|
|
|
}
|
2017-08-11 19:19:46 +02:00
|
|
|
|
|
|
|
if secureSet && attachSet {
|
|
|
|
return nil, ErrSecureConfigAndReattach
|
|
|
|
}
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Create the logging channel for when we kill
|
|
|
|
c.doneLogging = make(chan struct{})
|
2018-01-25 20:32:05 +01:00
|
|
|
// Create a context for when we kill
|
|
|
|
var ctxCancel context.CancelFunc
|
|
|
|
c.doneCtx, ctxCancel = context.WithCancel(context.Background())
|
2016-03-23 18:09:46 +01:00
|
|
|
|
|
|
|
if c.config.Reattach != nil {
|
|
|
|
// Verify the process still exists. If not, then it is an error
|
|
|
|
p, err := os.FindProcess(c.config.Reattach.Pid)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Attempt to connect to the addr since on Unix systems FindProcess
|
|
|
|
// doesn't actually return an error if it can't find the process.
|
|
|
|
conn, err := net.Dial(
|
|
|
|
c.config.Reattach.Addr.Network(),
|
|
|
|
c.config.Reattach.Addr.String())
|
|
|
|
if err != nil {
|
|
|
|
p.Kill()
|
|
|
|
return nil, ErrProcessNotFound
|
|
|
|
}
|
|
|
|
conn.Close()
|
|
|
|
|
|
|
|
// Goroutine to mark exit status
|
|
|
|
go func(pid int) {
|
|
|
|
// Wait for the process to die
|
|
|
|
pidWait(pid)
|
|
|
|
|
|
|
|
// Log so we can see it
|
2017-08-11 19:19:46 +02:00
|
|
|
c.logger.Debug("reattached plugin process exited")
|
2016-03-23 18:09:46 +01:00
|
|
|
|
|
|
|
// Mark it
|
|
|
|
c.l.Lock()
|
|
|
|
defer c.l.Unlock()
|
|
|
|
c.exited = true
|
|
|
|
|
|
|
|
// Close the logging channel since that doesn't work on reattach
|
|
|
|
close(c.doneLogging)
|
2018-01-25 20:32:05 +01:00
|
|
|
|
|
|
|
// Cancel the context
|
|
|
|
ctxCancel()
|
2016-03-23 18:09:46 +01:00
|
|
|
}(p.Pid)
|
|
|
|
|
|
|
|
// Set the address and process
|
|
|
|
c.address = c.config.Reattach.Addr
|
|
|
|
c.process = p
|
2017-08-11 19:19:46 +02:00
|
|
|
c.protocol = c.config.Reattach.Protocol
|
|
|
|
if c.protocol == "" {
|
|
|
|
// Default the protocol to net/rpc for backwards compatibility
|
|
|
|
c.protocol = ProtocolNetRPC
|
|
|
|
}
|
2016-03-23 18:09:46 +01:00
|
|
|
|
|
|
|
return c.address, nil
|
|
|
|
}
|
|
|
|
|
2018-09-25 20:19:23 +02:00
|
|
|
if c.config.VersionedPlugins == nil {
|
|
|
|
c.config.VersionedPlugins = make(map[int]PluginSet)
|
|
|
|
}
|
|
|
|
|
|
|
|
// handle all plugins as versioned, using the handshake config as the default.
|
|
|
|
version := int(c.config.ProtocolVersion)
|
|
|
|
|
|
|
|
// Make sure we're not overwriting a real version 0. If ProtocolVersion was
|
|
|
|
// non-zero, then we have to just assume the user made sure that
|
|
|
|
// VersionedPlugins doesn't conflict.
|
|
|
|
if _, ok := c.config.VersionedPlugins[version]; !ok && c.config.Plugins != nil {
|
|
|
|
c.config.VersionedPlugins[version] = c.config.Plugins
|
|
|
|
}
|
|
|
|
|
|
|
|
var versionStrings []string
|
|
|
|
for v := range c.config.VersionedPlugins {
|
|
|
|
versionStrings = append(versionStrings, strconv.Itoa(v))
|
|
|
|
}
|
|
|
|
|
2016-03-23 18:09:46 +01:00
|
|
|
env := []string{
|
|
|
|
fmt.Sprintf("%s=%s", c.config.MagicCookieKey, c.config.MagicCookieValue),
|
|
|
|
fmt.Sprintf("PLUGIN_MIN_PORT=%d", c.config.MinPort),
|
|
|
|
fmt.Sprintf("PLUGIN_MAX_PORT=%d", c.config.MaxPort),
|
2018-09-25 20:19:23 +02:00
|
|
|
fmt.Sprintf("PLUGIN_PROTOCOL_VERSIONS=%s", strings.Join(versionStrings, ",")),
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
stdout_r, stdout_w := io.Pipe()
|
|
|
|
stderr_r, stderr_w := io.Pipe()
|
|
|
|
|
|
|
|
cmd := c.config.Cmd
|
|
|
|
cmd.Env = append(cmd.Env, os.Environ()...)
|
|
|
|
cmd.Env = append(cmd.Env, env...)
|
|
|
|
cmd.Stdin = os.Stdin
|
|
|
|
cmd.Stderr = stderr_w
|
|
|
|
cmd.Stdout = stdout_w
|
|
|
|
|
2017-08-11 19:19:46 +02:00
|
|
|
if c.config.SecureConfig != nil {
|
|
|
|
if ok, err := c.config.SecureConfig.Check(cmd.Path); err != nil {
|
|
|
|
return nil, fmt.Errorf("error verifying checksum: %s", err)
|
|
|
|
} else if !ok {
|
|
|
|
return nil, ErrChecksumsDoNotMatch
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
c.logger.Debug("starting plugin", "path", cmd.Path, "args", cmd.Args)
|
2016-03-23 18:09:46 +01:00
|
|
|
err = cmd.Start()
|
|
|
|
if err != nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// Set the process
|
|
|
|
c.process = cmd.Process
|
|
|
|
|
|
|
|
// Make sure the command is properly cleaned up if there is an error
|
|
|
|
defer func() {
|
|
|
|
r := recover()
|
|
|
|
|
|
|
|
if err != nil || r != nil {
|
|
|
|
cmd.Process.Kill()
|
|
|
|
}
|
|
|
|
|
|
|
|
if r != nil {
|
|
|
|
panic(r)
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
|
|
|
|
// Start goroutine to wait for process to exit
|
|
|
|
exitCh := make(chan struct{})
|
|
|
|
go func() {
|
|
|
|
// Make sure we close the write end of our stderr/stdout so
|
|
|
|
// that the readers send EOF properly.
|
|
|
|
defer stderr_w.Close()
|
|
|
|
defer stdout_w.Close()
|
|
|
|
|
|
|
|
// Wait for the command to end.
|
|
|
|
cmd.Wait()
|
|
|
|
|
|
|
|
// Log and make sure to flush the logs write away
|
2017-08-11 19:19:46 +02:00
|
|
|
c.logger.Debug("plugin process exited", "path", cmd.Path)
|
2016-03-23 18:09:46 +01:00
|
|
|
os.Stderr.Sync()
|
|
|
|
|
|
|
|
// Mark that we exited
|
|
|
|
close(exitCh)
|
|
|
|
|
2018-01-25 20:32:05 +01:00
|
|
|
// Cancel the context, marking that we exited
|
|
|
|
ctxCancel()
|
|
|
|
|
2016-03-23 18:09:46 +01:00
|
|
|
// Set that we exited, which takes a lock
|
|
|
|
c.l.Lock()
|
|
|
|
defer c.l.Unlock()
|
|
|
|
c.exited = true
|
|
|
|
}()
|
|
|
|
|
|
|
|
// Start goroutine that logs the stderr
|
|
|
|
go c.logStderr(stderr_r)
|
|
|
|
|
|
|
|
// Start a goroutine that is going to be reading the lines
|
|
|
|
// out of stdout
|
|
|
|
linesCh := make(chan []byte)
|
|
|
|
go func() {
|
|
|
|
defer close(linesCh)
|
|
|
|
|
|
|
|
buf := bufio.NewReader(stdout_r)
|
|
|
|
for {
|
|
|
|
line, err := buf.ReadBytes('\n')
|
|
|
|
if line != nil {
|
|
|
|
linesCh <- line
|
|
|
|
}
|
|
|
|
|
|
|
|
if err == io.EOF {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
|
|
|
|
// Make sure after we exit we read the lines from stdout forever
|
|
|
|
// so they don't block since it is an io.Pipe
|
|
|
|
defer func() {
|
|
|
|
go func() {
|
|
|
|
for _ = range linesCh {
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
}()
|
|
|
|
|
|
|
|
// Some channels for the next step
|
|
|
|
timeout := time.After(c.config.StartTimeout)
|
|
|
|
|
|
|
|
// Start looking for the address
|
2017-08-11 19:19:46 +02:00
|
|
|
c.logger.Debug("waiting for RPC address", "path", cmd.Path)
|
2016-03-23 18:09:46 +01:00
|
|
|
select {
|
|
|
|
case <-timeout:
|
|
|
|
err = errors.New("timeout while waiting for plugin to start")
|
|
|
|
case <-exitCh:
|
|
|
|
err = errors.New("plugin exited before we could connect")
|
|
|
|
case lineBytes := <-linesCh:
|
|
|
|
// Trim the line and split by "|" in order to get the parts of
|
|
|
|
// the output.
|
|
|
|
line := strings.TrimSpace(string(lineBytes))
|
2017-08-11 19:19:46 +02:00
|
|
|
parts := strings.SplitN(line, "|", 6)
|
2016-03-23 18:09:46 +01:00
|
|
|
if len(parts) < 4 {
|
|
|
|
err = fmt.Errorf(
|
|
|
|
"Unrecognized remote plugin message: %s\n\n"+
|
|
|
|
"This usually means that the plugin is either invalid or simply\n"+
|
|
|
|
"needs to be recompiled to support the latest protocol.", line)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check the core protocol. Wrapped in a {} for scoping.
|
|
|
|
{
|
|
|
|
var coreProtocol int64
|
|
|
|
coreProtocol, err = strconv.ParseInt(parts[0], 10, 0)
|
|
|
|
if err != nil {
|
|
|
|
err = fmt.Errorf("Error parsing core protocol version: %s", err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
if int(coreProtocol) != CoreProtocolVersion {
|
|
|
|
err = fmt.Errorf("Incompatible core API version with plugin. "+
|
2018-01-25 20:32:05 +01:00
|
|
|
"Plugin version: %s, Core version: %d\n\n"+
|
2016-03-23 18:09:46 +01:00
|
|
|
"To fix this, the plugin usually only needs to be recompiled.\n"+
|
|
|
|
"Please report this to the plugin author.", parts[0], CoreProtocolVersion)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-09-25 20:19:23 +02:00
|
|
|
// Test the API version
|
|
|
|
version, pluginSet, err := c.checkProtoVersion(parts[1])
|
2016-03-23 18:09:46 +01:00
|
|
|
if err != nil {
|
2018-09-25 20:19:23 +02:00
|
|
|
return addr, err
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
2018-09-25 20:19:23 +02:00
|
|
|
// set the Plugins value to the compatible set, so the version
|
|
|
|
// doesn't need to be passed through to the ClientProtocol
|
|
|
|
// implementation.
|
|
|
|
c.config.Plugins = pluginSet
|
|
|
|
c.negotiatedVersion = version
|
|
|
|
c.logger.Debug("using plugin", "version", version)
|
2016-03-23 18:09:46 +01:00
|
|
|
|
|
|
|
switch parts[2] {
|
|
|
|
case "tcp":
|
|
|
|
addr, err = net.ResolveTCPAddr("tcp", parts[3])
|
|
|
|
case "unix":
|
|
|
|
addr, err = net.ResolveUnixAddr("unix", parts[3])
|
|
|
|
default:
|
|
|
|
err = fmt.Errorf("Unknown address type: %s", parts[3])
|
|
|
|
}
|
2017-08-11 19:19:46 +02:00
|
|
|
|
|
|
|
// If we have a server type, then record that. We default to net/rpc
|
|
|
|
// for backwards compatibility.
|
|
|
|
c.protocol = ProtocolNetRPC
|
|
|
|
if len(parts) >= 5 {
|
|
|
|
c.protocol = Protocol(parts[4])
|
|
|
|
}
|
|
|
|
|
|
|
|
found := false
|
|
|
|
for _, p := range c.config.AllowedProtocols {
|
|
|
|
if p == c.protocol {
|
|
|
|
found = true
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if !found {
|
|
|
|
err = fmt.Errorf("Unsupported plugin protocol %q. Supported: %v",
|
|
|
|
c.protocol, c.config.AllowedProtocols)
|
2018-09-25 20:19:23 +02:00
|
|
|
return addr, err
|
2017-08-11 19:19:46 +02:00
|
|
|
}
|
|
|
|
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
c.address = addr
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2018-09-25 20:19:23 +02:00
|
|
|
// checkProtoVersion returns the negotiated version and PluginSet.
|
|
|
|
// This returns an error if the server returned an incompatible protocol
|
|
|
|
// version, or an invalid handshake response.
|
|
|
|
func (c *Client) checkProtoVersion(protoVersion string) (int, PluginSet, error) {
|
|
|
|
serverVersion, err := strconv.Atoi(protoVersion)
|
|
|
|
if err != nil {
|
|
|
|
return 0, nil, fmt.Errorf("Error parsing protocol version %q: %s", protoVersion, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// record these for the error message
|
|
|
|
var clientVersions []int
|
|
|
|
|
|
|
|
// all versions, including the legacy ProtocolVersion have been added to
|
|
|
|
// the versions set
|
|
|
|
for version, plugins := range c.config.VersionedPlugins {
|
|
|
|
clientVersions = append(clientVersions, version)
|
|
|
|
|
|
|
|
if serverVersion != version {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
return version, plugins, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return 0, nil, fmt.Errorf("Incompatible API version with plugin. "+
|
|
|
|
"Plugin version: %d, Client versions: %d", serverVersion, clientVersions)
|
|
|
|
}
|
|
|
|
|
2016-03-23 18:09:46 +01:00
|
|
|
// ReattachConfig returns the information that must be provided to NewClient
|
|
|
|
// to reattach to the plugin process that this client started. This is
|
|
|
|
// useful for plugins that detach from their parent process.
|
|
|
|
//
|
|
|
|
// If this returns nil then the process hasn't been started yet. Please
|
|
|
|
// call Start or Client before calling this.
|
|
|
|
func (c *Client) ReattachConfig() *ReattachConfig {
|
|
|
|
c.l.Lock()
|
|
|
|
defer c.l.Unlock()
|
|
|
|
|
|
|
|
if c.address == nil {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
if c.config.Cmd != nil && c.config.Cmd.Process == nil {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// If we connected via reattach, just return the information as-is
|
|
|
|
if c.config.Reattach != nil {
|
|
|
|
return c.config.Reattach
|
|
|
|
}
|
|
|
|
|
|
|
|
return &ReattachConfig{
|
2017-08-11 19:19:46 +02:00
|
|
|
Protocol: c.protocol,
|
|
|
|
Addr: c.address,
|
|
|
|
Pid: c.config.Cmd.Process.Pid,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Protocol returns the protocol of server on the remote end. This will
|
|
|
|
// start the plugin process if it isn't already started. Errors from
|
|
|
|
// starting the plugin are surpressed and ProtocolInvalid is returned. It
|
|
|
|
// is recommended you call Start explicitly before calling Protocol to ensure
|
|
|
|
// no errors occur.
|
|
|
|
func (c *Client) Protocol() Protocol {
|
|
|
|
_, err := c.Start()
|
|
|
|
if err != nil {
|
|
|
|
return ProtocolInvalid
|
|
|
|
}
|
|
|
|
|
|
|
|
return c.protocol
|
|
|
|
}
|
|
|
|
|
2018-01-25 20:32:05 +01:00
|
|
|
func netAddrDialer(addr net.Addr) func(string, time.Duration) (net.Conn, error) {
|
|
|
|
return func(_ string, _ time.Duration) (net.Conn, error) {
|
|
|
|
// Connect to the client
|
|
|
|
conn, err := net.Dial(addr.Network(), addr.String())
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if tcpConn, ok := conn.(*net.TCPConn); ok {
|
|
|
|
// Make sure to set keep alive so that the connection doesn't die
|
|
|
|
tcpConn.SetKeepAlive(true)
|
|
|
|
}
|
|
|
|
|
|
|
|
return conn, nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-08-11 19:19:46 +02:00
|
|
|
// dialer is compatible with grpc.WithDialer and creates the connection
|
|
|
|
// to the plugin.
|
|
|
|
func (c *Client) dialer(_ string, timeout time.Duration) (net.Conn, error) {
|
2018-01-25 20:32:05 +01:00
|
|
|
conn, err := netAddrDialer(c.address)("", timeout)
|
2017-08-11 19:19:46 +02:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// If we have a TLS config we wrap our connection. We only do this
|
|
|
|
// for net/rpc since gRPC uses its own mechanism for TLS.
|
|
|
|
if c.protocol == ProtocolNetRPC && c.config.TLSConfig != nil {
|
|
|
|
conn = tls.Client(conn, c.config.TLSConfig)
|
|
|
|
}
|
|
|
|
|
|
|
|
return conn, nil
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
func (c *Client) logStderr(r io.Reader) {
|
|
|
|
bufR := bufio.NewReader(r)
|
2018-09-25 20:19:23 +02:00
|
|
|
l := c.logger.Named(filepath.Base(c.config.Cmd.Path))
|
|
|
|
|
2016-03-23 18:09:46 +01:00
|
|
|
for {
|
|
|
|
line, err := bufR.ReadString('\n')
|
|
|
|
if line != "" {
|
|
|
|
c.config.Stderr.Write([]byte(line))
|
|
|
|
line = strings.TrimRightFunc(line, unicode.IsSpace)
|
2017-08-11 19:19:46 +02:00
|
|
|
|
2017-08-16 17:25:28 +02:00
|
|
|
entry, err := parseJSON(line)
|
|
|
|
// If output is not JSON format, print directly to Debug
|
|
|
|
if err != nil {
|
|
|
|
l.Debug(line)
|
2017-08-11 19:19:46 +02:00
|
|
|
} else {
|
|
|
|
out := flattenKVPairs(entry.KVPairs)
|
|
|
|
|
2018-09-25 20:19:23 +02:00
|
|
|
out = append(out, "timestamp", entry.Timestamp.Format(hclog.TimeFormat))
|
2017-08-11 19:19:46 +02:00
|
|
|
switch hclog.LevelFromString(entry.Level) {
|
|
|
|
case hclog.Trace:
|
|
|
|
l.Trace(entry.Message, out...)
|
|
|
|
case hclog.Debug:
|
|
|
|
l.Debug(entry.Message, out...)
|
|
|
|
case hclog.Info:
|
|
|
|
l.Info(entry.Message, out...)
|
|
|
|
case hclog.Warn:
|
|
|
|
l.Warn(entry.Message, out...)
|
|
|
|
case hclog.Error:
|
|
|
|
l.Error(entry.Message, out...)
|
|
|
|
}
|
|
|
|
}
|
2016-03-23 18:09:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if err == io.EOF {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Flag that we've completed logging for others
|
|
|
|
close(c.doneLogging)
|
|
|
|
}
|