* add method to tell if a string is a biniplist
[lcore.git] / binipstuff.pas
1 { Copyright (C) 2005 Bas Steendijk and Peter Green\r
2   For conditions of distribution and use, see copyright notice in zlib_license.txt\r
3   which is included in the package\r
4   ----------------------------------------------------------------------------- }\r
5 unit binipstuff;\r
6 \r
7 interface\r
8 \r
9 {$include lcoreconfig.inc}\r
10 \r
11 {$ifndef win32}\r
12 {$ifdef ipv6}\r
13 uses sockets;\r
14 {$endif}\r
15 {$endif}\r
16 \r
17 {$ifdef fpc}\r
18   {$mode delphi}\r
19 {$endif}\r
20 {$ifdef cpu386}{$define i386}{$endif}\r
21 {$ifdef i386}{$define ENDIAN_LITTLE}{$endif}\r
22 \r
23 {$include uint32.inc}\r
24 \r
25 const\r
26   hexchars:array[0..15] of char='0123456789abcdef';\r
27   AF_INET=2;\r
28   {$ifdef win32}\r
29     AF_INET6=23;\r
30   {$else}\r
31     AF_INET6=10;\r
32   {$endif}\r
33 \r
34 type\r
35   {$ifdef ipv6}\r
36     \r
37     {$ifdef win32}\r
38       {$define want_Tin6_addr}\r
39     {$endif}\r
40     {$ifdef ver1_0}\r
41       {$define want_Tin6_addr}\r
42     {$endif}\r
43     {$ifdef want_Tin6_addr}\r
44       Tin6_addr = packed record\r
45         case byte of\r
46           0: (u6_addr8  : array[0..15] of byte);\r
47           1: (u6_addr16 : array[0..7] of Word);\r
48           2: (u6_addr32 : array[0..3] of uint32);\r
49           3: (s6_addr8  : array[0..15] of shortint);\r
50           4: (s6_addr   : array[0..15] of shortint);\r
51           5: (s6_addr16 : array[0..7] of smallint);\r
52           6: (s6_addr32 : array[0..3] of LongInt);\r
53       end;\r
54     {$endif}\r
55   {$endif}\r
56 \r
57   tbinip=record\r
58     family:integer;\r
59     {$ifdef ipv6}\r
60       case integer of\r
61         0: (ip:longint);\r
62         1: (ip6:tin6_addr);\r
63     {$else}\r
64       ip:longint;\r
65     {$endif}\r
66   end;\r
67 \r
68   {$ifdef win32}\r
69     TInetSockAddr = packed Record\r
70       family:Word;\r
71       port  :Word;\r
72       addr  :uint32;\r
73       pad   :array [1..8] of byte;\r
74     end;\r
75     {$ifdef ipv6}\r
76 \r
77       TInetSockAddr6 = packed record\r
78         sin6_family: word;\r
79         sin6_port: word;\r
80         sin6_flowinfo: uint32;\r
81         sin6_addr: tin6_addr;\r
82         sin6_scope_id: uint32;\r
83       end;\r
84     {$endif}\r
85   {$endif}\r
86 \r
87 \r
88 \r
89     {$ifdef ipv6}\r
90     {$ifdef ver1_0}\r
91       cuint16=word;\r
92       cuint32=dword;\r
93       sa_family_t=word;\r
94 \r
95     {$endif}\r
96   {$endif}\r
97   TinetSockAddrv = packed record\r
98     case integer of\r
99       0: (InAddr:TInetSockAddr);\r
100       {$ifdef ipv6}\r
101       1: (InAddr6:TInetSockAddr6);\r
102       {$endif}\r
103   end;\r
104   Pinetsockaddrv = ^Tinetsockaddrv;\r
105 \r
106   type\r
107     tsockaddrin=TInetSockAddr;\r
108 \r
109 \r
110 \r
111 {\r
112 bin IP list code, by beware\r
113 while this is really just a string, on the interface side it must be treated\r
114 as an opaque var which is passed as "var" when it needs to be modified}\r
115 \r
116   tbiniplist=string;\r
117 \r
118 function biniplist_new:tbiniplist;\r
119 procedure biniplist_add(var l:tbiniplist;ip:tbinip);\r
120 function biniplist_getcount(const l:tbiniplist):integer;\r
121 function biniplist_get(const l:tbiniplist;index:integer):tbinip;\r
122 procedure biniplist_set(var l:tbiniplist;index:integer;ip:tbinip);\r
123 procedure biniplist_setcount(var l:tbiniplist;newlen:integer);\r
124 procedure biniplist_free(var l:tbiniplist);\r
125 procedure biniplist_addlist(var l:tbiniplist;const l2:tbiniplist);\r
126 function biniplist_tostr(const l:tbiniplist):string;\r
127 function isbiniplist(const l:tbiniplist):boolean;\r
128 \r
129 function htons(w:word):word;\r
130 function htonl(i:uint32):uint32;\r
131 \r
132 function ipstrtobin(const s:string;var binip:tbinip):boolean;\r
133 function ipstrtobinf(const s:string):tbinip;\r
134 function ipbintostr(const binip:tbinip):string;\r
135 {$ifdef ipv6}\r
136 function ip6bintostr(const bin:tin6_addr):string;\r
137 function ip6strtobin(const s:string;var bin:tin6_addr):boolean;\r
138 {$endif}\r
139 \r
140 function comparebinip(const ip1,ip2:tbinip):boolean;\r
141 procedure maskbits(var binip:tbinip;bits:integer);\r
142 function comparebinipmask(ip1,ip2:tbinip;bits:integer):boolean;\r
143 \r
144 {deprecated}\r
145 function longip(s:string):longint;\r
146 \r
147 procedure converttov4(var ip:tbinip);\r
148 \r
149 function inaddrvtobinip(inaddrv:tinetsockaddrv):tbinip;\r
150 function makeinaddrv(addr:tbinip;port:string;var inaddr:tinetsockaddrv):integer;\r
151 function inaddrsize(inaddr:tinetsockaddrv):integer;\r
152 \r
153 implementation\r
154 \r
155 uses sysutils;\r
156 \r
157 function htons(w:word):word;\r
158 begin\r
159   {$ifdef ENDIAN_LITTLE}\r
160   result := ((w and $ff00) shr 8) or ((w and $ff) shl 8);\r
161   {$else}\r
162   result := w;\r
163   {$endif}\r
164 end;\r
165 \r
166 function htonl(i:uint32):uint32;\r
167 begin\r
168   {$ifdef ENDIAN_LITTLE}\r
169   result := (i shr 24) or (i shr 8 and $ff00) or (i shl 8 and $ff0000) or (i shl 24 and $ff000000);\r
170   {$else}\r
171   result := i;\r
172   {$endif}\r
173 end;\r
174 \r
175 \r
176 function inaddrvtobinip(inaddrv:tinetsockaddrv):tbinip;\r
177 begin\r
178   result.family := inaddrv.inaddr.family;\r
179   if result.family = AF_INET then result.ip := inaddrv.inaddr.addr;\r
180   {$ifdef ipv6}\r
181   if result.family = AF_INET6 then result.ip6 := inaddrv.inaddr6.sin6_addr;\r
182   {$endif}\r
183 end;\r
184 \r
185 function makeinaddrv(addr:tbinip;port:string;var inaddr:tinetsockaddrv):integer;\r
186 begin\r
187   result := 0;\r
188 {  biniptemp := forwardlookup(addr,10);}\r
189   fillchar(inaddr,sizeof(inaddr),0);\r
190   //writeln('converted address '+addr+' to binip '+ipbintostr(biniptemp));\r
191   if addr.family = AF_INET then begin\r
192     inAddr.InAddr.family:=AF_INET;\r
193     inAddr.InAddr.port:=htons(strtointdef(port,0));\r
194     inAddr.InAddr.addr:=addr.ip;\r
195     result := sizeof(tinetsockaddr);\r
196   end else\r
197   {$ifdef ipv6}\r
198   if addr.family = AF_INET6 then begin\r
199     inAddr.InAddr6.sin6_family:=AF_INET6;\r
200     inAddr.InAddr6.sin6_port:=htons(strtointdef(port,0));\r
201     inAddr.InAddr6.sin6_addr:=addr.ip6;\r
202     result := sizeof(tinetsockaddr6);\r
203   end;\r
204   {$endif}\r
205 end;\r
206 \r
207 function inaddrsize(inaddr:tinetsockaddrv):integer;\r
208 begin\r
209   {$ifdef ipv6}\r
210   if inaddr.inaddr.family = AF_INET6 then result := sizeof(tinetsockaddr6) else\r
211   {$endif}\r
212   result := sizeof(tinetsockaddr);\r
213 end;\r
214 \r
215 {internal}\r
216 {converts dotted v4 IP to longint. returns host endian order}\r
217 function longip(s:string):longint;\r
218 var\r
219   l:longint;\r
220   a,b:integer;\r
221 function convertbyte(const s:string):integer;\r
222 begin\r
223   result := strtointdef(s,-1);\r
224   if result < 0 then begin\r
225     result := -1;\r
226     exit;\r
227   end;\r
228   if result > 255 then begin\r
229     result := -1;\r
230     exit;\r
231   end;\r
232   {01 exception}\r
233   if (result <> 0) and (s[1] = '0') then begin\r
234     result := -1;\r
235     exit;\r
236   end;\r
237   {+1 exception}\r
238   if not (s[1] in ['0'..'9']) then begin\r
239     result := -1;\r
240     exit\r
241   end;\r
242 end;\r
243 \r
244 begin\r
245   result := 0;\r
246   a := pos('.',s);\r
247   if a = 0 then exit;\r
248   b := convertbyte(copy(s,1,a-1));if (b < 0) then exit;\r
249   l := b shl 24;\r
250   s := copy(s,a+1,256);\r
251   a := pos('.',s);\r
252   if a = 0 then exit;\r
253   b := convertbyte(copy(s,1,a-1));if (b < 0) then exit;\r
254   l := l or b shl 16;\r
255   s := copy(s,a+1,256);\r
256   a := pos('.',s);\r
257   if a = 0 then exit;\r
258   b := convertbyte(copy(s,1,a-1));if (b < 0) then exit;\r
259   l := l or b shl 8;\r
260   s := copy(s,a+1,256);\r
261   b := convertbyte(copy(s,1,256));if (b < 0) then exit;\r
262   l := l or b;\r
263   result := l;\r
264 end;\r
265 \r
266 \r
267 function ipstrtobinf;\r
268 begin\r
269   ipstrtobin(s,result);\r
270 end;\r
271 \r
272 function ipstrtobin(const s:string;var binip:tbinip):boolean;\r
273 begin\r
274   binip.family := 0;\r
275   result := false;\r
276   {$ifdef ipv6}\r
277   if pos(':',s) <> 0 then begin\r
278     {try ipv6. use builtin routine}\r
279     result := ip6strtobin(s,binip.ip6);\r
280     if result then binip.family := AF_INET6;\r
281     exit;\r
282   end;\r
283   {$endif}\r
284 \r
285   {try v4}\r
286   binip.ip := htonl(longip(s));\r
287   if (binip.ip <> 0) or (s = '0.0.0.0') then begin\r
288     result := true;\r
289     binip.family := AF_INET;\r
290     exit;\r
291   end;\r
292 end;\r
293 \r
294 function ipbintostr(const binip:tbinip):string;\r
295 var\r
296   a:integer;\r
297 begin\r
298   result := '';\r
299   {$ifdef ipv6}\r
300   if binip.family = AF_INET6 then begin\r
301     result := ip6bintostr(binip.ip6);\r
302   end else\r
303   {$endif}\r
304   if binip.family = AF_INET then begin\r
305     a := htonl(binip.ip);\r
306     result := inttostr(a shr 24)+'.'+inttostr((a shr 16) and $ff)+'.'+inttostr((a shr 8) and $ff)+'.'+inttostr(a and $ff);\r
307   end;\r
308 end;\r
309 \r
310 \r
311 {------------------------------------------------------------------------------}\r
312 \r
313 {$ifdef ipv6}\r
314 \r
315 {\r
316 IPv6 address binary to/from string conversion routines\r
317 written by beware (steendijk at xs4all dot nl)\r
318 \r
319 - implementation does not depend on other ipv6 code such as the tin6_addr type,\r
320   the parameter can also be untyped.\r
321 - it is host endian neutral - binary format is aways network order\r
322 - it supports compression of zeroes\r
323 - it supports ::ffff:192.168.12.34 style addresses\r
324 - they are made to do the Right Thing, more efficient implementations are possible\r
325 }\r
326 \r
327 {fpc has hostaddrtostr6 and strtohostaddr6 but the later isnt implemented yet}\r
328 \r
329 \r
330 function ip6bintostr(const bin:tin6_addr):string;\r
331 {base16 with lowercase output}\r
332 function makehex(w:word):string;\r
333 begin\r
334   result := '';\r
335   if w >= 4096 then result := result + hexchars[w shr 12];\r
336   if w >= 256 then result := result + hexchars[w shr 8 and $f];\r
337   if w >= 16 then result := result + hexchars[w shr 4 and $f];\r
338   result := result + hexchars[w and $f];\r
339 end;\r
340 \r
341 var\r
342   a,b,c,addrlen:integer;\r
343   runbegin,runlength:integer;\r
344   bytes:array[0..15] of byte absolute bin;\r
345   words:array[0..7] of word;\r
346   dwords:array[0..3] of integer absolute words;\r
347 begin\r
348   for a := 0 to 7 do begin\r
349     words[a] := bytes[a shl 1] shl 8 or bytes[a shl 1 or 1];\r
350   end;\r
351   if (dwords[0] = 0) and (dwords[1] = 0) and (words[4] = 0) and (words[5] = $ffff) then begin\r
352     {::ffff:/96 exception: v4 IP}\r
353     addrlen := 6;\r
354   end else begin\r
355     addrlen := 8;\r
356   end;\r
357   {find longest run of zeroes}\r
358   runbegin := 0;\r
359   runlength := 0;\r
360   for a := 0 to addrlen-1 do begin\r
361     if words[a] = 0 then begin\r
362       c := 0;\r
363       for b := a to addrlen-1 do if words[b] = 0 then begin\r
364         inc(c);\r
365       end else break;\r
366       if (c > runlength) then begin\r
367         runlength := c;\r
368         runbegin := a;\r
369       end;\r
370     end;\r
371   end;\r
372   result := '';\r
373   for a := 0 to runbegin-1 do begin\r
374     if (a <> 0) then result := result + ':';\r
375     result := result + makehex(words[a]);\r
376   end;\r
377   if runlength > 0 then result := result + '::';\r
378   c := runbegin+runlength;\r
379   for a := c to addrlen-1 do begin\r
380     if (a > c) then result := result + ':';\r
381     result := result + makehex(words[a]);\r
382   end;\r
383   if addrlen = 6 then begin\r
384     result := result + ':'+inttostr(bytes[12])+'.'+inttostr(bytes[13])+'.'+inttostr(bytes[14])+'.'+inttostr(bytes[15]);\r
385   end;\r
386 end;\r
387 \r
388 function ip6strtobin(const s:string;var bin:tin6_addr):boolean;\r
389 var\r
390   a,b:integer;\r
391   fields:array[0..7] of string;\r
392   fieldcount:integer;\r
393   emptyfield:integer;\r
394   wordcount:integer;\r
395   words:array[0..7] of word;\r
396   bytes:array[0..15] of byte absolute bin;\r
397 begin\r
398   result := false;\r
399   for a := 0 to 7 do fields[a] := '';\r
400   fieldcount := 0;\r
401   for a := 1 to length(s) do begin\r
402     if s[a] = ':' then inc(fieldcount) else fields[fieldcount] := fields[fieldcount] + s[a];\r
403     if fieldcount > 7 then exit;\r
404   end;\r
405   if fieldcount < 2 then exit;\r
406 \r
407   {find the empty field (compressed zeroes), not counting the first and last there may be at most 1}\r
408   emptyfield := -1;\r
409   for a := 1 to fieldcount-1 do begin\r
410     if fields[a] = '' then begin\r
411       if emptyfield = -1 then emptyfield := a else exit;\r
412     end;\r
413   end;\r
414 \r
415   {check if last field is a valid v4 IP}\r
416   a := longip(fields[fieldcount]);\r
417   if (a <> 0) or (fields[fieldcount] = '0.0.0.0') then wordcount := 6 else wordcount := 8;\r
418   {0:1:2:3:4:5:6.6.6.6\r
419    0:1:2:3:4:5:6:7}\r
420   fillchar(words,sizeof(words),0);\r
421   if wordcount = 6 then begin\r
422     if fieldcount > 6 then exit;\r
423     words[6] := a shr 16;\r
424     words[7] := a and $ffff;\r
425   end;\r
426   if emptyfield = -1 then begin\r
427     {no run length: must be an exact number of fields}\r
428     if wordcount = 6 then begin\r
429       if fieldcount <> 6 then exit;\r
430       emptyfield := 5;\r
431     end else if wordcount = 8 then begin\r
432       if fieldcount <> 7 then exit;\r
433       emptyfield := 7;\r
434     end else exit;\r
435   end;\r
436   for a := 0 to emptyfield do begin\r
437     if fields[a] = '' then b := 0 else b := strtointdef('$'+fields[a],-1);\r
438     if (b < 0) or (b > $ffff) then exit;\r
439     words[a] := b;\r
440   end;\r
441   if wordcount = 6 then dec(fieldcount);\r
442   for a := wordcount-1 downto wordcount-(fieldcount-emptyfield) do begin\r
443     b := a+fieldcount-wordcount+1;\r
444     if fields[b] = '' then b := 0 else b := strtointdef('$'+fields[b],-1);\r
445     if (b < 0) or (b > $ffff) then exit;\r
446     words[a] := b;\r
447   end;\r
448   for a := 0 to 7 do begin\r
449     bytes[a shl 1] := words[a] shr 8;\r
450     bytes[a shl 1 or 1] := words[a] and $ff;\r
451   end;\r
452   result := true;\r
453 end;\r
454 {$endif}\r
455 \r
456 function comparebinip(const ip1,ip2:tbinip):boolean;\r
457 begin\r
458   if (ip1.ip <> ip2.ip) then begin\r
459     result := false;\r
460     exit;\r
461   end;\r
462 \r
463   {$ifdef ipv6}\r
464   if ip1.family = AF_INET6 then begin\r
465     if (ip1.ip6.s6_addr32[1] <> ip2.ip6.s6_addr32[1])\r
466     or (ip1.ip6.s6_addr32[2] <> ip2.ip6.s6_addr32[2])\r
467     or (ip1.ip6.s6_addr32[3] <> ip2.ip6.s6_addr32[3]) then begin\r
468       result := false;\r
469       exit;\r
470     end;\r
471   end;\r
472   {$endif}\r
473 \r
474   result := (ip1.family = ip2.family);\r
475 end;\r
476 \r
477 procedure maskbits(var binip:tbinip;bits:integer);\r
478 const\r
479   ipmax={$ifdef ipv6}15{$else}3{$endif};\r
480 type tarr=array[0..ipmax] of byte;\r
481 var\r
482   arr:^tarr;\r
483   a,b:integer;\r
484 begin\r
485   arr := @binip.ip;\r
486   if bits = 0 then b := 0 else b := ((bits-1) div 8)+1;\r
487   for a := b to ipmax do begin\r
488     arr[a] := 0;\r
489   end;\r
490   if (bits and 7 <> 0) then begin\r
491     arr[bits shr 3] := arr[bits div 8] and not ($ff shr (bits and 7))\r
492   end;\r
493 end;\r
494 \r
495 function comparebinipmask;\r
496 begin\r
497   maskbits(ip1,bits);\r
498   maskbits(ip2,bits);\r
499   result := comparebinip(ip1,ip2);\r
500 end;\r
501 \r
502 {converts a binary IP to v4 if it is a v6 IP in the v4 range}\r
503 procedure converttov4(var ip:tbinip);\r
504 begin\r
505   {$ifdef ipv6}\r
506   if ip.family = AF_INET6 then begin\r
507     if (ip.ip6.u6_addr32[0] = 0) and (ip.ip6.u6_addr32[1] = 0) and\r
508     (ip.ip6.u6_addr16[4] = 0) and (ip.ip6.u6_addr16[5] = $ffff) then begin\r
509       ip.family := AF_INET;\r
510       ip.ip := ip.ip6.s6_addr32[3];\r
511     end;\r
512   end;\r
513   {$endif}\r
514 end;\r
515 \r
516 {-----------biniplist stuff--------------------------------------------------}\r
517 \r
518 const\r
519   biniplist_prefix='bipl'#0;\r
520   biniplist_prefixlen=length(biniplist_prefix);\r
521 \r
522 function biniplist_new:tbiniplist;\r
523 begin\r
524   result := biniplist_prefix;\r
525 end;\r
526 \r
527 procedure biniplist_add(var l:tbiniplist;ip:tbinip);\r
528 var\r
529   a:integer;\r
530 begin\r
531   a := biniplist_getcount(l);\r
532   biniplist_setcount(l,a+1);\r
533   biniplist_set(l,a,ip);\r
534 end;\r
535 \r
536 function biniplist_getcount(const l:tbiniplist):integer;\r
537 begin\r
538   result := (length(l)-biniplist_prefixlen) div sizeof(tbinip);\r
539 end;\r
540 \r
541 function biniplist_get(const l:tbiniplist;index:integer):tbinip;\r
542 begin\r
543   if (index >= biniplist_getcount(l)) then begin\r
544     fillchar(result,sizeof(result),0);\r
545     exit;\r
546   end;\r
547   move(l[index*sizeof(tbinip)+1+biniplist_prefixlen],result,sizeof(result));\r
548 end;\r
549 \r
550 procedure biniplist_set(var l:tbiniplist;index:integer;ip:tbinip);\r
551 begin\r
552   uniquestring(l);\r
553   move(ip,l[index*sizeof(tbinip)+1+biniplist_prefixlen],sizeof(ip));\r
554 end;\r
555 \r
556 procedure biniplist_setcount(var l:tbiniplist;newlen:integer);\r
557 begin\r
558   setlength(l,(sizeof(tbinip)*newlen)+biniplist_prefixlen);\r
559 end;\r
560 \r
561 procedure biniplist_free(var l:tbiniplist);\r
562 begin\r
563   l := '';\r
564 end;\r
565 \r
566 procedure biniplist_addlist;\r
567 begin\r
568   l := l + l2;\r
569 end;\r
570 \r
571 function biniplist_tostr(const l:tbiniplist):string;\r
572 var\r
573   a:integer;\r
574 begin\r
575   result := '(';\r
576   for a := 0 to biniplist_getcount(l)-1 do begin\r
577     if result <> '(' then result := result + ', ';\r
578     result := result + ipbintostr(biniplist_get(l,a));\r
579   end;\r
580   result := result + ')';\r
581 end;\r
582 \r
583 function isbiniplist(const l:tbiniplist):boolean;\r
584 var\r
585   i : integer;\r
586 begin\r
587   for i := 1 to biniplist_prefixlen do begin\r
588     if biniplist_prefix[i] <> l[i] then begin\r
589       result := false;\r
590       exit;\r
591     end;\r
592   end;\r
593   result := true;\r
594 end;\r
595 \r
596 end.\r