Support SNMPv3 and asyncio in snmp sensor #14753

mtdcr · 2018-06-02T00:13:54Z

Instantiate pysnmp objects once during setup and reuse them. Requires asyncio, because SnmpEngine objects can't be shared between threads. This speeds up repeated queries significantly and simplifies support for different authentication types.

Related to #6973 and #11370.

For SNMPv3, the following new options were modified or added:

version
Changed to accept version '3'.
username
<string>
auth_key
<string>
auth_protocol
<none|hmac-md5|hmac-sha|hmac128-sha224|hmac192-sha256|hmac256-sha384|hmac384-sha512>
priv_key
<string>
priv_protocol
<none|des|3des-ede|aes-cfb-128|aes-cfb-192|aes-cfb-256>

Note:

auth_protocol defaults to none.
priv_protocol defaults to none.
Setting no auth_key forces auth_protocol to none.
Setting no priv_key forces priv_protocol to none.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#5484

Checklist:

The code change is tested and works locally.
Local tests pass with tox.

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

Documentation added/updated in home-assistant.github.io

No new files or dependencies were introduced.

homeassistant · 2018-06-02T00:13:56Z

Hi @mtdcr,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2018-06-02T00:14:05Z

homeassistant/components/sensor/snmp.py

+                authProtocol=auth_protocols[authproto] if authkey
+                    else usmNoAuthProtocol,
+                provProtocol=priv_protocols[privproto] if privkey
+                    else usmNoPrivProtocol,


continuation line unaligned for hanging indent

houndci-bot · 2018-06-02T00:14:05Z

homeassistant/components/sensor/snmp.py

+                authKey=authkey or None,
+                privKey=privkey or None,
+                authProtocol=auth_protocols[authproto] if authkey
+                    else usmNoAuthProtocol,


continuation line unaligned for hanging indent

mtdcr · 2018-06-02T18:04:59Z

TOXENV=pylint fails on Travis CI:

E:161,40: No value for argument 'transportTarget' in function call (no-value-for-parameter)
E:161,40: No value for argument 'contextData' in function call (no-value-for-parameter)

I'd say that's not true. And it doesn't occur when I run the tests locally.

mtdcr · 2018-06-02T18:51:44Z

I managed to reproduce the warning locally and successively replaced the code in question with functionally equivalent code accepted by pylint.

dgomes · 2018-06-02T23:12:07Z

We have adopted PEP 492, please update accordingly, eg:

