Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Socket authenticators and data transformers #4

Merged
merged 47 commits into from
Jan 22, 2024
Merged

feat: Socket authenticators and data transformers #4

merged 47 commits into from
Jan 22, 2024

Conversation

gkc
Copy link
Contributor

@gkc gkc commented Jan 2, 2024

- What I did

  • Added support for requiring client sockets to be authenticated in some
    app-defined way before they will be connected to the other side
  • Added support for app-defined data transformers which can be used to
    transform the data while sending from A to B, and vice versa. Useful for
    adding traffic encryption, for example.
  • Refactored for readability
  • Multiple breaking changes to improve API readability
  • More documentation
  • More tests
  • Added GitHub action to run the unit tests

- How I did it

  • See commits

- How to verify it

  • Unit test job passes

gkc and others added 26 commits November 23, 2023 12:13
…ge response while keeping socket_connector package generic.
docs: improved class doc for SocketAuthenticator
…ble implementations and the changes in the test to uptake it.
…e non-future value because of possible race condition
…ds to write to them in order to validate them self
refactor: removed dup code
refactor: inlined _onData method and removed it
refactor: inlined _onData method and removed it
@gkc gkc requested review from cconstab and VJag January 2, 2024 12:07
gkc added 2 commits January 2, 2024 12:15
- made `verbose` an instance variable
- made `print`s into `stderr.writeln`s
- wrapped `writeln`s in `if (verbose)` blocks
@gkc gkc requested review from VJag and removed request for VJag January 2, 2024 13:09
@gkc gkc requested a review from XavierChanth January 3, 2024 10:52
CHANGELOG.md Outdated
@@ -1,3 +1,11 @@
## 1.1.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aren't we looking at a major version change? The SocketConnector class had breaking changes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated version and CHANGELOG for 2.0.0 in this commit

Copy link
Member

@XavierChanth XavierChanth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, my only additional feedback is that we think about disabling the logTraffic flag, and only enabling it with a debug flag, like with our debug build for sshrvd, however maybe not, because this is a library.

@gkc
Copy link
Contributor Author

gkc commented Jan 13, 2024

@XavierChanth @VJag @cconstab I think this is good to go, please review again - main thing to look at since last time is the additions to the test pack. Still marked as draft because I still need to update the main README before the new version is published

@gkc gkc requested a review from XavierChanth January 13, 2024 16:06
Copy link
Member

@cconstab cconstab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay farside

@gkc gkc marked this pull request as ready for review January 22, 2024 12:32
@gkc gkc merged commit c2efc86 into atsign-foundation:trunk Jan 22, 2024
2 checks passed
@gkc gkc deleted the socket-authenticator-option branch January 22, 2024 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants