refactor: Remove file system bindings #516

XavierChanth · 2023-10-04T21:38:48Z

- What I did

Updated key arguments:
- Added -i just like ssh, -s is now a bool which sends the public key associated with -i
Renamed SSHNPImpl to SSHNPCore since it is abstract, it isn't really an implementation
A major overhaul to local file and ssh key management
- Added AtSSHKeyPair which holds a set of ssh keys
- Added LocalSSHKeyUtil and DartSSHKeyUtil to manage keys depending on what is available to store / create SSH Keys
- Added SSHNPDLocalSSHKeyHandler (a mixin on SSHNPCore) which exposes LocalSSHKeyUtil safely
- Added SSHNPDDartSSHKeyHandler (a mixin on SSHNPForwardDart) which exposes DartSSHKeyUtil safely
Split the ForwardDart implementation into two:
- one which expects that the local file system is still available, so it can output an ssh command
- another which expects that there is no local file system available and just passes a handler to the dartssh2 SSHClient
- The reason for this design decision is that I expect we will want to run the first in a separate isolate so that we can exit the main program safely, but then we can no longer access the SSHClient so it is not suitable for use in sshnp_gui
- I have not implemented these design decisions as I am leaving them open ended for an architecture discussion
Deferred payload handling from sshnpd to mixins, since it is implementation specific
- The default payload handler mixin exposes the ephemeralPrivateKey safely
Added type-safety to
- DefaultArgs
- String names in SSHNPArg/SSHNPParams
Replaced the rsa boolean with an enum of sshAlgorithms
- currently just ed25519 (default) and rsa

Several Action items come out of these changes:

Write new unit tests for arg parsing which validate against the new argument changes to:
- -i, -s, -r
Modify the GUI to be able to input the new arguments
- Need to write UI for handling SSH key management
Architecture discussion
- How to handle the ForwardDart Implementations

- How to verify it

NB - Ignore the failed client-trunk test, it is being provided the -i arg and doesn't know how to handle it.

- Description for the changelog
refactor: Remove file system bindings

… key management is not pure dart with it)

XavierChanth · 2023-10-06T22:38:00Z

Trunk test is failing because of the breaking change caused by adding the -i option, this makes me wonder if we even need the trunk test, or if it should be disabled by default like the backward tests.

XavierChanth · 2023-10-06T23:38:55Z

packages/noports_core/lib/src/sshnpd/sshnpd_params.dart

+  final String rootDomain;
+  final int localSshdPort;
+  final String ephemeralPermissions;
+  final SupportedSSHAlgorithm sshAlgorithm;


Remove late from all of these, which means I had to change how they get set below

XavierChanth · 2023-10-06T23:39:20Z

packages/noports_core/lib/src/sshrv/sshrv.dart

@@ -4,8 +4,6 @@ import 'package:noports_core/src/sshrv/sshrv_impl.dart';
 import 'package:socket_connector/socket_connector.dart';
 import 'package:noports_core/src/common/default_args.dart';

-typedef SSHRVGenerator = SSHRV Function(String, int, {int localSshdPort});


Moved this to src/common/types.dart

XavierChanth · 2023-10-06T23:41:16Z

packages/noports_core/lib/sshnp_core.dart

@@ -0,0 +1,3 @@
+library noports_core_sshnp_core;
+
+export 'src/sshnp/sshnp_core.dart';


Exported this so it can implemented in a flutter library later

If we want to optimize down the road

XavierChanth · 2023-10-06T23:42:08Z

packages/noports_core/pubspec.yaml

  at_utils: ^3.0.15
-  crypton: ^2.1.0
+  cryptography: ^2.7.0


Cryptography is used for generating ed25519 keys in pure dart

XavierChanth · 2023-10-06T23:42:48Z

packages/noports_core/pubspec.yaml

  meta: ^1.9.1
+  openssh_ed25519: ^1.1.0


openssh_ed25519 is used for converting the generated ed25519 keys to openssh format

XavierChanth · 2023-10-06T23:43:57Z

packages/noports_core/pubspec.yaml

  path: ^1.8.3
+  posix: ^5.0.0


posix is used for calling chmod to modify the written ephemeral keys

