path: root/pysnmp/entity/rfc3413/cmdrsp.py

#
# This file is part of pysnmp software.
#
# Copyright (c) 2005-2019, Ilya Etingof <etingof@gmail.com>
# License: http://snmplabs.com/pysnmp/license.html
#
import pysnmp.smi.error
from pysnmp import debug
from pysnmp.proto import errind
from pysnmp.proto import error
from pysnmp.proto import rfc1902
from pysnmp.proto import rfc1905
from pysnmp.proto import rfc3411
from pysnmp.proto.api import v2c  # backend is always SMIv2 compliant
from pysnmp.proto.proxy import rfc2576
from pysnmp.smi import exval


# 3.2
class CommandResponderBase(object):
    ACM_ID = 3  # default MIB access control method to use
    SUPPORTED_PDU_TYPES = ()
    SMI_ERROR_MAP = {
        pysnmp.smi.error.TooBigError: 'tooBig',
        # this should never bubble up, SNMP exception objects should be passed as values
        pysnmp.smi.error.NoSuchNameError: 'noSuchName',
        pysnmp.smi.error.BadValueError: 'badValue',
        pysnmp.smi.error.ReadOnlyError: 'readOnly',
        pysnmp.smi.error.GenError: 'genErr',
        pysnmp.smi.error.NoAccessError: 'noAccess',
        pysnmp.smi.error.WrongTypeError: 'wrongType',
        pysnmp.smi.error.WrongLengthError: 'wrongLength',
        pysnmp.smi.error.WrongEncodingError: 'wrongEncoding',
        pysnmp.smi.error.WrongValueError: 'wrongValue',
        pysnmp.smi.error.NoCreationError: 'noCreation',
        pysnmp.smi.error.InconsistentValueError: 'inconsistentValue',
        pysnmp.smi.error.ResourceUnavailableError: 'resourceUnavailable',
        pysnmp.smi.error.CommitFailedError: 'commitFailed',
        pysnmp.smi.error.UndoFailedError: 'undoFailed',
        pysnmp.smi.error.AuthorizationError: 'authorizationError',
        pysnmp.smi.error.NotWritableError: 'notWritable',
        pysnmp.smi.error.InconsistentNameError: 'inconsistentName'
    }

    def __init__(self, snmpEngine, snmpContext, cbCtx=None):
        snmpEngine.msgAndPduDsp.registerContextEngineId(
            snmpContext.contextEngineId, self.SUPPORTED_PDU_TYPES, self.processPdu
        )
        self.snmpContext = snmpContext
        self.cbCtx = cbCtx
        self.__pendingReqs = {}

    def close(self, snmpEngine):
        snmpEngine.msgAndPduDsp.unregisterContextEngineId(
            self.snmpContext.contextEngineId, self.SUPPORTED_PDU_TYPES
        )
        self.snmpContext = self.__pendingReqs = None

    def releaseStateInformation(self, stateReference):
        if stateReference in self.__pendingReqs:
            del self.__pendingReqs[stateReference]

    def sendVarBinds(self, snmpEngine, stateReference,
                     errorStatus, errorIndex, varBinds):
        (messageProcessingModel,
         securityModel,
         securityName,
         securityLevel,
         contextEngineId,
         contextName,
         pduVersion,
         PDU,
         origPdu,
         maxSizeResponseScopedPDU,
         statusInformation) = self.__pendingReqs[stateReference]

        v2c.apiPDU.setErrorStatus(PDU, errorStatus)
        v2c.apiPDU.setErrorIndex(PDU, errorIndex)
        v2c.apiPDU.setVarBinds(PDU, varBinds)

        debug.logger & debug.FLAG_APP and debug.logger(
            'sendVarBinds: stateReference %s, errorStatus %s, errorIndex %s, varBinds %s' % (
            stateReference, errorStatus, errorIndex, varBinds)
        )

        self.sendPdu(snmpEngine, stateReference, PDU)

    def sendPdu(self, snmpEngine, stateReference, PDU):
        (messageProcessingModel,
         securityModel,
         securityName,
         securityLevel,
         contextEngineId,
         contextName,
         pduVersion,
         _,
         origPdu,
         maxSizeResponseScopedPDU,
         statusInformation) = self.__pendingReqs[stateReference]

        # Agent-side API complies with SMIv2
        if messageProcessingModel == 0:
            PDU = rfc2576.v2ToV1(PDU, origPdu)

        # 3.2.6
        try:
            snmpEngine.msgAndPduDsp.returnResponsePdu(
                snmpEngine,
                messageProcessingModel,
                securityModel,
                securityName,
                securityLevel,
                contextEngineId,
                contextName,
                pduVersion,
                PDU,
                maxSizeResponseScopedPDU,
                stateReference,
                statusInformation
            )

        except error.StatusInformation as exc:
            debug.logger & debug.FLAG_APP and debug.logger(
                'sendPdu: stateReference %s, statusInformation %s' % (stateReference, exc))
            snmpSilentDrops, = snmpEngine.msgAndPduDsp.mibInstrumController.mibBuilder.importSymbols('__SNMPv2-MIB',
                                                                                                     'snmpSilentDrops')
            snmpSilentDrops.syntax += 1

    _getRequestType = rfc1905.GetRequestPDU.tagSet
    _getNextRequestType = rfc1905.GetNextRequestPDU.tagSet
    _setRequestType = rfc1905.SetRequestPDU.tagSet
    _counter64Type = rfc1902.Counter64.tagSet

    def processPdu(self, snmpEngine, messageProcessingModel, securityModel,
                   securityName, securityLevel, contextEngineId, contextName,
                   pduVersion, PDU, maxSizeResponseScopedPDU, stateReference):

        # Agent-side API complies with SMIv2
        if messageProcessingModel == 0:
            origPdu = PDU
            PDU = rfc2576.v1ToV2(PDU)
        else:
            origPdu = None

        # 3.2.1
        if (PDU.tagSet not in rfc3411.READ_CLASS_PDUS and
                PDU.tagSet not in rfc3411.WRITE_CLASS_PDUS):
            raise error.ProtocolError('Unexpected PDU class %s' % PDU.tagSet)

        # 3.2.2 --> no-op

        # 3.2.4
        rspPDU = v2c.apiPDU.getResponse(PDU)

        statusInformation = {}

        self.__pendingReqs[stateReference] = (
            messageProcessingModel, securityModel, securityName,
            securityLevel, contextEngineId, contextName, pduVersion,
            rspPDU, origPdu, maxSizeResponseScopedPDU, statusInformation
        )

        # 3.2.5
        varBinds = v2c.apiPDU.getVarBinds(PDU)

        debug.logger & debug.FLAG_APP and debug.logger(
            'processPdu: stateReference %s, varBinds %s' % (stateReference, varBinds))

        self.initiateMgmtOperation(snmpEngine, stateReference, contextName, PDU)

    @staticmethod
    def _storeAccessContext(snmpEngine):
        """Copy received message metadata while it lasts"""
        execCtx = snmpEngine.observer.getExecutionContext('rfc3412.receiveMessage:request')
        return {
            'securityModel': execCtx['securityModel'],
            'securityName': execCtx['securityName'],
            'securityLevel': execCtx['securityLevel'],
            'contextName': execCtx['contextName'],
            'pduType': execCtx['pdu'].getTagSet()
        }

    @classmethod
    def verifyAccess(cls, viewType, varBind, **context):
        name, val = varBind

        snmpEngine = context['snmpEngine']

        (securityModel,
         securityName,
         securityLevel,
         contextName,
         pduType) = (context['securityModel'],
                     context['securityName'],
                     context['securityLevel'],
                     context['contextName'],
                     context['pduType'])

        try:
            snmpEngine.accessControlModel[cls.ACM_ID].isAccessAllowed(
                snmpEngine, securityModel, securityName,
                securityLevel, viewType, contextName, name
            )

        # Map ACM errors onto SMI ones
        except error.StatusInformation as exc:
            statusInformation = exc
            debug.logger & debug.FLAG_APP and debug.logger(
                '__verifyAccess: name %s, statusInformation %s' % (name, statusInformation))
            errorIndication = statusInformation['errorIndication']
            # 3.2.5...
            if (errorIndication == errind.noSuchView or
                    errorIndication == errind.noAccessEntry or
                    errorIndication == errind.noGroupName):
                raise pysnmp.smi.error.AuthorizationError(name=name, idx=context.get('idx'))

            elif errorIndication == errind.otherError:
                raise pysnmp.smi.error.GenError(name=name, idx=context.get('idx'))

            elif errorIndication == errind.noSuchContext:
                snmpUnknownContexts, = snmpEngine.msgAndPduDsp.mibInstrumController.mibBuilder.importSymbols(
                    '__SNMP-TARGET-MIB', 'snmpUnknownContexts')
                snmpUnknownContexts.syntax += 1
                # Request REPORT generation
                raise pysnmp.smi.error.GenError(name=name, idx=context.get('idx'),
                                                oid=snmpUnknownContexts.name,
                                                val=snmpUnknownContexts.syntax)

            elif errorIndication == errind.notInView:
                return True

            else:
                raise error.ProtocolError('Unknown ACM error %s' % errorIndication)
        else:
            # rfc2576: 4.1.2.1
            if (securityModel == 1 and val is not None and
                    cls._counter64Type == val.getTagSet() and
                    cls._getNextRequestType == pduType):
                # This will cause MibTree to skip this OID-value
                raise pysnmp.smi.error.NoAccessError(name=name, idx=context.get('idx'))

    def _getMgmtFun(self, contextName):
        return lambda *args, **kwargs: None

    def _mapSmiErrors(self, varBinds, **context):
        errorIndication = None
        errorStatus = errorIndex = 0

        errors = context.get('errors')
        if not errors:
            return errorIndication, errorStatus, errorIndex, varBinds

        # Take the latest exception
        err = errors[-1]

        if isinstance(err, pysnmp.smi.error.GenError):
            errorIndication = str(err)

        elif isinstance(err, pysnmp.smi.error.SmiError):

            if isinstance(err, pysnmp.smi.error.TooBigError):
                # rfc1905: 4.2.1.3
                varBinds = []

            errorStatus = self.SMI_ERROR_MAP.get(err.__class__, 'genErr')

            try:
                errorIndex = err['idx'] + 1

            except IndexError:
                errorIndex = len(varBinds) and 1 or 0

        return errorIndication, errorStatus, errorIndex, varBinds

    def completeMgmtOperation(self, varBinds, **context):

        (errorIndication,
         errorStatus, errorIndex,
         varBinds) = self._mapSmiErrors(varBinds, **context)

        stateReference = context['stateReference']

        if errorIndication:
            statusInformation = self.__pendingReqs[stateReference]['statusInformation']

            try:
                # Request REPORT generation
                statusInformation['oid'] = errorIndication['oid']
                statusInformation['val'] = errorIndication['val']

            except KeyError:
                pass

        self.sendVarBinds(context['snmpEngine'], stateReference,
                          errorStatus, errorIndex, varBinds)

        self.releaseStateInformation(stateReference)

    def initiateMgmtOperation(self, snmpEngine, stateReference, contextName, PDU):
        varBinds = v2c.apiPDU.getVarBinds(PDU)

        mgmtFun = self._getMgmtFun(contextName)

        context = dict(snmpEngine=snmpEngine,
                       stateReference=stateReference,
                       acFun=self.verifyAccess,
                       cbFun=self.completeMgmtOperation,
                       cbCtx=self.cbCtx)

        context.update(self._storeAccessContext(snmpEngine))

        mgmtFun(*varBinds, **context)


