/
load.go
228 lines (188 loc) · 5.02 KB
/
load.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
package runner
import (
"crypto/sha256"
"encoding/hex"
"errors"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"strings"
"github.com/BurntSushi/toml"
plugin "github.com/gideaworx/terraform-exporter-plugin-go"
"github.com/hashicorp/go-hclog"
goplug "github.com/hashicorp/go-plugin"
)
const PLUGIN_HOME = "TFE_PLUGIN_HOME"
const DEFAULT_PLUGIN_HOME = ".tf-exporter-plugins"
type PluginDefinition struct {
info plugin.PluginInformation
p plugin.ExportPlugin
executable string
client *goplug.Client
}
var pluginMap map[int]goplug.PluginSet = map[int]goplug.PluginSet{
int(plugin.RPCProtocol): {
"plugin": &plugin.RPCExportPlugin{},
},
int(plugin.GRPCProtocol): {
"plugin": &plugin.GRPCExportPlugin{},
},
}
func (p PluginDefinition) PluginInfo() plugin.PluginInformation {
return p.info
}
func (p PluginDefinition) Plugin() (plugin.ExportPlugin, error) {
if p.p == nil {
if p.client == nil {
return nil, errors.New("cannot get plugin because the rpc client is unavailable")
}
rpcClient, err := p.client.Client()
if err != nil {
return nil, fmt.Errorf("could not connect to rpc client: %w", err)
}
raw, err := rpcClient.Dispense("plugin")
if err != nil {
return nil, fmt.Errorf("could not initialize plugin: %w", err)
}
plugin, ok := raw.(plugin.ExportPlugin)
if !ok {
return nil, fmt.Errorf("did not get the expected plugin implementation. expected an implementation of plugin.Plugin but got %T", plugin)
}
p.p = plugin
}
return p.p, nil
}
func (p PluginDefinition) Kill() {
p.client.Kill()
}
func PluginHome() (string, error) {
var err error
home := os.Getenv(PLUGIN_HOME)
if home == "" {
homedir, err := os.UserHomeDir()
if err != nil {
return "", fmt.Errorf("could not find user's home directory: %w", err)
}
home = filepath.Join(homedir, DEFAULT_PLUGIN_HOME)
}
if home, err = filepath.Abs(home); err != nil {
return "", fmt.Errorf("could not get absolute path of plugins directory %s: %w", home, err)
}
info, err := os.Stat(home)
if err != nil {
if !os.IsNotExist(err) {
return "", fmt.Errorf("could not read plugin directory %s: %w", home, err)
}
if err = os.MkdirAll(home, 0o777); err != nil {
return "", err
}
}
if info != nil && !info.IsDir() {
return "", fmt.Errorf("%q is not a directory", home)
}
return home, nil
}
func PluginDir(pluginName string, create bool) (string, error) {
home, err := PluginHome()
if err != nil {
return "", err
}
pluginDir := filepath.Join(home, pluginName)
info, err := os.Stat(pluginDir)
if err != nil {
if !os.IsNotExist(err) {
return "", fmt.Errorf("could not read plugin directory %s: %w", pluginDir, err)
}
if create {
if err = os.MkdirAll(pluginDir, 0o777); err != nil {
return "", err
}
}
}
if info != nil && !info.IsDir() {
return "", fmt.Errorf("%q is not a directory", pluginDir)
}
return pluginDir, nil
}
func LoadPlugin(pluginName string, integrity *PluginIntegrity) (PluginDefinition, error) {
var executable string
var err error
home, err := PluginHome()
if err != nil {
return PluginDefinition{}, err
}
executable = filepath.Join(home, pluginName, "export-plugin")
if strings.ContainsRune(pluginName, '/') {
executable, err = filepath.Abs(pluginName)
if err != nil {
return PluginDefinition{}, err
}
}
var checksum []byte
var sc *goplug.SecureConfig
if integrity == nil {
bomFile := filepath.Join(home, pluginName, "export-plugin.bom")
bomBytes, err := os.ReadFile(bomFile)
if err != nil {
return PluginDefinition{}, err
}
var bom BillOfMaterials
if err = toml.Unmarshal(bomBytes, &bom); err != nil {
return PluginDefinition{}, err
}
integrity = bom.Integrity
}
if integrity != nil {
checksum, err = hex.DecodeString(integrity.Checksum)
if err != nil {
return PluginDefinition{}, err
}
sc = &goplug.SecureConfig{
Hash: sha256.New(),
Checksum: checksum,
}
}
client := goplug.NewClient(&goplug.ClientConfig{
HandshakeConfig: plugin.HandshakeConfig,
VersionedPlugins: pluginMap,
Cmd: exec.Command(executable),
SecureConfig: sc,
Logger: hclog.New(&hclog.LoggerOptions{
Name: "plugin",
Level: hclog.Debug,
Output: io.Discard,
}),
})
c, err := client.Client()
if err != nil {
return PluginDefinition{}, fmt.Errorf("error creating plugin client: %w", err)
}
raw, err := c.Dispense("plugin")
if err != nil {
return PluginDefinition{}, fmt.Errorf("error loading plugin: %w", err)
}
ep, ok := raw.(plugin.ExportPlugin)
if !ok {
return PluginDefinition{}, errors.New("client did not dispense an ExportPlugin")
}
info, err := ep.Info()
if err != nil {
return PluginDefinition{}, err
}
return PluginDefinition{
info: info,
p: ep,
executable: executable,
client: client,
}, nil
}
func LoadPluginInfo(pluginName string, integrity *PluginIntegrity) (plugin.PluginInformation, error) {
pd, err := LoadPlugin(pluginName, integrity)
if err != nil {
return plugin.PluginInformation{}, err
}
defer pd.client.Kill()
return pd.PluginInfo(), nil
}