The hash table merely associates data structures with conversations,
[obnox/wireshark/wip.git] / packet-srvloc.c
1 /* packet-srvloc.c
2  * Routines for SRVLOC (Service Location Protocol) packet dissection
3  * Copyright 1999, James Coe <jammer@cin.net>
4  *
5  * NOTE: This is Alpha software not all features have been verified yet.
6  *       In particular I have not had an opportunity to see how it 
7  *       responds to SRVLOC over TCP.
8  *
9  * $Id: packet-srvloc.c,v 1.25 2001/07/15 19:14:00 guy Exp $
10  *
11  * Ethereal - Network traffic analyzer
12  * By Gerald Combs <gerald@ethereal.com>
13  * Copyright 1998 Gerald Combs
14  *
15  * Service Location Protocol is RFC 2165
16  *
17  * This program is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU General Public License
19  * as published by the Free Software Foundation; either version 2
20  * of the License, or (at your option) any later version.
21  * 
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  * 
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
30  */
31
32 #ifdef HAVE_CONFIG_H
33 # include "config.h"
34 #endif
35
36 #include <stdio.h>
37 #include <stdlib.h>
38
39 #ifdef HAVE_SYS_TYPES_H
40 # include <sys/types.h>
41 #endif
42
43 #ifdef HAVE_NETINET_IN_H
44 # include <netinet/in.h>
45 #endif
46
47 #include <string.h>
48 #include <time.h>
49 #include <glib.h>
50
51 #ifdef NEED_SNPRINTF_H
52 # include "snprintf.h"
53 #endif
54
55 #include "packet.h"
56 #include "strutil.h"
57
58 static int proto_srvloc = -1;
59 static int hf_srvloc_version = -1;
60 static int hf_srvloc_function = -1;
61 static int hf_srvloc_flags = -1;
62 static int hf_srvloc_error = -1;
63
64 static gint ett_srvloc = -1;
65 static gint ett_srvloc_flags = -1;
66
67 #define TCP_PORT_SRVLOC 427
68 #define UDP_PORT_SRVLOC 427
69
70 /* Define function types */
71
72 #define SRVREQ          1
73 #define SRVRPLY         2
74 #define SRVREG          3
75 #define SRVDEREG        4
76 #define SRVACK          5
77 #define ATTRRQST        6
78 #define ATTRRPLY        7
79 #define DAADVERT        8
80 #define SRVTYPERQST     9
81 #define SRVTYPERPLY     10
82
83 /* Create protocol header structure */
84
85 struct srvloc_hdr {
86     guint8      version;
87     guint8      function;
88     guint16     length;
89     guint8      flags;
90     guint8      dialect;
91     u_char      language[2];
92     guint16     encoding;
93     guint16     xid;
94 };
95
96 /* List to resolve function numbers to names */
97
98 static const value_string srvloc_functions[] = {
99     { SRVREQ, "Service Request" }, 
100     { SRVRPLY, "Service Reply" }, 
101     { SRVREG, "Service Registration" }, 
102     { SRVDEREG, "Service Deregister" }, 
103     { SRVACK, "Service Acknowledge" }, 
104     { ATTRRQST, "Attribute Request" }, 
105     { ATTRRPLY, "Attribute Reply" }, 
106     { DAADVERT, "DA Advertisement" }, 
107     { SRVTYPERQST, "Service Type Request" }, 
108     { SRVTYPERPLY, "Service Type Reply" }, 
109     { 0, NULL }
110 };
111
112 /* List to resolve flag values to names */
113
114
115 /* Define flag masks */
116
117 #define FLAG_O          0x80
118 #define FLAG_M          0x40
119 #define FLAG_U          0x20
120 #define FLAG_A          0x10
121 #define FLAG_F          0x08
122
123 /* Define Error Codes */
124
125 #define SUCCESS         0
126 #define LANG_NOT_SPTD   1
127 #define PROT_PARSE_ERR  2
128 #define INVLD_REG       3
129 #define SCOPE_NOT_SPTD  4
130 #define CHRSET_NOT_UND  5
131 #define AUTH_ABSENT     6
132 #define AUTH_FAILED     7
133
134 /* List to resolve error codes to names */
135
136 static const value_string srvloc_errs[] = {
137     { SUCCESS, "No Error" },
138     { LANG_NOT_SPTD, "Language not supported" },
139     { PROT_PARSE_ERR, "Protocol parse error" },
140     { INVLD_REG, "Invalid registration" },
141     { SCOPE_NOT_SPTD, "Scope not supported" },
142     { CHRSET_NOT_UND, "Character set not understood" },
143     { AUTH_ABSENT, "Authentication absent" },
144     { AUTH_FAILED, "Authentication failed" },
145     { 0, NULL }
146 };
147
148 /*
149  * Character encodings.
150  * This is a small subset of what's in
151  *
152  *      http://www.isi.edu/in-notes/iana/assignments/character-sets
153  *
154  * XXX - we should do something useful with this, i.e. properly
155  * handle strings based on the character set they're in.
156  *
157  * XXX - what does "properly handle strings" mean?  How do we know
158  * what character set the terminal can handle (for tty-based code)
159  * or the GUI can handle (for GUI code)?
160  *
161  * XXX - the Ethereal core really should be what does all the
162  * character set handling for strings, and it should be stuck with
163  * the task of figuring out how to properly handle them.
164  */
165 #define CHARSET_ASCII           3
166 #define CHARSET_ISO_10646_UTF_1 27
167 #define CHARSET_ISO_646_BASIC   28
168 #define CHARSET_ISO_646_IRV     30
169 #define CHARSET_ISO_8859_1      4
170 #define CHARSET_ISO_10646_UCS_2 1000    /* a/k/a Unicode */
171 #define CHARSET_UTF_7           1012
172 #define CHARSET_UTF_8           106
173
174 static const value_string charsets[] = {
175         { CHARSET_ASCII, "US-ASCII" },
176         { CHARSET_ISO_10646_UTF_1, "ISO 10646 UTF-1" },
177         { CHARSET_ISO_646_BASIC, "ISO 646 basic:1983" },
178         { CHARSET_ISO_646_IRV, "ISO 646 IRV:1983" },
179         { CHARSET_ISO_8859_1, "ISO 8859-1" },
180         { CHARSET_ISO_10646_UCS_2, "Unicode" },
181         { CHARSET_UTF_7, "UTF-7" },
182         { CHARSET_UTF_8, "UTF-8" },
183         { 0, NULL }
184 };
185
186 static int
187 dissect_authblk(tvbuff_t *tvb, int offset, proto_tree *tree)
188 {
189     struct tm *stamp;
190     time_t seconds;
191     double floatsec;
192     guint16 length;
193     
194     seconds = tvb_get_ntohl(tvb, offset) - 2208988800ul;
195     stamp = gmtime(&seconds);
196     if (stamp != NULL) {
197       floatsec = stamp->tm_sec + tvb_get_ntohl(tvb, offset + 4) / 4294967296.0;
198       proto_tree_add_text(tree, tvb, offset, 8,
199                           "Timestamp: %04d-%02d-%02d %02d:%02d:%07.4f UTC",
200                           stamp->tm_year + 1900, stamp->tm_mon + 1,
201                           stamp->tm_mday, stamp->tm_hour, stamp->tm_min,
202                           floatsec);
203     } else {
204       proto_tree_add_text(tree, tvb, offset, 8, "Timestamp not representable");
205     }
206     proto_tree_add_text(tree, tvb, offset + 8, 2, "Block Structure Desciptor: %u",
207                         tvb_get_ntohs(tvb, offset + 8));
208     length = tvb_get_ntohs(tvb, offset + 10);
209     proto_tree_add_text(tree, tvb, offset + 10, 2, "Authenticator length: %u",
210                         length);
211     offset += 12;
212     proto_tree_add_text(tree, tvb, offset, length, "Authentication block: %s",
213                         tvb_format_text(tvb, offset, length));
214     offset += length;
215     return offset;
216 }
217
218 /* Packet dissection routine called by tcp & udp when port 427 detected */
219
220 static void
221 dissect_srvloc(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
222 {
223     int offset = 0;
224     proto_item *ti, *tf;
225     proto_tree *srvloc_tree, *srvloc_flags;
226     guint8 version;
227     guint8 function;
228     guint16 encoding;
229     guint16 length;
230     guint8 flags;
231     guint32 count;
232
233     if (check_col(pinfo->fd, COL_PROTOCOL))
234         col_set_str(pinfo->fd, COL_PROTOCOL, "SRVLOC");
235     
236     if (check_col(pinfo->fd, COL_INFO))
237         col_clear(pinfo->fd, COL_INFO);
238
239     version = tvb_get_guint8(tvb, offset);
240     function = tvb_get_guint8(tvb, offset + 1);
241
242     if (check_col(pinfo->fd, COL_INFO))
243         col_add_str(pinfo->fd, COL_INFO,
244             val_to_str(function, srvloc_functions, "Unknown Function (%u)"));
245         
246     if (tree) {
247         ti = proto_tree_add_item(tree, proto_srvloc, tvb, offset,
248                                  tvb_length(tvb), FALSE);
249         srvloc_tree = proto_item_add_subtree(ti, ett_srvloc);
250     
251         proto_tree_add_uint(srvloc_tree, hf_srvloc_version, tvb, offset, 1,
252                             version);
253         proto_tree_add_uint(srvloc_tree, hf_srvloc_function, tvb, offset + 1, 1,
254                             function);
255         length = tvb_get_ntohs(tvb, offset + 2);
256         proto_tree_add_text(srvloc_tree, tvb, offset + 2, 2, "Length: %u",
257                             length);
258         flags = tvb_get_guint8(tvb, offset + 4);
259         tf = proto_tree_add_uint(srvloc_tree, hf_srvloc_flags, tvb, offset + 4, 1,
260                                  flags);
261         srvloc_flags = proto_item_add_subtree(tf, ett_srvloc_flags);
262         proto_tree_add_text(srvloc_flags, tvb, offset + 4, 0, "Overflow                          %d... .xxx", (flags & FLAG_O) >> 7 );
263         proto_tree_add_text(srvloc_flags, tvb, offset + 4, 0, "Monolingual                       .%d.. .xxx", (flags & FLAG_M) >> 6 );
264         proto_tree_add_text(srvloc_flags, tvb, offset + 4, 0, "URL Authentication Present        ..%d. .xxx", (flags & FLAG_U) >> 5 );
265         proto_tree_add_text(srvloc_flags, tvb, offset + 4, 0, "Attribute Authentication Present  ...%d .xxx", (flags & FLAG_A) >> 4 );
266         proto_tree_add_text(srvloc_flags, tvb, offset + 4, 0, "Fresh Service Entry               .... %dxxx", (flags & FLAG_F) >> 3 );
267         proto_tree_add_text(srvloc_tree, tvb, offset + 5, 1, "Dialect: %u",
268                             tvb_get_guint8(tvb, offset + 5));
269         proto_tree_add_text(srvloc_tree, tvb, offset + 6, 2, "Language: %s",
270                             tvb_format_text(tvb, offset + 6, 2));
271         encoding = tvb_get_ntohs(tvb, offset + 8);
272         proto_tree_add_text(srvloc_tree, tvb, offset + 8, 2, "Encoding: %u (%s)",
273                             encoding,
274                             val_to_str(encoding, charsets, "Unknown"));
275         proto_tree_add_text(srvloc_tree, tvb, offset + 10, 2, "Transaction ID: %u",
276                             tvb_get_ntohs(tvb, offset + 10));
277         offset += 12;
278         
279         switch (function) {
280             case SRVREQ:
281                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Service Request");
282                 length = tvb_get_ntohs(tvb, offset);
283                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Previous Response List Length: %u",
284                                     length);
285                 offset += 2;
286                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Previous Response List: %s",
287                                     tvb_format_text(tvb, offset, length));
288                 offset += length;
289                 length = tvb_get_ntohs(tvb, offset);
290                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Predicate length: %u",
291                                     length);
292                 offset += 2;
293                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Predicate: %s",
294                                     tvb_format_text(tvb, offset, length));
295                 offset += length;
296             break;
297             
298             case SRVRPLY:
299                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Service Reply");
300                 proto_tree_add_item(srvloc_tree, hf_srvloc_error, tvb, offset, 2, FALSE);
301                 offset += 2;
302                 count = tvb_get_ntohs(tvb, offset);
303                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "URL Count: %u",
304                                     count);
305                 offset += 2;
306                 while (count > 0) {
307                     proto_tree_add_text(srvloc_tree, tvb, offset, 2, "URL lifetime: %u",
308                                         tvb_get_ntohs(tvb, offset));
309                     offset += 2;
310                     length = tvb_get_ntohs(tvb, offset);
311                     proto_tree_add_text(srvloc_tree, tvb, offset, 2, "URL length: %u",
312                                         length);
313                     offset += 2;
314                     proto_tree_add_text(srvloc_tree, tvb, offset, length, "Service URL: %s",
315                                         tvb_format_text(tvb, offset, length));
316                     offset += length;
317                     if ( (flags & FLAG_U) == FLAG_U ) 
318                         offset = dissect_authblk(tvb, offset, srvloc_tree);
319                     count--;
320                 };
321             break;
322
323             case SRVREG:
324                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Service Registration");
325                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "URL lifetime: %u",
326                                     tvb_get_ntohs(tvb, offset));
327                 offset += 2;
328                 length = tvb_get_ntohs(tvb, offset);
329                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "URL length: %u",
330                                     length);
331                 offset += 2;
332                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Service URL: %s",
333                                     tvb_format_text(tvb, offset, length));
334                 offset += length;
335                 if ( (flags & FLAG_U) == FLAG_U ) 
336                     offset = dissect_authblk(tvb, offset, srvloc_tree);
337                 length = tvb_get_ntohs(tvb, offset);
338                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Attribute List length: %u",
339                                     length);
340                 offset += 2;
341                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Attribute List: %s",
342                                     tvb_format_text(tvb, offset, length));
343                 offset += length;
344                 if ( (flags & FLAG_A) == FLAG_A ) 
345                     offset = dissect_authblk(tvb, offset, srvloc_tree);
346             break;
347
348             case SRVDEREG:
349                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Service Deregister");
350                 length = tvb_get_ntohs(tvb, offset);
351                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "URL length: %u",
352                                     length);
353                 offset += 2;
354                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Service URL: %s",
355                                     tvb_format_text(tvb, offset, length));
356                 offset += length;
357                 if ( (flags & FLAG_U) == FLAG_U ) 
358                     offset = dissect_authblk(tvb, offset, srvloc_tree);
359                 length = tvb_get_ntohs(tvb, offset);
360                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Attribute List length: %u",
361                                     length);
362                 offset += 2;
363                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Attribute List: %s",
364                                     tvb_format_text(tvb, offset, length));
365                 offset += length;
366                 if ( (flags & FLAG_A) == FLAG_A ) 
367                     offset = dissect_authblk(tvb, offset, srvloc_tree);
368             break;
369             
370             case SRVACK:
371                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Service Acknowledge");
372                 proto_tree_add_item(srvloc_tree, hf_srvloc_error, tvb, offset, 2, FALSE);
373                 offset += 2;
374             break;
375
376             case ATTRRQST:
377                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Attribute Request");
378                 length = tvb_get_ntohs(tvb, offset);
379                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Previous Response List Length: %u",
380                                     length);
381                 offset += 2;
382                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Previous Response List: %s",
383                                     tvb_format_text(tvb, offset, length));
384                 offset += length;
385                 length = tvb_get_ntohs(tvb, offset);
386                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "URL length: %u",
387                                     length);
388                 offset += 2;
389                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Service URL: %s",
390                                     tvb_format_text(tvb, offset, length));
391                 offset += length;
392                 length = tvb_get_ntohs(tvb, offset);
393                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Scope List Length: %u",
394                                     length);
395                 offset += 2;
396                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Scope Response List: %s",
397                                     tvb_format_text(tvb, offset, length));
398                 offset += length;
399                 length = tvb_get_ntohs(tvb, offset);
400                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Attribute List length: %u",
401                                     length);
402                 offset += 2;
403                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Attribute List: %s",
404                                     tvb_format_text(tvb, offset, length));
405                 offset += length;
406             break;
407             
408             case ATTRRPLY:
409                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Attribute Reply");
410                 proto_tree_add_item(srvloc_tree, hf_srvloc_error, tvb, offset, 2, FALSE);
411                 offset += 2;
412                 length = tvb_get_ntohs(tvb, offset);
413                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Attribute List length: %u",
414                                     length);
415                 offset += 2;
416                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Attribute List: %s",
417                                     tvb_format_text(tvb, offset, length));
418                 offset += length;
419                 if ( (flags & FLAG_A) == FLAG_A ) 
420                     offset = dissect_authblk(tvb, offset, srvloc_tree);
421             break;
422             
423             case DAADVERT:
424                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "DA Advertisement");
425                 proto_tree_add_item(srvloc_tree, hf_srvloc_error, tvb, offset, 2, FALSE);
426                 offset += 2;
427                 length = tvb_get_ntohs(tvb, offset);
428                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "URL length: %u",
429                                     length);
430                 offset += 2;
431                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Service URL: %s",
432                                     tvb_format_text(tvb, offset, length));
433                 offset += length;
434                 length = tvb_get_ntohs(tvb, offset);
435                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Scope List Length: %u",
436                                     length);
437                 offset += 2;
438                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Scope Response List: %s",
439                                     tvb_format_text(tvb, offset, length));
440                 offset += length;
441             break;
442
443             case SRVTYPERQST:
444                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Service Type Request");
445                 length = tvb_get_ntohs(tvb, offset);
446                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Previous Response List Length: %u",
447                                     length);
448                 offset += 2;
449                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Previous Response List: %s",
450                                     tvb_format_text(tvb, offset, length));
451                 offset += length;
452                 length = tvb_get_ntohs(tvb, offset);
453                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Naming Authority List length: %u",
454                                     length);
455                 offset += 2;
456                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Naming Authority List: %s",
457                                     tvb_format_text(tvb, offset, length));
458                 offset += length;
459                 length = tvb_get_ntohs(tvb, offset);
460                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Scope List Length: %u",
461                                     length);
462                 offset += 2;
463                 proto_tree_add_text(srvloc_tree, tvb, offset, length, "Scope Response List: %s",
464                                     tvb_format_text(tvb, offset, length));
465                 offset += length;
466             break;
467
468             case SRVTYPERPLY:
469                 proto_tree_add_text(srvloc_tree, tvb, offset, 0, "Service Type Reply");
470                 proto_tree_add_item(srvloc_tree, hf_srvloc_error, tvb, offset, 2, FALSE);
471                 offset += 2;
472                 count = tvb_get_ntohs(tvb, offset);
473                 proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Service Type Count: %u",
474                                     count);
475                 offset += 2;
476                 while (count > 0) {
477                     length = tvb_get_ntohs(tvb, offset);
478                     proto_tree_add_text(srvloc_tree, tvb, offset, 2, "Service Type List length: %u",
479                                         length);
480                     offset += 2;
481                     proto_tree_add_text(srvloc_tree, tvb, offset, length, "Service Type List: %s",
482                                         tvb_format_text(tvb, offset, length));
483                     offset += length;
484                     count--;
485                 };
486             break;
487
488             default:
489                 proto_tree_add_text(srvloc_tree, tvb, offset, tvb_length_remaining(tvb, offset), "Unknown Function Type");
490         };
491     };
492 }
493
494 /* Register protocol with Ethereal. */
495
496 void
497 proto_register_srvloc(void)
498 {
499     static hf_register_info hf[] = {
500         { &hf_srvloc_version,
501             { "Version",           "srvloc.version",
502             FT_UINT8, BASE_DEC, NULL, 0x0,
503             "", HFILL }
504         },
505       
506         {&hf_srvloc_function,
507             {"Function", "srvloc.function", 
508             FT_UINT8, BASE_DEC, VALS(srvloc_functions), 0x0, 
509             "", HFILL }
510         },
511
512         {&hf_srvloc_flags,
513             {"Flags", "srvloc.flags", 
514             FT_UINT8, BASE_HEX, NULL, 0x0, 
515             "", HFILL }
516         },
517         
518         {&hf_srvloc_error,
519             {"Error Code", "srvloc.err",
520             FT_UINT16, BASE_DEC, VALS(srvloc_errs), 0x0,
521             "", HFILL }
522         },
523     };
524                   
525     static gint *ett[] = {
526         &ett_srvloc,
527         &ett_srvloc_flags,
528     };
529
530     proto_srvloc = proto_register_protocol("Service Location Protocol",
531                                            "SRVLOC", "srvloc");
532     proto_register_field_array(proto_srvloc, hf, array_length(hf));
533     proto_register_subtree_array(ett, array_length(ett));
534 };
535
536 void
537 proto_reg_handoff_srvloc(void)
538 {
539     dissector_add("tcp.port", TCP_PORT_SRVLOC, dissect_srvloc, proto_srvloc);
540     dissector_add("udp.port", UDP_PORT_SRVLOC, dissect_srvloc, proto_srvloc);
541 }
542