Files
versitygw/iamapi/router_test.go
T
niksis02 3227a629dc feat: add AWS-compatible standalone IAM service
Closes #1640

Add a standalone AWS IAM Query API implementation for managing IAM users through standard AWS SDKs and the AWS CLI.

Server usage

Start the IAM server with internal file-backed storage:

    mkdir -p /tmp/versitygw-iam
    ./versitygw --port 127.0.0.1:7070 --access user --secret pass iam --dir /tmp/versitygw-iam

Start the IAM server with Vault KV v2 storage using AppRole:

    VGW_IAM_VAULT_ROLE_SECRET=<role-secret> ./versitygw --port 127.0.0.1:7070 --access user --secret pass iam --vault-endpoint-url http://127.0.0.1:8200 --vault-auth-method approle --vault-role-id <role-id> --vault-mount-path kv --vault-secret-storage-path iam

Vault authentication also supports root tokens, separate authentication and secret-storage namespaces, custom mount paths, server certificate validation, and mutual TLS client certificates.

Configure the AWS CLI credentials used by the IAM server:

    export AWS_ACCESS_KEY_ID=user
    export AWS_SECRET_ACCESS_KEY=pass
    export AWS_DEFAULT_REGION=us-east-1

Implemented IAM actions

CreateUser creates an IAM user with an AWS-compatible ARN, generated AIDA user ID, creation timestamp, optional path, and tags. It validates usernames, paths, tag limits, reserved tag prefixes, duplicate tag keys, and existing users.

    aws --endpoint-url http://127.0.0.1:7070 iam create-user --user-name bob

    aws --endpoint-url http://127.0.0.1:7070 iam create-user --user-name bob --path /engineering/ --tags Key=team,Value=storage

GetUser returns a stored user or the root identity when requested without a username through the IAM Query API.

    aws --endpoint-url http://127.0.0.1:7070 iam get-user --user-name bob

ListUsers returns users in deterministic username order and supports path filtering, marker-based pagination, and MaxItems limits.

    aws --endpoint-url http://127.0.0.1:7070 iam list-users

    aws --endpoint-url http://127.0.0.1:7070 iam list-users --path-prefix /engineering/ --max-items 100

UpdateUser updates the username and/or path, recalculates the user ARN, and rejects conflicts with existing users.

    aws --endpoint-url http://127.0.0.1:7070 iam update-user --user-name bob --new-user-name robert --new-path /platform/

DeleteUser permanently removes an IAM user and returns AWS-compatible errors for missing users.

    aws --endpoint-url http://127.0.0.1:7070 iam delete-user --user-name robert

IAM protocol and authentication

- Support the AWS IAM Query protocol version 2010-05-08 over GET and POST form requests.
- Return AWS-compatible XML responses, error documents, status codes, request IDs, user metadata, and pagination fields.
- Authenticate root credentials with AWS Signature Version 4 for the IAM service in us-east-1.
- Support both Authorization-header and query-string SigV4 authentication.
- Validate credential scope, signed headers, timestamps, clock skew, content length, signatures, and unsupported signature or session-token modes.
- Add IAM-specific validation and error mapping for malformed requests, invalid actions, duplicate entities, missing users, throttling, and internal failures.

Storage implementations

- Add an internal JSON-backed store using iam.json and iam.json.backup with atomic temporary-file replacement, concurrent access protection, stable ordering, pagination, and persistence across restarts.
- Add a Vault KV v2 store with one secret per user, CAS-based duplicate protection, permanent deletion, AppRole reauthentication, namespace support, configurable authentication and KV mounts, root-token authentication, and TLS/mTLS configuration.
- Introduce a common Storer interface and require exactly one storage backend to be configured.

Server and embedding support

- Register the new `versitygw iam` command with environment-variable and CLI configuration for both storage backends.
- Add `embedgw.RunIAMAPI` and `IAMConfig` for embedding the IAM service in Go applications.

Gateway-level internal packages

