← Back to branch summary

~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to twisted/protocols/pureber.py

  • Committer: Bazaar Package Importer
  • Author(s): Moshe Zadka
  • Date: 2002-03-08 07:14:16 UTC
  • Revision ID: james.westby@ubuntu.com-20020308071416-oxvuw76tpcpi5v1q
Tags: upstream-0.15.5
Import upstream version 0.15.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
twisted/protocols/pureber.py
 
1
# Twisted, the Framework of Your Internet
 
2
# Copyright (C) 2001 Matthew W. Lefkowitz
 
3
# 
 
4
# This library is free software; you can redistribute it and/or
 
5
# modify it under the terms of version 2.1 of the GNU Lesser General Public
 
6
# License as published by the Free Software Foundation.
 
7
# 
 
8
# This library is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
11
# Lesser General Public License for more details.
 
12
# 
 
13
# You should have received a copy of the GNU Lesser General Public
 
14
# License along with this library; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Pure, simple, BER encoding and decoding"""
 
18
 
 
19
# This BER library is currently aimed at supporting LDAP, thus
 
20
# the following restrictions from RFC2251 apply:
 
21
#
 
22
# (1) Only the definite form of length encoding will be used.
 
23
#
 
24
# (2) OCTET STRING values will be encoded in the primitive form
 
25
#     only.
 
26
#
 
27
# (3) If the value of a BOOLEAN type is true, the encoding MUST have
 
28
#     its contents octets set to hex "FF".
 
29
#
 
30
# (4) If a value of a type is its default value, it MUST be absent.
 
31
#     Only some BOOLEAN and INTEGER types have default values in
 
32
#     this protocol definition.
 
33
 
 
34
 
 
35
import string
 
36
from twisted.python.mutablestring import MutableString
 
37
 
 
38
# xxxxxxxx
 
39
# |/|\.../
 
40
# | | |
 
41
# | | tag
 
42
# | |
 
43
# | primitive (0) or structured (1)
 
44
# |
 
45
# class
 
46
 
 
47
CLASS_MASK              = 0xc0
 
48
CLASS_UNIVERSAL         = 0x00
 
49
CLASS_APPLICATION       = 0x40
 
50
CLASS_CONTEXT           = 0x80
 
51
CLASS_PRIVATE           = 0xc0
 
52
 
 
53
STRUCTURED_MASK         = 0x20
 
54
STRUCTURED              = 0x20
 
55
NOT_STRUCTURED          = 0x00
 
56
 
 
57
TAG_MASK                = 0x1f
 
58
 
 
59
# LENGTH
 
60
# 0xxxxxxx = 0..127
 
61
# 1xxxxxxx = len is stored in the next 0xxxxxxx octets
 
62
# indefinite form not supported
 
63
 
 
64
import UserList
 
65
import UserDict
 
66
import types
 
67
 
 
68
def berlen2int(m):
 
69
    need(m, 1)
 
70
    l=ber2int(m[0])
 
71
    ll=0
 
72
    if l&0x80:
 
73
        l=l+128
 
74
        ll=l
 
75
        need(m, 1+ll)
 
76
        l=ber2int(m[1:1+ll], signed=0)
 
77
    del m[:1+ll]
 
78
    return l
 
79
 
 
80
def int2berlen(i):
 
81
    assert i>=0
 
82
    e=int2ber(i)
 
83
    l=len(e)
 
84
    assert l>0
 
85
    if l==1:
 
86
        return e
 
87
    else:
 
88
        assert l<=127
 
89
        le=int2ber(l)
 
90
        assert len(le)==1
 
91
        assert ord(le[0])&0x80==0
 
92
        le0=chr(ord(le[0])|0x80)
 
93
        assert ord(le0)&0x80
 
94
        return le0+le[1:]+e
 
95
 
 
96
def int2ber(i):
 
97
    encoded=MutableString()
 
98
    while i>127 or i<-128:
 
99
        encoded=chr(i%256)+encoded
 
100
        i=i>>8
 
101
    encoded=chr(i%256)+encoded
 
102
    return encoded
 
103
 
 
104
def ber2int(e, signed=1):
 
105
    need(e, 1)
 
106
    v=ord(e[0])
 
107
    if v&0x80 and signed:
 
108
        v=v-256
 
