-
Notifications
You must be signed in to change notification settings - Fork 23
/
discord.go
262 lines (218 loc) · 7.47 KB
/
discord.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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
//
// Copyright 2023 The Chainloop Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package discord
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"mime/multipart"
"net/http"
"github.com/chainloop-dev/chainloop/app/controlplane/plugins/sdk/v1"
"github.com/go-kratos/kratos/v2/log"
)
type Integration struct {
*sdk.FanOutIntegration
}
// 1 - API schema definitions
type registrationRequest struct {
WebhookURL string `json:"webhook" jsonschema:"format=uri,description=URL of the discord webhook"`
Username string `json:"username,omitempty" jsonschema:"minLength=1,description=Override the default username of the webhook"`
}
type attachmentRequest struct{}
// 2 - Configuration state
type registrationState struct {
// Information from the webhook
WebhookName string `json:"name"`
WebhookOwner string `json:"owner"`
// Username to be used while posting the message
Username string `json:"username,omitempty"`
}
func New(l log.Logger) (sdk.FanOut, error) {
base, err := sdk.NewFanOut(
&sdk.NewParams{
ID: "discord-webhook",
Version: "1.1",
Description: "Send attestations to Discord",
Logger: l,
InputSchema: &sdk.InputSchema{
Registration: registrationRequest{},
Attachment: attachmentRequest{},
},
},
)
if err != nil {
return nil, err
}
return &Integration{base}, nil
}
type webhookResponse struct {
Name string `json:"name"`
User struct {
Username string `json:"username"`
} `json:"user"`
}
// Register is executed when a operator wants to register a specific instance of this integration with their Chainloop organization
func (i *Integration) Register(_ context.Context, req *sdk.RegistrationRequest) (*sdk.RegistrationResponse, error) {
i.Logger.Info("registration requested")
var request *registrationRequest
if err := sdk.FromConfig(req.Payload, &request); err != nil {
return nil, fmt.Errorf("invalid registration request: %w", err)
}
// Test the webhook URL and extract some information from it to use it as reference for the user
resp, err := http.Get(request.WebhookURL)
if err != nil {
return nil, fmt.Errorf("invalid webhook URL: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("invalid webhook URL, status: %s", resp.Status)
}
var webHookInfo webhookResponse
if err := json.NewDecoder(resp.Body).Decode(&webHookInfo); err != nil {
return nil, fmt.Errorf("invalid webhook URL: %w", err)
}
// Configuration State
config, err := sdk.ToConfig(®istrationState{
WebhookName: webHookInfo.Name,
WebhookOwner: webHookInfo.User.Username,
Username: request.Username,
})
if err != nil {
return nil, fmt.Errorf("marshalling configuration: %w", err)
}
return &sdk.RegistrationResponse{
Configuration: config,
// We treat the webhook URL as a sensitive field so we store it in the credentials storage
Credentials: &sdk.Credentials{Password: request.WebhookURL},
}, nil
}
// Attachment is executed when to attach a registered instance of this integration to a specific workflow
func (i *Integration) Attach(_ context.Context, _ *sdk.AttachmentRequest) (*sdk.AttachmentResponse, error) {
i.Logger.Info("attachment requested")
return &sdk.AttachmentResponse{}, nil
}
// Execute will be instantiated when either an attestation or a material has been received
// It's up to the plugin builder to differentiate between inputs
func (i *Integration) Execute(_ context.Context, req *sdk.ExecutionRequest) error {
i.Logger.Info("execution requested")
if err := validateExecuteRequest(req); err != nil {
return fmt.Errorf("running validation: %w", err)
}
var config *registrationState
if err := sdk.FromConfig(req.RegistrationInfo.Configuration, &config); err != nil {
return fmt.Errorf("invalid registration config: %w", err)
}
summary, err := sdk.SummaryTable(req)
if err != nil {
return fmt.Errorf("generating summary table: %w", err)
}
webhookURL := req.RegistrationInfo.Credentials.Password
if err := executeWebhook(webhookURL, config.Username, []byte(summary), "New Attestation Received"); err != nil {
return fmt.Errorf("error executing webhook: %w", err)
}
i.Logger.Info("execution finished")
return nil
}
// Send attestation to Discord
// https://discord.com/developers/docs/reference#uploading-files
// --boundary
// Content-Disposition: form-data; name="payload_json"
// Content-Type: application/json
//
// {
// "content": "New attestation!",
// "attachments": [{
// "id": 0,
// "filename": "attestation.json"
// }]
// }
//
// --boundary
// Content-Disposition: form-data; name="files[0]"; filename="statement.json"
// --boundary
func executeWebhook(webhookURL, usernameOverride string, statement []byte, msgContent string) error {
var b bytes.Buffer
multipartWriter := multipart.NewWriter(&b)
// webhook POST payload JSON
payload := payloadJSON{
Content: msgContent,
Username: usernameOverride,
Attachments: []payloadAttachment{
{
ID: 0,
Filename: "statement.txt",
},
},
}
payloadJSON, err := json.Marshal(payload)
if err != nil {
return fmt.Errorf("marshalling payload: %w", err)
}
payloadWriter, err := multipartWriter.CreateFormField("payload_json")
if err != nil {
return fmt.Errorf("creating payload form field: %w", err)
}
if _, err := payloadWriter.Write(payloadJSON); err != nil {
return fmt.Errorf("writing payload form field: %w", err)
}
// attach attestation JSON
attachmentWriter, err := multipartWriter.CreateFormFile("files[0]", "statement.txt")
if err != nil {
return fmt.Errorf("creating attachment form field: %w", err)
}
if _, err := attachmentWriter.Write(statement); err != nil {
return fmt.Errorf("writing attachment form field: %w", err)
}
// Needed to dump the content of the multipartWriter to the buffer
multipartWriter.Close()
// #nosec G107 - we are using a constant API URL that is not user input at this stage
r, err := http.Post(webhookURL, multipartWriter.FormDataContentType(), &b)
if err != nil {
return fmt.Errorf("creating request: %w", err)
}
defer r.Body.Close()
if r.StatusCode != http.StatusOK {
b, _ := io.ReadAll(r.Body)
return fmt.Errorf("non-OK HTTP status while calling the webhook: %d, body: %s", r.StatusCode, string(b))
}
return nil
}
type payloadJSON struct {
Content string `json:"content"`
Username string `json:"username,omitempty"`
Attachments []payloadAttachment `json:"attachments"`
}
type payloadAttachment struct {
ID int `json:"id"`
Filename string `json:"filename"`
}
func validateExecuteRequest(req *sdk.ExecutionRequest) error {
if req == nil || req.Input == nil {
return errors.New("execution input not received")
}
if req.Input.Attestation == nil {
return errors.New("execution input invalid, envelope is nil")
}
if req.RegistrationInfo == nil || req.RegistrationInfo.Configuration == nil {
return errors.New("missing registration configuration")
}
if req.RegistrationInfo.Credentials == nil {
return errors.New("missing credentials")
}
return nil
}