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
|
"""TransferBackend class with methods for supported APIs."""
from typing import Any, Optional
from moto.core.base_backend import BackendDict, BaseBackend
from moto.core.utils import unix_time
from moto.transfer.exceptions import PublicKeyNotFound, ServerNotFound, UserNotFound
from .types import (
Server,
ServerDomain,
ServerEndpointType,
ServerIdentityProviderType,
ServerProtocols,
User,
UserHomeDirectoryType,
)
class TransferBackend(BaseBackend):
"""Implementation of Transfer APIs."""
def __init__(self, region_name: str, account_id: str) -> None:
super().__init__(region_name, account_id)
self.servers: dict[str, Server] = {}
def create_server(
self,
certificate: Optional[str],
domain: Optional[ServerDomain],
endpoint_details: Optional[dict[str, Any]],
endpoint_type: Optional[ServerEndpointType],
host_key: str,
identity_provider_details: Optional[dict[str, Any]],
identity_provider_type: Optional[ServerIdentityProviderType],
logging_role: Optional[str],
post_authentication_login_banner: Optional[str],
pre_authentication_login_banner: Optional[str],
protocols: Optional[list[ServerProtocols]],
protocol_details: Optional[dict[str, Any]],
security_policy_name: Optional[str],
tags: Optional[list[dict[str, str]]],
workflow_details: Optional[dict[str, Any]],
structured_log_destinations: Optional[list[str]],
s3_storage_options: Optional[dict[str, Optional[str]]],
) -> str:
server = Server(
certificate=certificate,
domain=domain,
endpoint_type=endpoint_type,
host_key_fingerprint=host_key,
identity_provider_type=identity_provider_type,
logging_role=logging_role,
post_authentication_login_banner=post_authentication_login_banner,
pre_authentication_login_banner=pre_authentication_login_banner,
protocols=protocols,
security_policy_name=security_policy_name,
structured_log_destinations=structured_log_destinations,
tags=(tags or []),
)
if endpoint_details is not None:
endpoint_details = {
"address_allocation_ids": endpoint_details.get("AddressAllocationIds"),
"subnet_ids": endpoint_details.get("SubnetIds"),
"vpc_endpoint_id": endpoint_details.get("VpcEndpointId"),
"vpc_id": endpoint_details.get("VpcId"),
"security_group_ids": endpoint_details.get("SecurityGroupIds"),
}
server.endpoint_details = endpoint_details
if identity_provider_details is not None:
identity_provider_details = {
"url": identity_provider_details.get("Url"),
"invocation_role": identity_provider_details.get("InvocationRole"),
"directory_id": identity_provider_details.get("DirectoryId"),
"function": identity_provider_details.get("Function"),
"sftp_authentication_methods": identity_provider_details.get(
"SftpAuthenticationMethods"
),
}
server.identity_provider_details = identity_provider_details
if protocol_details is not None:
protocol_details = {
"passive_ip": protocol_details.get("PassiveIp"),
"tls_session_resumption_mode": protocol_details.get(
"TlsSessionResumptionMode"
),
"set_stat_option": protocol_details.get("SetStatOption"),
"as2_transports": protocol_details.get("As2Transports"),
}
server.protocol_details = protocol_details
if s3_storage_options is not None:
server.s3_storage_options = {
"directory_listing_optimization": s3_storage_options.get(
"DirectoryListingOptimization"
)
}
if workflow_details is not None:
server.workflow_details = {
"on_upload": [
{
"workflow_id": workflow.get("WorkflowId"),
"execution_role": workflow.get("ExecutionRole"),
}
for workflow in (workflow_details.get("OnUpload") or [])
],
"on_partial_upload": [
{
"workflow_id": workflow.get("WorkflowId"),
"execution_role": workflow.get("ExecutionRole"),
}
for workflow in (workflow_details.get("OnPartialUpload") or [])
],
}
server_id = server.server_id
self.servers[server_id] = server
return server_id
def describe_server(self, server_id: str) -> Server:
if server_id not in self.servers:
ServerNotFound(server_id=server_id)
server = self.servers[server_id]
return server
def delete_server(self, server_id: str) -> None:
if server_id not in self.servers:
ServerNotFound(server_id=server_id)
del self.servers[server_id]
return
def create_user(
self,
home_directory: Optional[str],
home_directory_type: Optional[UserHomeDirectoryType],
home_directory_mappings: Optional[list[dict[str, Optional[str]]]],
policy: Optional[str],
posix_profile: Optional[dict[str, Any]],
role: str,
server_id: str,
ssh_public_key_body: Optional[str],
tags: Optional[list[dict[str, str]]],
user_name: str,
) -> tuple[str, str]:
if server_id not in self.servers:
ServerNotFound(server_id=server_id)
user = User(
home_directory=home_directory,
home_directory_type=home_directory_type,
policy=policy,
role=role,
tags=(tags or []),
user_name=user_name,
)
if home_directory_mappings:
for mapping in home_directory_mappings:
user.home_directory_mappings.append(
{
"entry": mapping.get("Entry"),
"target": mapping.get("Target"),
"type": mapping.get("Type"),
}
)
if posix_profile is not None:
posix_profile = {
"gid": posix_profile.get("Gid"),
"uid": posix_profile.get("Uid"),
"secondary_gids": posix_profile.get("SecondaryGids"),
}
user.posix_profile = posix_profile
if ssh_public_key_body is not None:
now = unix_time()
ssh_public_keys = [
{
"date_imported": str(now),
"ssh_public_key_body": ssh_public_key_body,
"ssh_public_key_id": "mock_ssh_public_key_id_{ssh_public_key_body}_{now}",
}
]
user.ssh_public_keys = ssh_public_keys
self.servers[server_id]._users.append(user)
self.servers[server_id].user_count += 1
return server_id, user_name
def describe_user(self, server_id: str, user_name: str) -> tuple[str, User]:
if server_id not in self.servers:
raise ServerNotFound(server_id=server_id)
for user in self.servers[server_id]._users:
if user.user_name == user_name:
return server_id, user
raise UserNotFound(user_name=user_name, server_id=server_id)
def delete_user(self, server_id: str, user_name: str) -> None:
if server_id not in self.servers:
raise ServerNotFound(server_id=server_id)
for i, user in enumerate(self.servers[server_id]._users):
if user.user_name == user_name:
del self.servers[server_id]._users[i]
self.servers[server_id].user_count -= 1
return
raise UserNotFound(server_id=server_id, user_name=user_name)
def import_ssh_public_key(
self, server_id: str, ssh_public_key_body: str, user_name: str
) -> tuple[str, str, str]:
if server_id not in self.servers:
raise ServerNotFound(server_id=server_id)
for user in self.servers[server_id]._users:
if user.user_name == user_name:
date_imported = unix_time()
ssh_public_key_id = (
f"{server_id}:{user_name}:public_key:{date_imported}"
)
key = {
"ssh_public_key_id": ssh_public_key_id,
"ssh_public_key_body": ssh_public_key_body,
"date_imported": str(date_imported),
}
user.ssh_public_keys.append(key)
return server_id, ssh_public_key_id, user_name
raise UserNotFound(user_name=user_name, server_id=server_id)
def delete_ssh_public_key(
self, server_id: str, ssh_public_key_id: str, user_name: str
) -> None:
if server_id not in self.servers:
raise ServerNotFound(server_id=server_id)
for i, user in enumerate(self.servers[server_id]._users):
if user.user_name == user_name:
for j, key in enumerate(
self.servers[server_id]._users[i].ssh_public_keys
):
if key["ssh_public_key_id"] == ssh_public_key_id:
del user.ssh_public_keys[j]
return
raise PublicKeyNotFound(
user_name=user_name,
server_id=server_id,
ssh_public_key_id=ssh_public_key_id,
)
raise UserNotFound(user_name=user_name, server_id=server_id)
transfer_backends = BackendDict(TransferBackend, "transfer")
|