109
    for i in range(1, len(e)):
 
110
        v=(v<<8) | ord(e[i])
 
111
    return v
 
112
 
 
113
class BERBase:
 
114
    tag = None
 
115
 
 
116
    def identification(self):
 
117
        return self.tag
 
118
    
 
119
    def __init__(self, tag=None):
 
120
        if tag!=None:
 
121
            self.tag=tag
 
122
 
 
123
    def __len__(self):
 
124
        return len(str(self))
 
125
 
 
126
    def __cmp__(self, other):
 
127
        if isinstance(other, BERBase):
 
128
            return cmp(str(self), str(other))
 
129
        else:
 
130
            return -1
 
131
 
 
132
class BERStructured(BERBase):
 
133
    def identification(self):
 
134
        return STRUCTURED|self.tag
 
135
 
 
136
class BERException(Exception): pass
 
137
 
 
138
class BERExceptionInsufficientData(Exception): pass
 
139
 
 
140
def need(buf, n):
 
141
    d=n-len(buf)
 
142
    if d>0:
 
143
        raise BERExceptionInsufficientData, d
 
144
 
 
145
class BERInteger(BERBase):
 
146
    tag = 0x02
 
147
 
 
148
    def decode(self, encoded, berdecoder):
 
149
        e2=MutableString(encoded)
 
150
        need(e2, 2)
 
151
        self.tag=ber2int(e2[0], signed=0)&(CLASS_MASK|TAG_MASK)
 
152
        del e2[0]
 
153
        l=berlen2int(e2)
 
154
        assert l>0
 
155
        need(e2, l)
 
156
        e=e2[:l]
 
157
        del e2[:l]
 
158
        encoded.set(e2)
 
159
        self.value=ber2int(e)
 
160
 
 
161
    def __init__(self, value=None, encoded=None, berdecoder=None, tag=None):
 
162
        """Create a new BERInteger object.
 
163
        Either value or encoded must be given:
 
164
        value is an integer, encoded is a MutableString.
 
165
        """
 
166
        BERBase.__init__(self, tag)
 
167
        if value!=None:
 
168
            assert encoded==None
 
169
            self.value=value
 
170
        elif encoded!=None:
 
171
            assert value==None
 
172
            assert berdecoder
 
173
            self.decode(encoded, berdecoder)
 
174
        else:
 
175
            raise "You must give either value or encoded"
 
176
        
 
177
    def __str__(self):
 
178
        encoded=int2ber(self.value)
 
179
        return chr(self.identification()) \
 
180
               +int2berlen(len(encoded)) \
 
181
               +encoded
 
182
 
 
183
    def __repr__(self):
 
184
        if self.tag==self.__class__.tag:
 
185
            return self.__class__.__name__+"(value=%d)"%self.value
 
186
        else:
 
187
            return self.__class__.__name__+"(value=%d, tag=%d)" \
 
188
                   %(self.value, self.tag)
 
189
 
 
190
class BEROctetString(BERBase):
 
191
    tag = 0x04
 
192
 
 
193
    def decode(self, encoded, berdecoder):
 
194
        e2=MutableString(encoded)
 
195
        need(e2, 2)
 
196
        self.tag=ber2int(e2[0], signed=0)&(CLASS_MASK|TAG_MASK)
 
197
        del e2[0]
 
198
        l=berlen2int(e2)
 
199
        assert l>=0
 
200
        need(e2, l)
 
201
        e=e2[:l]
 
202
        del e2[:l]
 
203
        encoded.set(e2)
 
204
        self.value=e
 
205
 
 
206
    def __init__(self, value=None, encoded=None, berdecoder=None, tag=None):
 
207
        BERBase.__init__(self, tag)
 
208
        if value!=None:
 
209
            assert encoded==None
 
210
            self.value=value
 
211
        elif encoded!=None:
 
212
            assert value==None
 
213
            assert berdecoder
 
214
            self.decode(encoded, berdecoder)
 
215
        else:
 
216
            raise "You must give either value or encoded"
 
217
 
 
218
    def __str__(self):
 
219
        return chr(self.identification()) \
 
220
               +int2berlen(len(self.value)) \
 
221
               +self.value
 
222
 
 
223
    def __repr__(self):
 
224
        if self.tag==self.__class__.tag:
 
225
            return self.__class__.__name__+"(value=%s)" \
 
226
                   %repr(self.value)
 
227
        else:
 
228
            return self.__class__.__name__ \
 
229
                   +"(value=%s, tag=%d)" \
 
230
                   %(repr(self.value), self.tag)
 
231
 
 
232
class BERNull(BERBase):
 
233
    tag = 0x05
 
234
 
 
235
    def decode(self, encoded, berdecoder):
 
236
        need(encoded, 2)
 
237
        self.tag=ber2int(encoded[0], signed=0)&(CLASS_MASK|TAG_MASK)
 
238
        assert encoded[1]=='\000'
 
239
        del encoded[:2]
 
240
 
 
241
    def __init__(self, encoded=None, berdecoder=None, tag=None):
 
242
        BERBase.__init__(self, tag)
 
243
        if encoded!=None:
 
244
            assert berdecoder
 
245
            self.decode(encoded, berdecoder)
 
246
 
 
247
    def __str__(self):
 
248
        return chr(self.identification())+chr(0)
 
249
 
 
250
    def __repr__(self):
 
251
        if self.tag==self.__class__.tag:
 
252
            return self.__class__.__name__+"()"
 
253
        else:
 
254
            return self.__class__.__name__+"(tag=%d)"%self.tag
 
255
 
 
256
class BERBoolean(BERBase):
 
257
    tag = 0x01
 
258
 
 
259
    def decode(self, encoded, berdecoder):
 
260
        e2=MutableString(encoded)
 
261
        need(e2, 2)
 
262
        self.tag=ber2int(e2[0], signed=0)&(CLASS_MASK|TAG_MASK)
 
263
        del e2[0]
 
264
        l=berlen2int(e2)
 
265
        assert l>0
 
266
        need(e2, l)
 
267
        e=e2[:l]
 
268
        del e2[:l]
 
269
        encoded.set(e2)
 
270
        v=ber2int(e)
 
271
        if v:
 
272
           v=0xFF
 
273
        self.value=v
 
274
 
 
275
    def __init__(self, value=None, encoded=None, berdecoder=None, tag=None):
 
276
        """Create a new BERInteger object.
 
277
        Either value or encoded must be given:
 
278
        value is an integer, encoded is a MutableString.
 
279
        """
 
280
        BERBase.__init__(self, tag)
 
281
        if value!=None:
 
282
            assert encoded==None
 
283
            if value:
 
284
                value=0xFF 
 
285
            self.value=value
 
286
        elif encoded!=None:
 
287
            assert value==None
 
288
            assert berdecoder
 
289
            self.decode(encoded, berdecoder)
 
290
        else:
 
291
            raise "You must give either value or encoded"
 
292
        
 
293
    def __str__(self):
 
294
        assert self.value==0 or self.value==0xFF
 
295
        return chr(self.identification()) \
 
296
               +int2berlen(1) \
 
297
               +chr(self.value)
 
298
 
 
299
    def __repr__(self):
 
300
        if self.tag==self.__class__.tag:
 
301
            return self.__class__.__name__+"(value=%d)"%self.value
 
302
        else:
 
303
            return self.__class__.__name__+"(value=%d, tag=%d)" \
 
304
                   %(self.value, self.tag)
 
305
 
 
306
 
 
307
class BEREnumerated(BERInteger):
 
308
    tag = 0x0a
 
309
 
 
310
class BERSequence(BERStructured, UserList.UserList):
 
311
    # TODO __getslice__ calls __init__ with no args.
 
312
    tag = 0x10
 
313
 
 
314
    def decode(self, encoded, berdecoder):
 
315
        e2=MutableString(encoded)
 
316
        need(e2, 2)
 
317
        self.tag=ber2int(e2[0], signed=0)&(CLASS_MASK|TAG_MASK)
 
318
        del e2[0]
 
319
        l=berlen2int(e2)
 
320
        need(e2, l)
 
321
        content=e2[:l]
 
322
        del e2[:l]
 
323
        self[:]=[]
 
324
        # decode content
 
325
        while content:
 
326
            n=ber2object(berdecoder, content)
 
327
            assert n!=None
 
328
            self.append(n)
 
329
        encoded.set(e2)
 
330
 
 
331
    def __init__(self, value=None, encoded=None, berdecoder=None, tag=None):
 
