pysnmp-sky/pysnmp/proto/rfc1905.py

179 lines
5.6 KiB
Python

#
# This file is part of pysnmp software.
#
# Copyright (c) 2005-2017, Ilya Etingof <etingof@gmail.com>
# License: http://pysnmp.sf.net/license.html
#
from pyasn1.type import univ, tag, constraint, namedtype, namedval
from pysnmp.proto import rfc1902
__all__ = ['unSpecified', 'EndOfMibView', 'ReportPDU', 'UnSpecified',
'BulkPDU', 'SNMPv2TrapPDU', 'GetRequestPDU', 'NoSuchObject',
'GetNextRequestPDU', 'GetBulkRequestPDU', 'NoSuchInstance',
'ResponsePDU', 'noSuchObject', 'InformRequestPDU', 'endOfMibView',
'SetRequestPDU', 'noSuchInstance']
# Value reference -- max bindings in VarBindList
max_bindings = rfc1902.Integer(2147483647)
# Take SNMP exception values out of BindValue structure for convenience
UnSpecified = univ.Null
unSpecified = UnSpecified()
class NoSuchObject(univ.Null):
tagSet = univ.Null.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatSimple, 0x00)
)
def prettyPrint(self, scope=0):
return 'No Such Object currently exists at this OID'
noSuchObject = NoSuchObject()
class NoSuchInstance(univ.Null):
tagSet = univ.Null.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatSimple, 0x01)
)
def prettyPrint(self, scope=0):
return 'No Such Instance currently exists at this OID'
noSuchInstance = NoSuchInstance()
class EndOfMibView(univ.Null):
tagSet = univ.Null.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatSimple, 0x02)
)
def prettyPrint(self, scope=0):
return 'No more variables left in this MIB View'
endOfMibView = EndOfMibView()
# Made a separate class for better readability
class _BindValue(univ.Choice):
componentType = namedtype.NamedTypes(
namedtype.NamedType('value', rfc1902.ObjectSyntax()),
namedtype.NamedType('unSpecified', unSpecified),
namedtype.NamedType('noSuchObject', noSuchObject),
namedtype.NamedType('noSuchInstance', noSuchInstance),
namedtype.NamedType('endOfMibView', endOfMibView)
)
class VarBind(univ.Sequence):
componentType = namedtype.NamedTypes(
namedtype.NamedType('name', rfc1902.ObjectName()),
namedtype.NamedType('', _BindValue())
)
class VarBindList(univ.SequenceOf):
componentType = VarBind()
subtypeSpec = univ.SequenceOf.subtypeSpec + constraint.ValueSizeConstraint(
0, max_bindings
)
errorStatus = univ.Integer(
namedValues=namedval.NamedValues(('noError', 0), ('tooBig', 1), ('noSuchName', 2), ('badValue', 3), ('readOnly', 4),
('genErr', 5), ('noAccess', 6), ('wrongType', 7), ('wrongLength', 8),
('wrongEncoding', 9), ('wrongValue', 10), ('noCreation', 11),
('inconsistentValue', 12), ('resourceUnavailable', 13), ('commitFailed', 14),
('undoFailed', 15), ('authorizationError', 16), ('notWritable', 17),
('inconsistentName', 18)))
# Base class for a non-bulk PDU
class PDU(univ.Sequence):
componentType = namedtype.NamedTypes(
namedtype.NamedType('request-id', rfc1902.Integer32()),
namedtype.NamedType('error-status', errorStatus),
namedtype.NamedType('error-index',
univ.Integer().subtype(subtypeSpec=constraint.ValueRangeConstraint(0, max_bindings))),
namedtype.NamedType('variable-bindings', VarBindList())
)
nonRepeaters = univ.Integer().subtype(subtypeSpec=constraint.ValueRangeConstraint(0, max_bindings))
maxRepetitions = univ.Integer().subtype(subtypeSpec=constraint.ValueRangeConstraint(0, max_bindings))
# Base class for bulk PDU
class BulkPDU(univ.Sequence):
componentType = namedtype.NamedTypes(
namedtype.NamedType('request-id', rfc1902.Integer32()),
namedtype.NamedType('non-repeaters', nonRepeaters),
namedtype.NamedType('max-repetitions', maxRepetitions),
namedtype.NamedType('variable-bindings', VarBindList())
)
class GetRequestPDU(PDU):
tagSet = PDU.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatConstructed, 0)
)
class GetNextRequestPDU(PDU):
tagSet = PDU.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatConstructed, 1)
)
class ResponsePDU(PDU):
tagSet = PDU.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatConstructed, 2)
)
class SetRequestPDU(PDU):
tagSet = PDU.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatConstructed, 3)
)
class GetBulkRequestPDU(BulkPDU):
tagSet = PDU.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatConstructed, 5)
)
class InformRequestPDU(PDU):
tagSet = PDU.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatConstructed, 6)
)
class SNMPv2TrapPDU(PDU):
tagSet = PDU.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatConstructed, 7)
)
class ReportPDU(PDU):
tagSet = PDU.tagSet.tagImplicitly(
tag.Tag(tag.tagClassContext, tag.tagFormatConstructed, 8)
)
class PDUs(univ.Choice):
componentType = namedtype.NamedTypes(
namedtype.NamedType('get-request', GetRequestPDU()),
namedtype.NamedType('get-next-request', GetNextRequestPDU()),
namedtype.NamedType('get-bulk-request', GetBulkRequestPDU()),
namedtype.NamedType('response', ResponsePDU()),
namedtype.NamedType('set-request', SetRequestPDU()),
namedtype.NamedType('inform-request', InformRequestPDU()),
namedtype.NamedType('snmpV2-trap', SNMPv2TrapPDU()),
namedtype.NamedType('report', ReportPDU())
)