- Add `internal/iamstore` as a reusable generic file-backed IAM persistence engine and migrate the existing gateway internal IAM service to it.
- Add `internal/sigv4auth` for shared SigV4 header and presigned-query parsing, canonical request generation, signature verification, and structured authentication errors.
- Refactor the S3 authentication paths to use the shared SigV4 implementation while preserving S3-specific error responses.
- Add `internal/httpctx` for shared Fiber context keys and AWS-style request ID handling.
- Add `internal/routekit` for shared query, form, and header route matchers.
- Add `internal/netutil` for reusable certificate storage, hostname-aware listeners, multi-address serving, TLS listeners, and UNIX socket handling.
- Update the custom SigV4 signer to honor an explicitly supplied signed-header list so unrelated headers do not alter IAM signatures.

Testing and CI

- Add AWS IAM SDK-based integration coverage for all supported user actions, header authentication, query authentication, validation, errors, filtering, and pagination.
- Split standalone IAM tests into `versitygw test iam` and retain existing gateway IAM tests under `versitygw test gw-iam`.
- Add unit coverage for controllers, authentication, routing, storage, embedding, listeners, request matching, persistence, and signing behavior.
- Add `runiamtests.sh` to exercise internal storage over HTTP and HTTPS plus Vault storage through AppRole.
- Add a dedicated IAM functional-test workflow with a Vault service and merged runtime coverage reporting.
- Include the IAM test runner in shellcheck and add the AWS IAM SDK dependency.
2026-08-15 17:38:14 +04:00

207 lines
6.5 KiB
Go

// Copyright 2026 Versity Software
// This file is 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 iamapi
import (
"bytes"
"io"
"net/http"
"net/http/httptest"
"strconv"
"testing"
"github.com/gofiber/fiber/v3"
"github.com/versity/versitygw/iamapi/internal/iammiddleware"
)
func TestIAMApiRouter_InitRegistersGetAndPostActionRoutesForAnyPath(t *testing.T) {
app := fiber.New()
router := &IAMApiRouter{app: app}
router.Init()
methodCounts := map[string]int{}
for _, routes := range app.Stack() {
for _, route := range routes {
if route.Path != "/*" {
continue
}
methodCounts[route.Method]++
}
}
// GET and POST each have an action route plus the all-method fallback;
// other methods have only the fallback.
if methodCounts[http.MethodGet] != 2 || methodCounts[http.MethodPost] != 2 || methodCounts[http.MethodPut] != 1 {
t.Fatalf("wildcard route method counts = %v", methodCounts)
}
}
func TestIAMApiRouter_RouteActionDetectsQueryAction(t *testing.T) {
app := fiber.New()
router := &IAMApiRouter{
actions: map[string]ActionHandler{
"GetUser": func(ctx fiber.Ctx) (*Response, error) {
return &Response{Status: http.StatusAccepted}, nil
},
},
}
app.Get("/", ProcessHandlers(router.routeAction))
resp, err := app.Test(httptest.NewRequest(http.MethodGet, "/?Action=GetUser&Version="+iamAPIVersion, nil))
if err != nil {
t.Fatalf("app.Test: %v", err)
}
if resp.StatusCode != http.StatusAccepted {
t.Fatalf("status = %d, want %d", resp.StatusCode, http.StatusAccepted)
}
}
func TestIAMApiRouter_RouteActionDetectsFormAction(t *testing.T) {
app := fiber.New()
router := &IAMApiRouter{
actions: map[string]ActionHandler{
"CreateUser": func(ctx fiber.Ctx) (*Response, error) {
return &Response{Status: http.StatusCreated}, nil
},
},
}
app.Post("/", ProcessHandlers(router.routeAction))
req := httptest.NewRequest(http.MethodPost, "/", bytes.NewBufferString("Action=CreateUser&Version="+iamAPIVersion))
req.Header.Set("Content-Type", fiber.MIMEApplicationForm)
resp, err := app.Test(req)
if err != nil {
t.Fatalf("app.Test: %v", err)
}
if resp.StatusCode != http.StatusCreated {
t.Fatalf("status = %d, want %d", resp.StatusCode, http.StatusCreated)
}
}
func TestIAMApiRouter_RouteActionValidatesVersionBeforeAction(t *testing.T) {
tests := []struct {
name string
target string
message string
}{
{
name: "missing version",
target: "/?Action=ListUsers",
message: "Could not find operation ListUsers for version NO_VERSION_SPECIFIED",
},
{
name: "invalid version",
target: "/?Action=ListUsers&Version=this-is-custom-invalid-version",
message: "Could not find operation ListUsers for version this-is-custom-invalid-version",
},
{
name: "unknown action",
target: "/?Action=ListUserssssss&Version=" + iamAPIVersion,
message: "Could not find operation ListUserssssss for version 2010-05-08",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
app := fiber.New()
router := &IAMApiRouter{actions: map[string]ActionHandler{}}
app.Get("/", ProcessHandlers(router.routeAction))
resp, err := app.Test(httptest.NewRequest(http.MethodGet, tt.target, nil))
if err != nil {
t.Fatalf("app.Test: %v", err)
}
requireIAMError(t, resp, http.StatusBadRequest, "Sender", "InvalidAction", tt.message)
})
}
}
func TestIAMApiRouter_ActionRoutesMatchAnyPath(t *testing.T) {
app := fiber.New(fiber.Config{ErrorHandler: iammiddleware.GlobalErrorHandler})
router := &IAMApiRouter{app: app, rootCreds: &testRoot}
router.Init()
resp, err := app.Test(httptest.NewRequest(http.MethodGet, "/any/nested/path?Action=ListUsers&Version="+iamAPIVersion, nil))
if err != nil {
t.Fatalf("GET app.Test: %v", err)
}
requireIAMError(t, resp, http.StatusForbidden, "Sender", "MissingAuthenticationToken", "Request is missing Authentication Token")
req := httptest.NewRequest(http.MethodPost, "/another/path", bytes.NewBufferString("Action=ListUsers&Version="+iamAPIVersion))
req.Header.Set("Content-Type", fiber.MIMEApplicationForm)
resp, err = app.Test(req)
if err != nil {
t.Fatalf("POST app.Test: %v", err)
}
requireIAMError(t, resp, http.StatusForbidden, "Sender", "MissingAuthenticationToken", "Request is missing Authentication Token")
}
func TestIAMApiRouter_RootWithoutActionRedirects(t *testing.T) {
app := fiber.New()
router := &IAMApiRouter{app: app}
router.Init()
resp, err := app.Test(httptest.NewRequest(http.MethodGet, "/", nil))
if err != nil {
t.Fatalf("app.Test: %v", err)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("read body: %v", err)
}
if resp.StatusCode != http.StatusFound {
t.Fatalf("status = %d, want %d", resp.StatusCode, http.StatusFound)
}
if got := resp.Header.Get("Location"); got != productURL {
t.Fatalf("Location = %q, want %q", got, productURL)
}
if got := resp.Header.Get(HeaderAmznRequestID); got == "" {
t.Fatal("missing x-amzn-RequestId")
}
if got := resp.Header.Get("Content-Length"); got != "0" {
t.Fatalf("Content-Length = %q, want 0", got)
}
if len(body) != 0 {
t.Fatalf("body = %q, want empty", string(body))
}
}
func TestIAMApiRouter_UnmatchedRouteReturnsUnknownOperation(t *testing.T) {
app := fiber.New()
router := &IAMApiRouter{app: app}
router.Init()
resp, err := app.Test(httptest.NewRequest(http.MethodGet, "/not-an-action-route", nil))
if err != nil {
t.Fatalf("app.Test: %v", err)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("read body: %v", err)
}
if resp.StatusCode != http.StatusNotFound {
t.Fatalf("status = %d, want %d", resp.StatusCode, http.StatusNotFound)
}
if string(body) != string(unknownOperationBody) {
t.Fatalf("body = %q, want %q", string(body), string(unknownOperationBody))
}
if got := resp.Header.Get("Content-Length"); got != strconv.Itoa(len(unknownOperationBody)) {
t.Fatalf("Content-Length = %q, want %d", got, len(unknownOperationBody))
}
if got := resp.Header.Get(HeaderAmznRequestID); got == "" {
t.Fatal("missing x-amzn-RequestId")
}
}