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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
|
package ec2rolecreds
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"io/ioutil"
"reflect"
"strings"
"testing"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
sdkrand "github.com/aws/aws-sdk-go-v2/internal/rand"
"github.com/aws/aws-sdk-go-v2/internal/sdk"
"github.com/aws/smithy-go"
"github.com/aws/smithy-go/logging"
"github.com/aws/smithy-go/middleware"
)
const credsRespTmpl = `{
"Code": "Success",
"Type": "AWS-HMAC",
"AccessKeyId" : "accessKey",
"SecretAccessKey" : "secret",
"Token" : "token",
"Expiration" : "%s",
"LastUpdated" : "2009-11-23T00:00:00Z"
}`
const credsFailRespTmpl = `{
"Code": "ErrorCode",
"Message": "ErrorMsg",
"LastUpdated": "2009-11-23T00:00:00Z"
}`
type mockClient struct {
t *testing.T
roleName string
failAssume bool
expireOn string
}
func (c mockClient) GetMetadata(
ctx context.Context, params *imds.GetMetadataInput, optFns ...func(*imds.Options),
) (
*imds.GetMetadataOutput, error,
) {
switch params.Path {
case iamSecurityCredsPath:
return &imds.GetMetadataOutput{
Content: ioutil.NopCloser(strings.NewReader(c.roleName)),
}, nil
case iamSecurityCredsPath + c.roleName:
var w strings.Builder
if c.failAssume {
fmt.Fprintf(&w, credsFailRespTmpl)
} else {
fmt.Fprintf(&w, credsRespTmpl, c.expireOn)
}
return &imds.GetMetadataOutput{
Content: ioutil.NopCloser(strings.NewReader(w.String())),
}, nil
default:
return nil, fmt.Errorf("unexpected path, %v", params.Path)
}
}
var (
_ aws.AdjustExpiresByCredentialsCacheStrategy = (*Provider)(nil)
_ aws.HandleFailRefreshCredentialsCacheStrategy = (*Provider)(nil)
)
func TestProvider(t *testing.T) {
orig := sdk.NowTime
defer func() { sdk.NowTime = orig }()
p := New(func(options *Options) {
options.Client = mockClient{
roleName: "RoleName",
failAssume: false,
expireOn: "2014-12-16T01:51:37Z",
}
})
creds, err := p.Retrieve(context.Background())
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "accessKey", creds.AccessKeyID; e != a {
t.Errorf("Expect access key ID to match")
}
if e, a := "secret", creds.SecretAccessKey; e != a {
t.Errorf("Expect secret access key to match")
}
if e, a := "token", creds.SessionToken; e != a {
t.Errorf("Expect session token to match")
}
sdk.NowTime = func() time.Time {
return time.Date(2014, 12, 16, 0, 55, 37, 0, time.UTC)
}
if creds.Expired() {
t.Errorf("Expect not expired")
}
}
func TestProvider_FailAssume(t *testing.T) {
p := New(func(options *Options) {
options.Client = mockClient{
roleName: "RoleName",
failAssume: true,
expireOn: "2014-12-16T01:51:37Z",
}
})
creds, err := p.Retrieve(context.Background())
if err == nil {
t.Fatalf("expect error, got none")
}
var apiErr smithy.APIError
if !errors.As(err, &apiErr) {
t.Fatalf("expect %T error, got %v", apiErr, err)
}
if e, a := "ErrorCode", apiErr.ErrorCode(); e != a {
t.Errorf("expect %v code, got %v", e, a)
}
if e, a := "ErrorMsg", apiErr.ErrorMessage(); e != a {
t.Errorf("expect %v message, got %v", e, a)
}
nestedErr := errors.Unwrap(apiErr)
if nestedErr != nil {
t.Fatalf("expect no nested error, got %v", err)
}
if e, a := "", creds.AccessKeyID; e != a {
t.Errorf("Expect access key ID to match")
}
if e, a := "", creds.SecretAccessKey; e != a {
t.Errorf("Expect secret access key to match")
}
if e, a := "", creds.SessionToken; e != a {
t.Errorf("Expect session token to match")
}
}
func TestProvider_IsExpired(t *testing.T) {
orig := sdk.NowTime
defer func() { sdk.NowTime = orig }()
p := New(func(options *Options) {
options.Client = mockClient{
roleName: "RoleName",
failAssume: false,
expireOn: "2014-12-16T01:51:37Z",
}
})
sdk.NowTime = func() time.Time {
return time.Date(2014, 12, 16, 0, 55, 37, 0, time.UTC)
}
creds, err := p.Retrieve(context.Background())
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if creds.Expired() {
t.Errorf("expect not to be expired")
}
sdk.NowTime = func() time.Time {
return time.Date(2014, 12, 16, 1, 55, 37, 0, time.UTC)
}
if !creds.Expired() {
t.Errorf("expect to be expired")
}
}
type byteReader byte
func (b byteReader) Read(p []byte) (int, error) {
for i := 0; i < len(p); i++ {
p[i] = byte(b)
}
return len(p), nil
}
func TestProvider_HandleFailToRetrieve(t *testing.T) {
origTime := sdk.NowTime
defer func() { sdk.NowTime = origTime }()
sdk.NowTime = func() time.Time {
return time.Date(2014, 04, 04, 0, 1, 0, 0, time.UTC)
}
origRand := sdkrand.Reader
defer func() { sdkrand.Reader = origRand }()
sdkrand.Reader = byteReader(0)
cases := map[string]struct {
creds aws.Credentials
err error
randReader io.Reader
expectCreds aws.Credentials
expectErr string
expectLogged string
}{
"expired low": {
randReader: byteReader(0),
creds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(-5 * time.Minute),
},
err: fmt.Errorf("some error"),
expectCreds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(5 * time.Minute),
},
expectLogged: fmt.Sprintf("again in 5 minutes"),
},
"expired high": {
randReader: byteReader(0xFF),
creds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(-5 * time.Minute),
},
err: fmt.Errorf("some error"),
expectCreds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(14*time.Minute + 59*time.Second),
},
expectLogged: fmt.Sprintf("again in 14 minutes"),
},
"not expired": {
randReader: byteReader(0xFF),
creds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(10 * time.Minute),
},
err: fmt.Errorf("some error"),
expectCreds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(10 * time.Minute),
},
},
"cannot expire": {
randReader: byteReader(0xFF),
creds: aws.Credentials{
CanExpire: false,
},
err: fmt.Errorf("some error"),
expectErr: "some error",
},
}
for name, c := range cases {
t.Run(name, func(t *testing.T) {
sdkrand.Reader = c.randReader
if sdkrand.Reader == nil {
sdkrand.Reader = byteReader(0)
}
var logBuf bytes.Buffer
logger := logging.LoggerFunc(func(class logging.Classification, format string, args ...interface{}) {
fmt.Fprintf(&logBuf, string(class)+" "+format, args...)
})
ctx := middleware.SetLogger(context.Background(), logger)
p := New()
creds, err := p.HandleFailToRefresh(ctx, c.creds, c.err)
if err == nil && len(c.expectErr) != 0 {
t.Fatalf("expect error %v, got none", c.expectErr)
}
if err != nil && len(c.expectErr) == 0 {
t.Fatalf("expect no error, got %v", err)
}
if err != nil && !strings.Contains(err.Error(), c.expectErr) {
t.Fatalf("expect error to contain %v, got %v", c.expectErr, err)
}
if c.expectErr != "" {
return
}
if len(c.expectLogged) != 0 && logBuf.Len() == 0 {
t.Errorf("expect %v logged, got none", c.expectLogged)
}
if e, a := c.expectLogged, logBuf.String(); !strings.Contains(a, e) {
t.Errorf("expect %v to be logged in %v", e, a)
}
// Truncate time so it can be easily compared.
creds.Expires = creds.Expires.Truncate(time.Second)
if diff := cmpDiff(c.expectCreds, creds); diff != "" {
t.Errorf("expect creds match\n%s", diff)
}
})
}
}
func TestProvider_AdjustExpiresBy(t *testing.T) {
origTime := sdk.NowTime
defer func() { sdk.NowTime = origTime }()
sdk.NowTime = func() time.Time {
return time.Date(2014, 04, 04, 0, 1, 0, 0, time.UTC)
}
cases := map[string]struct {
creds aws.Credentials
dur time.Duration
expectCreds aws.Credentials
}{
"modify expires": {
creds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(1 * time.Hour),
},
dur: -5 * time.Minute,
expectCreds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(55 * time.Minute),
},
},
"expiry too soon": {
creds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(14*time.Minute + 59*time.Second),
},
dur: -5 * time.Minute,
expectCreds: aws.Credentials{
CanExpire: true,
Expires: sdk.NowTime().Add(14*time.Minute + 59*time.Second),
},
},
"cannot expire": {
creds: aws.Credentials{
CanExpire: false,
},
dur: 10 * time.Minute,
expectCreds: aws.Credentials{
CanExpire: false,
},
},
}
for name, c := range cases {
t.Run(name, func(t *testing.T) {
p := New()
creds, err := p.AdjustExpiresBy(c.creds, c.dur)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if diff := cmpDiff(c.expectCreds, creds); diff != "" {
t.Errorf("expect creds match\n%s", diff)
}
})
}
}
func cmpDiff(e, a interface{}) string {
if !reflect.DeepEqual(e, a) {
return fmt.Sprintf("%v != %v", e, a)
}
return ""
}
|