@asyncio.coroutine
def function():`

to

async def function

yield from becomes await

pvizeli · 2018-06-06T08:19:44Z

homeassistant/components/sensor/snmp.py

+    vol.Optional(CONF_AUTH_KEY): cv.string,
+    vol.Optional(CONF_AUTH_PROTOCOL, default=DEFAULT_AUTH_PROTOCOL):
+        vol.In(AUTH_PROTOCOLS),
+    vol.Optional(CONF_PRIV_KEY): cv.string,


is that a file, use cv.isfile

No, it's a string.

mtdcr · 2018-06-06T16:42:49Z

@dgomes: I've updated my branch.

pvizeli · 2018-06-15T13:11:57Z

homeassistant/components/sensor/snmp.py

+            UsmUserData(
+                username,
+                authKey=authkey or None,
+                privKey=privkey or None,


Need not set to None

This replaces en empty string with None, which makes a difference in UsmUserData. Are you implying that authkey=="" is guaranteed not to appear in this codepath?

pvizeli · 2018-06-15T13:24:29Z

Use on top:

MAP_XY = {
   'hmac-md5': 'usmHMACMD5AuthProtocol',
}
...
vol.In(MAP_XY.keys())
...

import pysnmp.hlapi.asyncio as snmp
...
dynval = getattr(snmp, MAP_XY[bla])

mtdcr · 2018-06-25T19:15:44Z

@pvizeli: Thanks for your suggestions! I've updated my branch.

fabaff · 2018-07-03T12:52:15Z

homeassistant/components/sensor/snmp.py

+    vol.Optional(CONF_USERNAME): cv.string,
+    vol.Optional(CONF_AUTH_KEY): cv.string,
+    vol.Optional(CONF_AUTH_PROTOCOL, default=DEFAULT_AUTH_PROTOCOL):
+        vol.In(MAP_AUTH_PROTOCOLS.keys()),


.keys() is not needed, it's the default.

fabaff · 2018-07-03T12:52:18Z

homeassistant/components/sensor/snmp.py

+        vol.In(MAP_AUTH_PROTOCOLS.keys()),
+    vol.Optional(CONF_PRIV_KEY): cv.string,
+    vol.Optional(CONF_PRIV_PROTOCOL, default=DEFAULT_PRIV_PROTOCOL):
+        vol.In(MAP_PRIV_PROTOCOLS.keys()),


thrawnarn · 2018-07-31T07:24:01Z

Any progress on this PR?

mtdcr · 2018-07-31T09:14:48Z

I rebased this branch on dev again and removed keys(), even though using keys() was suggested to use before. Contributing to this project is fun, really.

MartinHjelmare

Looks good to me.
@pvizeli @fabaff ?

* Update sensor.snmp.markdown Depends on home-assistant/core#14753 * ✏️ Minor tweaks * Minor changes

homeassistant added cla-needed platform: sensor.snmp labels Jun 2, 2018

houndci-bot reviewed Jun 2, 2018

View reviewed changes

homeassistant added cla-signed and removed cla-needed labels Jun 2, 2018

mtdcr mentioned this pull request Jun 2, 2018

Support SNMPv3 and asyncio in snmp switch #14754

Merged

3 tasks

homeassistant added the cla-signed label Jun 2, 2018

mtdcr mentioned this pull request Jun 2, 2018

Update sensor.snmp.markdown home-assistant/home-assistant.io#5484

Merged

2 tasks

pvizeli reviewed Jun 6, 2018

View reviewed changes

homeassistant added the cla-signed label Jun 6, 2018

pvizeli reviewed Jun 15, 2018

View reviewed changes

homeassistant added the cla-signed label Jun 25, 2018

ghost added the in progress label Jun 25, 2018

homeassistant added cla-signed labels Jun 25, 2018

dgomes added the Ready for review label Jul 1, 2018

fabaff added docs-missing and removed docs-missing labels Jul 3, 2018

fabaff reviewed Jul 3, 2018

View reviewed changes

snmp sensor: Add asyncio support and reuse SnmpEngine object

d38bbdc

homeassistant added the cla-signed label Jul 31, 2018

snmp sensor: Support protocol v3

4069a05

homeassistant added the cla-signed label Jul 31, 2018

MartinHjelmare approved these changes Jul 31, 2018

View reviewed changes

Merge branch 'dev' into snmpv3-asyncio-sensor

5c4e969

ghost assigned fabaff Sep 7, 2018

fabaff pushed a commit to home-assistant/home-assistant.io that referenced this pull request Sep 7, 2018

Update sensor.snmp.markdown (#5484)

c8f7e3f

* Update sensor.snmp.markdown Depends on home-assistant/core#14753 * ✏️ Minor tweaks * Minor changes

Fix lint issue

e9d6f2b

homeassistant added the cla-signed label Sep 7, 2018

fabaff merged commit 50266e9 into home-assistant:dev Sep 7, 2018

ghost removed the in progress label Sep 7, 2018

balloob mentioned this pull request Sep 17, 2018

0.78.0 #16666

Merged

awarecan mentioned this pull request Sep 18, 2018

SNMP broken after upgrade to 0.78 #16679

Closed

home-assistant locked and limited conversation to collaborators Dec 10, 2018

ghost added integration: snmp and removed platform: sensor.snmp labels Mar 21, 2019

mtdcr deleted the snmpv3-asyncio-sensor branch April 10, 2021 18:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support SNMPv3 and asyncio in snmp sensor #14753

Support SNMPv3 and asyncio in snmp sensor #14753

mtdcr commented Jun 2, 2018 •

edited by fabaff

Loading

homeassistant commented Jun 2, 2018

houndci-bot Jun 2, 2018

houndci-bot Jun 2, 2018

mtdcr commented Jun 2, 2018

mtdcr commented Jun 2, 2018

dgomes commented Jun 2, 2018

pvizeli Jun 6, 2018

mtdcr Jun 6, 2018

mtdcr commented Jun 6, 2018

pvizeli Jun 15, 2018

mtdcr Jun 15, 2018

pvizeli commented Jun 15, 2018

mtdcr commented Jun 25, 2018

fabaff Jul 3, 2018

fabaff Jul 3, 2018

thrawnarn commented Jul 31, 2018

mtdcr commented Jul 31, 2018

MartinHjelmare left a comment

Support SNMPv3 and asyncio in snmp sensor #14753

Support SNMPv3 and asyncio in snmp sensor #14753

Conversation

mtdcr commented Jun 2, 2018 • edited by fabaff Loading

Checklist:

homeassistant commented Jun 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mtdcr commented Jun 2, 2018

mtdcr commented Jun 2, 2018

dgomes commented Jun 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mtdcr commented Jun 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pvizeli commented Jun 15, 2018

mtdcr commented Jun 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thrawnarn commented Jul 31, 2018

mtdcr commented Jul 31, 2018

MartinHjelmare left a comment

Choose a reason for hiding this comment

mtdcr commented Jun 2, 2018 •

edited by fabaff

Loading