Repository navigation
Fix examples and documentation to use SshSocksConnector for HTTPS - #49
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes consistently use the connector required for TLS and match existing HTTPS guidance.
0 open findings
What changed in this PR
Updates HTTPS documentation and examples to use the TLS-compatible SshSocksConnector.
Changes:
- Replaces
SshProcessConnectorin HTTPS examples. - Corrects an example comment typo.
- Updates the MySQL example reference to #31.
| File | Description |
|---|---|
README.md |
Fixes HTTPS quickstart and MySQL example reference. |
examples/01-https-request.php |
Uses the SOCKS connector and fixes comment spacing. |
examples/02-optional-proxy-https-request.php |
Uses the SOCKS connector when proxying HTTPS. |
examples/22-optional-proxy-raw-https-protocol.php |
Uses the SOCKS connector for raw TLS connections. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This changeset fixes the HTTPS examples and documentation to use the
SshSocksConnector. TheSshProcessConnectoronly supports plaintext TCP/IP connections as discussed in #4, so these examples have been failing withBase connector does not use internal Connection class exposing stream resourceever since they were added in #21 (2020) and the HTTPS quickstart in #29 (2021). Secure TLS connections require theSshSocksConnectoradded in #8 instead.This also updates the README link to the MySQL example that was renamed in #21. Together with #48, the HTTPS examples also work with current OpenSSH 9.2+ (2023). Examples and documentation only, the library itself is unchanged.
Builds on top of #8, #21 and #29
Refs #4 and #48