jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-19 11:17:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add verify_ssl option for connection setup to synology_dsm (#42539)

Browse Source
This commit is contained in:
Michael 2020-11-02 14:23:16 +01:00 committed by GitHub
parent 098dead16d
commit 8d9a844e84
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 55 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
homeassistant/components/synology_dsm/__init__.py
View File

@ -27,6 +27,7 @@ from homeassistant.const import (
CONF_SSL, CONF_SSL,
CONF_TIMEOUT, CONF_TIMEOUT,
CONF_USERNAME, CONF_USERNAME,
CONF_VERIFY_SSL,
) )
from homeassistant.core import callback from homeassistant.core import callback
from homeassistant.exceptions import ConfigEntryNotReady from homeassistant.exceptions import ConfigEntryNotReady
@ -43,7 +44,8 @@ from homeassistant.helpers.typing import HomeAssistantType
from .const import ( from .const import (
CONF_VOLUMES, CONF_VOLUMES,
DEFAULT_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL,
DEFAULT_SSL, DEFAULT_USE_SSL,
DEFAULT_VERIFY_SSL,
DOMAIN, DOMAIN,
ENTITY_CLASS, ENTITY_CLASS,
ENTITY_ENABLE, ENTITY_ENABLE,
@ -64,7 +66,8 @@ CONFIG_SCHEMA = vol.Schema(
{ {
vol.Required(CONF_HOST): cv.string, vol.Required(CONF_HOST): cv.string,
vol.Optional(CONF_PORT): cv.port, vol.Optional(CONF_PORT): cv.port,
vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean, vol.Optional(CONF_SSL, default=DEFAULT_USE_SSL): cv.boolean,
vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
vol.Required(CONF_USERNAME): cv.string, vol.Required(CONF_USERNAME): cv.string,
vol.Required(CONF_PASSWORD): cv.string, vol.Required(CONF_PASSWORD): cv.string,
vol.Optional(CONF_DISKS): cv.ensure_list, vol.Optional(CONF_DISKS): cv.ensure_list,
@ -260,6 +263,7 @@ class SynoApi:
self._entry.data[CONF_USERNAME], self._entry.data[CONF_USERNAME],
self._entry.data[CONF_PASSWORD], self._entry.data[CONF_PASSWORD],
self._entry.data[CONF_SSL], self._entry.data[CONF_SSL],
self._entry.data[CONF_VERIFY_SSL],
timeout=self._entry.options.get(CONF_TIMEOUT), timeout=self._entry.options.get(CONF_TIMEOUT),
) )
await self._hass.async_add_executor_job( await self._hass.async_add_executor_job(

20
homeassistant/components/synology_dsm/config_flow.py
View File

@ -25,6 +25,7 @@ from homeassistant.const import (
CONF_SSL, CONF_SSL,
CONF_TIMEOUT, CONF_TIMEOUT,
CONF_USERNAME, CONF_USERNAME,
CONF_VERIFY_SSL,
) )
from homeassistant.core import callback from homeassistant.core import callback
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
@ -34,8 +35,9 @@ from .const import (
DEFAULT_PORT, DEFAULT_PORT,
DEFAULT_PORT_SSL, DEFAULT_PORT_SSL,
DEFAULT_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL,
DEFAULT_SSL,
DEFAULT_TIMEOUT, DEFAULT_TIMEOUT,
DEFAULT_USE_SSL,
DEFAULT_VERIFY_SSL,
) )
from .const import DOMAIN # pylint: disable=unused-import from .const import DOMAIN # pylint: disable=unused-import
@ -62,7 +64,13 @@ def _ordered_shared_schema(schema_input):
vol.Required(CONF_USERNAME, default=schema_input.get(CONF_USERNAME, "")): str, vol.Required(CONF_USERNAME, default=schema_input.get(CONF_USERNAME, "")): str,
vol.Required(CONF_PASSWORD, default=schema_input.get(CONF_PASSWORD, "")): str, vol.Required(CONF_PASSWORD, default=schema_input.get(CONF_PASSWORD, "")): str,
vol.Optional(CONF_PORT, default=schema_input.get(CONF_PORT, "")): str, vol.Optional(CONF_PORT, default=schema_input.get(CONF_PORT, "")): str,
vol.Optional(CONF_SSL, default=schema_input.get(CONF_SSL, DEFAULT_SSL)): bool, vol.Optional(
CONF_SSL, default=schema_input.get(CONF_SSL, DEFAULT_USE_SSL)
): bool,
vol.Optional(
CONF_VERIFY_SSL,
default=schema_input.get(CONF_VERIFY_SSL, DEFAULT_VERIFY_SSL),
): bool,
} }
@ -117,7 +125,8 @@ class SynologyDSMFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
port = user_input.get(CONF_PORT) port = user_input.get(CONF_PORT)
username = user_input[CONF_USERNAME] username = user_input[CONF_USERNAME]
password = user_input[CONF_PASSWORD] password = user_input[CONF_PASSWORD]
use_ssl = user_input.get(CONF_SSL, DEFAULT_SSL) use_ssl = user_input.get(CONF_SSL, DEFAULT_USE_SSL)
verify_ssl = user_input.get(CONF_VERIFY_SSL, DEFAULT_VERIFY_SSL)
otp_code = user_input.get(CONF_OTP_CODE) otp_code = user_input.get(CONF_OTP_CODE)
if not port: if not port:
@ -126,7 +135,9 @@ class SynologyDSMFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
else: else:
port = DEFAULT_PORT port = DEFAULT_PORT
api = SynologyDSM(host, port, username, password, use_ssl, timeout=30) api = SynologyDSM(
host, port, username, password, use_ssl, verify_ssl, timeout=30
)
try: try:
serial = await self.hass.async_add_executor_job( serial = await self.hass.async_add_executor_job(
@ -161,6 +172,7 @@ class SynologyDSMFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
CONF_HOST: host, CONF_HOST: host,
CONF_PORT: port, CONF_PORT: port,
CONF_SSL: use_ssl, CONF_SSL: use_ssl,
CONF_VERIFY_SSL: verify_ssl,
CONF_USERNAME: username, CONF_USERNAME: username,
CONF_PASSWORD: password, CONF_PASSWORD: password,
CONF_MAC: api.network.macs, CONF_MAC: api.network.macs,

3
homeassistant/components/synology_dsm/const.py
View File

@ -27,7 +27,8 @@ UNDO_UPDATE_LISTENER = "undo_update_listener"
# Configuration # Configuration
CONF_VOLUMES = "volumes" CONF_VOLUMES = "volumes"
DEFAULT_SSL = True DEFAULT_USE_SSL = True
DEFAULT_VERIFY_SSL = False
DEFAULT_PORT = 5000 DEFAULT_PORT = 5000
DEFAULT_PORT_SSL = 5001 DEFAULT_PORT_SSL = 5001
# Options # Options

2
homeassistant/components/synology_dsm/strings.json
View File

@ -8,6 +8,7 @@
"host": "[%key:common::config_flow::data::host%]", "host": "[%key:common::config_flow::data::host%]",
"port": "[%key:common::config_flow::data::port%]", "port": "[%key:common::config_flow::data::port%]",
"ssl": "[%key:common::config_flow::data::ssl%]", "ssl": "[%key:common::config_flow::data::ssl%]",
"verify_ssl": "[%key:common::config_flow::data::verify_ssl%]",
"username": "[%key:common::config_flow::data::username%]", "username": "[%key:common::config_flow::data::username%]",
"password": "[%key:common::config_flow::data::password%]" "password": "[%key:common::config_flow::data::password%]"
} }
@ -23,6 +24,7 @@
"description": "Do you want to setup {name} ({host})?", "description": "Do you want to setup {name} ({host})?",
"data": { "data": {
"ssl": "[%key:common::config_flow::data::ssl%]", "ssl": "[%key:common::config_flow::data::ssl%]",
"verify_ssl": "[%key:common::config_flow::data::verify_ssl%]",
"username": "[%key:common::config_flow::data::username%]", "username": "[%key:common::config_flow::data::username%]",
"password": "[%key:common::config_flow::data::password%]", "password": "[%key:common::config_flow::data::password%]",
"port": "[%key:common::config_flow::data::port%]" "port": "[%key:common::config_flow::data::port%]"

8
homeassistant/components/synology_dsm/translations/en.json
View File

@ -5,9 +5,7 @@
}, },
"error": { "error": {
"cannot_connect": "Failed to connect", "cannot_connect": "Failed to connect",
"connection": "Connection error: please check your host, port & ssl",
"invalid_auth": "Invalid authentication", "invalid_auth": "Invalid authentication",
"login": "Login error: please check your username & password",
"missing_data": "Missing data: please retry later or an other configuration", "missing_data": "Missing data: please retry later or an other configuration",
"otp_failed": "Two-step authentication failed, retry with a new pass code", "otp_failed": "Two-step authentication failed, retry with a new pass code",
"unknown": "Unexpected error" "unknown": "Unexpected error"
@ -25,7 +23,8 @@
"password": "Password", "password": "Password",
"port": "Port", "port": "Port",
"ssl": "Uses an SSL certificate", "ssl": "Uses an SSL certificate",
"username": "Username" "username": "Username",
"verify_ssl": "Verify SSL certificate"
}, },
"description": "Do you want to setup {name} ({host})?", "description": "Do you want to setup {name} ({host})?",
"title": "Synology DSM" "title": "Synology DSM"
@ -36,7 +35,8 @@
"password": "Password", "password": "Password",
"port": "Port", "port": "Port",
"ssl": "Uses an SSL certificate", "ssl": "Uses an SSL certificate",
"username": "Username" "username": "Username",
"verify_ssl": "Verify SSL certificate"
}, },
"title": "Synology DSM" "title": "Synology DSM"
} }

