mirror of
https://github.com/versity/versitygw.git
synced 2026-08-18 13:16:31 +00:00
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.
157 lines
5.5 KiB
Go
157 lines
5.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 integration
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/aws/aws-sdk-go-v2/aws"
|
|
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
|
|
"github.com/aws/aws-sdk-go-v2/service/iam"
|
|
iamtypes "github.com/aws/aws-sdk-go-v2/service/iam/types"
|
|
"github.com/versity/versitygw/iamapi/iamerr"
|
|
)
|
|
|
|
func IAMGetUser_long_user_name(s *S3Conf) error {
|
|
testName := "IAMGetUser_long_user_name"
|
|
return iamActionHandler(s, testName, func(client *iam.Client) error {
|
|
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
|
|
defer cancel()
|
|
_, err := client.GetUser(ctx, &iam.GetUserInput{
|
|
UserName: aws.String(strings.Repeat("a", 129)),
|
|
})
|
|
return checkIAMApiErr(err, iamerr.UserNameTooLong("userName", 128))
|
|
})
|
|
}
|
|
|
|
func IAMGetUser_invalid_user_name(s *S3Conf) error {
|
|
testName := "IAMGetUser_invalid_user_name"
|
|
return iamActionHandler(s, testName, func(client *iam.Client) error {
|
|
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
|
|
defer cancel()
|
|
_, err := client.GetUser(ctx, &iam.GetUserInput{
|
|
UserName: aws.String("invalid/user"),
|
|
})
|
|
return checkIAMApiErr(err, iamerr.InvalidUserName("userName"))
|
|
})
|
|
}
|
|
|
|
func IAMGetUser_non_existing_user(s *S3Conf) error {
|
|
testName := "IAMGetUser_non_existing_user"
|
|
return iamActionHandler(s, testName, func(client *iam.Client) error {
|
|
const userName = "asdkjnfkj"
|
|
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
|
|
defer cancel()
|
|
_, err := client.GetUser(ctx, &iam.GetUserInput{UserName: aws.String(userName)})
|
|
return checkIAMApiErr(err, iamerr.NoSuchEntityUser(userName))
|
|
})
|
|
}
|
|
|
|
func IAMGetUser_success(s *S3Conf) error {
|
|
testName := "IAMGetUser_success"
|
|
return iamActionHandler(s, testName, func(client *iam.Client) error {
|
|
userName := newIAMUserName()
|
|
_, err := createIAMUser(client, &iam.CreateUserInput{
|
|
UserName: &userName,
|
|
Tags: []iamtypes.Tag{
|
|
{Key: aws.String("team"), Value: aws.String("integration")},
|
|
{Key: aws.String("purpose"), Value: aws.String("get-user")},
|
|
},
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
|
|
out, err := client.GetUser(ctx, &iam.GetUserInput{UserName: &userName})
|
|
cancel()
|
|
if err != nil {
|
|
deleteErr := deleteIAMUser(client, userName)
|
|
if deleteErr != nil {
|
|
return fmt.Errorf("get user: %v; delete user: %w", err, deleteErr)
|
|
}
|
|
return err
|
|
}
|
|
|
|
checkErr := func() error {
|
|
if out == nil || out.User == nil {
|
|
return fmt.Errorf("expected GetUser output user")
|
|
}
|
|
|
|
user := out.User
|
|
if aws.ToString(user.Path) != "/" {
|
|
return fmt.Errorf("expected user path to be %q, instead got %q", "/", aws.ToString(user.Path))
|
|
}
|
|
if aws.ToString(user.UserName) != userName {
|
|
return fmt.Errorf("expected user name to be %q, instead got %q", userName, aws.ToString(user.UserName))
|
|
}
|
|
expectedARN := "arn:aws:iam::000000000000:user/" + userName
|
|
if aws.ToString(user.Arn) != expectedARN {
|
|
return fmt.Errorf("expected user ARN to be %q, instead got %q", expectedARN, aws.ToString(user.Arn))
|
|
}
|
|
if !integrationIAMUserIDPattern.MatchString(aws.ToString(user.UserId)) {
|
|
return fmt.Errorf("expected AWS IAM user id, instead got %q", aws.ToString(user.UserId))
|
|
}
|
|
if user.CreateDate == nil || user.CreateDate.IsZero() {
|
|
return fmt.Errorf("expected user create date")
|
|
}
|
|
if len(user.Tags) != 2 ||
|
|
aws.ToString(user.Tags[0].Key) != "team" || aws.ToString(user.Tags[0].Value) != "integration" ||
|
|
aws.ToString(user.Tags[1].Key) != "purpose" || aws.ToString(user.Tags[1].Value) != "get-user" {
|
|
return fmt.Errorf("expected user tags team=integration and purpose=get-user, instead got %#v", user.Tags)
|
|
}
|
|
if requestID, ok := awsmiddleware.GetRequestIDMetadata(out.ResultMetadata); !ok || requestID == "" {
|
|
return fmt.Errorf("expected GetUser response request id")
|
|
}
|
|
|
|
return nil
|
|
}()
|
|
|
|
deleteErr := deleteIAMUser(client, userName)
|
|
if checkErr != nil {
|
|
return checkErr
|
|
}
|
|
return deleteErr
|
|
})
|
|
}
|
|
|
|
func IAMGetUser_root_user(s *S3Conf) error {
|
|
testName := "IAMGetUser_root_user"
|
|
return iamActionHandler(s, testName, func(client *iam.Client) error {
|
|
ctx, cancel := context.WithTimeout(context.Background(), shortTimeout)
|
|
defer cancel()
|
|
out, err := client.GetUser(ctx, &iam.GetUserInput{UserName: aws.String("")})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if out == nil || out.User == nil {
|
|
return fmt.Errorf("expected GetUser output root user")
|
|
}
|
|
if aws.ToString(out.User.Arn) != "arn:aws:iam::000000000000:root" {
|
|
return fmt.Errorf("expected root user ARN, instead got %q", aws.ToString(out.User.Arn))
|
|
}
|
|
if aws.ToString(out.User.UserId) != "000000000000" {
|
|
return fmt.Errorf("expected root user id to be %q, instead got %q", "000000000000", aws.ToString(out.User.UserId))
|
|
}
|
|
if requestID, ok := awsmiddleware.GetRequestIDMetadata(out.ResultMetadata); !ok || requestID == "" {
|
|
return fmt.Errorf("expected GetUser response request id")
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|