Skip to content

Attach SSL context to SMTP notify and IMAP sensor#72568

Merged
balloob merged 3 commits into
devfrom
attach-SSL-context-smtp-imap
May 27, 2022
Merged

Attach SSL context to SMTP notify and IMAP sensor#72568
balloob merged 3 commits into
devfrom
attach-SSL-context-smtp-imap

Conversation

@balloob
Copy link
Copy Markdown
Member

@balloob balloob commented May 26, 2022

Breaking change

Proposed change

Default SSL contexts in Python standard lib for SMTP and IMAP are set to use an unverified context. This fixes it.

Thanks to @The-Compiler for his research and notifying us.

Background: python/cpython#91826

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@bdraco
Copy link
Copy Markdown
Member

bdraco commented May 26, 2022

I think this is a good change, but this will be a breaking change for the reasons outlined in python/cpython#91826 (comment)

In my experience there are a vast number of smtp servers that support STARTTLS but don't actually present a valid certificate because since they don't support SNI. SMTP server SNI support has historically been far behind what browsers support, and since other SMTP server's historically have not enforced verification, the state of these its not so great.

I expect many users will need to turn the verification off to be able to send mail.

@balloob
Copy link
Copy Markdown
Member Author

balloob commented May 27, 2022

Pushed a commit that allows disabling the SSL verification. By default certification is enabled. Made an exception to update YAML configuration because it's security related.

Copy link
Copy Markdown
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

LGTM. Exception seems 100% justified to me given its security.

@balloob balloob merged commit cbd0c89 into dev May 27, 2022
@balloob balloob deleted the attach-SSL-context-smtp-imap branch May 27, 2022 05:15
@github-actions github-actions Bot locked and limited conversation to collaborators May 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants