@@ -1,294 +1,294 | |||
|
1 | 1 | # $Id: ber.rb 142 2006-07-26 12:20:33Z blackhedd $ |
|
2 | 2 | # |
|
3 | 3 | # NET::BER |
|
4 | 4 | # Mixes ASN.1/BER convenience methods into several standard classes. |
|
5 | 5 | # Also provides BER parsing functionality. |
|
6 | 6 | # |
|
7 | 7 | #---------------------------------------------------------------------------- |
|
8 | 8 | # |
|
9 | 9 | # Copyright (C) 2006 by Francis Cianfrocca. All Rights Reserved. |
|
10 | 10 | # |
|
11 | 11 | # Gmail: garbagecat10 |
|
12 | 12 | # |
|
13 | 13 | # This program is free software; you can redistribute it and/or modify |
|
14 | 14 | # it under the terms of the GNU General Public License as published by |
|
15 | 15 | # the Free Software Foundation; either version 2 of the License, or |
|
16 | 16 | # (at your option) any later version. |
|
17 | 17 | # |
|
18 | 18 | # This program is distributed in the hope that it will be useful, |
|
19 | 19 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
20 | 20 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
21 | 21 | # GNU General Public License for more details. |
|
22 | 22 | # |
|
23 | 23 | # You should have received a copy of the GNU General Public License |
|
24 | 24 | # along with this program; if not, write to the Free Software |
|
25 | 25 | # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|
26 | 26 | # |
|
27 | 27 | #--------------------------------------------------------------------------- |
|
28 | 28 | # |
|
29 | 29 | # |
|
30 | 30 | |
|
31 | 31 | |
|
32 | 32 | |
|
33 | 33 | |
|
34 | 34 | module Net |
|
35 | 35 | |
|
36 | 36 | module BER |
|
37 | 37 | |
|
38 | 38 | class BerError < Exception; end |
|
39 | 39 | |
|
40 | 40 | |
|
41 | 41 | # This module is for mixing into IO and IO-like objects. |
|
42 | 42 | module BERParser |
|
43 | 43 | |
|
44 | 44 | # The order of these follows the class-codes in BER. |
|
45 | 45 | # Maybe this should have been a hash. |
|
46 | 46 | TagClasses = [:universal, :application, :context_specific, :private] |
|
47 | 47 | |
|
48 | 48 | BuiltinSyntax = { |
|
49 | 49 | :universal => { |
|
50 | 50 | :primitive => { |
|
51 | 51 | 1 => :boolean, |
|
52 | 52 | 2 => :integer, |
|
53 | 53 | 4 => :string, |
|
54 | 54 | 10 => :integer, |
|
55 | 55 | }, |
|
56 | 56 | :constructed => { |
|
57 | 57 | 16 => :array, |
|
58 | 58 | 17 => :array |
|
59 | 59 | } |
|
60 | 60 | } |
|
61 | 61 | } |
|
62 | 62 | |
|
63 | 63 | # |
|
64 | 64 | # read_ber |
|
65 | 65 | # TODO: clean this up so it works properly with partial |
|
66 | 66 | # packets coming from streams that don't block when |
|
67 | 67 | # we ask for more data (like StringIOs). At it is, |
|
68 | 68 | # this can throw TypeErrors and other nasties. |
|
69 | 69 | # |
|
70 | 70 | def read_ber syntax=nil |
|
71 | return nil if eof? | |
|
71 | return nil if (StringIO == self.class) and eof? | |
|
72 | 72 | |
|
73 | 73 | id = getc # don't trash this value, we'll use it later |
|
74 | 74 | tag = id & 31 |
|
75 | 75 | tag < 31 or raise BerError.new( "unsupported tag encoding: #{id}" ) |
|
76 | 76 | tagclass = TagClasses[ id >> 6 ] |
|
77 | 77 | encoding = (id & 0x20 != 0) ? :constructed : :primitive |
|
78 | 78 | |
|
79 | 79 | n = getc |
|
80 | 80 | lengthlength,contentlength = if n <= 127 |
|
81 | 81 | [1,n] |
|
82 | 82 | else |
|
83 | 83 | j = (0...(n & 127)).inject(0) {|mem,x| mem = (mem << 8) + getc} |
|
84 | 84 | [1 + (n & 127), j] |
|
85 | 85 | end |
|
86 | 86 | |
|
87 | 87 | newobj = read contentlength |
|
88 | 88 | |
|
89 | 89 | objtype = nil |
|
90 | 90 | [syntax, BuiltinSyntax].each {|syn| |
|
91 | 91 | if syn && (ot = syn[tagclass]) && (ot = ot[encoding]) && ot[tag] |
|
92 | 92 | objtype = ot[tag] |
|
93 | 93 | break |
|
94 | 94 | end |
|
95 | 95 | } |
|
96 | 96 | |
|
97 | 97 | obj = case objtype |
|
98 | 98 | when :boolean |
|
99 | 99 | newobj != "\000" |
|
100 | 100 | when :string |
|
101 | 101 | (newobj || "").dup |
|
102 | 102 | when :integer |
|
103 | 103 | j = 0 |
|
104 | 104 | newobj.each_byte {|b| j = (j << 8) + b} |
|
105 | 105 | j |
|
106 | 106 | when :array |
|
107 | 107 | seq = [] |
|
108 | 108 | sio = StringIO.new( newobj || "" ) |
|
109 | 109 | # Interpret the subobject, but note how the loop |
|
110 | 110 | # is built: nil ends the loop, but false (a valid |
|
111 | 111 | # BER value) does not! |
|
112 | 112 | while (e = sio.read_ber(syntax)) != nil |
|
113 | 113 | seq << e |
|
114 | 114 | end |
|
115 | 115 | seq |
|
116 | 116 | else |
|
117 | 117 | raise BerError.new( "unsupported object type: class=#{tagclass}, encoding=#{encoding}, tag=#{tag}" ) |
|
118 | 118 | end |
|
119 | 119 | |
|
120 | 120 | # Add the identifier bits into the object if it's a String or an Array. |
|
121 | 121 | # We can't add extra stuff to Fixnums and booleans, not that it makes much sense anyway. |
|
122 | 122 | obj and ([String,Array].include? obj.class) and obj.instance_eval "def ber_identifier; #{id}; end" |
|
123 | 123 | obj |
|
124 | 124 | |
|
125 | 125 | end |
|
126 | 126 | |
|
127 | 127 | end # module BERParser |
|
128 | 128 | end # module BER |
|
129 | 129 | |
|
130 | 130 | end # module Net |
|
131 | 131 | |
|
132 | 132 | |
|
133 | 133 | class IO |
|
134 | 134 | include Net::BER::BERParser |
|
135 | 135 | end |
|
136 | 136 | |
|
137 | 137 | require "stringio" |
|
138 | 138 | class StringIO |
|
139 | 139 | include Net::BER::BERParser |
|
140 | 140 | end |
|
141 | 141 | |
|
142 | 142 | begin |
|
143 | 143 | require 'openssl' |
|
144 | 144 | class OpenSSL::SSL::SSLSocket |
|
145 | 145 | include Net::BER::BERParser |
|
146 | 146 | end |
|
147 | 147 | rescue LoadError |
|
148 | 148 | # Ignore LoadError. |
|
149 | 149 | # DON'T ignore NameError, which means the SSLSocket class |
|
150 | 150 | # is somehow unavailable on this implementation of Ruby's openssl. |
|
151 | 151 | # This may be WRONG, however, because we don't yet know how Ruby's |
|
152 | 152 | # openssl behaves on machines with no OpenSSL library. I suppose |
|
153 | 153 | # it's possible they do not fail to require 'openssl' but do not |
|
154 | 154 | # create the classes. So this code is provisional. |
|
155 | 155 | # Also, you might think that OpenSSL::SSL::SSLSocket inherits from |
|
156 | 156 | # IO so we'd pick it up above. But you'd be wrong. |
|
157 | 157 | end |
|
158 | 158 | |
|
159 | 159 | class String |
|
160 | 160 | def read_ber syntax=nil |
|
161 | 161 | StringIO.new(self).read_ber(syntax) |
|
162 | 162 | end |
|
163 | 163 | end |
|
164 | 164 | |
|
165 | 165 | |
|
166 | 166 | |
|
167 | 167 | #---------------------------------------------- |
|
168 | 168 | |
|
169 | 169 | |
|
170 | 170 | class FalseClass |
|
171 | 171 | # |
|
172 | 172 | # to_ber |
|
173 | 173 | # |
|
174 | 174 | def to_ber |
|
175 | 175 | "\001\001\000" |
|
176 | 176 | end |
|
177 | 177 | end |
|
178 | 178 | |
|
179 | 179 | |
|
180 | 180 | class TrueClass |
|
181 | 181 | # |
|
182 | 182 | # to_ber |
|
183 | 183 | # |
|
184 | 184 | def to_ber |
|
185 | 185 | "\001\001\001" |
|
186 | 186 | end |
|
187 | 187 | end |
|
188 | 188 | |
|
189 | 189 | |
|
190 | 190 | |
|
191 | 191 | class Fixnum |
|
192 | 192 | # |
|
193 | 193 | # to_ber |
|
194 | 194 | # |
|
195 | 195 | def to_ber |
|
196 | 196 | i = [self].pack('w') |
|
197 | 197 | [2, i.length].pack("CC") + i |
|
198 | 198 | end |
|
199 | 199 | |
|
200 | 200 | # |
|
201 | 201 | # to_ber_enumerated |
|
202 | 202 | # |
|
203 | 203 | def to_ber_enumerated |
|
204 | 204 | i = [self].pack('w') |
|
205 | 205 | [10, i.length].pack("CC") + i |
|
206 | 206 | end |
|
207 | 207 | |
|
208 | 208 | # |
|
209 | 209 | # to_ber_length_encoding |
|
210 | 210 | # |
|
211 | 211 | def to_ber_length_encoding |
|
212 | 212 | if self <= 127 |
|
213 | 213 | [self].pack('C') |
|
214 | 214 | else |
|
215 | 215 | i = [self].pack('N').sub(/^[\0]+/,"") |
|
216 | 216 | [0x80 + i.length].pack('C') + i |
|
217 | 217 | end |
|
218 | 218 | end |
|
219 | 219 | |
|
220 | 220 | end # class Fixnum |
|
221 | 221 | |
|
222 | 222 | |
|
223 | 223 | class Bignum |
|
224 | 224 | |
|
225 | 225 | def to_ber |
|
226 | 226 | i = [self].pack('w') |
|
227 | 227 | i.length > 126 and raise Net::BER::BerError.new( "range error in bignum" ) |
|
228 | 228 | [2, i.length].pack("CC") + i |
|
229 | 229 | end |
|
230 | 230 | |
|
231 | 231 | end |
|
232 | 232 | |
|
233 | 233 | |
|
234 | 234 | |
|
235 | 235 | class String |
|
236 | 236 | # |
|
237 | 237 | # to_ber |
|
238 | 238 | # A universal octet-string is tag number 4, |
|
239 | 239 | # but others are possible depending on the context, so we |
|
240 | 240 | # let the caller give us one. |
|
241 | 241 | # The preferred way to do this in user code is via to_ber_application_sring |
|
242 | 242 | # and to_ber_contextspecific. |
|
243 | 243 | # |
|
244 | 244 | def to_ber code = 4 |
|
245 | 245 | [code].pack('C') + length.to_ber_length_encoding + self |
|
246 | 246 | end |
|
247 | 247 | |
|
248 | 248 | # |
|
249 | 249 | # to_ber_application_string |
|
250 | 250 | # |
|
251 | 251 | def to_ber_application_string code |
|
252 | 252 | to_ber( 0x40 + code ) |
|
253 | 253 | end |
|
254 | 254 | |
|
255 | 255 | # |
|
256 | 256 | # to_ber_contextspecific |
|
257 | 257 | # |
|
258 | 258 | def to_ber_contextspecific code |
|
259 | 259 | to_ber( 0x80 + code ) |
|
260 | 260 | end |
|
261 | 261 | |
|
262 | 262 | end # class String |
|
263 | 263 | |
|
264 | 264 | |
|
265 | 265 | |
|
266 | 266 | class Array |
|
267 | 267 | # |
|
268 | 268 | # to_ber_appsequence |
|
269 | 269 | # An application-specific sequence usually gets assigned |
|
270 | 270 | # a tag that is meaningful to the particular protocol being used. |
|
271 | 271 | # This is different from the universal sequence, which usually |
|
272 | 272 | # gets a tag value of 16. |
|
273 | 273 | # Now here's an interesting thing: We're adding the X.690 |
|
274 | 274 | # "application constructed" code at the top of the tag byte (0x60), |
|
275 | 275 | # but some clients, notably ldapsearch, send "context-specific |
|
276 | 276 | # constructed" (0xA0). The latter would appear to violate RFC-1777, |
|
277 | 277 | # but what do I know? We may need to change this. |
|
278 | 278 | # |
|
279 | 279 | |
|
280 | 280 | def to_ber id = 0; to_ber_seq_internal( 0x30 + id ); end |
|
281 | 281 | def to_ber_set id = 0; to_ber_seq_internal( 0x31 + id ); end |
|
282 | 282 | def to_ber_sequence id = 0; to_ber_seq_internal( 0x30 + id ); end |
|
283 | 283 | def to_ber_appsequence id = 0; to_ber_seq_internal( 0x60 + id ); end |
|
284 | 284 | def to_ber_contextspecific id = 0; to_ber_seq_internal( 0xA0 + id ); end |
|
285 | 285 | |
|
286 | 286 | private |
|
287 | 287 | def to_ber_seq_internal code |
|
288 | 288 | s = self.to_s |
|
289 | 289 | [code].pack('C') + s.length.to_ber_length_encoding + s |
|
290 | 290 | end |
|
291 | 291 | |
|
292 | 292 | end # class Array |
|
293 | 293 | |
|
294 | 294 |
General Comments 0
You need to be logged in to leave comments.
Login now