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

🔒 📚 Improvements and docs for SASL::ClientAdapter #320

Merged
merged 5 commits into from
Sep 13, 2024

Conversation

nevans
Copy link
Collaborator

@nevans nevans commented Sep 13, 2024

Several minor updates, all related to the SASL::ClientAdapter API:

  • Improved SASL::ClientAdapter documentation.
  • Added documention to SASL::ProtocolAdapters and each of the methods in SASL::ProtocolAdapters::Generic.
  • #host and #port didn't make sense in SASL::ProtocolAdapters. Moved them to SASL::ClientAdapter.
  • #service returns the generic GSSAPI service name ("host") rather than raise an exception.
  • Use Forwardable: almost all of the methods simply delegate to #client.
  • Delete IMAP::SASLAdapter#auth_capable?: the superclass definition is identical.

These were moved from SASL::ProtocolAdapters::Generic because they are
mostly specific to client implementation, not protocol specification.
It simply delegates to #client, so there's no need to redefine it here.
@nevans nevans merged commit 34c1064 into master Sep 13, 2024
18 checks passed
@nevans nevans deleted the sasl/client-adapter-api branch September 13, 2024 21:59
@nevans nevans added the SASL 🔒 Authentication and authentication mechanisms label Sep 13, 2024
@nevans nevans added the documentation Improvements or additions to documentation label Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation SASL 🔒 Authentication and authentication mechanisms
Development

Successfully merging this pull request may close these issues.

1 participant