332
        BERStructured.__init__(self, tag)
 
333
        UserList.UserList.__init__(self)
 
334
        if value!=None:
 
335
            assert encoded==None
 
336
            self[:]=value
 
337
        elif encoded!=None:
 
338
            assert value==None
 
339
            assert berdecoder
 
340
            self.decode(encoded, berdecoder)
 
341
        else:
 
342
            raise "You must give either value or encoded"
 
343
 
 
344
    def __str__(self):
 
345
        r=string.join(map(str, self.data), '')
 
346
        return chr(self.identification())+int2berlen(len(r))+r
 
347
    
 
348
    def __repr__(self):
 
349
        if self.tag==self.__class__.tag:
 
350
            return self.__class__.__name__+"(value=%s)"%repr(self.data)
 
351
        else:
 
352
            return self.__class__.__name__+"(value=%s, tag=%d)" \
 
353
                   %(repr(self.data), self.tag)
 
354
 
 
355
 
 
356
class BERSequenceOf(BERSequence):
 
357
    pass
 
358
 
 
359
class BERSet(BERSequence):
 
360
    tag = 0x11
 
361
    pass
 
362
 
 
363
 
 
364
 
 
365
class BERDecoderContext:
 
366
    Identities = {
 
367
        BERInteger.tag: BERInteger,
 
368
        BEROctetString.tag: BEROctetString,
 
369
        BERNull.tag: BERNull,
 
370
        BERBoolean.tag: BERBoolean,
 
371
        BEREnumerated.tag: BEREnumerated,
 
372
        BERSequence.tag: BERSequence,
 
373
        BERSet.tag: BERSet,
 
374
        }
 
375
 
 
376
    def __init__(self, fallback=None, inherit=None):
 
377
        self.fallback=fallback
 
378
        self.inherit_context=inherit
 
379
 
 
380
    def lookup_id(self, id):
 
381
        try:
 
382
            return self.Identities[id]
 
383
        except KeyError:
 
384
            if self.fallback:
 
385
                return self.fallback.lookup_id(id)
 
386
            else:
 
387
                return None
 
388
 
 
389
    def inherit(self):
 
390
        return self.inherit_context or self
 
391
 
 
392
    def __repr__(self):
 
393
        return "<"+self.__class__.__name__ \
 
394
               +" identities="+repr(self.Identities) \
 
395
               +" fallback="+repr(self.fallback) \
 
396
               +" inherit="+repr(self.inherit_context) \
 
397
               +">"
 
398
 
 
399
def ber2object(context, m):
 
400
    """ber2object(mutablestring) -> berobject
 
401
    Modifies mutablestring to remove decoded part.
 
402
    May give None
 
403
    """
 
404
    while m:
 
405
        need(m, 1)
 
406
        i=ber2int(m[0], signed=0)&(CLASS_MASK|TAG_MASK)
 
407
        berclass=context.lookup_id(i)
 
408
        if berclass:
 
409
            inh=context.inherit()
 
410
            assert inh
 
411
            return berclass(encoded=m, berdecoder=inh)
 
412
        else:
 
413
            raise "BERDecoderContext %s has no tag 0x%02x"%(context, i)
 
414
            tag=ber2int(m[0], signed=0)
 
415
            del m[0]
 
416
            l=berlen2int(m)
 
417
            print "Skipped unknown tag=%d, len=%d"%(tag,l)
 
418
            del m[:l]
 
419
            return None
 
420
 
 
421
#TODO unimplemented classes are below:
 
422
 
 
423
#class BERObjectIdentifier(BERBase):
 
424
#    tag = 0x06
 
425
#    pass
 
426
 
 
427
#class BERIA5String(BERBase):
 
428
#    tag = 0x16
 
429
#    pass
 
430
 
 
431
#class BERPrintableString(BERBase):
 
432
#    tag = 0x13
 
433
#    pass
 
434
 
 
435
#class BERT61String(BERBase):
 
436
#    tag = 0x14
 
437
#    pass
 
438
 
 
439
#class BERUTCTime(BERBase):
 
440
#    tag = 0x17
 
441
#    pass
 
442
 
 
443
#class BERBitString(BERBase):
 
444
#    tag = 0x03
 
445
#    pass
 
446