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

isync/mbsync: update module for 1.5.0 changes #5918

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

KarlJoad
Copy link
Contributor

Description

Update isync to use new features in isync 1.5.0.

Closes #5884 and #3317.

Checklist

  • Change is backwards compatible.

  • Code formatted with ./format.

  • Code tested through nix-shell --pure tests -A run.all or nix develop --ignore-environment .#all using Flakes.

  • Test cases updated/added. See example.

  • Commit messages are formatted like

    {component}: {description}
    
    {long description}
    

    See CONTRIBUTING for more information and recent commit messages for examples.

  • If this PR adds a new module

    • Added myself as module maintainer. See example.

Maintainer CC

@github-actions github-actions bot added the mail label Sep 30, 2024
@KarlJoad KarlJoad force-pushed the mbsync-updates branch 2 times, most recently from 10c889c to 36f99cd Compare September 30, 2024 17:20
mbsync 1.5.0 replaced the name of the configuration option [1].

Also update SSLVersions to TLSVersions for the same reason. Inform the
user if the option was renamed.

[1] https://sourceforge.net/projects/isync/files/isync/1.5.0/
mbsync 1.5.0 supports placing isync's configuration file in
$XDG_CONFIG_HOME/isyncrc [1].

[1] https://sourceforge.net/projects/isync/files/isync/1.5.0/
SSLType IMAPS
SSLVersions TLSv1.3 TLSv1.2
TLSType IMAPS
TLSVersions TLSv1.3 TLSv1.2

Choose a reason for hiding this comment

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

Suggested change
TLSVersions TLSv1.3 TLSv1.2
TLSVersions +1.3 +1.2

Sorry about the drive-by comment, but i just got bitten by this change in isync/mbsync. The SSLVersions and TLSVersions config keys don't take the same arguments, it's not a simple rename.

I have found references here https://sourceforge.net/projects/isync/files/isync/1.5.0/ and here https://isync.sourceforge.io/mbsync.html but frustratingly i haven't found actual documentation for permitted arguments. By trial and error i managed to make things work with the + as shown above.

Disclosure/disclaimer is that i'm using isync/mbsync on macOS via Homebrew – i am just making a comment here before this change wastes other people's time more than necessary. I found this PR because i was looking for working examples.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good catch! Thanks! I will have to mark SSLVersions as completely deprecated and inform the user about TLSVersions along with the +/- change, I guess.

...but frustratingly i haven't found actual documentation for permitted arguments.

I found the source file that implements this parsing (src/drv_imap.c:3788). They also support a - symbol to disable a particular version. I suspect this was an undocumented change to support isync 1.5.0's default-disabling of TLS 1.0/1.1.

I will document this in a release note. But because SSLVersions/TLSVersions is part of extraConfig, I doubt I will be able to automatically catch this misconfiguration.

Copy link
Contributor

Choose a reason for hiding this comment

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

isync 1.5.0's default-disabling of TLS 1.0/1.1

This is the only reason I used SSLVersions so I could delete the line. (I probably won't, though, in case there are future changes.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mbsync: update module for v1.5.0
3 participants