Skip to content

Commit 05d806b

Browse files
committed
Update documentation on supported ports
1 parent 6bd09e9 commit 05d806b

File tree

4 files changed

+13
-26
lines changed

4 files changed

+13
-26
lines changed

DESIGN.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,8 @@ Key settings:
141141

142142
## Supported Services
143143

144-
See README.md for complete service list. Common services:
145-
146-
- SSH (22), HTTP (80), HTTPS (443), RDP (3389), VNC (5900)
144+
With support of localproxy application can support a wide range of protocol but
145+
for the first release only SSH (22) and VNC (5900) will be supported.
147146

148147
## Build & Test
149148

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ A Greengrass component that enables secure tunneling to IoT devices using AWS
44
IoT Device Management Secure Tunneling service.
55

66
This component listens for tunnel notifications and automatically establishes
7-
secure tunnels using the localproxy client, supporting services like SSH, HTTP,
8-
HTTPS, RDP, and VNC.
7+
secure tunnels using the localproxy client, supporting services like SSH and
8+
VNC.
99

1010
## Quick Start
1111

@@ -42,9 +42,6 @@ Tunnel timeout duration in seconds.
4242
| Service | Port |
4343
| ------- | ---- |
4444
| SSH | 22 |
45-
| HTTP | 80 |
46-
| HTTPS | 443 |
47-
| RDP | 3389 |
4845
| VNC | 5900 |
4946

5047
## Resource Usage

src/tunnel_notification_parser.c

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,6 @@ static uint16_t get_port_from_service(GgBuffer service) {
1111
if (gg_buffer_eq(service, GG_STR("SSH"))) {
1212
return 22;
1313
}
14-
if (gg_buffer_eq(service, GG_STR("HTTP"))) {
15-
return 80;
16-
}
17-
if (gg_buffer_eq(service, GG_STR("HTTPS"))) {
18-
return 443;
19-
}
20-
if (gg_buffer_eq(service, GG_STR("RDP"))) {
21-
return 3389;
22-
}
2314
if (gg_buffer_eq(service, GG_STR("VNC"))) {
2415
return 5900;
2516
}

test/unit/test_service_name_validation.c

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,27 +65,27 @@ static void test_ssh_service_accepted(void) {
6565
);
6666
}
6767

68-
static void test_http_service_accepted(void) {
68+
static void test_http_service_rejected(void) {
6969
uint8_t arena_mem[1024];
7070
GgMap notification = create_notification(arena_mem, "HTTP");
7171
TEST_ASSERT_EQUAL(
72-
GG_ERR_OK, handle_tunnel_notification(notification, &config)
72+
GG_ERR_INVALID, handle_tunnel_notification(notification, &config)
7373
);
7474
}
7575

76-
static void test_https_service_accepted(void) {
76+
static void test_https_service_rejected(void) {
7777
uint8_t arena_mem[1024];
7878
GgMap notification = create_notification(arena_mem, "HTTPS");
7979
TEST_ASSERT_EQUAL(
80-
GG_ERR_OK, handle_tunnel_notification(notification, &config)
80+
GG_ERR_INVALID, handle_tunnel_notification(notification, &config)
8181
);
8282
}
8383

84-
static void test_rdp_service_accepted(void) {
84+
static void test_rdp_service_rejected(void) {
8585
uint8_t arena_mem[1024];
8686
GgMap notification = create_notification(arena_mem, "RDP");
8787
TEST_ASSERT_EQUAL(
88-
GG_ERR_OK, handle_tunnel_notification(notification, &config)
88+
GG_ERR_INVALID, handle_tunnel_notification(notification, &config)
8989
);
9090
}
9191

@@ -116,9 +116,9 @@ static void test_empty_service_rejected(void) {
116116
int main(void) {
117117
UNITY_BEGIN();
118118
RUN_TEST(test_ssh_service_accepted);
119-
RUN_TEST(test_http_service_accepted);
120-
RUN_TEST(test_https_service_accepted);
121-
RUN_TEST(test_rdp_service_accepted);
119+
RUN_TEST(test_http_service_rejected);
120+
RUN_TEST(test_https_service_rejected);
121+
RUN_TEST(test_rdp_service_rejected);
122122
RUN_TEST(test_vnc_service_accepted);
123123
RUN_TEST(test_random_service_rejected);
124124
RUN_TEST(test_empty_service_rejected);

0 commit comments

Comments
 (0)