mirror of
https://github.com/xcat2/confluent.git
synced 2026-10-20 06:35:33 +00:00
Jarrod Johnson
188 lines
8.1 KiB
Python
188 lines
8.1 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Copyright 2016-2025 Lenovo
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
# This provides a simplified wrapper around snmp implementation roughly
|
|
# mapping to the net-snmp commands
|
|
|
|
# net-snmp-python was considered as the API is cleaner, but
|
|
# want clean asyncio support
|
|
# This module simplifies the complex hlapi pysnmp interface
|
|
|
|
import asyncio
|
|
import confluent.exceptions as exc
|
|
import inspect
|
|
import socket
|
|
try:
|
|
# Some pysnmp installs expect util to be an attribute of importlib, but that doesn't naturally happen reliably
|
|
# So we prime the pump by importing it the proper way, then pysnmp can succesfully do it the wrong way
|
|
import importlib.util
|
|
except ImportError:
|
|
importlib = None
|
|
|
|
import pysnmp.hlapi.asyncio as snmp
|
|
|
|
async def _get_transport(name):
|
|
# Annoyingly, pysnmp does not automatically determine ipv6 v ipv4
|
|
res = await asyncio.get_running_loop().getaddrinfo(name, 161, type=socket.SOCK_DGRAM)
|
|
if res[0][0] == socket.AF_INET6:
|
|
target = snmp.Udp6TransportTarget
|
|
else:
|
|
target = snmp.UdpTransportTarget
|
|
if hasattr(target, 'create'):
|
|
return await target.create(res[0][4], timeout=2)
|
|
return target(res[0][4], timeout=2)
|
|
|
|
|
|
class Session(object):
|
|
|
|
def __init__(self, server, secret, username=None, context=None, privacy_protocol=None, auth_protocol=None):
|
|
"""Create a new session to interrogate a switch
|
|
|
|
If username is not given, it is assumed that
|
|
the secret is community string, and v2c is used. If a username given,
|
|
it'll assume SHA auth and DES privacy with the secret being the same
|
|
for both.
|
|
|
|
:param server: The network name/address to target
|
|
:param secret: The community string or password
|
|
:param username: The username for SNMPv3
|
|
:param context: The SNMPv3 context or index for community indexing
|
|
"""
|
|
self.server = server
|
|
self.context = context
|
|
if username is None:
|
|
# SNMP v2c
|
|
self.authdata = snmp.CommunityData(secret, mpModel=1)
|
|
else:
|
|
if privacy_protocol == 'aes':
|
|
privproto = snmp.usmAesCfb128Protocol
|
|
elif privacy_protocol == 'aes256':
|
|
privproto = snmp.usmAesCfb256Protocol
|
|
elif privacy_protocol in ('des', None):
|
|
privproto = snmp.usmDESPrivProtocol
|
|
else:
|
|
raise exc.ConfluentException('Unsupported SNMPv3 privacy protocol '
|
|
'{0}'.format(privacy_protocol))
|
|
if auth_protocol == 'sha256':
|
|
authproto = snmp.usmHMAC192SHA256AuthProtocol
|
|
elif auth_protocol == 'md5':
|
|
authproto = snmp.usmHMACMD5AuthProtocol
|
|
elif auth_protocol in ('sha', None):
|
|
authproto = snmp.usmHMACSHAAuthProtocol
|
|
else:
|
|
raise exc.ConfluentException('Unsupported SNMPv3 auth protocol '
|
|
'{0}'.format(auth_protocol))
|
|
self.authdata = snmp.UsmUserData(
|
|
username, authKey=secret, privKey=secret,
|
|
authProtocol=authproto,
|
|
privProtocol=privproto)
|
|
self.eng = snmp.SnmpEngine()
|
|
|
|
async def walk(self, oid):
|
|
"""Walk over children of a given OID
|
|
|
|
This is roughly equivalent to snmpwalk. It will automatically try to
|
|
be a snmpbulkwalk if possible.
|
|
|
|
:param oid: The SNMP object identifier
|
|
"""
|
|
# SNMP is a complicated mess of things. Will endeavor to shield caller
|
|
# from as much as possible, assuming reasonable defaults when possible.
|
|
# there may come a time where we add more parameters to override the
|
|
# automatic behavior (e.g. DES is weak, so it's likely to be
|
|
# overriden, but some devices only support DES)
|
|
tp = await _get_transport(self.server)
|
|
ctx = snmp.ContextData(self.context)
|
|
resolvemib = False
|
|
if '::' in oid:
|
|
resolvemib = True
|
|
mib, field = oid.split('::')
|
|
obj = snmp.ObjectType(snmp.ObjectIdentity(mib, field))
|
|
else:
|
|
obj = snmp.ObjectType(snmp.ObjectIdentity(oid))
|
|
if hasattr(snmp, 'bulk_walk_cmd'):
|
|
walking = snmp.bulk_walk_cmd(self.eng, self.authdata, tp, ctx, 0, 10, obj,
|
|
lexicographicMode=False, lookupMib=resolvemib)
|
|
async for rsp in walking:
|
|
errstr, errnum, erridx, answers = rsp
|
|
if errstr:
|
|
errstr = str(errstr)
|
|
finerr = errstr + ' while trying to connect to ' \
|
|
'{0}'.format(self.server)
|
|
if errstr in ('Unknown USM user', 'unknownUserName',
|
|
'wrongDigest', 'Wrong SNMP PDU digest'):
|
|
raise exc.TargetEndpointBadCredentials(finerr)
|
|
# need to do bad credential versus timeout
|
|
raise exc.TargetEndpointUnreachable(finerr)
|
|
elif errnum:
|
|
raise exc.ConfluentException(errnum.prettyPrint() +
|
|
' while trying to connect to '
|
|
'{0}'.format(self.server))
|
|
for ans in answers:
|
|
if not obj[0].isPrefixOf(ans[0]):
|
|
break
|
|
yield ans
|
|
else: # PySNMP 5 compatibility path for older async
|
|
root = None
|
|
while True:
|
|
rsp = snmp.bulkCmd(self.eng, self.authdata, tp, ctx, 0, 10, obj,
|
|
lookupMib=resolvemib)
|
|
while inspect.isawaitable(rsp):
|
|
rsp = await rsp
|
|
errstr, errnum, erridx, answers = rsp
|
|
if errstr:
|
|
errstr = str(errstr)
|
|
finerr = errstr + ' while trying to connect to ' \
|
|
'{0}'.format(self.server)
|
|
if errstr in ('Unknown USM user', 'unknownUserName',
|
|
'wrongDigest', 'Wrong SNMP PDU digest'):
|
|
raise exc.TargetEndpointBadCredentials(finerr)
|
|
# need to do bad credential versus timeout
|
|
raise exc.TargetEndpointUnreachable(finerr)
|
|
elif errnum:
|
|
raise exc.ConfluentException(errnum.prettyPrint() +
|
|
' while trying to connect to '
|
|
'{0}'.format(self.server))
|
|
if not answers:
|
|
break
|
|
if root is None:
|
|
root = obj[0]
|
|
last_identity = None
|
|
for row in answers:
|
|
if snmp.isEndOfMib(row):
|
|
return
|
|
for ans in row:
|
|
if not root.isPrefixOf(ans[0]):
|
|
# PySNMP returns leftovers in a bulk command
|
|
# filter out such leftovers
|
|
return
|
|
last_identity = ans[0]
|
|
yield ans
|
|
if last_identity is None:
|
|
break
|
|
obj = snmp.ObjectType(snmp.ObjectIdentity(last_identity))
|
|
#except snmperr.WrongValueError:
|
|
# raise exc.TargetEndpointBadCredentials('Invalid SNMPv3 password')
|
|
|
|
|
|
|
|
if __name__ == '__main__':
|
|
import sys
|
|
ts = Session(sys.argv[1], 'public')
|
|
for kp in ts.walk(sys.argv[2]):
|
|
print(str(kp[0]))
|
|
print(str(kp[1]))
|