We will have to assess if this method works on windows, I have yet to test it

XavierChanth and others added 14 commits October 3, 2023 14:05

feat: checkin webserver code

be15739

feat: add webserver portion

62a51da

fix: path to binary dart files

c3f4826

fix: mount path

8f08ed5

chore: cleanup webserver setup

8770687

chore: setup mobile endpoints code

ae190ee

chore: safely guarantee a homeDirectory in noports_core

4bb2409

chore: remove unused import

8c2c18a

chore: flatten webserver demo

173144e

checkin webserver demo

a23bc41

chore: prevent double init completion on error

59a1c87

chore: decouple local filesystem from SSHNPImpl family

c5ab1ce

docs: add sshnp_class_diagrams.md

b0aa277

Merge branch 'trunk' into remove-file-system-bindings

2a05805

XavierChanth changed the title ~~DRAFT: Remove file system bindings~~ chore(DRAFT): Remove file system bindings Oct 4, 2023

XavierChanth added 15 commits October 4, 2023 18:25

chore: organize utils and remove dependency on path_provider

f3ce8f1

fix: remove path_provider dep

4025f49

chore: use new guarantees

6163de5

fix: DefaultArg typings

342f9d5

feat: complete sshKeyPair implementation in sshnp params

f76285a

fix: avoid late init errors

f394e84

fix: file system binding removal

9832956

fix: entrypoints for new -i arg

fe4dcab

fix: use -e for arg replacement

c5bb379

fix: escape sed expression

d0224af

fix: use non-path delimiter

7d91e3f

fix:

5c2fa2b

fix: try to prevent globbing

8dc51a0

fix: try no eval

25fe4ec

docs: comment a design decision

d747e04

XavierChanth added 8 commits October 6, 2023 16:45

chore: log notification value

693984f

chore: log all inits

e7319d0

chore: log when the ephemeral privateKey is set

76b400f

fix: build ephemeral affter requesting an ssh connection

1471bc1

chore: cleanup logging

8cbca2a

chore: print params during init

07b5d58

fix: add typesafety to sshnp args in sshnp params

5a8667f

chore: rename cliArg for ssh-client from pure-dart to dart (since ssh…

5c7d6e1

… key management is not pure dart with it)

XavierChanth added 5 commits October 6, 2023 18:39

chore: add a todo

f91cdca

chore: add a todo

589f735

docs: update diagrams

cb83e69

chore: remove identityType (not needed)

51d7c0f

chore: comment

985e013

XavierChanth commented Oct 6, 2023

View reviewed changes

chore: change import file name

9be9001

XavierChanth commented Oct 6, 2023

View reviewed changes

chore: remove unused dep

659f604

XavierChanth commented Oct 6, 2023

View reviewed changes

XavierChanth changed the title ~~refactor(DRAFT): Remove file system bindings~~ refactor: Remove file system bindings Oct 6, 2023

XavierChanth requested review from gkc and cconstab October 6, 2023 23:50

XavierChanth self-assigned this Oct 6, 2023

XavierChanth marked this pull request as ready for review October 6, 2023 23:50

gkc approved these changes Oct 9, 2023

View reviewed changes

gkc merged commit 982bb5a into trunk Oct 9, 2023
13 of 14 checks passed

gkc deleted the remove-file-system-bindings branch October 9, 2023 11:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Remove file system bindings #516

refactor: Remove file system bindings #516

XavierChanth commented Oct 4, 2023 •

edited

XavierChanth commented Oct 6, 2023

XavierChanth Oct 6, 2023

XavierChanth Oct 6, 2023

XavierChanth Oct 6, 2023

XavierChanth Oct 6, 2023

XavierChanth Oct 6, 2023

XavierChanth Oct 6, 2023

XavierChanth Oct 6, 2023

XavierChanth Oct 6, 2023

		@@ -0,0 +1,3 @@
		library noports_core_sshnp_core;

		export 'src/sshnp/sshnp_core.dart';

refactor: Remove file system bindings #516

refactor: Remove file system bindings #516

Conversation

XavierChanth commented Oct 4, 2023 • edited

XavierChanth commented Oct 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

XavierChanth commented Oct 4, 2023 •

edited