Skip to content

Ministack: Free, open-source local AWS emulator - 60+ services, Terraform compatible, real databases. Free forever. MIT licensed.

feat(transfer): add AWS Transfer Family service (10 operations) (#330)

Matt Davidson6adbb90d8b9d
diff --git a/CHANGELOG.md b/CHANGELOG.md
index bdb25c1c..04b9213d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,8 @@ Versioning follows [Semantic Versioning](https://semver.org/).
## [Unreleased]
+### Added
+- **Transfer Family** — new service: CreateServer, DescribeServer, DeleteServer, ListServers, CreateUser, DescribeUser, DeleteUser, ListUsers, ImportSshPublicKey, DeleteSshPublicKey. 10 operations covering SFTP server/user management with SSH key rotation and LOGICAL home directory mappings to S3. 19 integration tests.
### Fixed
- **Cognito `cognito:groups` missing from tokens** — `initiate_auth` and `admin_initiate_auth` now include the `cognito:groups` claim in both access and ID tokens when the user belongs to one or more groups. Real AWS Cognito includes this claim automatically; MiniStack was not threading the already-populated `_groups` list through to the JWT builder.
diff --git a/README.md b/README.md
index ae3b3ad6..9dae8573 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
<h1 align="center">MiniStack</h1>
<p align="center"><strong>Free, open-source local AWS emulator. Free forever.</strong></p>
-<p align="center">42 AWS services on a single port · Terraform compatible · Real databases · MIT licensed</p>
+<p align="center">43 AWS services on a single port · Terraform compatible · Real databases · MIT licensed</p>
<p align="center">
<a href="https://github.com/ministackorg/ministack/releases"><img src="https://img.shields.io/github/v/release/ministackorg/ministack" alt="GitHub release"></a>
@@ -26,7 +26,7 @@
LocalStack recently moved its core services behind a paid plan. If you relied on LocalStack Community for local development and CI/CD pipelines, MiniStack is your free alternative.
-- **42 AWS services** emulated on a single port (4566)
+- **43 AWS services** emulated on a single port (4566)
- **Drop-in compatible** — works with `boto3`, AWS CLI, Terraform, CDK, Pulumi, any SDK
- **Real infrastructure** — RDS spins up actual Postgres/MySQL containers, ElastiCache spins up real Redis, Athena runs real SQL via DuckDB, ECS runs real Docker containers
- **Tiny footprint** — ~270MB image, ~45MB RAM at idle vs LocalStack's ~1GB image and ~500MB RAM
@@ -479,6 +479,7 @@ Unsupported resource types fail with `CREATE_FAILED` (or `ROLLBACK_COMPLETE` if
| **AutoScaling** | CreateAutoScalingGroup, DescribeAutoScalingGroups, UpdateAutoScalingGroup, DeleteAutoScalingGroup, DescribeAutoScalingInstances, CreateLaunchConfiguration, DescribeLaunchConfigurations, DeleteLaunchConfiguration, PutScalingPolicy, DescribePolicies, DeletePolicy, PutLifecycleHook, DescribeLifecycleHooks, DeleteLifecycleHook, CompleteLifecycleAction, RecordLifecycleActionHeartbeat, PutScheduledUpdateGroupAction, DescribeScheduledActions, DeleteScheduledAction, CreateOrUpdateTags, DescribeTags, DeleteTags | 22 actions; in-memory state — no real instance scaling; full ASG lifecycle (launch configs, scaling policies, lifecycle hooks, scheduled actions, tags); CDK/Terraform compatible |
| **CodeBuild** | CreateProject, BatchGetProjects, ListProjects, UpdateProject, DeleteProject, StartBuild, BatchGetBuilds, StopBuild, ListBuilds, ListBuildsForProject, BatchDeleteBuilds | 11 actions; builds complete immediately with SUCCEEDED status; project and build metadata stored in-memory |
| **AppConfig** | CreateApplication, GetApplication, ListApplications, UpdateApplication, DeleteApplication, CreateEnvironment, GetEnvironment, ListEnvironments, UpdateEnvironment, DeleteEnvironment, CreateConfigurationProfile, GetConfigurationProfile, ListConfigurationProfiles, UpdateConfigurationProfile, DeleteConfigurationProfile, CreateHostedConfigurationVersion, GetHostedConfigurationVersion, ListHostedConfigurationVersions, DeleteHostedConfigurationVersion, CreateDeploymentStrategy, GetDeploymentStrategy, ListDeploymentStrategies, UpdateDeploymentStrategy, DeleteDeploymentStrategy, StartDeployment, GetDeployment, ListDeployments, StopDeployment, TagResource, UntagResource, ListTagsForResource, StartConfigurationSession, GetLatestConfiguration | 33 operations; control plane + data plane; hosted configuration versions; deployments complete immediately; session-based configuration retrieval with token rotation |
+| **Transfer Family** | CreateServer, DescribeServer, DeleteServer, ListServers, CreateUser, DescribeUser, DeleteUser, ListUsers, ImportSshPublicKey, DeleteSshPublicKey | 10 operations; SFTP server and user management; SSH key rotation; LOGICAL home directory mappings to S3; in-memory state |
---
@@ -686,7 +687,7 @@ Install DuckDB for full Athena SQL compatibility: `pip install ministack[full]`.
When `PERSIST_STATE=1`, MiniStack saves service state to `STATE_DIR` on shutdown and reloads it on startup. Writes are atomic (write-to-tmp then rename) to prevent corruption on crash.
-Services currently supporting persistence: **All 42 services** — API Gateway v1/v2, ALB, ACM, AppConfig, AppSync, Athena, Cloud Map, CloudFront, CloudWatch, CloudWatch Logs, CodeBuild, Cognito, DynamoDB, EC2, ECR, ECS, EFS, ElastiCache, EMR, EventBridge, Firehose, Glue, IAM/STS, Kinesis, KMS, Lambda, RDS, Route 53, S3, Secrets Manager, SES, SES v2, SNS, SQS, SSM, Step Functions, WAF v2
+Services currently supporting persistence: **All 43 services** — API Gateway v1/v2, ALB, ACM, AppConfig, AppSync, Athena, Cloud Map, CloudFront, CloudWatch, CloudWatch Logs, CodeBuild, Cognito, DynamoDB, EC2, ECR, ECS, EFS, ElastiCache, EMR, EventBridge, Firehose, Glue, IAM/STS, Kinesis, KMS, Lambda, RDS, Route 53, S3, Secrets Manager, SES, SES v2, SNS, SQS, SSM, Step Functions, Transfer Family, WAF v2
```bash
docker run -p 4566:4566 \
@@ -784,7 +785,7 @@ pip install boto3 pytest duckdb docker cbor2
# Start MiniStack
docker compose up -d
-# Run the full test suite (1,188 tests across all 42 services)
+# Run the full test suite (1,207 tests across all 43 services)
pytest tests/ -v
```
@@ -980,6 +981,7 @@ See [`Testcontainers/java-testcontainers`](Testcontainers/java-testcontainers),
| **AppSync** | ✅ | NO | ✅ |
| **Cloud Map** | ✅ | ❌ | ✅ |
| **CodeBuild** | ✅ | ✅ | ✅ |
+| **Transfer Family** | ✅ | ❌ | ❌ |
| **S3 Files** | ✅ | ❌ | ❌ |
| Cost | **Free forever** | Was free, now paid | $35+/mo |
| Docker image size | ~250MB | ~1GB | ~1GB |
diff --git a/ministack/app.py b/ministack/app.py
index 41accdf0..b9e10292 100644
--- a/ministack/app.py
+++ b/ministack/app.py
@@ -82,6 +82,7 @@ from ministack.services import (
servicediscovery,
s3files,
codebuild,
+ transfer,
)
from ministack.services import iam_sts
from ministack.services.iam_sts import handle_iam_request, handle_sts_request
@@ -131,6 +132,7 @@ SERVICE_HANDLERS = {
"kms": kms.handle_request,
"cloudfront": cloudfront.handle_request,
"codebuild": codebuild.handle_request,
+ "transfer": transfer.handle_request,
"appsync": appsync.handle_request,
"servicediscovery": servicediscovery.handle_request,
"s3files": s3files.handle_request,
@@ -193,7 +195,7 @@ BANNER = r"""
SSM, EventBridge, Kinesis, CloudWatch, SES, SES v2, ACM, WAF v2, Step Functions,
ECS, RDS, ElastiCache, Glue, Athena, API Gateway, Firehose, Route53,
Cognito, EC2, EMR, EBS, EFS, ALB/ELBv2, CloudFormation, KMS, ECR, CloudFront,
- AppSync, Cloud Map, S3 Files, RDS Data API, CodeBuild, AppConfig
+ AppSync, Cloud Map, S3 Files, RDS Data API, CodeBuild, AppConfig, Transfer
"""
@@ -516,7 +518,7 @@ async def app(scope, receive, send):
_non_s3_hosts = {"s3", "s3-control", "sqs", "sns", "dynamodb", "lambda", "iam", "sts",
"secretsmanager", "logs", "ssm", "events", "kinesis",
"monitoring", "ses", "states", "ecs", "rds", "rds-data", "elasticache",
- "glue", "athena", "apigateway", "cloudformation", "autoscaling", "codebuild"}
+ "glue", "athena", "apigateway", "cloudformation", "autoscaling", "codebuild", "transfer"}
if bucket not in _non_s3_hosts:
vhost_path = "/" + bucket + path if path != "/" else "/" + bucket + "/"
try:
@@ -653,6 +655,7 @@ async def _handle_lifespan(scope, receive, send):
"emr": emr.get_state,
"cloudfront": cloudfront.get_state,
"codebuild": codebuild.get_state,
+ "transfer": transfer.get_state,
"acm": acm.get_state,
"firehose": firehose.get_state,
"ses": ses.get_state,
@@ -836,6 +839,7 @@ def _reset_all_state():
(kms, kms.reset),
(cloudfront, cloudfront.reset),
(codebuild, codebuild.reset),
+ (transfer, transfer.reset),
(ecr, ecr.reset),
(appsync, appsync.reset),
(servicediscovery, servicediscovery.reset),
diff --git a/ministack/core/router.py b/ministack/core/router.py
index 48e98290..9ab334c6 100644
--- a/ministack/core/router.py
+++ b/ministack/core/router.py
@@ -167,6 +167,11 @@ SERVICE_PATTERNS = {
"host_patterns": [r"codebuild\."],
"credential_scope": "codebuild",
},
+ "transfer": {
+ "target_prefixes": ["TransferService"],
+ "host_patterns": [r"transfer\."],
+ "credential_scope": "transfer",
+ },
"appsync": {
"host_patterns": [r"appsync\."],
"path_prefixes": ["/v1/apis", "/v1/tags"],
@@ -252,6 +257,7 @@ def detect_service(method: str, path: str, headers: dict, query_params: dict) ->
"kms": "kms",
"cloudfront": "cloudfront",
"codebuild": "codebuild",
+ "transfer": "transfer",
"appsync": "appsync",
"servicediscovery": "servicediscovery",
"s3files": "s3files",
diff --git a/ministack/services/transfer.py b/ministack/services/transfer.py
new file mode 100644
index 00000000..2495eb84
--- /dev/null
+++ b/ministack/services/transfer.py
@@ -0,0 +1,402 @@
+"""
+AWS Transfer Family Service Emulator.
+JSON-based API via X-Amz-Target: TransferService.<Operation>.
+
+Supports:
+ Servers: CreateServer, DescribeServer, DeleteServer, ListServers
+ Users: CreateUser, DescribeUser, DeleteUser, ListUsers
+ SSH Keys: ImportSshPublicKey, DeleteSshPublicKey
+"""
+
+import copy
+import json
+import logging
+import os
+import re
+
+from ministack.core.persistence import load_state
+from ministack.core.responses import (
+ AccountScopedDict,
+ error_response_json,
+ get_account_id,
+ json_response,
+ new_uuid,
+ now_iso,
+)
+
+logger = logging.getLogger("transfer")
+
+REGION = os.environ.get("MINISTACK_REGION", "us-east-1")
+
+# ---------------------------------------------------------------------------
+# In-memory state
+# ---------------------------------------------------------------------------
+_servers = AccountScopedDict() # server_id -> server record
+_users = AccountScopedDict() # "{server_id}/{user_name}" -> user record
+
+
+def reset():
+ _servers.clear()
+ _users.clear()
+
+
+def get_state():
+ return copy.deepcopy({
+ "servers": _servers,
+ "users": _users,
+ })
+
+
+def restore_state(data):
+ _servers.update(data.get("servers", {}))
+ _users.update(data.get("users", {}))
+
+
+_restored = load_state("transfer")
+if _restored:
+ restore_state(_restored)
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+def _server_id():
+ return "s-" + new_uuid().replace("-", "")[:17]
+
+
+def _key_id():
+ return "key-" + new_uuid().replace("-", "")[:17]
+
+
+def _server_arn(server_id):
+ return f"arn:aws:transfer:{REGION}:{get_account_id()}:server/{server_id}"
+
+
+def _user_arn(server_id, user_name):
+ return f"arn:aws:transfer:{REGION}:{get_account_id()}:user/{server_id}/{user_name}"
+
+
+def _user_key(server_id, user_name):
+ return f"{server_id}/{user_name}"
+
+
+_SSH_KEY_PREFIXES = ("ssh-rsa", "ssh-ed25519", "ssh-dss", "ecdsa-sha2-")
+
+
+def _validate_ssh_key(key_body):
+ """Basic SSH public key format validation."""
+ if not key_body or not isinstance(key_body, str):
+ return False
+ parts = key_body.strip().split()
+ if len(parts) < 2:
+ return False
+ return any(parts[0].startswith(p) for p in _SSH_KEY_PREFIXES)
+
+
+def _error(code, message, status=400):
+ return error_response_json(code, message, status)
+
+
+# ---------------------------------------------------------------------------
+# Request dispatcher
+# ---------------------------------------------------------------------------
+
+async def handle_request(method, path, headers, body, query_params):
+ target = headers.get("x-amz-target", "")
+ action = target.split(".")[-1] if "." in target else ""
+
+ try:
+ data = json.loads(body) if body else {}
+ except json.JSONDecodeError:
+ return error_response_json("SerializationException", "Invalid JSON", 400)
+
+ handlers = {
+ "CreateServer": _create_server,
+ "DescribeServer": _describe_server,
+ "DeleteServer": _delete_server,
+ "ListServers": _list_servers,
+ "CreateUser": _create_user,
+ "DescribeUser": _describe_user,
+ "DeleteUser": _delete_user,
+ "ListUsers": _list_users,
+ "ImportSshPublicKey": _import_ssh_public_key,
+ "DeleteSshPublicKey": _delete_ssh_public_key,
+ }
+
+ handler = handlers.get(action)
+ if not handler:
+ return error_response_json("InvalidAction", f"Unknown action: {action}", 400)
+ return handler(data)
+
+
+# ---------------------------------------------------------------------------
+# Server handlers
+# ---------------------------------------------------------------------------
+
+def _create_server(data):
+ sid = _server_id()
+ now = now_iso()
+
+ server = {
+ "Arn": _server_arn(sid),
+ "ServerId": sid,
+ "State": "ONLINE",
+ "EndpointType": data.get("EndpointType", "PUBLIC"),
+ "IdentityProviderType": data.get("IdentityProviderType", "SERVICE_MANAGED"),
+ "Protocols": data.get("Protocols", ["SFTP"]),
+ "Domain": data.get("Domain", "S3"),
+ "Tags": data.get("Tags", []),
+ "UserCount": 0,
+ "DateCreated": now,
+ }
+
+ _servers[sid] = server
+ return json_response({"ServerId": sid})
+
+
+def _describe_server(data):
+ sid = data.get("ServerId", "")
+ if sid not in _servers:
+ return _error("ResourceNotFoundException",
+ f"Unknown server: {sid}", 404)
+
+ server = _servers[sid]
+ described = {
+ "Arn": server["Arn"],
+ "Domain": server.get("Domain", "S3"),
+ "EndpointType": server["EndpointType"],
+ "IdentityProviderType": server["IdentityProviderType"],
+ "Protocols": server["Protocols"],
+ "ServerId": sid,
+ "State": server["State"],
+ "Tags": server.get("Tags", []),
+ "UserCount": server.get("UserCount", 0),
+ }
+ return json_response({"Server": described})
+
+
+def _delete_server(data):
+ sid = data.get("ServerId", "")
+ if sid not in _servers:
+ return _error("ResourceNotFoundException",
+ f"Unknown server: {sid}", 404)
+
+ # Cascade-delete all users on this server
+ to_delete = [k for k in _users if k.startswith(sid + "/")]
+ for k in to_delete:
+ del _users[k]
+
+ del _servers[sid]
+ return json_response({})
+
+
+def _list_servers(data):
+ max_results = data.get("MaxResults", 1000)
+ next_token = data.get("NextToken")
+
+ all_servers = sorted(_servers.values(), key=lambda s: s["ServerId"])
+
+ start = 0
+ if next_token:
+ for i, s in enumerate(all_servers):
+ if s["ServerId"] == next_token:
+ start = i
+ break
+
+ page = all_servers[start:start + max_results]
+ result = {
+ "Servers": [{
+ "Arn": s["Arn"],
+ "Domain": s.get("Domain", "S3"),
+ "EndpointType": s["EndpointType"],
+ "IdentityProviderType": s["IdentityProviderType"],
+ "Protocols": s["Protocols"],
+ "ServerId": s["ServerId"],
+ "State": s["State"],
+ "UserCount": s.get("UserCount", 0),
+ } for s in page],
+ }
+
+ if start + max_results < len(all_servers):
+ result["NextToken"] = all_servers[start + max_results]["ServerId"]
+
+ return json_response(result)
+
+
+# ---------------------------------------------------------------------------
+# User handlers
+# ---------------------------------------------------------------------------
+
+def _create_user(data):
+ sid = data.get("ServerId", "")
+ user_name = data.get("UserName", "")
+
+ if sid not in _servers:
+ return _error("ResourceNotFoundException",
+ f"Unknown server: {sid}", 404)
+
+ uk = _user_key(sid, user_name)
+ if uk in _users:
+ return _error("ResourceExistsException",
+ f"User already exists: {user_name}", 409)
+
+ ssh_keys = []
+ ssh_body = data.get("SshPublicKeyBody")
+ if ssh_body:
+ if not _validate_ssh_key(ssh_body):
+ return _error("InvalidRequestException",
+ "Unsupported or invalid SSH public key format", 400)
+ now = now_iso()
+ ssh_keys.append({
+ "SshPublicKeyId": _key_id(),
+ "SshPublicKeyBody": ssh_body.strip(),
+ "DateImported": now,
+ })
+
+ user = {
+ "Arn": _user_arn(sid, user_name),
+ "UserName": user_name,
+ "ServerId": sid,
+ "HomeDirectoryType": data.get("HomeDirectoryType", "PATH"),
+ "HomeDirectoryMappings": data.get("HomeDirectoryMappings", []),
+ "HomeDirectory": data.get("HomeDirectory"),
+ "Role": data.get("Role", ""),
+ "SshPublicKeys": ssh_keys,
+ "Tags": data.get("Tags", []),
+ }
+
+ _users[uk] = user
+ _servers[sid]["UserCount"] = _servers[sid].get("UserCount", 0) + 1
+
+ return json_response({"ServerId": sid, "UserName": user_name})
+
+
+def _describe_user(data):
+ sid = data.get("ServerId", "")
+ user_name = data.get("UserName", "")
+
+ uk = _user_key(sid, user_name)
+ if uk not in _users:
+ return _error("ResourceNotFoundException",
+ f"Unknown user: {user_name}", 404)
+
+ user = _users[uk]
+ described = {
+ "Arn": user["Arn"],
+ "HomeDirectoryType": user.get("HomeDirectoryType", "PATH"),
+ "HomeDirectoryMappings": user.get("HomeDirectoryMappings", []),
+ "Role": user.get("Role", ""),
+ "SshPublicKeys": user.get("SshPublicKeys", []),
+ "Tags": user.get("Tags", []),
+ "UserName": user["UserName"],
+ }
+ if user.get("HomeDirectory"):
+ described["HomeDirectory"] = user["HomeDirectory"]
+
+ return json_response({"ServerId": sid, "User": described})
+
+
+def _delete_user(data):
+ sid = data.get("ServerId", "")
+ user_name = data.get("UserName", "")
+
+ uk = _user_key(sid, user_name)
+ if uk not in _users:
+ return _error("ResourceNotFoundException",
+ f"Unknown user: {user_name}", 404)
+
+ del _users[uk]
+ if sid in _servers:
+ _servers[sid]["UserCount"] = max(0, _servers[sid].get("UserCount", 1) - 1)
+
+ return json_response({})
+
+
+def _list_users(data):
+ sid = data.get("ServerId", "")
+ if sid not in _servers:
+ return _error("ResourceNotFoundException",
+ f"Unknown server: {sid}", 404)
+
+ max_results = data.get("MaxResults", 1000)
+ next_token = data.get("NextToken")
+
+ prefix = sid + "/"
+ server_users = sorted(
+ [u for k, u in _users.items() if k.startswith(prefix)],
+ key=lambda u: u["UserName"],
+ )
+
+ start = 0
+ if next_token:
+ for i, u in enumerate(server_users):
+ if u["UserName"] == next_token:
+ start = i
+ break
+
+ page = server_users[start:start + max_results]
+ result = {
+ "ServerId": sid,
+ "Users": [{
+ "Arn": u["Arn"],
+ "HomeDirectoryType": u.get("HomeDirectoryType", "PATH"),
+ "Role": u.get("Role", ""),
+ "SshPublicKeyCount": len(u.get("SshPublicKeys", [])),
+ "UserName": u["UserName"],
+ } for u in page],
+ }
+
+ if start + max_results < len(server_users):
+ result["NextToken"] = server_users[start + max_results]["UserName"]
+
+ return json_response(result)
+
+
+# ---------------------------------------------------------------------------
+# SSH key handlers
+# ---------------------------------------------------------------------------
+
+def _import_ssh_public_key(data):
+ sid = data.get("ServerId", "")
+ user_name = data.get("UserName", "")
+ ssh_body = data.get("SshPublicKeyBody", "")
+
+ uk = _user_key(sid, user_name)
+ if uk not in _users:
+ return _error("ResourceNotFoundException",
+ f"Unknown user: {user_name}", 404)
+
+ if not _validate_ssh_key(ssh_body):
+ return _error("InvalidRequestException",
+ "Unsupported or invalid SSH public key format", 400)
+
+ kid = _key_id()
+ now = now_iso()
+ _users[uk]["SshPublicKeys"].append({
+ "SshPublicKeyId": kid,
+ "SshPublicKeyBody": ssh_body.strip(),
+ "DateImported": now,
+ })
+
+ return json_response({
+ "ServerId": sid,
+ "SshPublicKeyId": kid,
+ "UserName": user_name,
+ })
+
+
+def _delete_ssh_public_key(data):
+ sid = data.get("ServerId", "")
+ user_name = data.get("UserName", "")
+ key_id = data.get("SshPublicKeyId", "")
+
+ uk = _user_key(sid, user_name)
+ if uk not in _users:
+ return _error("ResourceNotFoundException",
+ f"Unknown user: {user_name}", 404)
+
+ keys = _users[uk]["SshPublicKeys"]
+ _users[uk]["SshPublicKeys"] = [k for k in keys if k["SshPublicKeyId"] != key_id]
+
+ return json_response({})
diff --git a/tests/conftest.py b/tests/conftest.py
index 6627033b..db7faaa6 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -288,3 +288,7 @@ def codebuild():
@pytest.fixture(scope="session")
def autoscaling():
return make_client("autoscaling")
+
[email protected](scope="session")
+def transfer():
+ return make_client("transfer")
diff --git a/tests/test_transfer.py b/tests/test_transfer.py
new file mode 100644
index 00000000..b821c71a
--- /dev/null
+++ b/tests/test_transfer.py
@@ -0,0 +1,317 @@
+import pytest
+from botocore.exceptions import ClientError
+
+# ========== Server lifecycle ==========
+
+def test_transfer_create_server(transfer):
+ resp = transfer.create_server()
+ assert "ServerId" in resp
+ assert resp["ServerId"].startswith("s-")
+
+
+def test_transfer_describe_server(transfer):
+ sid = transfer.create_server()["ServerId"]
+ resp = transfer.describe_server(ServerId=sid)
+ server = resp["Server"]
+ assert server["ServerId"] == sid
+ assert server["State"] == "ONLINE"
+ assert server["EndpointType"] == "PUBLIC"
+ assert server["IdentityProviderType"] == "SERVICE_MANAGED"
+ assert "SFTP" in server["Protocols"]
+ assert server["Arn"].startswith("arn:aws:transfer:")
+
+
+def test_transfer_describe_server_not_found(transfer):
+ with pytest.raises(ClientError) as exc:
+ transfer.describe_server(ServerId="s-doesnotexist00000")
+ assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
+
+
+def test_transfer_list_servers(transfer):
+ resp = transfer.list_servers()
+ assert "Servers" in resp
+ assert len(resp["Servers"]) >= 1
+
+
+def test_transfer_create_server_with_options(transfer):
+ resp = transfer.create_server(
+ EndpointType="VPC",
+ Protocols=["SFTP", "FTPS"],
+ IdentityProviderType="API_GATEWAY",
+ Tags=[{"Key": "env", "Value": "test"}],
+ )
+ sid = resp["ServerId"]
+ server = transfer.describe_server(ServerId=sid)["Server"]
+ assert server["EndpointType"] == "VPC"
+ assert "FTPS" in server["Protocols"]
+ assert server["IdentityProviderType"] == "API_GATEWAY"
+
+
+def test_transfer_delete_server(transfer):
+ sid = transfer.create_server()["ServerId"]
+ transfer.delete_server(ServerId=sid)
+ with pytest.raises(ClientError) as exc:
+ transfer.describe_server(ServerId=sid)
+ assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
+
+
+def test_transfer_delete_server_cascades_users(transfer):
+ sid = transfer.create_server()["ServerId"]
+ transfer.create_user(
+ ServerId=sid,
+ UserName="cascade-user",
+ Role="arn:aws:iam::000000000000:role/transfer-role",
+ )
+ transfer.delete_server(ServerId=sid)
+ # Recreate to verify user is gone
+ sid2 = transfer.create_server()["ServerId"]
+ resp = transfer.list_users(ServerId=sid2)
+ assert len(resp["Users"]) == 0
+
+
+# ========== User CRUD ==========
+
+def server_id(transfer):
+ """Create a fresh server for user tests."""
+ return transfer.create_server()["ServerId"]
+
+
+def test_transfer_create_user(transfer, server_id):
+ resp = transfer.create_user(
+ ServerId=server_id,
+ UserName="test-sftp-user",
+ HomeDirectoryType="LOGICAL",
+ HomeDirectoryMappings=[{"Entry": "/", "Target": "/my-bucket/path"}],
+ Role="arn:aws:iam::000000000000:role/transfer-role",
+ SshPublicKeyBody="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ testkey",
+ )
+ assert resp["ServerId"] == server_id
+ assert resp["UserName"] == "test-sftp-user"
+
+
+def test_transfer_describe_user(transfer, server_id):
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="describe-user",
+ HomeDirectoryType="LOGICAL",
+ HomeDirectoryMappings=[{"Entry": "/", "Target": "/bucket/home"}],
+ Role="arn:aws:iam::000000000000:role/xfer",
+ SshPublicKeyBody="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ desckey",
+ )
+ resp = transfer.describe_user(ServerId=server_id, UserName="describe-user")
+ user = resp["User"]
+ assert user["UserName"] == "describe-user"
+ assert user["HomeDirectoryType"] == "LOGICAL"
+ assert user["HomeDirectoryMappings"] == [{"Entry": "/", "Target": "/bucket/home"}]
+ assert user["Role"] == "arn:aws:iam::000000000000:role/xfer"
+ assert len(user["SshPublicKeys"]) == 1
+ assert user["SshPublicKeys"][0]["SshPublicKeyBody"] == "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ desckey"
+ assert user["SshPublicKeys"][0]["SshPublicKeyId"].startswith("key-")
+ assert user["Arn"].startswith("arn:aws:transfer:")
+
+
+def test_transfer_create_user_duplicate(transfer, server_id):
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="dup-user",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ )
+ with pytest.raises(ClientError) as exc:
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="dup-user",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ )
+ assert exc.value.response["Error"]["Code"] == "ResourceExistsException"
+
+
+def test_transfer_create_user_server_not_found(transfer):
+ with pytest.raises(ClientError) as exc:
+ transfer.create_user(
+ ServerId="s-doesnotexist00000",
+ UserName="orphan-user",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ )
+ assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
+
+
+def test_transfer_create_user_bad_ssh_key(transfer, server_id):
+ with pytest.raises(ClientError) as exc:
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="badkey-user",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ SshPublicKeyBody="not-a-valid-key",
+ )
+ assert exc.value.response["Error"]["Code"] == "InvalidRequestException"
+
+
+def test_transfer_describe_user_not_found(transfer, server_id):
+ with pytest.raises(ClientError) as exc:
+ transfer.describe_user(ServerId=server_id, UserName="nonexistent")
+ assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
+
+
+def test_transfer_delete_user(transfer, server_id):
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="to-delete",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ )
+ transfer.delete_user(ServerId=server_id, UserName="to-delete")
+ with pytest.raises(ClientError) as exc:
+ transfer.describe_user(ServerId=server_id, UserName="to-delete")
+ assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"
+
+
+def test_transfer_list_users(transfer, server_id):
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="list-user-a",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ )
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="list-user-b",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ )
+ resp = transfer.list_users(ServerId=server_id)
+ names = [u["UserName"] for u in resp["Users"]]
+ assert "list-user-a" in names
+ assert "list-user-b" in names
+
+
+# ========== SSH key management ==========
+
+def test_transfer_import_ssh_key(transfer, server_id):
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="key-user",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ SshPublicKeyBody="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ original",
+ )
+ resp = transfer.import_ssh_public_key(
+ ServerId=server_id,
+ UserName="key-user",
+ SshPublicKeyBody="ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIG newkey",
+ )
+ assert resp["SshPublicKeyId"].startswith("key-")
+ assert resp["UserName"] == "key-user"
+
+ user = transfer.describe_user(ServerId=server_id, UserName="key-user")["User"]
+ assert len(user["SshPublicKeys"]) == 2
+ bodies = {k["SshPublicKeyBody"] for k in user["SshPublicKeys"]}
+ assert "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ original" in bodies
+ assert "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIG newkey" in bodies
+
+
+def test_transfer_import_ssh_key_bad_format(transfer, server_id):
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="badimport-user",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ )
+ with pytest.raises(ClientError) as exc:
+ transfer.import_ssh_public_key(
+ ServerId=server_id,
+ UserName="badimport-user",
+ SshPublicKeyBody="invalid-key-format",
+ )
+ assert exc.value.response["Error"]["Code"] == "InvalidRequestException"
+
+
+def test_transfer_delete_ssh_key(transfer, server_id):
+ transfer.create_user(
+ ServerId=server_id,
+ UserName="delkey-user",
+ Role="arn:aws:iam::000000000000:role/xfer",
+ SshPublicKeyBody="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ first",
+ )
+ import_resp = transfer.import_ssh_public_key(
+ ServerId=server_id,
+ UserName="delkey-user",
+ SshPublicKeyBody="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ second",
+ )
+ new_key_id = import_resp["SshPublicKeyId"]
+
+ # Get the original key ID
+ user = transfer.describe_user(ServerId=server_id, UserName="delkey-user")["User"]
+ original_key_id = [k["SshPublicKeyId"] for k in user["SshPublicKeys"]
+ if k["SshPublicKeyBody"] == "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ first"][0]
+
+ # Delete the original key
+ transfer.delete_ssh_public_key(
+ ServerId=server_id,
+ UserName="delkey-user",
+ SshPublicKeyId=original_key_id,
+ )
+
+ user = transfer.describe_user(ServerId=server_id, UserName="delkey-user")["User"]
+ assert len(user["SshPublicKeys"]) == 1
+ assert user["SshPublicKeys"][0]["SshPublicKeyId"] == new_key_id
+ assert user["SshPublicKeys"][0]["SshPublicKeyBody"] == "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ second"
+
+
+# ========== WorkOS end-to-end workflow ==========
+
+def test_transfer_workos_sftp_workflow(transfer):
+ """
+ Simulates the WorkOS SFTP directory sync workflow:
+ 1. Server exists (create it)
+ 2. Create user with LOGICAL home dir + SSH key
+ 3. Describe user to verify
+ 4. Rotate SSH key (import new, delete old)
+ 5. Verify single key remains
+ 6. Delete user
+ """
+ # 1. Create server
+ sid = transfer.create_server()["ServerId"]
+
+ # 2. Create user with LOGICAL home directory mapping to S3
+ transfer.create_user(
+ ServerId=sid,
+ UserName="sftp-org123",
+ HomeDirectoryType="LOGICAL",
+ HomeDirectoryMappings=[{"Entry": "/", "Target": "/sftp-org123-bucket/"}],
+ Role="arn:aws:iam::000000000000:role/aws_transfer_service_write_only_role",
+ SshPublicKeyBody="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ oldkey",
+ )
+
+ # 3. Describe user and verify setup
+ user = transfer.describe_user(ServerId=sid, UserName="sftp-org123")["User"]
+ assert user["HomeDirectoryType"] == "LOGICAL"
+ assert user["HomeDirectoryMappings"] == [{"Entry": "/", "Target": "/sftp-org123-bucket/"}]
+ assert len(user["SshPublicKeys"]) == 1
+ old_key_id = user["SshPublicKeys"][0]["SshPublicKeyId"]
+
+ # 4. Rotate SSH key: import new key
+ import_resp = transfer.import_ssh_public_key(
+ ServerId=sid,
+ UserName="sftp-org123",
+ SshPublicKeyBody="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ newkey",
+ )
+ new_key_id = import_resp["SshPublicKeyId"]
+
+ # Verify both keys present
+ user = transfer.describe_user(ServerId=sid, UserName="sftp-org123")["User"]
+ assert len(user["SshPublicKeys"]) == 2
+
+ # Delete old key
+ transfer.delete_ssh_public_key(
+ ServerId=sid,
+ UserName="sftp-org123",
+ SshPublicKeyId=old_key_id,
+ )
+
+ # 5. Verify single key remains
+ user = transfer.describe_user(ServerId=sid, UserName="sftp-org123")["User"]
+ assert len(user["SshPublicKeys"]) == 1
+ assert user["SshPublicKeys"][0]["SshPublicKeyId"] == new_key_id
+ assert user["SshPublicKeys"][0]["SshPublicKeyBody"] == "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQ newkey"
+
+ # 6. Delete user
+ transfer.delete_user(ServerId=sid, UserName="sftp-org123")
+ with pytest.raises(ClientError) as exc:
+ transfer.describe_user(ServerId=sid, UserName="sftp-org123")
+ assert exc.value.response["Error"]["Code"] == "ResourceNotFoundException"