Moved from the top-level under the roof of v4 API

1 files changed, 204 insertions, 0 deletions

diff --git a/pysnmp/proto/rfc1905.py b/pysnmp/proto/rfc1905.py
new file mode 100644
index 00000000..cc5f53a1
--- /dev/null
+++ b/pysnmp/proto/rfc1905.py
@@ -0,0 +1,204 @@
+"""Implementation of SNMP v.2c (RFC1905)"""
+
+from time import time
+from pysnmp.asn1 import univ, tags, subtypes
+from pysnmp.proto import rfc1902
+from pysnmp.proto.rfc1157 import InitialRequestIdMixIn
+import pysnmp.asn1.error
+
+__all__ = [
+    'Version', 'Community', 'RequestId', 'NoSuchObject',
+    'NoSuchInstance', 'EndOfMibView', 'BindValue', 'VarBind',
+    'VarBindList', 'Pdu', 'NonRepeaters', 'MaxRepetitions',
+    'GetRequestPdu', 'GetNextRequestPdu', 'ResponsePdu',
+    'SetRequestPdu', 'GetBulkRequestPdu', 'InformRequestPdu',
+    'SnmpV2TrapPdu', 'ReportPdu', 'Pdus', 'Message'
+    ]
+
+# Value reference -- max bindings in VarBindList
+max_bindings = rfc1902.Integer(2147483647)
+
+class Version(univ.Integer):
+    subtypeConstraints = ( subtypes.SingleValueConstraint(1), )
+    initialValue = 1
+    namedValues = univ.Integer.namedValues.clone(('version-2c', 1))
+    
+class Community(univ.OctetString):
+    initialValue = 'public'    
+
+class RequestId(InitialRequestIdMixIn, rfc1902.Integer32): pass
+
+class ErrorStatus(univ.Integer):
+    initialValue = 0
+    subtypeConstraints = ( subtypes.ValueRangeConstraint(0, 18), )
+    namedValues = univ.Integer.namedValues.clone(
+        ('noError', 0), ('tooBig', 1), ('noSuchName', 3), ('badValue', 4),
+        ('readOnly', 5), ('genError', 6), ('noAccess', 7), ('wrongType', 8),
+        ('wrongLength', 9), ('wrongEncoding', 10), ('wrongValue', 11),
+        ('noCreation', 12), ('inconsistentValue', 13),
+        ('resourceUnavailable', 14), ('commitFailed', 15), ('undoFailed', 16),
+        ('authorizationError', 17), ('notWritable', 18),
+        ('inconsistentName', 19)
+        )
+    pduErrors = [
+        '(noError) No Error',
+        '(tooBig) Response message would have been too large',
+        '(noSuchName) There is no such variable name in this MIB',
+        '(badValue) The value given has the wrong type or length',
+        '(readOnly) No modifications allowed to this object',
+        '(genError) A general failure occured',
+        '(noAccess) Access denied',
+        '(wrongType) Wrong BER type',
+        '(wrongLength) Wrong BER length',
+        '(wrongEncoding) Wrong BER encoding',
+        '(wrongValue) Wrong value',
+        '(noCreation) Object creation prohibited',
+        '(inconsistentValue) Inconsistent value',
+        '(resourceUnavailable) Resource unavailable',
+        '(commitFailed) Commit failed',
+        '(undoFailed) Undo failed',
+        '(authorizationError) Authorization error',
+        '(notWritable) Object is not writable',
+        '(inconsistentName) Inconsistent object name'
+        ]
+
+    def __str__(self):
+        return '%s: %d (%s)' % (
+            self.__class__.__name__, self.get(), self.pduErrors[self.get()]
+            )
+    
+class ErrorIndex(univ.Integer):
+    subtypeConstraints = (
+        subtypes.ValueRangeConstraint(0, max_bindings.get()),
+        )
+
+class NoSuchObject(univ.Null):
+    tagSet = univ.Null.tagSet.clone(
+        tagClass=tags.tagClassContext, tagId=0x00
+        )
+
+class NoSuchInstance(univ.Null):
+    tagSet = univ.Null.tagSet.clone(
+        tagClass=tags.tagClassContext, tagId=0x01
+        )
+
+class EndOfMibView(univ.Null):
+    tagSet = univ.Null.tagSet.clone(
+        tagClass=tags.tagClassContext, tagId=0x02
+        )
+
+class BindValue(univ.Choice):
+    protoComponents = {
+        'value': rfc1902.ObjectSyntax(),
+        'unspecified': rfc1902.Null(),
+        'noSuchObject': NoSuchObject(),
+        'noSuchInstance': NoSuchInstance(),
+        'endOfMibView': EndOfMibView()
+        }
+    initialComponentKey = 'unspecified'
+    
+class VarBind(univ.Sequence):
+    # Bind structure
+    protoComponents = {
+        'name': rfc1902.ObjectName(),
+        'value': BindValue()
+        }
+    protoSequence = ( 'name', 'value' )
+
+class VarBindList(univ.SequenceOf):
+    protoComponent = VarBind()
+    subtypeConstraints = (
+        subtypes.ValueSizeConstraint(0, max_bindings.get()),
+        )
+
+# Base class for a non-bulk PDU
+class Pdu(univ.Sequence):
+    tagSet = univ.Sequence.tagSet.clone(
+        tagClass=tags.tagClassContext
+        )
+    # PDU structure
+    protoComponents = {
+        'request_id': RequestId(),
+        'error_status': ErrorStatus(),
+        'error_index': ErrorIndex(),
+        'variable_bindings': VarBindList()
+        }
+    protoSequence = (
+        'request_id', 'error_status',
+        'error_index', 'variable_bindings'
+        )
+    
+class NonRepeaters(univ.Integer):
+    subtypeConstraints = (
+        subtypes.ValueRangeConstraint(0, max_bindings.get()),
+        )
+
+class MaxRepetitions(univ.Integer):
+    subtypeConstraints = (
+        subtypes.ValueRangeConstraint(0, max_bindings.get()),
+        )
+    initialValue = 255
+
+# Base class for bulk PDU
+class BulkPdu(univ.Sequence):
+    tagSet = univ.Sequence.tagSet.clone(
+        tagClass=tags.tagClassContext
+        )
+    # PDU structure
+    protoComponents = {
+        'request_id': RequestId(),
+        'non_repeaters': NonRepeaters(),
+        'max_repetitions': MaxRepetitions(),
+        'variable_bindings': VarBindList()
+        }
+    protoSequence = (
+        'request_id', 'non_repeaters',
+        'max_repetitions', 'variable_bindings'
+        )
+
+class GetRequestPdu(Pdu):
+    tagSet = Pdu.tagSet.clone(tagId=0x00)
+
+class GetNextRequestPdu(Pdu):
+    tagSet = Pdu.tagSet.clone(tagId=0x01)
+
+class ResponsePdu(Pdu):
+    tagSet = Pdu.tagSet.clone(tagId=0x02)
+
+class SetRequestPdu(Pdu):
+    tagSet = Pdu.tagSet.clone(tagId=0x03)
+
+class GetBulkRequestPdu(BulkPdu):
+    tagSet = BulkPdu.tagSet.clone(tagId=0x05)
+
+class InformRequestPdu(Pdu):
+    tagSet = Pdu.tagSet.clone(tagId=0x06)
+
+class SnmpV2TrapPdu(Pdu):
+    tagSet = Pdu.tagSet.clone(tagId=0x07)
+
+# XXX v1 compatible alias
+TrapPdu = SnmpV2TrapPdu
+
+class ReportPdu(Pdu):
+    tagSet = Pdu.tagSet.clone(tagId=0x08)
+
+class Pdus(univ.Choice):
+    protoComponents = {
+        'get_request': GetRequestPdu(),
+        'get_next_request': GetNextRequestPdu(),
+        'get_bulk_request': GetBulkRequestPdu(),
+        'response': ResponsePdu(),
+        'set_request': SetRequestPdu(),
+        'inform_request': InformRequestPdu(),
+        'snmpV2_trap': SnmpV2TrapPdu(),
+        'report': ReportPdu()
+        }
+    
+class Message(univ.Sequence):
+    protoComponents = {
+        'version': Version(),
+        'community': Community(),
+        'pdu': Pdus()
+        }
+    protoSequence = ( 'version', 'community', 'pdu' )