search

aatxe / irc

the irc crate – usable, async IRC for Rust
Mozilla Public License 2.0
525 stars 100 forks source link

Add SASL PLAIN authentication support #261

Open anisse opened 2 months ago

anisse commented 2 months ago

Add a new config option "sasl", which can be set to "none" or "plain". In none, behavior does not change and will be the same as, using the password config option with PASS. When plain is selected, the new "login" option will be coupled with the existing "password" option to connect to the server with SASL PLAIN mode.

The implementation currently does blind SASL login. It does not check if the server supports sasl, sasl plain, and does not verify login errors, etc. For simplicity, I chose not to add a state-machine that would handle verifying SASL support, login success, etc. It would need a different, async API for that, and I thought it would be overkill. It has been tested successfully with libera.chat.

This PR adds a new dependency "base64ct", a base64 crate by the RustCrypto project with no dependency (here std is enabled though); if you prefer I can add an ad-hoc licence compatible base64 encode function. I'd prefer not to guard the SASL support behind a feature if possible.

Tests were added and doc has been updated.

Related to #166

anisse commented 2 months ago

So... I ran cargo semver-checks and technically this change is a semver violation. I wanted to add a commit to mark the Config struct as non-exhaustive, but this is an even bigger breakage. Since both new fields (sasl and login) are Option, which has a default and can be Deserialized from a config file, I think it's not to big of an issue.