🔍 Add more detail to Net::IMAP#inspect TLS info#674
Merged
Conversation
Previously, the existance of `ssl_ctx` would cause `TLS (NOT VERIFIED)` to be printed. But that isn't quite right: `ssl_ctx` is assigned immediately, before sending the `STARTTLS` command, before calling `start_tls_session`, and before `start_tls_session` returns. And those intermediate states are important distinctions for debugging TLS issues. So this updates `Net::IMAP#inspect` with two new TLS/PLAINTEXT states: * `PLAINTEXT (TLS NOT STARTED)`, when: * `#starttls` has been called (`@ssl_ctx` has been set), * but `#start_tls_session` hasn't (`@sock` is a `TCPSocket`). * `TLS (NOT ESTABLISHED)`, when: * `#start_tls_session` was called (`@sock` is an `SSLSocket`), * but hasn't returned successfully (`@sock.session` isn't available).
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
1 participant
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.
Previously, the existence of
ssl_ctxwithouttls_verified?would causeTLS (NOT VERIFIED)to be output. But that isn't quite right:ssl_ctxis assigned immediately, before even sending theSTARTTLScommand, before callingstart_tls_session, and beforestart_tls_sessionreturns. And those intermediate states are important distinctions for debugging TLS issues.So this updates
Net::IMAP#inspectwith two new TLS/PLAINTEXT states:PLAINTEXT (TLS NOT STARTED), when:#starttlshas been called (@ssl_ctxhas been set),#start_tls_sessionhasn't (@sockis aTCPSocket).TLS (NOT ESTABLISHED), when:#start_tls_sessionwas called (@sockis anSSLSocket),@sock.sessionisn't available).Generally, users will only encounter these states in edge cases. For example:
STARTTLSwithNOorBAD, etcssl_ctx