class GetCommandResponder(CommandResponderBase):
    SUPPORTED_PDU_TYPES = (rfc1905.GetRequestPDU.tagSet,)

    # rfc1905: 4.2.1
    def _getMgmtFun(self, contextName):
        return self.snmpContext.getMibInstrum(contextName).readMibObjects


class NextCommandResponder(CommandResponderBase):
    SUPPORTED_PDU_TYPES = (rfc1905.GetNextRequestPDU.tagSet,)

    # rfc1905: 4.2.2
    def _getMgmtFun(self, contextName):
        return self.snmpContext.getMibInstrum(contextName).readNextMibObjects

    def _getManagedObjectsInstances(self, varBinds, **context):
        """Iterate over Managed Objects fulfilling SNMP query.

        Parameters
        ----------
        varBinds
        context

        Returns
        -------
        :py:class:`list` - List of Managed Objects Instances to respond with or
            `None` to indicate that not all objects have been gathered
            so far.
        """
        rspVarBinds = context['rspVarBinds']
        varBindsMap = context['varBindsMap']

        rtrVarBinds = []

        for idx, varBind in enumerate(varBinds):
            name, val = varBind
            if (exval.noSuchObject.isSameTypeWith(val) or
                    exval.noSuchInstance.isSameTypeWith(val)):
                varBindsMap[len(rtrVarBinds)] = varBindsMap.pop(idx, idx)
                rtrVarBinds.append(varBind)

            else:
                rspVarBinds[varBindsMap.pop(idx, idx)] = varBind

        if rtrVarBinds:
            snmpEngine = context['snmpEngine']

            # Need to unwind stack, can't recurse any more
            def callLater(*args):
                snmpEngine.transportDispatcher.unregisterTimerCbFun(callLater)
                mgmtFun = context['mgmtFun']
                mgmtFun(*varBinds, **context)

            snmpEngine.transportDispatcher.registerTimerCbFun(callLater, 0.01)

        else:
            return rspVarBinds

    def completeMgmtOperation(self, varBinds, **context):
        rspVarBinds = self._getManagedObjectsInstances(varBinds, **context)
        if rspVarBinds:
            CommandResponderBase.completeMgmtOperation(self, rspVarBinds, **context)

    def initiateMgmtOperation(self, snmpEngine, stateReference, contextName, PDU):
        varBinds = v2c.apiPDU.getVarBinds(PDU)

        mgmtFun = self._getMgmtFun(contextName)

        context = dict(snmpEngine=snmpEngine,
                       stateReference=stateReference,
                       acFun=self.verifyAccess,
                       cbFun=self.completeMgmtOperation,
                       cbCtx=self.cbCtx,
                       rspVarBinds=varBinds[:],
                       varBindsMap={},
                       mgmtFun=mgmtFun)

        context.update(self._storeAccessContext(snmpEngine))

        mgmtFun(*varBinds, **context)


