forked from aws/session-manager-plugin
/
startsession.go
289 lines (240 loc) · 8.21 KB
/
startsession.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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
// Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"). You may not
// use this file except in compliance with the License. A copy of the
// License is located at
//
// http://aws.amazon.com/apache2.0/
//
// or in the "license" file accompanying this file. This file 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 ssmclicommands contains all the commands with its implementation.
package ssmclicommands
import (
"bytes"
"errors"
"fmt"
"html/template"
"strings"
sdkSession "github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/ssm"
"github.com/aws/session-manager-plugin/src/datachannel"
"github.com/aws/session-manager-plugin/src/jsonutil"
"github.com/aws/session-manager-plugin/src/log"
"github.com/aws/session-manager-plugin/src/sdkutil"
"github.com/aws/session-manager-plugin/src/sessionmanagerplugin/session"
_ "github.com/aws/session-manager-plugin/src/sessionmanagerplugin/session/portsession"
_ "github.com/aws/session-manager-plugin/src/sessionmanagerplugin/session/shellsession"
"github.com/aws/session-manager-plugin/src/ssmclicommands/utils"
"github.com/twinj/uuid"
)
const (
START_SESSION = "start-session"
INSTANCE_ID = "instance-id"
REGION = "region"
PROFILE = "profile"
ENDPOINT = "endpoint"
DOCUMENT_NAME = "document-name"
PARAMETERS = "parameters"
)
var ParameterKeys = []string{INSTANCE_ID, REGION, PROFILE, ENDPOINT, DOCUMENT_NAME, PARAMETERS}
const START_SESSION_HELP = `NAME : {{.StartSessionName}}
SYNOPSIS:
{{.SsmCliName}}
{{.StartSessionName}}
{{.InstanceId}}
{{.Region}}
PARAMETERS:
{{.InstanceId}} (string) InstanceId
InstanceId is required to start a session
{{.Region}} (string) Region
Region is required if not configured in aws config file (https://docs.aws.amazon.com/credref/latest/refdocs/creds-config-files.html)
Command:
For any region,
{{.SsmCliName}} {{.StartSessionName}} --{{.InstanceId}} i-123456 --{{.Region}} us-east-1
For any aws credentials profile,
{{.SsmCliName}} {{.StartSessionName}} --{{.InstanceId}} i-123456 --{{.Profile}} profile-name
For any document with parameters,
{{.SsmCliName}} {{.StartSessionName}} --{{.InstanceId}} i-123456 --{{.DocumentName}} AWS-StartPortForwardingSession --{{.Parameters}} '{"localPortNumber":["6789"]}'
`
type StartSessionHelpParams struct {
SsmCliName string
StartSessionName string
InstanceId string
Region string
Profile string
Endpoint string
DocumentName string
Parameters string
}
type StartSessionCommand struct {
helpText string
sdk *ssm.SSM
}
//getSSMClient generate ssm client by configuration
var getSSMClient = func(log log.T, region string, profile string, endpoint string) (*ssm.SSM, error) {
sdkutil.SetRegionAndProfile(region, profile)
var sdkSession *sdkSession.Session
sdkSession, err := sdkutil.GetNewSessionWithEndpoint(endpoint)
if err != nil {
log.Errorf("Get session with endpoint Failed: %v", err)
return nil, err
}
return ssm.New(sdkSession), nil
}
//executeSession to open datachannel
var executeSession = func(log log.T, session *session.Session) (err error) {
return session.Execute(log)
}
// startSession trigger a sdk start session call.
var startSession = func(s *StartSessionCommand, input *ssm.StartSessionInput) (*ssm.StartSessionOutput, error) {
return s.sdk.StartSession(input)
}
func init() {
utils.Register(&StartSessionCommand{})
}
// Name is the command name used in the cli
func (StartSessionCommand) Name() string {
return START_SESSION
}
// Help prints help for the start-session cli command
func (c *StartSessionCommand) Help() string {
if len(c.helpText) == 0 {
t, _ := template.New("StartSessionHelp").Parse(START_SESSION_HELP)
params := StartSessionHelpParams{
utils.SsmCliName,
START_SESSION,
INSTANCE_ID,
REGION,
PROFILE,
ENDPOINT,
DOCUMENT_NAME,
PARAMETERS,
}
buf := new(bytes.Buffer)
t.Execute(buf, params)
c.helpText = buf.String()
}
return c.helpText
}
//validates and execute start-session command
func (s *StartSessionCommand) Execute(parameters map[string][]string) (error, string) {
var (
err error
region string
profile string
endpoint string
instanceId string
)
validation := s.validateStartSessionInput(parameters)
if len(validation) > 0 {
return errors.New(strings.Join(validation, "\n")), ""
}
log := log.Logger(true, "ssmcli")
if parameters[REGION] != nil {
region = parameters[REGION][0]
}
if parameters[PROFILE] != nil {
profile = parameters[PROFILE][0]
}
if parameters[ENDPOINT] != nil {
endpoint = parameters[ENDPOINT][0]
}
if parameters[INSTANCE_ID] != nil {
instanceId = parameters[INSTANCE_ID][0]
}
if s.sdk, err = getSSMClient(log, region, profile, endpoint); err != nil {
return err, "StartSession failed"
}
log.Infof("Calling StartSession API with parameters: %v", parameters)
sessionId, tokenValue, streamUrl, err := s.getStartSessionParams(log, parameters)
if err != nil {
log.Errorf("Error in getting start awsSession params: %v", err)
return err, "StartSession failed"
}
log.Infof("For SessionId: %s, StartSession returned streamUrl: %s", sessionId, streamUrl)
clientId := uuid.NewV4().String()
session := session.Session{
SessionId: sessionId,
StreamUrl: streamUrl,
TokenValue: tokenValue,
Endpoint: endpoint,
ClientId: clientId,
TargetId: instanceId,
DataChannel: &datachannel.DataChannel{},
}
if err = executeSession(log, &session); err != nil {
log.Errorf("Cannot perform start session: %v", err)
return err, "StartSession failed"
}
return err, "StartSession executed successfully"
}
//func to validate start-session input
func (StartSessionCommand) validateStartSessionInput(parameters map[string][]string) []string {
validation := make([]string, 0)
instanceIdValue := parameters[INSTANCE_ID]
//look for required parameters
if instanceIdValue == nil {
validation = append(validation, fmt.Sprintf("%v is required",
utils.FormatFlag(INSTANCE_ID)))
}
for key := range parameters {
if !contains(ParameterKeys, key) {
validation = append(validation, fmt.Sprintf("%v not a valid command parameter flag", key))
}
}
return validation
}
func contains(arr []string, item string) bool {
for _, v := range arr {
if v == item {
return true
}
}
return false
}
// function to get start-session parameters
func (s *StartSessionCommand) getStartSessionParams(log log.T, parameters map[string][]string) (string, string, string, error) {
//Fetch command token
uuid.SwitchFormat(uuid.CleanHyphen)
startSessionInput := ssm.StartSessionInput{
Target: ¶meters[INSTANCE_ID][0],
}
if parameters[DOCUMENT_NAME] != nil {
startSessionInput.DocumentName = ¶meters[DOCUMENT_NAME][0]
}
delete(parameters, INSTANCE_ID)
delete(parameters, DOCUMENT_NAME)
delete(parameters, REGION)
if parameters["parameters"] != nil && len(parameters["parameters"]) == 1 {
userParameters := make(map[string][]*string)
params := make(map[string][]string)
if err := jsonutil.Unmarshal(parameters[PARAMETERS][0], ¶ms); err != nil {
return "", "", "", fmt.Errorf("%v not valid input, get error: %v", PARAMETERS, err)
}
for k, v := range params {
values := make([]*string, len(v))
for index, element := range v {
value := element
values[index] = &value
}
userParameters[k] = values
}
startSessionInput.Parameters = userParameters
}
log.Infof("StartSession input parameters: %v", startSessionInput)
startSessionOutput, err := startSession(s, &startSessionInput)
if err != nil {
log.Errorf("StartSession Failed: %v", err)
return "", "", "", fmt.Errorf("start session failed with error: %v", err)
}
sessionId := startSessionOutput.SessionId
tokenValue := startSessionOutput.TokenValue
streamUrl := startSessionOutput.StreamUrl
if tokenValue == nil || sessionId == nil || streamUrl == nil {
return "", "", "", fmt.Errorf("token value or sessionId or streamUrl should not be empty. \n")
}
return *sessionId, *tokenValue, *streamUrl, err
}