36
tests/components/synology_dsm/test_config_flow.py
View File

@ -16,8 +16,9 @@ from homeassistant.components.synology_dsm.const import (
DEFAULT_PORT, DEFAULT_PORT,
DEFAULT_PORT_SSL, DEFAULT_PORT_SSL,
DEFAULT_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL,
DEFAULT_SSL,
DEFAULT_TIMEOUT, DEFAULT_TIMEOUT,
DEFAULT_USE_SSL,
DEFAULT_VERIFY_SSL,
DOMAIN, DOMAIN,
) )
from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_SSDP, SOURCE_USER from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_SSDP, SOURCE_USER
@ -31,6 +32,7 @@ from homeassistant.const import (
CONF_SSL, CONF_SSL,
CONF_TIMEOUT, CONF_TIMEOUT,
CONF_USERNAME, CONF_USERNAME,
CONF_VERIFY_SSL,
) )
from homeassistant.helpers.typing import HomeAssistantType from homeassistant.helpers.typing import HomeAssistantType
@ -42,7 +44,8 @@ SERIAL = "mySerial"
HOST_2 = "nas.worldwide.me" HOST_2 = "nas.worldwide.me"
SERIAL_2 = "mySerial2" SERIAL_2 = "mySerial2"
PORT = 1234 PORT = 1234
SSL = True USE_SSL = True
VERIFY_SSL = False
USERNAME = "Home_Assistant" USERNAME = "Home_Assistant"
PASSWORD = "password" PASSWORD = "password"
DEVICE_TOKEN = "Dév!cè_T0k€ñ" DEVICE_TOKEN = "Dév!cè_T0k€ñ"
@ -124,7 +127,8 @@ async def test_user(hass: HomeAssistantType, service: MagicMock):
data={ data={
CONF_HOST: HOST, CONF_HOST: HOST,
CONF_PORT: PORT, CONF_PORT: PORT,
CONF_SSL: SSL, CONF_SSL: USE_SSL,
CONF_VERIFY_SSL: VERIFY_SSL,
CONF_USERNAME: USERNAME, CONF_USERNAME: USERNAME,
CONF_PASSWORD: PASSWORD, CONF_PASSWORD: PASSWORD,
}, },
@ -134,7 +138,8 @@ async def test_user(hass: HomeAssistantType, service: MagicMock):
assert result["title"] == HOST assert result["title"] == HOST
assert result["data"][CONF_HOST] == HOST assert result["data"][CONF_HOST] == HOST
assert result["data"][CONF_PORT] == PORT assert result["data"][CONF_PORT] == PORT
assert result["data"][CONF_SSL] == SSL assert result["data"][CONF_SSL] == USE_SSL
assert result["data"][CONF_VERIFY_SSL] == VERIFY_SSL
assert result["data"][CONF_USERNAME] == USERNAME assert result["data"][CONF_USERNAME] == USERNAME
assert result["data"][CONF_PASSWORD] == PASSWORD assert result["data"][CONF_PASSWORD] == PASSWORD
assert result["data"][CONF_MAC] == MACS assert result["data"][CONF_MAC] == MACS
@ -150,6 +155,7 @@ async def test_user(hass: HomeAssistantType, service: MagicMock):
data={ data={
CONF_HOST: HOST, CONF_HOST: HOST,
CONF_SSL: False, CONF_SSL: False,
CONF_VERIFY_SSL: VERIFY_SSL,
CONF_USERNAME: USERNAME, CONF_USERNAME: USERNAME,
CONF_PASSWORD: PASSWORD, CONF_PASSWORD: PASSWORD,
}, },
@ -160,6 +166,7 @@ async def test_user(hass: HomeAssistantType, service: MagicMock):
assert result["data"][CONF_HOST] == HOST assert result["data"][CONF_HOST] == HOST
assert result["data"][CONF_PORT] == DEFAULT_PORT assert result["data"][CONF_PORT] == DEFAULT_PORT
assert not result["data"][CONF_SSL] assert not result["data"][CONF_SSL]
assert result["data"][CONF_VERIFY_SSL] == VERIFY_SSL
assert result["data"][CONF_USERNAME] == USERNAME assert result["data"][CONF_USERNAME] == USERNAME
assert result["data"][CONF_PASSWORD] == PASSWORD assert result["data"][CONF_PASSWORD] == PASSWORD
assert result["data"][CONF_MAC] == MACS assert result["data"][CONF_MAC] == MACS
@ -201,7 +208,8 @@ async def test_user_2sa(hass: HomeAssistantType, service_2sa: MagicMock):
assert result["title"] == HOST assert result["title"] == HOST
assert result["data"][CONF_HOST] == HOST assert result["data"][CONF_HOST] == HOST
assert result["data"][CONF_PORT] == DEFAULT_PORT_SSL assert result["data"][CONF_PORT] == DEFAULT_PORT_SSL
assert result["data"][CONF_SSL] == DEFAULT_SSL assert result["data"][CONF_SSL] == DEFAULT_USE_SSL
assert result["data"][CONF_VERIFY_SSL] == DEFAULT_VERIFY_SSL
assert result["data"][CONF_USERNAME] == USERNAME assert result["data"][CONF_USERNAME] == USERNAME
assert result["data"][CONF_PASSWORD] == PASSWORD assert result["data"][CONF_PASSWORD] == PASSWORD
assert result["data"][CONF_MAC] == MACS assert result["data"][CONF_MAC] == MACS
@ -225,7 +233,8 @@ async def test_user_vdsm(hass: HomeAssistantType, service_vdsm: MagicMock):
data={ data={
CONF_HOST: HOST, CONF_HOST: HOST,
CONF_PORT: PORT, CONF_PORT: PORT,
CONF_SSL: SSL, CONF_SSL: USE_SSL,
CONF_VERIFY_SSL: VERIFY_SSL,
CONF_USERNAME: USERNAME, CONF_USERNAME: USERNAME,
CONF_PASSWORD: PASSWORD, CONF_PASSWORD: PASSWORD,
}, },
@ -235,7 +244,8 @@ async def test_user_vdsm(hass: HomeAssistantType, service_vdsm: MagicMock):
assert result["title"] == HOST assert result["title"] == HOST
assert result["data"][CONF_HOST] == HOST assert result["data"][CONF_HOST] == HOST
assert result["data"][CONF_PORT] == PORT assert result["data"][CONF_PORT] == PORT
assert result["data"][CONF_SSL] == SSL assert result["data"][CONF_SSL] == USE_SSL
assert result["data"][CONF_VERIFY_SSL] == VERIFY_SSL
assert result["data"][CONF_USERNAME] == USERNAME assert result["data"][CONF_USERNAME] == USERNAME
assert result["data"][CONF_PASSWORD] == PASSWORD assert result["data"][CONF_PASSWORD] == PASSWORD
assert result["data"][CONF_MAC] == MACS assert result["data"][CONF_MAC] == MACS
@ -257,7 +267,8 @@ async def test_import(hass: HomeAssistantType, service: MagicMock):
assert result["title"] == HOST assert result["title"] == HOST
assert result["data"][CONF_HOST] == HOST assert result["data"][CONF_HOST] == HOST
assert result["data"][CONF_PORT] == DEFAULT_PORT_SSL assert result["data"][CONF_PORT] == DEFAULT_PORT_SSL
assert result["data"][CONF_SSL] == DEFAULT_SSL assert result["data"][CONF_SSL] == DEFAULT_USE_SSL
assert result["data"][CONF_VERIFY_SSL] == DEFAULT_VERIFY_SSL
assert result["data"][CONF_USERNAME] == USERNAME assert result["data"][CONF_USERNAME] == USERNAME
assert result["data"][CONF_PASSWORD] == PASSWORD assert result["data"][CONF_PASSWORD] == PASSWORD
assert result["data"][CONF_MAC] == MACS assert result["data"][CONF_MAC] == MACS
@ -273,7 +284,8 @@ async def test_import(hass: HomeAssistantType, service: MagicMock):
data={ data={
CONF_HOST: HOST_2, CONF_HOST: HOST_2,
CONF_PORT: PORT, CONF_PORT: PORT,
CONF_SSL: SSL, CONF_SSL: USE_SSL,
CONF_VERIFY_SSL: VERIFY_SSL,
CONF_USERNAME: USERNAME, CONF_USERNAME: USERNAME,
CONF_PASSWORD: PASSWORD, CONF_PASSWORD: PASSWORD,
CONF_DISKS: ["sda", "sdb", "sdc"], CONF_DISKS: ["sda", "sdb", "sdc"],
@ -285,7 +297,8 @@ async def test_import(hass: HomeAssistantType, service: MagicMock):
assert result["title"] == HOST_2 assert result["title"] == HOST_2
assert result["data"][CONF_HOST] == HOST_2 assert result["data"][CONF_HOST] == HOST_2
assert result["data"][CONF_PORT] == PORT assert result["data"][CONF_PORT] == PORT
assert result["data"][CONF_SSL] == SSL assert result["data"][CONF_SSL] == USE_SSL
assert result["data"][CONF_VERIFY_SSL] == VERIFY_SSL
assert result["data"][CONF_USERNAME] == USERNAME assert result["data"][CONF_USERNAME] == USERNAME
assert result["data"][CONF_PASSWORD] == PASSWORD assert result["data"][CONF_PASSWORD] == PASSWORD
assert result["data"][CONF_MAC] == MACS assert result["data"][CONF_MAC] == MACS
@ -434,7 +447,8 @@ async def test_form_ssdp(hass: HomeAssistantType, service: MagicMock):
assert result["title"] == "192.168.1.5" assert result["title"] == "192.168.1.5"
assert result["data"][CONF_HOST] == "192.168.1.5" assert result["data"][CONF_HOST] == "192.168.1.5"
assert result["data"][CONF_PORT] == 5001 assert result["data"][CONF_PORT] == 5001
assert result["data"][CONF_SSL] == DEFAULT_SSL assert result["data"][CONF_SSL] == DEFAULT_USE_SSL
assert result["data"][CONF_VERIFY_SSL] == DEFAULT_VERIFY_SSL
assert result["data"][CONF_USERNAME] == USERNAME assert result["data"][CONF_USERNAME] == USERNAME
assert result["data"][CONF_PASSWORD] == PASSWORD assert result["data"][CONF_PASSWORD] == PASSWORD
assert result["data"][CONF_MAC] == MACS assert result["data"][CONF_MAC] == MACS