class BulkCommandResponder(NextCommandResponder):
    SUPPORTED_PDU_TYPES = (rfc1905.GetBulkRequestPDU.tagSet,)
    maxVarBinds = 64

    def _completeNonRepeaters(self, varBinds, **context):
        mgmtFun = context['mgmtFun']

        if not varBinds:
            # No non-repeaters requested, proceed with repeaters
            mgmtFun(*context['reqVarBinds'],
                    **dict(context, cbFun=self.completeMgmtOperation,
                           varBinds=context['reqVarBinds'][:]))
            return

        rspVarBinds = self._getManagedObjectsInstances(varBinds, **context)
        if rspVarBinds:
            context['allVarBinds'].extend(rspVarBinds)

            if context['counters']['M'] and context['counters']['R']:

                rspVarBinds = self._getManagedObjectsInstances(varBinds, **context)
                if rspVarBinds:
                    # Done with non-repeaters, proceed with repeaters
                    mgmtFun(*context['reqVarBinds'],
                            **dict(context,
                                   cbFun=self.completeMgmtOperation,
                                   varBindsMap={},
                                   rspVarBinds=context['reqVarBinds'][:]))
                    return

            else:
                CommandResponderBase.completeMgmtOperation(self, context['allVarBinds'], **context)

    def completeMgmtOperation(self, varBinds, **context):
        rspVarBinds = self._getManagedObjectsInstances(varBinds, **context)
        if rspVarBinds:
            context['counters']['M'] -= 1

            context['allVarBinds'].extend(rspVarBinds)

            eom = all(exval.endOfMibView.isSameTypeWith(value) for name, value in rspVarBinds)

            if not eom and context['counters']['M'] and context['counters']['R']:
                snmpEngine = context['snmpEngine']

                # Need to unwind stack, can't recurse any more
                def callLater(*args):
                    snmpEngine.transportDispatcher.unregisterTimerCbFun(callLater)
                    mgmtFun = context['mgmtFun']
                    reqVarBinds = varBinds[-context['counters']['R']:]
                    mgmtFun(*reqVarBinds,
                            **dict(context, cbFun=self.completeMgmtOperation,
                                   varBindsMap={}, rspVarBinds=reqVarBinds[:]))

                snmpEngine.transportDispatcher.registerTimerCbFun(callLater, 0.01)

            else:
                CommandResponderBase.completeMgmtOperation(self, context['allVarBinds'], **context)

    # rfc1905: 4.2.3
    def initiateMgmtOperation(self, snmpEngine, stateReference, contextName, PDU):
        nonRepeaters = v2c.apiBulkPDU.getNonRepeaters(PDU)
        if nonRepeaters < 0:
            nonRepeaters = 0

        maxRepetitions = v2c.apiBulkPDU.getMaxRepetitions(PDU)
        if maxRepetitions < 0:
            maxRepetitions = 0

        varBinds = v2c.apiPDU.getVarBinds(PDU)

        N = min(int(nonRepeaters), len(varBinds))
        M = int(maxRepetitions)
        R = max(len(varBinds) - N, 0)

        if R:
            M = min(M, self.maxVarBinds // R)

        debug.logger & debug.FLAG_APP and debug.logger(
            'initiateMgmtOperation: N %d, M %d, R %d' % (N, M, R))

        mgmtFun = self._getMgmtFun(contextName)

        context = dict(snmpEngine=snmpEngine,
                       stateReference=stateReference,
                       contextName=contextName,
                       acFun=self.verifyAccess,
                       cbFun=self._completeNonRepeaters,
                       cbCtx=self.cbCtx,
                       reqVarBinds=varBinds[N:],
                       counters={'M': M, 'R': R},
                       rspVarBinds=varBinds[N:],
                       allVarBinds=[],
                       varBindsMap={},
                       mgmtFun=mgmtFun)

        context.update(self._storeAccessContext(snmpEngine))

        mgmtFun(*varBinds[:N], **context)


class SetCommandResponder(CommandResponderBase):
    SUPPORTED_PDU_TYPES = (rfc1905.SetRequestPDU.tagSet,)

    SMI_ERROR_MAP = CommandResponderBase.SMI_ERROR_MAP.copy()

    # turn missing OIDs into access denial
    SMI_ERROR_MAP[pysnmp.smi.error.NoSuchObjectError] = 'notWritable'
    SMI_ERROR_MAP[pysnmp.smi.error.NoSuchInstanceError] = 'notWritable'

    # rfc1905: 4.2.5.1-13
    def _getMgmtFun(self, contextName):
        return self.snmpContext.getMibInstrum(contextName).writeMibObjects