From 927cbf74ae1c08876a717f739449177d03740f2e Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Wed, 5 Jul 2006 20:49:50 +0000 Subject: r16824: Rename Ethereal -> Wireshark (patch from Joerg Mayer) (This used to be commit a789aa468b2b2b631289dd65888b352de46ad900) --- source4/pidl/MANIFEST | 4 +- source4/pidl/README | 6 +- .../pidl/lib/Parse/Pidl/Ethereal/Conformance.pm | 360 ------- source4/pidl/lib/Parse/Pidl/Ethereal/NDR.pm | 1054 -------------------- .../pidl/lib/Parse/Pidl/Wireshark/Conformance.pm | 360 +++++++ source4/pidl/lib/Parse/Pidl/Wireshark/NDR.pm | 1054 ++++++++++++++++++++ source4/pidl/pidl | 38 +- 7 files changed, 1438 insertions(+), 1438 deletions(-) delete mode 100644 source4/pidl/lib/Parse/Pidl/Ethereal/Conformance.pm delete mode 100644 source4/pidl/lib/Parse/Pidl/Ethereal/NDR.pm create mode 100644 source4/pidl/lib/Parse/Pidl/Wireshark/Conformance.pm create mode 100644 source4/pidl/lib/Parse/Pidl/Wireshark/NDR.pm (limited to 'source4/pidl') diff --git a/source4/pidl/MANIFEST b/source4/pidl/MANIFEST index a55898f60b..0a4df7ba89 100644 --- a/source4/pidl/MANIFEST +++ b/source4/pidl/MANIFEST @@ -26,8 +26,8 @@ lib/Parse/Pidl/Samba4/TDR.pm lib/Parse/Pidl/Samba4/Template.pm lib/Parse/Pidl/Samba4/EJS.pm lib/Parse/Pidl/Samba4.pm -lib/Parse/Pidl/Ethereal/Conformance.pm -lib/Parse/Pidl/Ethereal/NDR.pm +lib/Parse/Pidl/Wireshark/Conformance.pm +lib/Parse/Pidl/Wireshark/NDR.pm lib/Parse/Pidl/Typelist.pm lib/Parse/Pidl/Dump.pm lib/Parse/Pidl/Compat.pm diff --git a/source4/pidl/README b/source4/pidl/README index ddd5fdf319..f29e274192 100644 --- a/source4/pidl/README +++ b/source4/pidl/README @@ -46,9 +46,9 @@ Parse::Pidl::Samba4::COM::Proxy - Generates proxy object for DCOM (client-side) Parse::Pidl::Samba4::COM::Stub - Generates stub call handler for DCOM (server-side) Parse::Pidl::Samba4::COM::Header - Generates headers for COM --- Ethereal -- -Parse::Pidl::Ethereal::NDR - Generates a parser for the ethereal network sniffer -Parse::Pidl::Ethereal::Conformance - Reads conformance files containing additional data for generating Ethereal parsers +-- Wireshark -- +Parse::Pidl::Wireshark::NDR - Generates a parser for the Wireshark network sniffer +Parse::Pidl::Wireshark::Conformance - Reads conformance files containing additional data for generating Wireshark parsers -- Utility modules -- Parse::Pidl::Util - Misc utility functions used by *.pm and pidl.pl diff --git a/source4/pidl/lib/Parse/Pidl/Ethereal/Conformance.pm b/source4/pidl/lib/Parse/Pidl/Ethereal/Conformance.pm deleted file mode 100644 index e7f2922c7f..0000000000 --- a/source4/pidl/lib/Parse/Pidl/Ethereal/Conformance.pm +++ /dev/null @@ -1,360 +0,0 @@ -################################################### -# parse an ethereal conformance file -# Copyright jelmer@samba.org 2005 -# released under the GNU GPL - -=pod - -=head1 NAME - -Parse::Pidl::Ethereal::Conformance - Conformance file parser for Ethereal - -=head1 DESCRIPTION - -This module supports parsing Ethereal conformance files (*.cnf). - -=head1 FILE FORMAT - -Pidl needs additional data for ethereal output. This data is read from -so-called conformance files. This section describes the format of these -files. - -Conformance files are simple text files with a single command on each line. -Empty lines and lines starting with a '#' character are ignored. -Arguments to commands are seperated by spaces. - -The following commands are currently supported: - -=over 4 - -=item I name dissector ft_type base_type mask valsstring alignment - -Register new data type with specified name, what dissector function to call -and what properties to give header fields for elements of this type. - -=item I type - -Suppress emitting a dissect_type function for the specified type - -=item I type param - -Set parameter to specify to dissector function for given type. - -=item I hf title filter ft_type base_type valsstring mask description - -Generate a custom header field with specified properties. - -=item I old_hf_name new_hf_name - -Force the use of new_hf_name when the parser generator was going to -use old_hf_name. - -This can be used in conjunction with HF_FIELD in order to make more than -one element use the same filter name. - -=item I prefix - -Remove the specified prefix from all function names (if present). - -=item I longname shortname filtername - -Change the short-, long- and filter-name for the current interface in -Ethereal. - -=item I field desc - -Change description for the specified header field. `field' is the hf name of the field. - -=item I dissector code... - -Code to insert when generating the specified dissector. @HF@ and -@PARAM@ will be substituted. - -=item I hf_name "true string" "false string" - -Override the text shown when a bitmap boolean value is enabled or disabled. - -=item I fn_name - -Force pidl to not generate a particular function but allow the user -to write a function manually. This can be used to remove the function -for only one level for a particular element rather than all the functions and -ett/hf variables for a particular element as the NOEMIT command does. - -=back - -=head1 EXAMPLE - - INFO_KEY OpenKey.Ke - -=cut - -package Parse::Pidl::Ethereal::Conformance; - -require Exporter; -use vars qw($VERSION); -$VERSION = '0.01'; - -@ISA = qw(Exporter); -@EXPORT_OK = qw(ReadConformance); - -use strict; - -use Parse::Pidl::Util qw(has_property); - -sub handle_type($$$$$$$$$$) -{ - my ($pos,$data,$name,$dissectorname,$ft_type,$base_type,$mask,$valsstring,$alignment) = @_; - - unless(defined($alignment)) { - print "$pos: error incomplete TYPE command\n"; - return; - } - - unless ($dissectorname =~ /.*dissect_.*/) { - print "$pos: warning: dissector name does not contain `dissect'\n"; - } - - unless(valid_ft_type($ft_type)) { - print "$pos: warning: invalid FT_TYPE `$ft_type'\n"; - } - - unless (valid_base_type($base_type)) { - print "$pos: warning: invalid BASE_TYPE `$base_type'\n"; - } - - $data->{types}->{$name} = { - NAME => $name, - POS => $pos, - USED => 0, - DISSECTOR_NAME => $dissectorname, - FT_TYPE => $ft_type, - BASE_TYPE => $base_type, - MASK => $mask, - VALSSTRING => $valsstring, - ALIGNMENT => $alignment - }; -} - -sub handle_tfs($$$$$) -{ - my ($pos,$data,$hf,$trues,$falses) = @_; - - unless(defined($falses)) { - print "$pos: error: incomplete TFS command\n"; - return; - } - - $data->{tfs}->{$hf} = { - TRUE_STRING => $trues, - FALSE_STRING => $falses - }; -} - -sub handle_hf_rename($$$$) -{ - my ($pos,$data,$old,$new) = @_; - - unless(defined($new)) { - print "$pos: error: incomplete HF_RENAME command\n"; - return; - } - - $data->{hf_renames}->{$old} = { - OLDNAME => $old, - NEWNAME => $new, - POS => $pos, - USED => 0 - }; -} - -sub handle_param_value($$$$) -{ - my ($pos,$data,$dissector_name,$value) = @_; - - unless(defined($value)) { - print "$pos: error: incomplete PARAM_VALUE command\n"; - return; - } - - $data->{dissectorparams}->{$dissector_name} = { - DISSECTOR => $dissector_name, - PARAM => $value, - POS => $pos, - USED => 0 - }; -} - -sub valid_base_type($) -{ - my $t = shift; - return 0 unless($t =~ /^BASE_.*/); - return 1; -} - -sub valid_ft_type($) -{ - my $t = shift; - return 0 unless($t =~ /^FT_.*/); - return 1; -} - -sub handle_hf_field($$$$$$$$$$) -{ - my ($pos,$data,$index,$name,$filter,$ft_type,$base_type,$valsstring,$mask,$blurb) = @_; - - unless(defined($blurb)) { - print "$pos: error: incomplete HF_FIELD command\n"; - return; - } - - unless(valid_ft_type($ft_type)) { - print "$pos: warning: invalid FT_TYPE `$ft_type'\n"; - } - - unless(valid_base_type($base_type)) { - print "$pos: warning: invalid BASE_TYPE `$base_type'\n"; - } - - $data->{header_fields}->{$index} = { - INDEX => $index, - POS => $pos, - USED => 0, - NAME => $name, - FILTER => $filter, - FT_TYPE => $ft_type, - BASE_TYPE => $base_type, - VALSSTRING => $valsstring, - MASK => $mask, - BLURB => $blurb - }; -} - -sub handle_strip_prefix($$$) -{ - my ($pos,$data,$x) = @_; - - push (@{$data->{strip_prefixes}}, $x); -} - -sub handle_noemit($$$) -{ - my ($pos,$data,$type) = @_; - - if (defined($type)) { - $data->{noemit}->{$type} = 1; - } else { - $data->{noemit_dissector} = 1; - } -} - -sub handle_manual($$$) -{ - my ($pos,$data,$fn) = @_; - - $data->{manual}->{$fn} = 1; -} - -sub handle_protocol($$$$$$) -{ - my ($pos, $data, $name, $longname, $shortname, $filtername) = @_; - - $data->{protocols}->{$name} = { - LONGNAME => $longname, - SHORTNAME => $shortname, - FILTERNAME => $filtername - }; -} - -sub handle_fielddescription($$$$) -{ - my ($pos,$data,$field,$desc) = @_; - - $data->{fielddescription}->{$field} = { - DESCRIPTION => $desc, - POS => $pos, - USED => 0 - }; -} - -sub handle_import -{ - my $pos = shift @_; - my $data = shift @_; - my $dissectorname = shift @_; - - unless(defined($dissectorname)) { - print "$pos: error: no dissectorname specified\n"; - return; - } - - $data->{imports}->{$dissectorname} = { - NAME => $dissectorname, - DATA => join(' ', @_), - USED => 0, - POS => $pos - }; -} - -my %field_handlers = ( - TYPE => \&handle_type, - NOEMIT => \&handle_noemit, - MANUAL => \&handle_manual, - PARAM_VALUE => \&handle_param_value, - HF_FIELD => \&handle_hf_field, - HF_RENAME => \&handle_hf_rename, - TFS => \&handle_tfs, - STRIP_PREFIX => \&handle_strip_prefix, - PROTOCOL => \&handle_protocol, - FIELD_DESCRIPTION => \&handle_fielddescription, - IMPORT => \&handle_import -); - -sub ReadConformance($$) -{ - my ($f,$data) = @_; - - $data->{override} = ""; - - my $incodeblock = 0; - - open(IN,"<$f") or return undef; - - my $ln = 0; - - foreach () { - $ln++; - next if (/^#.*$/); - next if (/^$/); - - s/[\r\n]//g; - - if ($_ eq "CODE START") { - $incodeblock = 1; - next; - } elsif ($incodeblock and $_ eq "CODE END") { - $incodeblock = 0; - next; - } elsif ($incodeblock) { - $data->{override}.="$_\n"; - next; - } - - my @fields = /([^ "]+|"[^"]+")/g; - - my $cmd = $fields[0]; - - shift @fields; - - if (not defined($field_handlers{$cmd})) { - print "$f:$ln: Warning: Unknown command `$cmd'\n"; - next; - } - - $field_handlers{$cmd}("$f:$ln", $data, @fields); - } - - close(IN); -} - -1; diff --git a/source4/pidl/lib/Parse/Pidl/Ethereal/NDR.pm b/source4/pidl/lib/Parse/Pidl/Ethereal/NDR.pm deleted file mode 100644 index 685cb5a12a..0000000000 --- a/source4/pidl/lib/Parse/Pidl/Ethereal/NDR.pm +++ /dev/null @@ -1,1054 +0,0 @@ -################################################## -# Samba4 NDR parser generator for IDL structures -# Copyright tridge@samba.org 2000-2003 -# Copyright tpot@samba.org 2001,2005 -# Copyright jelmer@samba.org 2004-2005 -# Portions based on idl2eth.c by Ronnie Sahlberg -# released under the GNU GPL - -=pod - -=head1 NAME - -Parse::Pidl::Ethereal::NDR - Parser generator for Ethereal - -=cut - -package Parse::Pidl::Ethereal::NDR; - -use strict; -use Parse::Pidl::Typelist qw(getType); -use Parse::Pidl::Util qw(has_property ParseExpr property_matches make_str); -use Parse::Pidl::NDR qw(ContainsString GetNextLevel); -use Parse::Pidl::Dump qw(DumpTypedef DumpFunction); -use Parse::Pidl::Ethereal::Conformance qw(ReadConformance); -use File::Basename; - -use vars qw($VERSION); -$VERSION = '0.01'; - -sub error($$) -{ - my ($e,$t) = @_; - print "$e->{FILE}:$e->{LINE}: $t\n"; -} - -my @ett; - -my %hf_used = (); -my %dissector_used = (); - -my $conformance = undef; - -my %ptrtype_mappings = ( - "unique" => "NDR_POINTER_UNIQUE", - "ref" => "NDR_POINTER_REF", - "ptr" => "NDR_POINTER_PTR" -); - -sub StripPrefixes($) -{ - my ($s) = @_; - - foreach (@{$conformance->{strip_prefixes}}) { - $s =~ s/^$_\_//g; - } - - return $s; -} - -# Convert a IDL structure field name (e.g access_mask) to a prettier -# string like 'Access Mask'. - -sub field2name($) -{ - my($field) = shift; - - $field =~ s/_/ /g; # Replace underscores with spaces - $field =~ s/(\w+)/\u\L$1/g; # Capitalise each word - - return $field; -} - -my %res = (); -my $tabs = ""; -my $cur_fn = undef; -sub pidl_fn_start($) -{ - my $fn = shift; - $cur_fn = $fn; -} -sub pidl_fn_end($) -{ - my $fn = shift; - die("Inconsistent state: $fn != $cur_fn") if ($fn ne $cur_fn); - $cur_fn = undef; -} - -sub pidl_code($) -{ - my $d = shift; - return if (defined($cur_fn) and defined($conformance->{manual}->{$cur_fn})); - - if ($d) { - $res{code} .= $tabs; - $res{code} .= $d; - } - $res{code} .="\n"; -} - -sub pidl_hdr($) { my $x = shift; $res{hdr} .= "$x\n"; } -sub pidl_def($) { my $x = shift; $res{def} .= "$x\n"; } - -sub indent() -{ - $tabs .= "\t"; -} - -sub deindent() -{ - $tabs = substr($tabs, 0, -1); -} - -sub PrintIdl($) -{ - my $idl = shift; - - foreach (split /\n/, $idl) { - pidl_code "/* IDL: $_ */"; - } - - pidl_code ""; -} - -##################################################################### -# parse the interface definitions -sub Interface($) -{ - my($interface) = @_; - Const($_,$interface->{NAME}) foreach (@{$interface->{CONSTS}}); - Typedef($_,$interface->{NAME}) foreach (@{$interface->{TYPES}}); - Function($_,$interface->{NAME}) foreach (@{$interface->{FUNCTIONS}}); -} - -sub Enum($$$) -{ - my ($e,$name,$ifname) = @_; - my $valsstring = "$ifname\_$name\_vals"; - my $dissectorname = "$ifname\_dissect\_enum\_".StripPrefixes($name); - - return if (defined($conformance->{noemit}->{StripPrefixes($name)})); - - foreach (@{$e->{ELEMENTS}}) { - if (/([^=]*)=(.*)/) { - pidl_hdr "#define $1 ($2)"; - } - } - - pidl_hdr "extern const value_string $valsstring\[];"; - pidl_hdr "int $dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep, int hf_index, guint32 param);"; - - pidl_def "const value_string ".$valsstring."[] = {"; - foreach (@{$e->{ELEMENTS}}) { - next unless (/([^=]*)=(.*)/); - pidl_def "\t{ $1, \"$1\" },"; - } - - pidl_def "{ 0, NULL }"; - pidl_def "};"; - - pidl_fn_start $dissectorname; - pidl_code "int"; - pidl_code "$dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep, int hf_index, guint32 param _U_)"; - pidl_code "{"; - indent; - pidl_code "offset = dissect_ndr_$e->{BASE_TYPE}(tvb, offset, pinfo, tree, drep, hf_index, NULL);"; - pidl_code "return offset;"; - deindent; - pidl_code "}\n"; - pidl_fn_end $dissectorname; - - my $enum_size = $e->{BASE_TYPE}; - $enum_size =~ s/uint//g; - register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$enum_size", "BASE_DEC", "0", "VALS($valsstring)", $enum_size / 8); -} - -sub Bitmap($$$) -{ - my ($e,$name,$ifname) = @_; - my $dissectorname = "$ifname\_dissect\_bitmap\_".StripPrefixes($name); - - register_ett("ett_$ifname\_$name"); - - pidl_hdr "int $dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep, int hf_index, guint32 param);"; - - pidl_fn_start $dissectorname; - pidl_code "int"; - pidl_code "$dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *parent_tree, guint8 *drep, int hf_index, guint32 param _U_)"; - pidl_code "{"; - indent; - pidl_code "proto_item *item = NULL;"; - pidl_code "proto_tree *tree = NULL;"; - pidl_code ""; - - pidl_code "g$e->{BASE_TYPE} flags;"; - if ($e->{ALIGN} > 1) { - pidl_code "ALIGN_TO_$e->{ALIGN}_BYTES;"; - } - - pidl_code ""; - - pidl_code "if (parent_tree) {"; - indent; - pidl_code "item = proto_tree_add_item(parent_tree, hf_index, tvb, offset, $e->{ALIGN}, TRUE);"; - pidl_code "tree = proto_item_add_subtree(item,ett_$ifname\_$name);"; - deindent; - pidl_code "}\n"; - - pidl_code "offset = dissect_ndr_$e->{BASE_TYPE}(tvb, offset, pinfo, NULL, drep, -1, &flags);"; - - pidl_code "proto_item_append_text(item, \": \");\n"; - pidl_code "if (!flags)"; - pidl_code "\tproto_item_append_text(item, \"(No values set)\");\n"; - - foreach (@{$e->{ELEMENTS}}) { - next unless (/([^ ]*) (.*)/); - my ($en,$ev) = ($1,$2); - my $hf_bitname = "hf_$ifname\_$name\_$en"; - my $filtername = "$ifname\.$name\.$en"; - - $hf_used{$hf_bitname} = 1; - - register_hf_field($hf_bitname, field2name($en), $filtername, "FT_BOOLEAN", $e->{ALIGN} * 8, "TFS(&$name\_$en\_tfs)", $ev, ""); - - pidl_def "static const true_false_string $name\_$en\_tfs = {"; - if (defined($conformance->{tfs}->{$hf_bitname})) { - pidl_def " $conformance->{tfs}->{$hf_bitname}->{TRUE_STRING},"; - pidl_def " $conformance->{tfs}->{$hf_bitname}->{FALSE_STRING},"; - $conformance->{tfs}->{$hf_bitname}->{USED} = 1; - } else { - pidl_def " \"$en is SET\","; - pidl_def " \"$en is NOT SET\","; - } - pidl_def "};"; - - pidl_code "proto_tree_add_boolean(tree, $hf_bitname, tvb, offset-$e->{ALIGN}, $e->{ALIGN}, flags);"; - pidl_code "if (flags&$ev){"; - pidl_code "\tproto_item_append_text(item, \"$en\");"; - pidl_code "\tif (flags & (~$ev))"; - pidl_code "\t\tproto_item_append_text(item, \", \");"; - pidl_code "}"; - pidl_code "flags&=(~$ev);"; - pidl_code ""; - } - - pidl_code "if (flags) {"; - pidl_code "\tproto_item_append_text(item, \"Unknown bitmap value 0x%x\", flags);"; - pidl_code "}\n"; - pidl_code "return offset;"; - deindent; - pidl_code "}\n"; - pidl_fn_end $dissectorname; - - my $size = $e->{BASE_TYPE}; - $size =~ s/uint//g; - register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$size", "BASE_HEX", "0", "NULL", $size/8); -} - -sub ElementLevel($$$$$) -{ - my ($e,$l,$hf,$myname,$pn) = @_; - - my $param = 0; - - if (defined($conformance->{dissectorparams}->{$myname})) { - $conformance->{dissectorparams}->{$myname}->{PARAM} = 1; - $param = $conformance->{dissectorparams}->{$myname}->{PARAM}; - } - - if ($l->{TYPE} eq "POINTER") { - my $type; - if ($l->{LEVEL} eq "TOP") { - $type = "toplevel"; - } elsif ($l->{LEVEL} eq "EMBEDDED") { - $type = "embedded"; - } - pidl_code "offset = dissect_ndr_$type\_pointer(tvb, offset, pinfo, tree, drep, $myname\_, $ptrtype_mappings{$l->{POINTER_TYPE}}, \"Pointer to ".field2name(StripPrefixes($e->{NAME})) . " ($e->{TYPE})\",$hf);"; - } elsif ($l->{TYPE} eq "ARRAY") { - if ($l->{IS_INLINE}) { - error($e->{ORIGINAL}, "Inline arrays not supported"); - } elsif ($l->{IS_FIXED}) { - pidl_code "int i;"; - pidl_code "for (i = 0; i < $l->{SIZE_IS}; i++)"; - pidl_code "\toffset = $myname\_(tvb, offset, pinfo, tree, drep);"; - } else { - my $type = ""; - $type .= "c" if ($l->{IS_CONFORMANT}); - $type .= "v" if ($l->{IS_VARYING}); - - unless ($l->{IS_ZERO_TERMINATED}) { - pidl_code "offset = dissect_ndr_u" . $type . "array(tvb, offset, pinfo, tree, drep, $myname\_);"; - } else { - my $nl = GetNextLevel($e,$l); - pidl_code "char *data;"; - pidl_code ""; - pidl_code "offset = dissect_ndr_$type" . "string(tvb, offset, pinfo, tree, drep, sizeof(g$nl->{DATA_TYPE}), $hf, FALSE, &data);"; - pidl_code "proto_item_append_text(tree, \": %s\", data);"; - } - } - } elsif ($l->{TYPE} eq "DATA") { - if ($l->{DATA_TYPE} eq "string") { - my $bs = 2; # Byte size defaults to that of UCS2 - - - ($bs = 1) if (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_ASCII.*")); - - if (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_SIZE4.*") and property_matches($e, "flag", ".*LIBNDR_FLAG_STR_LEN4.*")) { - pidl_code "char *data;\n"; - pidl_code "offset = dissect_ndr_cvstring(tvb, offset, pinfo, tree, drep, $bs, $hf, FALSE, &data);"; - pidl_code "proto_item_append_text(tree, \": %s\", data);"; - } elsif (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_SIZE4.*")) { - pidl_code "offset = dissect_ndr_vstring(tvb, offset, pinfo, tree, drep, $bs, $hf, FALSE, NULL);"; - } else { - warn("Unable to handle string with flags $e->{PROPERTIES}->{flag}"); - } - } else { - my $call; - - if ($conformance->{imports}->{$l->{DATA_TYPE}}) { - $call = $conformance->{imports}->{$l->{DATA_TYPE}}->{DATA}; - $conformance->{imports}->{$l->{DATA_TYPE}}->{USED} = 1; - } elsif (defined($conformance->{imports}->{"$pn.$e->{NAME}"})) { - $call = $conformance->{imports}->{"$pn.$e->{NAME}"}->{DATA}; - $conformance->{imports}->{"$pn.$e->{NAME}"}->{USED} = 1; - - } elsif (defined($conformance->{types}->{$l->{DATA_TYPE}})) { - $call= $conformance->{types}->{$l->{DATA_TYPE}}->{DISSECTOR_NAME}; - $conformance->{types}->{$l->{DATA_TYPE}}->{USED} = 1; - } else { - if ($l->{DATA_TYPE} =~ /^([a-z]+)\_(.*)$/) - { - pidl_code "offset = $1_dissect_struct_$2(tvb,offset,pinfo,tree,drep,$hf,$param);"; - } - - return; - } - - $call =~ s/\@HF\@/$hf/g; - $call =~ s/\@PARAM\@/$param/g; - pidl_code "$call"; - } - } elsif ($_->{TYPE} eq "SUBCONTEXT") { - my $num_bits = ($l->{HEADER_SIZE}*8); - pidl_code "guint$num_bits size;"; - pidl_code "int start_offset = offset;"; - pidl_code "tvbuff_t *subtvb;"; - pidl_code "offset = dissect_ndr_uint$num_bits(tvb, offset, pinfo, tree, drep, $hf, &size);"; - pidl_code "proto_tree_add_text(tree, tvb, start_offset, offset - start_offset + size, \"Subcontext size\");"; - - pidl_code "subtvb = tvb_new_subset(tvb, offset, size, -1);"; - pidl_code "$myname\_(subtvb, 0, pinfo, tree, drep);"; - } else { - die("Unknown type `$_->{TYPE}'"); - } -} - -sub Element($$$) -{ - my ($e,$pn,$ifname) = @_; - - my $dissectorname = "$ifname\_dissect\_element\_".StripPrefixes($pn)."\_".StripPrefixes($e->{NAME}); - - my $call_code = "offset = $dissectorname(tvb, offset, pinfo, tree, drep);"; - - my $type = find_type($e->{TYPE}); - - if (not defined($type)) { - # default settings - $type = { - MASK => 0, - VALSSTRING => "NULL", - FT_TYPE => "FT_NONE", - BASE_TYPE => "BASE_HEX" - }; - } - - if (ContainsString($e)) { - $type = { - MASK => 0, - VALSSTRING => "NULL", - FT_TYPE => "FT_STRING", - BASE_TYPE => "BASE_DEC" - }; - } - - my $hf = register_hf_field("hf_$ifname\_$pn\_$e->{NAME}", field2name($e->{NAME}), "$ifname.$pn.$e->{NAME}", $type->{FT_TYPE}, $type->{BASE_TYPE}, $type->{VALSSTRING}, $type->{MASK}, ""); - $hf_used{$hf} = 1; - - my $eltname = StripPrefixes($pn) . ".$e->{NAME}"; - if (defined($conformance->{noemit}->{$eltname})) { - return $call_code; - } - - my $add = ""; - - foreach (@{$e->{LEVELS}}) { - next if ($_->{TYPE} eq "SWITCH"); - pidl_def "static int $dissectorname$add(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep);"; - pidl_fn_start "$dissectorname$add"; - pidl_code "static int"; - pidl_code "$dissectorname$add(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep)"; - pidl_code "{"; - indent; - - ElementLevel($e,$_,$hf,$dissectorname.$add,$pn); - - pidl_code ""; - pidl_code "return offset;"; - deindent; - pidl_code "}\n"; - pidl_fn_end "$dissectorname$add"; - $add.="_"; - last if ($_->{TYPE} eq "ARRAY" and $_->{IS_ZERO_TERMINATED}); - } - - return $call_code; -} - -sub Function($$$) -{ - my ($fn,$ifname) = @_; - - my %dissectornames; - - foreach (@{$fn->{ELEMENTS}}) { - $dissectornames{$_->{NAME}} = Element($_, $fn->{NAME}, $ifname) if not defined($dissectornames{$_->{NAME}}); - } - - my $fn_name = $_->{NAME}; - $fn_name =~ s/^${ifname}_//; - - PrintIdl DumpFunction($fn->{ORIGINAL}); - pidl_fn_start "$ifname\_dissect\_$fn_name\_response"; - pidl_code "static int"; - pidl_code "$ifname\_dissect\_${fn_name}_response(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)"; - pidl_code "{"; - indent; - pidl_code "guint32 status;\n"; - foreach (@{$fn->{ELEMENTS}}) { - if (grep(/out/,@{$_->{DIRECTION}})) { - pidl_code "$dissectornames{$_->{NAME}}"; - pidl_code "offset = dissect_deferred_pointers(pinfo, tvb, offset, drep);"; - pidl_code ""; - } - } - - if (not defined($fn->{RETURN_TYPE})) { - } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS") { - pidl_code "offset = dissect_ntstatus(tvb, offset, pinfo, tree, drep, hf\_$ifname\_status, &status);\n"; - pidl_code "if (status != 0 && check_col(pinfo->cinfo, COL_INFO))"; - pidl_code "\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Error: %s\", val_to_str(status, NT_errors, \"Unknown NT status 0x%08x\"));\n"; - $hf_used{"hf\_$ifname\_status"} = 1; - } elsif ($fn->{RETURN_TYPE} eq "WERROR") { - pidl_code "offset = dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, hf\_$ifname\_werror, &status);\n"; - pidl_code "if (status != 0 && check_col(pinfo->cinfo, COL_INFO))"; - pidl_code "\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Error: %s\", val_to_str(status, DOS_errors, \"Unknown DOS error 0x%08x\"));\n"; - - $hf_used{"hf\_$ifname\_werror"} = 1; - } else { - print "$fn->{FILE}:$fn->{LINE}: error: return type `$fn->{RETURN_TYPE}' not yet supported\n"; - } - - - pidl_code "return offset;"; - deindent; - pidl_code "}\n"; - pidl_fn_end "$ifname\_dissect\_$fn_name\_response"; - - pidl_fn_start "$ifname\_dissect\_$fn_name\_request"; - pidl_code "static int"; - pidl_code "$ifname\_dissect\_${fn_name}_request(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)"; - pidl_code "{"; - indent; - foreach (@{$fn->{ELEMENTS}}) { - if (grep(/in/,@{$_->{DIRECTION}})) { - pidl_code "$dissectornames{$_->{NAME}}"; - pidl_code "offset = dissect_deferred_pointers(pinfo, tvb, offset, drep);"; - } - - } - - pidl_code "return offset;"; - deindent; - pidl_code "}\n"; - pidl_fn_end "$ifname\_dissect\_$fn_name\_request"; -} - -sub Struct($$$) -{ - my ($e,$name,$ifname) = @_; - my $dissectorname = "$ifname\_dissect\_struct\_".StripPrefixes($name); - - return if (defined($conformance->{noemit}->{StripPrefixes($name)})); - - register_ett("ett_$ifname\_$name"); - - my $res = ""; - ($res.="\t".Element($_, $name, $ifname)."\n\n") foreach (@{$e->{ELEMENTS}}); - - pidl_hdr "int $dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *parent_tree, guint8 *drep, int hf_index, guint32 param _U_);"; - - pidl_fn_start $dissectorname; - pidl_code "int"; - pidl_code "$dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *parent_tree, guint8 *drep, int hf_index, guint32 param _U_)"; - pidl_code "{"; - indent; - pidl_code "proto_item *item = NULL;"; - pidl_code "proto_tree *tree = NULL;"; - pidl_code "int old_offset;"; - pidl_code ""; - - if ($e->{ALIGN} > 1) { - pidl_code "ALIGN_TO_$e->{ALIGN}_BYTES;"; - } - pidl_code ""; - - pidl_code "old_offset = offset;"; - pidl_code ""; - pidl_code "if (parent_tree) {"; - indent; - pidl_code "item = proto_tree_add_item(parent_tree, hf_index, tvb, offset, -1, TRUE);"; - pidl_code "tree = proto_item_add_subtree(item, ett_$ifname\_$name);"; - deindent; - pidl_code "}"; - - pidl_code "\n$res"; - - pidl_code "proto_item_set_len(item, offset-old_offset);\n"; - pidl_code "return offset;"; - deindent; - pidl_code "}\n"; - pidl_fn_end $dissectorname; - - register_type($name, "offset = $dissectorname(tvb,offset,pinfo,tree,drep,\@HF\@,\@PARAM\@);", "FT_NONE", "BASE_NONE", 0, "NULL", 0); -} - -sub Union($$$) -{ - my ($e,$name,$ifname) = @_; - - my $dissectorname = "$ifname\_dissect_".StripPrefixes($name); - - return if (defined($conformance->{noemit}->{StripPrefixes($name)})); - - register_ett("ett_$ifname\_$name"); - - my $res = ""; - foreach (@{$e->{ELEMENTS}}) { - $res.="\n\t\t$_->{CASE}:\n"; - if ($_->{TYPE} ne "EMPTY") { - $res.="\t\t\t".Element($_, $name, $ifname)."\n"; - } - $res.="\t\tbreak;\n"; - } - - my $switch_type; - my $switch_dissect; - my $switch_dt = getType($e->{SWITCH_TYPE}); - if ($switch_dt->{DATA}->{TYPE} eq "ENUM") { - $switch_type = "g".Parse::Pidl::Typelist::enum_type_fn($switch_dt); - $switch_dissect = "dissect_ndr_" .Parse::Pidl::Typelist::enum_type_fn($switch_dt); - } elsif ($switch_dt->{DATA}->{TYPE} eq "SCALAR") { - $switch_type = "g$e->{SWITCH_TYPE}"; - $switch_dissect = "dissect_ndr_$e->{SWITCH_TYPE}"; - } - - pidl_fn_start $dissectorname; - pidl_code "static int"; - pidl_code "$dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *parent_tree, guint8 *drep, int hf_index, guint32 param _U_)"; - pidl_code "{"; - indent; - pidl_code "proto_item *item = NULL;"; - pidl_code "proto_tree *tree = NULL;"; - pidl_code "int old_offset;"; - pidl_code "$switch_type level;"; - pidl_code ""; - - if ($e->{ALIGN} > 1) { - pidl_code "ALIGN_TO_$e->{ALIGN}_BYTES;"; - } - - pidl_code ""; - - pidl_code "old_offset = offset;"; - pidl_code "if (parent_tree) {"; - indent; - pidl_code "item = proto_tree_add_text(parent_tree, tvb, offset, -1, \"$name\");"; - pidl_code "tree = proto_item_add_subtree(item, ett_$ifname\_$name);"; - deindent; - pidl_code "}"; - - pidl_code ""; - - pidl_code "offset = $switch_dissect(tvb, offset, pinfo, tree, drep, hf_index, &level);"; - - pidl_code "switch(level) {$res\t}"; - pidl_code "proto_item_set_len(item, offset-old_offset);\n"; - pidl_code "return offset;"; - deindent; - pidl_code "}"; - pidl_fn_end $dissectorname; - - register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_NONE", "BASE_NONE", 0, "NULL", 0); -} - -sub Const($$) -{ - my ($const,$ifname) = @_; - - if (!defined($const->{ARRAY_LEN}[0])) { - pidl_hdr "#define $const->{NAME}\t( $const->{VALUE} )\n"; - } else { - pidl_hdr "#define $const->{NAME}\t $const->{VALUE}\n"; - } -} - -sub Typedef($$) -{ - my ($e,$ifname) = @_; - - PrintIdl DumpTypedef($e->{ORIGINAL}); - - { - ENUM => \&Enum, - STRUCT => \&Struct, - UNION => \&Union, - BITMAP => \&Bitmap - }->{$e->{DATA}->{TYPE}}->($e->{DATA}, $e->{NAME}, $ifname); -} - -sub RegisterInterface($) -{ - my ($x) = @_; - - pidl_fn_start "proto_register_dcerpc_$x->{NAME}"; - pidl_code "void proto_register_dcerpc_$x->{NAME}(void)"; - pidl_code "{"; - indent; - - $res{code}.=DumpHfList()."\n"; - $res{code}.="\n".DumpEttList()."\n"; - - if (defined($x->{UUID})) { - # These can be changed to non-pidl_code names if the old dissectors - # in epan/dissctors are deleted. - - my $name = uc($x->{NAME}) . " (pidl)"; - my $short_name = uc($x->{NAME}); - my $filter_name = $x->{NAME}; - - if (has_property($x, "helpstring")) { - $name = $x->{PROPERTIES}->{helpstring}; - } - - if (defined($conformance->{protocols}->{$x->{NAME}})) { - $short_name = $conformance->{protocols}->{$x->{NAME}}->{SHORTNAME}; - $name = $conformance->{protocols}->{$x->{NAME}}->{LONGNAME}; - $filter_name = $conformance->{protocols}->{$x->{NAME}}->{FILTERNAME}; - } - - pidl_code "proto_dcerpc_$x->{NAME} = proto_register_protocol(".make_str($name).", ".make_str($short_name).", ".make_str($filter_name).");"; - - pidl_code "proto_register_field_array(proto_dcerpc_$x->{NAME}, hf, array_length (hf));"; - pidl_code "proto_register_subtree_array(ett, array_length(ett));"; - } else { - pidl_code "proto_dcerpc = proto_get_id_by_filter_name(\"dcerpc\");"; - pidl_code "proto_register_field_array(proto_dcerpc, hf, array_length(hf));"; - pidl_code "proto_register_subtree_array(ett, array_length(ett));"; - } - - deindent; - pidl_code "}\n"; - pidl_fn_end "proto_register_dcerpc_$x->{NAME}"; -} - -sub RegisterInterfaceHandoff($) -{ - my $x = shift; - - if (defined($x->{UUID})) { - pidl_fn_start "proto_reg_handoff_dcerpc_$x->{NAME}"; - pidl_code "void proto_reg_handoff_dcerpc_$x->{NAME}(void)"; - pidl_code "{"; - indent; - pidl_code "dcerpc_init_uuid(proto_dcerpc_$x->{NAME}, ett_dcerpc_$x->{NAME},"; - pidl_code "\t&uuid_dcerpc_$x->{NAME}, ver_dcerpc_$x->{NAME},"; - pidl_code "\t$x->{NAME}_dissectors, hf_$x->{NAME}_opnum);"; - deindent; - pidl_code "}"; - pidl_fn_end "proto_reg_handoff_dcerpc_$x->{NAME}"; - - $hf_used{"hf_$x->{NAME}_opnum"} = 1; - } -} - -sub ProcessInterface($) -{ - my ($x) = @_; - - push(@{$conformance->{strip_prefixes}}, $x->{NAME}); - - my $define = "__PACKET_DCERPC_" . uc($_->{NAME}) . "_H"; - pidl_hdr "#ifndef $define"; - pidl_hdr "#define $define"; - pidl_hdr ""; - - if (defined $x->{PROPERTIES}->{depends}) { - foreach (split / /, $x->{PROPERTIES}->{depends}) { - next if($_ eq "security"); - pidl_hdr "#include \"packet-dcerpc-$_\.h\"\n"; - } - } - - pidl_def "static gint proto_dcerpc_$x->{NAME} = -1;"; - register_ett("ett_dcerpc_$x->{NAME}"); - register_hf_field("hf_$x->{NAME}_opnum", "Operation", "$x->{NAME}.opnum", "FT_UINT16", "BASE_DEC", "NULL", 0, ""); - - if (defined($x->{UUID})) { - my $if_uuid = $x->{UUID}; - - pidl_def "/* Version information */\n\n"; - - pidl_def "static e_uuid_t uuid_dcerpc_$x->{NAME} = {"; - pidl_def "\t0x" . substr($if_uuid, 1, 8) - . ", 0x" . substr($if_uuid, 10, 4) - . ", 0x" . substr($if_uuid, 15, 4) . ","; - pidl_def "\t{ 0x" . substr($if_uuid, 20, 2) - . ", 0x" . substr($if_uuid, 22, 2) - . ", 0x" . substr($if_uuid, 25, 2) - . ", 0x" . substr($if_uuid, 27, 2) - . ", 0x" . substr($if_uuid, 29, 2) - . ", 0x" . substr($if_uuid, 31, 2) - . ", 0x" . substr($if_uuid, 33, 2) - . ", 0x" . substr($if_uuid, 35, 2) . " }"; - pidl_def "};"; - - my $maj = $x->{VERSION}; - $maj =~ s/\.(.*)$//g; - pidl_def "static guint16 ver_dcerpc_$x->{NAME} = $maj;"; - pidl_def ""; - } - - Interface($x); - - pidl_code "\n".DumpFunctionTable($x); - - # Only register these two return types if they were actually used - if (defined($hf_used{"hf_$x->{NAME}_status"})) { - register_hf_field("hf_$x->{NAME}_status", "Status", "$x->{NAME}.status", "FT_UINT32", "BASE_HEX", "VALS(NT_errors)", 0, ""); - } - - if (defined($hf_used{"hf_$x->{NAME}_werror"})) { - register_hf_field("hf_$x->{NAME}_werror", "Windows Error", "$x->{NAME}.werror", "FT_UINT32", "BASE_HEX", "VALS(DOS_errors)", 0, ""); - } - - RegisterInterface($x); - RegisterInterfaceHandoff($x); - - pidl_hdr "#endif /* $define */"; -} - -sub find_type($) -{ - my $n = shift; - - return $conformance->{types}->{$n}; -} - -sub register_type($$$$$$$) -{ - my ($type,$call,$ft,$base,$mask,$vals,$length) = @_; - - $conformance->{types}->{$type} = { - NAME => $type, - DISSECTOR_NAME => $call, - FT_TYPE => $ft, - BASE_TYPE => $base, - MASK => $mask, - VALSSTRING => $vals, - ALIGNMENT => $length - }; -} - -# Loads the default types -sub Initialize($) -{ - my $cnf_file = shift; - - $conformance = { - imports => {}, - header_fields=> {} - }; - - ReadConformance($cnf_file, $conformance) or print "Warning: No conformance file `$cnf_file'\n"; - - foreach my $bytes (qw(1 2 4 8)) { - my $bits = $bytes * 8; - register_type("uint$bits", "offset = dissect_ndr_uint$bits(tvb, offset, pinfo, tree, drep, \@HF\@,NULL);", "FT_UINT$bits", "BASE_DEC", 0, "NULL", $bytes); - register_type("int$bits", "offset = dissect_ndr_uint$bits(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);", "FT_INT$bits", "BASE_DEC", 0, "NULL", $bytes); - } - - register_type("udlong", "offset = dissect_ndr_duint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);", "FT_UINT64", "BASE_DEC", 0, "NULL", 4); - register_type("bool8", "offset = dissect_ndr_uint8(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT8", "BASE_DEC", 0, "NULL", 1); - register_type("char", "offset = dissect_ndr_uint8(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT8", "BASE_DEC", 0, "NULL", 1); - register_type("long", "offset = dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT32", "BASE_DEC", 0, "NULL", 4); - register_type("dlong", "offset = dissect_ndr_duint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT64", "BASE_DEC", 0, "NULL", 8); - register_type("GUID", "offset = dissect_ndr_uuid_t(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_GUID", "BASE_NONE", 0, "NULL", 4); - register_type("policy_handle", "offset = dissect_nt_policy_hnd(tvb, offset, pinfo, tree, drep, \@HF\@, NULL, NULL, \@PARAM\@&0x01, \@PARAM\@&0x02);","FT_BYTES", "BASE_NONE", 0, "NULL", 4); - register_type("NTTIME", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);","FT_ABSOLUTE_TIME", "BASE_NONE", 0, "NULL", 4); - register_type("NTTIME_hyper", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);","FT_ABSOLUTE_TIME", "BASE_NONE", 0, "NULL", 4); - register_type("time_t", "offset = dissect_ndr_time_t(tvb, offset, pinfo,tree, drep, \@HF\@, NULL);","FT_ABSOLUTE_TIME", "BASE_DEC", 0, "NULL", 4); - register_type("NTTIME_1sec", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);", "FT_ABSOLUTE_TIME", "BASE_NONE", 0, "NULL", 4); - register_type("SID", " - dcerpc_info *di = (dcerpc_info *)pinfo->private_data; - - di->hf_index = \@HF\@; - - offset = dissect_ndr_nt_SID_with_options(tvb, offset, pinfo, tree, drep, param); - ","FT_STRING", "BASE_DEC", 0, "NULL", 4); - register_type("WERROR", - "offset = dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_UINT32", "BASE_DEC", 0, "VALS(NT_errors)", 4); - -} - -##################################################################### -# Generate ethereal parser and header code -sub Parse($$$$) -{ - my($ndr,$idl_file,$h_filename,$cnf_file) = @_; - Initialize($cnf_file); - - return (undef, undef) if defined($conformance->{noemit_dissector}); - - $tabs = ""; - - %res = (code=>"",def=>"",hdr=>""); - @ett = (); - - my $notice = -"/* DO NOT EDIT - This filter was automatically generated - from $idl_file and $cnf_file. - - Pidl is a perl based IDL compiler for DCE/RPC idl files. - It is maintained by the Samba team, not the Ethereal team. - Instructions on how to download and install Pidl can be - found at http://wiki.ethereal.com/Pidl -*/ - -"; - - pidl_hdr $notice; - - $res{headers} = "\n"; - $res{headers} .= "#ifdef HAVE_CONFIG_H\n"; - $res{headers} .= "#include \"config.h\"\n"; - $res{headers} .= "#endif\n\n"; - $res{headers} .= "#include \n"; - $res{headers} .= "#include \n"; - $res{headers} .= "#include \n\n"; - - $res{headers} .= "#include \"packet-dcerpc.h\"\n"; - $res{headers} .= "#include \"packet-dcerpc-nt.h\"\n"; - $res{headers} .= "#include \"packet-windows-common.h\"\n"; - - my $h_basename = basename($h_filename); - - $res{headers} .= "#include \"$h_basename\"\n"; - pidl_code ""; - - # Ethereal protocol registration - - ProcessInterface($_) foreach (@$ndr); - - $res{ett} = DumpEttDeclaration(); - $res{hf} = DumpHfDeclaration(); - - my $parser = $notice; - $parser.= $res{headers}; - $parser.=$res{ett}; - $parser.=$res{hf}; - $parser.=$res{def}; - $parser.=$conformance->{override}; - $parser.=$res{code}; - - my $header = "/* autogenerated by pidl */\n\n"; - $header.=$res{hdr}; - - CheckUsed($conformance); - - return ($parser,$header); -} - -############################################################################### -# ETT -############################################################################### - -sub register_ett($) -{ - my $name = shift; - - push (@ett, $name); -} - -sub DumpEttList() -{ - my $res = "\tstatic gint *ett[] = {\n"; - foreach (@ett) { - $res .= "\t\t&$_,\n"; - } - - return "$res\t};\n"; -} - -sub DumpEttDeclaration() -{ - my $res = "\n/* Ett declarations */\n"; - foreach (@ett) { - $res .= "static gint $_ = -1;\n"; - } - - return "$res\n"; -} - -############################################################################### -# HF -############################################################################### - -sub register_hf_field($$$$$$$$) -{ - my ($index,$name,$filter_name,$ft_type,$base_type,$valsstring,$mask,$blurb) = @_; - - if (defined ($conformance->{hf_renames}->{$index})) { - $conformance->{hf_renames}->{$index}->{USED} = 1; - return $conformance->{hf_renames}->{$index}->{NEWNAME}; - } - - $conformance->{header_fields}->{$index} = { - INDEX => $index, - NAME => $name, - FILTER => $filter_name, - FT_TYPE => $ft_type, - BASE_TYPE => $base_type, - VALSSTRING => $valsstring, - MASK => $mask, - BLURB => $blurb - }; - - if ((not defined($blurb) or $blurb eq "") and - defined($conformance->{fielddescription}->{$index})) { - $conformance->{header_fields}->{$index}->{BLURB} = - $conformance->{fielddescription}->{$index}->{DESCRIPTION}; - $conformance->{fielddescription}->{$index}->{USED} = 1; - } - - return $index; -} - -sub DumpHfDeclaration() -{ - my $res = ""; - - $res = "\n/* Header field declarations */\n"; - - foreach (keys %{$conformance->{header_fields}}) - { - $res .= "static gint $_ = -1;\n"; - } - - return "$res\n"; -} - -sub DumpHfList() -{ - my $res = "\tstatic hf_register_info hf[] = {\n"; - - foreach (values %{$conformance->{header_fields}}) - { - $res .= "\t{ &$_->{INDEX}, - { ".make_str($_->{NAME}).", ".make_str($_->{FILTER}).", $_->{FT_TYPE}, $_->{BASE_TYPE}, $_->{VALSSTRING}, $_->{MASK}, ".make_str($_->{BLURB}).", HFILL }}, -"; - } - - return $res."\t};\n"; -} - - -############################################################################### -# Function table -############################################################################### - -sub DumpFunctionTable($) -{ - my $if = shift; - - my $res = "static dcerpc_sub_dissector $if->{NAME}\_dissectors[] = {\n"; - foreach (@{$if->{FUNCTIONS}}) { - my $fn_name = $_->{NAME}; - $fn_name =~ s/^$if->{NAME}_//; - $res.= "\t{ $_->{OPNUM}, \"$fn_name\",\n"; - $res.= "\t $if->{NAME}_dissect_${fn_name}_request, $if->{NAME}_dissect_${fn_name}_response},\n"; - } - - $res .= "\t{ 0, NULL, NULL, NULL }\n"; - - return "$res};\n"; -} - -sub CheckUsed($) -{ - my $conformance = shift; - foreach (values %{$conformance->{header_fields}}) { - if (not defined($hf_used{$_->{INDEX}})) { - print "$_->{POS}: warning: hf field `$_->{INDEX}' not used\n"; - } - } - - foreach (values %{$conformance->{hf_renames}}) { - if (not $_->{USED}) { - print "$_->{POS}: warning: hf field `$_->{OLDNAME}' not used\n"; - } - } - - foreach (values %{$conformance->{dissectorparams}}) { - if (not $_->{USED}) { - print "$_->{POS}: warning: dissector param never used\n"; - } - } - - foreach (values %{$conformance->{imports}}) { - if (not $_->{USED}) { - print "$_->{POS}: warning: import never used\n"; - } - } - - foreach (values %{$conformance->{types}}) { - if (not $_->{USED} and defined($_->{POS})) { - print "$_->{POS}: warning: type never used\n"; - } - } - - foreach (values %{$conformance->{fielddescription}}) { - if (not $_->{USED}) { - print "$_->{POS}: warning: description never used\n"; - } - } - - foreach (values %{$conformance->{tfs}}) { - if (not $_->{USED}) { - print "$_->{POS}: warning: True/False description never used\n"; - } - } -} - -1; diff --git a/source4/pidl/lib/Parse/Pidl/Wireshark/Conformance.pm b/source4/pidl/lib/Parse/Pidl/Wireshark/Conformance.pm new file mode 100644 index 0000000000..93927f8f54 --- /dev/null +++ b/source4/pidl/lib/Parse/Pidl/Wireshark/Conformance.pm @@ -0,0 +1,360 @@ +################################################### +# parse an Wireshark conformance file +# Copyright jelmer@samba.org 2005 +# released under the GNU GPL + +=pod + +=head1 NAME + +Parse::Pidl::Wireshark::Conformance - Conformance file parser for Wireshark + +=head1 DESCRIPTION + +This module supports parsing Wireshark conformance files (*.cnf). + +=head1 FILE FORMAT + +Pidl needs additional data for Wireshark output. This data is read from +so-called conformance files. This section describes the format of these +files. + +Conformance files are simple text files with a single command on each line. +Empty lines and lines starting with a '#' character are ignored. +Arguments to commands are seperated by spaces. + +The following commands are currently supported: + +=over 4 + +=item I name dissector ft_type base_type mask valsstring alignment + +Register new data type with specified name, what dissector function to call +and what properties to give header fields for elements of this type. + +=item I type + +Suppress emitting a dissect_type function for the specified type + +=item I type param + +Set parameter to specify to dissector function for given type. + +=item I hf title filter ft_type base_type valsstring mask description + +Generate a custom header field with specified properties. + +=item I old_hf_name new_hf_name + +Force the use of new_hf_name when the parser generator was going to +use old_hf_name. + +This can be used in conjunction with HF_FIELD in order to make more than +one element use the same filter name. + +=item I prefix + +Remove the specified prefix from all function names (if present). + +=item I longname shortname filtername + +Change the short-, long- and filter-name for the current interface in +Wireshark. + +=item I field desc + +Change description for the specified header field. `field' is the hf name of the field. + +=item I dissector code... + +Code to insert when generating the specified dissector. @HF@ and +@PARAM@ will be substituted. + +=item I hf_name "true string" "false string" + +Override the text shown when a bitmap boolean value is enabled or disabled. + +=item I fn_name + +Force pidl to not generate a particular function but allow the user +to write a function manually. This can be used to remove the function +for only one level for a particular element rather than all the functions and +ett/hf variables for a particular element as the NOEMIT command does. + +=back + +=head1 EXAMPLE + + INFO_KEY OpenKey.Ke + +=cut + +package Parse::Pidl::Wireshark::Conformance; + +require Exporter; +use vars qw($VERSION); +$VERSION = '0.01'; + +@ISA = qw(Exporter); +@EXPORT_OK = qw(ReadConformance); + +use strict; + +use Parse::Pidl::Util qw(has_property); + +sub handle_type($$$$$$$$$$) +{ + my ($pos,$data,$name,$dissectorname,$ft_type,$base_type,$mask,$valsstring,$alignment) = @_; + + unless(defined($alignment)) { + print "$pos: error incomplete TYPE command\n"; + return; + } + + unless ($dissectorname =~ /.*dissect_.*/) { + print "$pos: warning: dissector name does not contain `dissect'\n"; + } + + unless(valid_ft_type($ft_type)) { + print "$pos: warning: invalid FT_TYPE `$ft_type'\n"; + } + + unless (valid_base_type($base_type)) { + print "$pos: warning: invalid BASE_TYPE `$base_type'\n"; + } + + $data->{types}->{$name} = { + NAME => $name, + POS => $pos, + USED => 0, + DISSECTOR_NAME => $dissectorname, + FT_TYPE => $ft_type, + BASE_TYPE => $base_type, + MASK => $mask, + VALSSTRING => $valsstring, + ALIGNMENT => $alignment + }; +} + +sub handle_tfs($$$$$) +{ + my ($pos,$data,$hf,$trues,$falses) = @_; + + unless(defined($falses)) { + print "$pos: error: incomplete TFS command\n"; + return; + } + + $data->{tfs}->{$hf} = { + TRUE_STRING => $trues, + FALSE_STRING => $falses + }; +} + +sub handle_hf_rename($$$$) +{ + my ($pos,$data,$old,$new) = @_; + + unless(defined($new)) { + print "$pos: error: incomplete HF_RENAME command\n"; + return; + } + + $data->{hf_renames}->{$old} = { + OLDNAME => $old, + NEWNAME => $new, + POS => $pos, + USED => 0 + }; +} + +sub handle_param_value($$$$) +{ + my ($pos,$data,$dissector_name,$value) = @_; + + unless(defined($value)) { + print "$pos: error: incomplete PARAM_VALUE command\n"; + return; + } + + $data->{dissectorparams}->{$dissector_name} = { + DISSECTOR => $dissector_name, + PARAM => $value, + POS => $pos, + USED => 0 + }; +} + +sub valid_base_type($) +{ + my $t = shift; + return 0 unless($t =~ /^BASE_.*/); + return 1; +} + +sub valid_ft_type($) +{ + my $t = shift; + return 0 unless($t =~ /^FT_.*/); + return 1; +} + +sub handle_hf_field($$$$$$$$$$) +{ + my ($pos,$data,$index,$name,$filter,$ft_type,$base_type,$valsstring,$mask,$blurb) = @_; + + unless(defined($blurb)) { + print "$pos: error: incomplete HF_FIELD command\n"; + return; + } + + unless(valid_ft_type($ft_type)) { + print "$pos: warning: invalid FT_TYPE `$ft_type'\n"; + } + + unless(valid_base_type($base_type)) { + print "$pos: warning: invalid BASE_TYPE `$base_type'\n"; + } + + $data->{header_fields}->{$index} = { + INDEX => $index, + POS => $pos, + USED => 0, + NAME => $name, + FILTER => $filter, + FT_TYPE => $ft_type, + BASE_TYPE => $base_type, + VALSSTRING => $valsstring, + MASK => $mask, + BLURB => $blurb + }; +} + +sub handle_strip_prefix($$$) +{ + my ($pos,$data,$x) = @_; + + push (@{$data->{strip_prefixes}}, $x); +} + +sub handle_noemit($$$) +{ + my ($pos,$data,$type) = @_; + + if (defined($type)) { + $data->{noemit}->{$type} = 1; + } else { + $data->{noemit_dissector} = 1; + } +} + +sub handle_manual($$$) +{ + my ($pos,$data,$fn) = @_; + + $data->{manual}->{$fn} = 1; +} + +sub handle_protocol($$$$$$) +{ + my ($pos, $data, $name, $longname, $shortname, $filtername) = @_; + + $data->{protocols}->{$name} = { + LONGNAME => $longname, + SHORTNAME => $shortname, + FILTERNAME => $filtername + }; +} + +sub handle_fielddescription($$$$) +{ + my ($pos,$data,$field,$desc) = @_; + + $data->{fielddescription}->{$field} = { + DESCRIPTION => $desc, + POS => $pos, + USED => 0 + }; +} + +sub handle_import +{ + my $pos = shift @_; + my $data = shift @_; + my $dissectorname = shift @_; + + unless(defined($dissectorname)) { + print "$pos: error: no dissectorname specified\n"; + return; + } + + $data->{imports}->{$dissectorname} = { + NAME => $dissectorname, + DATA => join(' ', @_), + USED => 0, + POS => $pos + }; +} + +my %field_handlers = ( + TYPE => \&handle_type, + NOEMIT => \&handle_noemit, + MANUAL => \&handle_manual, + PARAM_VALUE => \&handle_param_value, + HF_FIELD => \&handle_hf_field, + HF_RENAME => \&handle_hf_rename, + TFS => \&handle_tfs, + STRIP_PREFIX => \&handle_strip_prefix, + PROTOCOL => \&handle_protocol, + FIELD_DESCRIPTION => \&handle_fielddescription, + IMPORT => \&handle_import +); + +sub ReadConformance($$) +{ + my ($f,$data) = @_; + + $data->{override} = ""; + + my $incodeblock = 0; + + open(IN,"<$f") or return undef; + + my $ln = 0; + + foreach () { + $ln++; + next if (/^#.*$/); + next if (/^$/); + + s/[\r\n]//g; + + if ($_ eq "CODE START") { + $incodeblock = 1; + next; + } elsif ($incodeblock and $_ eq "CODE END") { + $incodeblock = 0; + next; + } elsif ($incodeblock) { + $data->{override}.="$_\n"; + next; + } + + my @fields = /([^ "]+|"[^"]+")/g; + + my $cmd = $fields[0]; + + shift @fields; + + if (not defined($field_handlers{$cmd})) { + print "$f:$ln: Warning: Unknown command `$cmd'\n"; + next; + } + + $field_handlers{$cmd}("$f:$ln", $data, @fields); + } + + close(IN); +} + +1; diff --git a/source4/pidl/lib/Parse/Pidl/Wireshark/NDR.pm b/source4/pidl/lib/Parse/Pidl/Wireshark/NDR.pm new file mode 100644 index 0000000000..872a149274 --- /dev/null +++ b/source4/pidl/lib/Parse/Pidl/Wireshark/NDR.pm @@ -0,0 +1,1054 @@ +################################################## +# Samba4 NDR parser generator for IDL structures +# Copyright tridge@samba.org 2000-2003 +# Copyright tpot@samba.org 2001,2005 +# Copyright jelmer@samba.org 2004-2005 +# Portions based on idl2eth.c by Ronnie Sahlberg +# released under the GNU GPL + +=pod + +=head1 NAME + +Parse::Pidl::Wireshark::NDR - Parser generator for Wireshark + +=cut + +package Parse::Pidl::Wireshark::NDR; + +use strict; +use Parse::Pidl::Typelist qw(getType); +use Parse::Pidl::Util qw(has_property ParseExpr property_matches make_str); +use Parse::Pidl::NDR qw(ContainsString GetNextLevel); +use Parse::Pidl::Dump qw(DumpTypedef DumpFunction); +use Parse::Pidl::Wireshark::Conformance qw(ReadConformance); +use File::Basename; + +use vars qw($VERSION); +$VERSION = '0.01'; + +sub error($$) +{ + my ($e,$t) = @_; + print "$e->{FILE}:$e->{LINE}: $t\n"; +} + +my @ett; + +my %hf_used = (); +my %dissector_used = (); + +my $conformance = undef; + +my %ptrtype_mappings = ( + "unique" => "NDR_POINTER_UNIQUE", + "ref" => "NDR_POINTER_REF", + "ptr" => "NDR_POINTER_PTR" +); + +sub StripPrefixes($) +{ + my ($s) = @_; + + foreach (@{$conformance->{strip_prefixes}}) { + $s =~ s/^$_\_//g; + } + + return $s; +} + +# Convert a IDL structure field name (e.g access_mask) to a prettier +# string like 'Access Mask'. + +sub field2name($) +{ + my($field) = shift; + + $field =~ s/_/ /g; # Replace underscores with spaces + $field =~ s/(\w+)/\u\L$1/g; # Capitalise each word + + return $field; +} + +my %res = (); +my $tabs = ""; +my $cur_fn = undef; +sub pidl_fn_start($) +{ + my $fn = shift; + $cur_fn = $fn; +} +sub pidl_fn_end($) +{ + my $fn = shift; + die("Inconsistent state: $fn != $cur_fn") if ($fn ne $cur_fn); + $cur_fn = undef; +} + +sub pidl_code($) +{ + my $d = shift; + return if (defined($cur_fn) and defined($conformance->{manual}->{$cur_fn})); + + if ($d) { + $res{code} .= $tabs; + $res{code} .= $d; + } + $res{code} .="\n"; +} + +sub pidl_hdr($) { my $x = shift; $res{hdr} .= "$x\n"; } +sub pidl_def($) { my $x = shift; $res{def} .= "$x\n"; } + +sub indent() +{ + $tabs .= "\t"; +} + +sub deindent() +{ + $tabs = substr($tabs, 0, -1); +} + +sub PrintIdl($) +{ + my $idl = shift; + + foreach (split /\n/, $idl) { + pidl_code "/* IDL: $_ */"; + } + + pidl_code ""; +} + +##################################################################### +# parse the interface definitions +sub Interface($) +{ + my($interface) = @_; + Const($_,$interface->{NAME}) foreach (@{$interface->{CONSTS}}); + Typedef($_,$interface->{NAME}) foreach (@{$interface->{TYPES}}); + Function($_,$interface->{NAME}) foreach (@{$interface->{FUNCTIONS}}); +} + +sub Enum($$$) +{ + my ($e,$name,$ifname) = @_; + my $valsstring = "$ifname\_$name\_vals"; + my $dissectorname = "$ifname\_dissect\_enum\_".StripPrefixes($name); + + return if (defined($conformance->{noemit}->{StripPrefixes($name)})); + + foreach (@{$e->{ELEMENTS}}) { + if (/([^=]*)=(.*)/) { + pidl_hdr "#define $1 ($2)"; + } + } + + pidl_hdr "extern const value_string $valsstring\[];"; + pidl_hdr "int $dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep, int hf_index, guint32 param);"; + + pidl_def "const value_string ".$valsstring."[] = {"; + foreach (@{$e->{ELEMENTS}}) { + next unless (/([^=]*)=(.*)/); + pidl_def "\t{ $1, \"$1\" },"; + } + + pidl_def "{ 0, NULL }"; + pidl_def "};"; + + pidl_fn_start $dissectorname; + pidl_code "int"; + pidl_code "$dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep, int hf_index, guint32 param _U_)"; + pidl_code "{"; + indent; + pidl_code "offset = dissect_ndr_$e->{BASE_TYPE}(tvb, offset, pinfo, tree, drep, hf_index, NULL);"; + pidl_code "return offset;"; + deindent; + pidl_code "}\n"; + pidl_fn_end $dissectorname; + + my $enum_size = $e->{BASE_TYPE}; + $enum_size =~ s/uint//g; + register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$enum_size", "BASE_DEC", "0", "VALS($valsstring)", $enum_size / 8); +} + +sub Bitmap($$$) +{ + my ($e,$name,$ifname) = @_; + my $dissectorname = "$ifname\_dissect\_bitmap\_".StripPrefixes($name); + + register_ett("ett_$ifname\_$name"); + + pidl_hdr "int $dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep, int hf_index, guint32 param);"; + + pidl_fn_start $dissectorname; + pidl_code "int"; + pidl_code "$dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *parent_tree, guint8 *drep, int hf_index, guint32 param _U_)"; + pidl_code "{"; + indent; + pidl_code "proto_item *item = NULL;"; + pidl_code "proto_tree *tree = NULL;"; + pidl_code ""; + + pidl_code "g$e->{BASE_TYPE} flags;"; + if ($e->{ALIGN} > 1) { + pidl_code "ALIGN_TO_$e->{ALIGN}_BYTES;"; + } + + pidl_code ""; + + pidl_code "if (parent_tree) {"; + indent; + pidl_code "item = proto_tree_add_item(parent_tree, hf_index, tvb, offset, $e->{ALIGN}, TRUE);"; + pidl_code "tree = proto_item_add_subtree(item,ett_$ifname\_$name);"; + deindent; + pidl_code "}\n"; + + pidl_code "offset = dissect_ndr_$e->{BASE_TYPE}(tvb, offset, pinfo, NULL, drep, -1, &flags);"; + + pidl_code "proto_item_append_text(item, \": \");\n"; + pidl_code "if (!flags)"; + pidl_code "\tproto_item_append_text(item, \"(No values set)\");\n"; + + foreach (@{$e->{ELEMENTS}}) { + next unless (/([^ ]*) (.*)/); + my ($en,$ev) = ($1,$2); + my $hf_bitname = "hf_$ifname\_$name\_$en"; + my $filtername = "$ifname\.$name\.$en"; + + $hf_used{$hf_bitname} = 1; + + register_hf_field($hf_bitname, field2name($en), $filtername, "FT_BOOLEAN", $e->{ALIGN} * 8, "TFS(&$name\_$en\_tfs)", $ev, ""); + + pidl_def "static const true_false_string $name\_$en\_tfs = {"; + if (defined($conformance->{tfs}->{$hf_bitname})) { + pidl_def " $conformance->{tfs}->{$hf_bitname}->{TRUE_STRING},"; + pidl_def " $conformance->{tfs}->{$hf_bitname}->{FALSE_STRING},"; + $conformance->{tfs}->{$hf_bitname}->{USED} = 1; + } else { + pidl_def " \"$en is SET\","; + pidl_def " \"$en is NOT SET\","; + } + pidl_def "};"; + + pidl_code "proto_tree_add_boolean(tree, $hf_bitname, tvb, offset-$e->{ALIGN}, $e->{ALIGN}, flags);"; + pidl_code "if (flags&$ev){"; + pidl_code "\tproto_item_append_text(item, \"$en\");"; + pidl_code "\tif (flags & (~$ev))"; + pidl_code "\t\tproto_item_append_text(item, \", \");"; + pidl_code "}"; + pidl_code "flags&=(~$ev);"; + pidl_code ""; + } + + pidl_code "if (flags) {"; + pidl_code "\tproto_item_append_text(item, \"Unknown bitmap value 0x%x\", flags);"; + pidl_code "}\n"; + pidl_code "return offset;"; + deindent; + pidl_code "}\n"; + pidl_fn_end $dissectorname; + + my $size = $e->{BASE_TYPE}; + $size =~ s/uint//g; + register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$size", "BASE_HEX", "0", "NULL", $size/8); +} + +sub ElementLevel($$$$$) +{ + my ($e,$l,$hf,$myname,$pn) = @_; + + my $param = 0; + + if (defined($conformance->{dissectorparams}->{$myname})) { + $conformance->{dissectorparams}->{$myname}->{PARAM} = 1; + $param = $conformance->{dissectorparams}->{$myname}->{PARAM}; + } + + if ($l->{TYPE} eq "POINTER") { + my $type; + if ($l->{LEVEL} eq "TOP") { + $type = "toplevel"; + } elsif ($l->{LEVEL} eq "EMBEDDED") { + $type = "embedded"; + } + pidl_code "offset = dissect_ndr_$type\_pointer(tvb, offset, pinfo, tree, drep, $myname\_, $ptrtype_mappings{$l->{POINTER_TYPE}}, \"Pointer to ".field2name(StripPrefixes($e->{NAME})) . " ($e->{TYPE})\",$hf);"; + } elsif ($l->{TYPE} eq "ARRAY") { + if ($l->{IS_INLINE}) { + error($e->{ORIGINAL}, "Inline arrays not supported"); + } elsif ($l->{IS_FIXED}) { + pidl_code "int i;"; + pidl_code "for (i = 0; i < $l->{SIZE_IS}; i++)"; + pidl_code "\toffset = $myname\_(tvb, offset, pinfo, tree, drep);"; + } else { + my $type = ""; + $type .= "c" if ($l->{IS_CONFORMANT}); + $type .= "v" if ($l->{IS_VARYING}); + + unless ($l->{IS_ZERO_TERMINATED}) { + pidl_code "offset = dissect_ndr_u" . $type . "array(tvb, offset, pinfo, tree, drep, $myname\_);"; + } else { + my $nl = GetNextLevel($e,$l); + pidl_code "char *data;"; + pidl_code ""; + pidl_code "offset = dissect_ndr_$type" . "string(tvb, offset, pinfo, tree, drep, sizeof(g$nl->{DATA_TYPE}), $hf, FALSE, &data);"; + pidl_code "proto_item_append_text(tree, \": %s\", data);"; + } + } + } elsif ($l->{TYPE} eq "DATA") { + if ($l->{DATA_TYPE} eq "string") { + my $bs = 2; # Byte size defaults to that of UCS2 + + + ($bs = 1) if (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_ASCII.*")); + + if (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_SIZE4.*") and property_matches($e, "flag", ".*LIBNDR_FLAG_STR_LEN4.*")) { + pidl_code "char *data;\n"; + pidl_code "offset = dissect_ndr_cvstring(tvb, offset, pinfo, tree, drep, $bs, $hf, FALSE, &data);"; + pidl_code "proto_item_append_text(tree, \": %s\", data);"; + } elsif (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_SIZE4.*")) { + pidl_code "offset = dissect_ndr_vstring(tvb, offset, pinfo, tree, drep, $bs, $hf, FALSE, NULL);"; + } else { + warn("Unable to handle string with flags $e->{PROPERTIES}->{flag}"); + } + } else { + my $call; + + if ($conformance->{imports}->{$l->{DATA_TYPE}}) { + $call = $conformance->{imports}->{$l->{DATA_TYPE}}->{DATA}; + $conformance->{imports}->{$l->{DATA_TYPE}}->{USED} = 1; + } elsif (defined($conformance->{imports}->{"$pn.$e->{NAME}"})) { + $call = $conformance->{imports}->{"$pn.$e->{NAME}"}->{DATA}; + $conformance->{imports}->{"$pn.$e->{NAME}"}->{USED} = 1; + + } elsif (defined($conformance->{types}->{$l->{DATA_TYPE}})) { + $call= $conformance->{types}->{$l->{DATA_TYPE}}->{DISSECTOR_NAME}; + $conformance->{types}->{$l->{DATA_TYPE}}->{USED} = 1; + } else { + if ($l->{DATA_TYPE} =~ /^([a-z]+)\_(.*)$/) + { + pidl_code "offset = $1_dissect_struct_$2(tvb,offset,pinfo,tree,drep,$hf,$param);"; + } + + return; + } + + $call =~ s/\@HF\@/$hf/g; + $call =~ s/\@PARAM\@/$param/g; + pidl_code "$call"; + } + } elsif ($_->{TYPE} eq "SUBCONTEXT") { + my $num_bits = ($l->{HEADER_SIZE}*8); + pidl_code "guint$num_bits size;"; + pidl_code "int start_offset = offset;"; + pidl_code "tvbuff_t *subtvb;"; + pidl_code "offset = dissect_ndr_uint$num_bits(tvb, offset, pinfo, tree, drep, $hf, &size);"; + pidl_code "proto_tree_add_text(tree, tvb, start_offset, offset - start_offset + size, \"Subcontext size\");"; + + pidl_code "subtvb = tvb_new_subset(tvb, offset, size, -1);"; + pidl_code "$myname\_(subtvb, 0, pinfo, tree, drep);"; + } else { + die("Unknown type `$_->{TYPE}'"); + } +} + +sub Element($$$) +{ + my ($e,$pn,$ifname) = @_; + + my $dissectorname = "$ifname\_dissect\_element\_".StripPrefixes($pn)."\_".StripPrefixes($e->{NAME}); + + my $call_code = "offset = $dissectorname(tvb, offset, pinfo, tree, drep);"; + + my $type = find_type($e->{TYPE}); + + if (not defined($type)) { + # default settings + $type = { + MASK => 0, + VALSSTRING => "NULL", + FT_TYPE => "FT_NONE", + BASE_TYPE => "BASE_HEX" + }; + } + + if (ContainsString($e)) { + $type = { + MASK => 0, + VALSSTRING => "NULL", + FT_TYPE => "FT_STRING", + BASE_TYPE => "BASE_DEC" + }; + } + + my $hf = register_hf_field("hf_$ifname\_$pn\_$e->{NAME}", field2name($e->{NAME}), "$ifname.$pn.$e->{NAME}", $type->{FT_TYPE}, $type->{BASE_TYPE}, $type->{VALSSTRING}, $type->{MASK}, ""); + $hf_used{$hf} = 1; + + my $eltname = StripPrefixes($pn) . ".$e->{NAME}"; + if (defined($conformance->{noemit}->{$eltname})) { + return $call_code; + } + + my $add = ""; + + foreach (@{$e->{LEVELS}}) { + next if ($_->{TYPE} eq "SWITCH"); + pidl_def "static int $dissectorname$add(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep);"; + pidl_fn_start "$dissectorname$add"; + pidl_code "static int"; + pidl_code "$dissectorname$add(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree, guint8 *drep)"; + pidl_code "{"; + indent; + + ElementLevel($e,$_,$hf,$dissectorname.$add,$pn); + + pidl_code ""; + pidl_code "return offset;"; + deindent; + pidl_code "}\n"; + pidl_fn_end "$dissectorname$add"; + $add.="_"; + last if ($_->{TYPE} eq "ARRAY" and $_->{IS_ZERO_TERMINATED}); + } + + return $call_code; +} + +sub Function($$$) +{ + my ($fn,$ifname) = @_; + + my %dissectornames; + + foreach (@{$fn->{ELEMENTS}}) { + $dissectornames{$_->{NAME}} = Element($_, $fn->{NAME}, $ifname) if not defined($dissectornames{$_->{NAME}}); + } + + my $fn_name = $_->{NAME}; + $fn_name =~ s/^${ifname}_//; + + PrintIdl DumpFunction($fn->{ORIGINAL}); + pidl_fn_start "$ifname\_dissect\_$fn_name\_response"; + pidl_code "static int"; + pidl_code "$ifname\_dissect\_${fn_name}_response(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)"; + pidl_code "{"; + indent; + pidl_code "guint32 status;\n"; + foreach (@{$fn->{ELEMENTS}}) { + if (grep(/out/,@{$_->{DIRECTION}})) { + pidl_code "$dissectornames{$_->{NAME}}"; + pidl_code "offset = dissect_deferred_pointers(pinfo, tvb, offset, drep);"; + pidl_code ""; + } + } + + if (not defined($fn->{RETURN_TYPE})) { + } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS") { + pidl_code "offset = dissect_ntstatus(tvb, offset, pinfo, tree, drep, hf\_$ifname\_status, &status);\n"; + pidl_code "if (status != 0 && check_col(pinfo->cinfo, COL_INFO))"; + pidl_code "\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Error: %s\", val_to_str(status, NT_errors, \"Unknown NT status 0x%08x\"));\n"; + $hf_used{"hf\_$ifname\_status"} = 1; + } elsif ($fn->{RETURN_TYPE} eq "WERROR") { + pidl_code "offset = dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, hf\_$ifname\_werror, &status);\n"; + pidl_code "if (status != 0 && check_col(pinfo->cinfo, COL_INFO))"; + pidl_code "\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Error: %s\", val_to_str(status, DOS_errors, \"Unknown DOS error 0x%08x\"));\n"; + + $hf_used{"hf\_$ifname\_werror"} = 1; + } else { + print "$fn->{FILE}:$fn->{LINE}: error: return type `$fn->{RETURN_TYPE}' not yet supported\n"; + } + + + pidl_code "return offset;"; + deindent; + pidl_code "}\n"; + pidl_fn_end "$ifname\_dissect\_$fn_name\_response"; + + pidl_fn_start "$ifname\_dissect\_$fn_name\_request"; + pidl_code "static int"; + pidl_code "$ifname\_dissect\_${fn_name}_request(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)"; + pidl_code "{"; + indent; + foreach (@{$fn->{ELEMENTS}}) { + if (grep(/in/,@{$_->{DIRECTION}})) { + pidl_code "$dissectornames{$_->{NAME}}"; + pidl_code "offset = dissect_deferred_pointers(pinfo, tvb, offset, drep);"; + } + + } + + pidl_code "return offset;"; + deindent; + pidl_code "}\n"; + pidl_fn_end "$ifname\_dissect\_$fn_name\_request"; +} + +sub Struct($$$) +{ + my ($e,$name,$ifname) = @_; + my $dissectorname = "$ifname\_dissect\_struct\_".StripPrefixes($name); + + return if (defined($conformance->{noemit}->{StripPrefixes($name)})); + + register_ett("ett_$ifname\_$name"); + + my $res = ""; + ($res.="\t".Element($_, $name, $ifname)."\n\n") foreach (@{$e->{ELEMENTS}}); + + pidl_hdr "int $dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *parent_tree, guint8 *drep, int hf_index, guint32 param _U_);"; + + pidl_fn_start $dissectorname; + pidl_code "int"; + pidl_code "$dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *parent_tree, guint8 *drep, int hf_index, guint32 param _U_)"; + pidl_code "{"; + indent; + pidl_code "proto_item *item = NULL;"; + pidl_code "proto_tree *tree = NULL;"; + pidl_code "int old_offset;"; + pidl_code ""; + + if ($e->{ALIGN} > 1) { + pidl_code "ALIGN_TO_$e->{ALIGN}_BYTES;"; + } + pidl_code ""; + + pidl_code "old_offset = offset;"; + pidl_code ""; + pidl_code "if (parent_tree) {"; + indent; + pidl_code "item = proto_tree_add_item(parent_tree, hf_index, tvb, offset, -1, TRUE);"; + pidl_code "tree = proto_item_add_subtree(item, ett_$ifname\_$name);"; + deindent; + pidl_code "}"; + + pidl_code "\n$res"; + + pidl_code "proto_item_set_len(item, offset-old_offset);\n"; + pidl_code "return offset;"; + deindent; + pidl_code "}\n"; + pidl_fn_end $dissectorname; + + register_type($name, "offset = $dissectorname(tvb,offset,pinfo,tree,drep,\@HF\@,\@PARAM\@);", "FT_NONE", "BASE_NONE", 0, "NULL", 0); +} + +sub Union($$$) +{ + my ($e,$name,$ifname) = @_; + + my $dissectorname = "$ifname\_dissect_".StripPrefixes($name); + + return if (defined($conformance->{noemit}->{StripPrefixes($name)})); + + register_ett("ett_$ifname\_$name"); + + my $res = ""; + foreach (@{$e->{ELEMENTS}}) { + $res.="\n\t\t$_->{CASE}:\n"; + if ($_->{TYPE} ne "EMPTY") { + $res.="\t\t\t".Element($_, $name, $ifname)."\n"; + } + $res.="\t\tbreak;\n"; + } + + my $switch_type; + my $switch_dissect; + my $switch_dt = getType($e->{SWITCH_TYPE}); + if ($switch_dt->{DATA}->{TYPE} eq "ENUM") { + $switch_type = "g".Parse::Pidl::Typelist::enum_type_fn($switch_dt); + $switch_dissect = "dissect_ndr_" .Parse::Pidl::Typelist::enum_type_fn($switch_dt); + } elsif ($switch_dt->{DATA}->{TYPE} eq "SCALAR") { + $switch_type = "g$e->{SWITCH_TYPE}"; + $switch_dissect = "dissect_ndr_$e->{SWITCH_TYPE}"; + } + + pidl_fn_start $dissectorname; + pidl_code "static int"; + pidl_code "$dissectorname(tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *parent_tree, guint8 *drep, int hf_index, guint32 param _U_)"; + pidl_code "{"; + indent; + pidl_code "proto_item *item = NULL;"; + pidl_code "proto_tree *tree = NULL;"; + pidl_code "int old_offset;"; + pidl_code "$switch_type level;"; + pidl_code ""; + + if ($e->{ALIGN} > 1) { + pidl_code "ALIGN_TO_$e->{ALIGN}_BYTES;"; + } + + pidl_code ""; + + pidl_code "old_offset = offset;"; + pidl_code "if (parent_tree) {"; + indent; + pidl_code "item = proto_tree_add_text(parent_tree, tvb, offset, -1, \"$name\");"; + pidl_code "tree = proto_item_add_subtree(item, ett_$ifname\_$name);"; + deindent; + pidl_code "}"; + + pidl_code ""; + + pidl_code "offset = $switch_dissect(tvb, offset, pinfo, tree, drep, hf_index, &level);"; + + pidl_code "switch(level) {$res\t}"; + pidl_code "proto_item_set_len(item, offset-old_offset);\n"; + pidl_code "return offset;"; + deindent; + pidl_code "}"; + pidl_fn_end $dissectorname; + + register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_NONE", "BASE_NONE", 0, "NULL", 0); +} + +sub Const($$) +{ + my ($const,$ifname) = @_; + + if (!defined($const->{ARRAY_LEN}[0])) { + pidl_hdr "#define $const->{NAME}\t( $const->{VALUE} )\n"; + } else { + pidl_hdr "#define $const->{NAME}\t $const->{VALUE}\n"; + } +} + +sub Typedef($$) +{ + my ($e,$ifname) = @_; + + PrintIdl DumpTypedef($e->{ORIGINAL}); + + { + ENUM => \&Enum, + STRUCT => \&Struct, + UNION => \&Union, + BITMAP => \&Bitmap + }->{$e->{DATA}->{TYPE}}->($e->{DATA}, $e->{NAME}, $ifname); +} + +sub RegisterInterface($) +{ + my ($x) = @_; + + pidl_fn_start "proto_register_dcerpc_$x->{NAME}"; + pidl_code "void proto_register_dcerpc_$x->{NAME}(void)"; + pidl_code "{"; + indent; + + $res{code}.=DumpHfList()."\n"; + $res{code}.="\n".DumpEttList()."\n"; + + if (defined($x->{UUID})) { + # These can be changed to non-pidl_code names if the old dissectors + # in epan/dissctors are deleted. + + my $name = uc($x->{NAME}) . " (pidl)"; + my $short_name = uc($x->{NAME}); + my $filter_name = $x->{NAME}; + + if (has_property($x, "helpstring")) { + $name = $x->{PROPERTIES}->{helpstring}; + } + + if (defined($conformance->{protocols}->{$x->{NAME}})) { + $short_name = $conformance->{protocols}->{$x->{NAME}}->{SHORTNAME}; + $name = $conformance->{protocols}->{$x->{NAME}}->{LONGNAME}; + $filter_name = $conformance->{protocols}->{$x->{NAME}}->{FILTERNAME}; + } + + pidl_code "proto_dcerpc_$x->{NAME} = proto_register_protocol(".make_str($name).", ".make_str($short_name).", ".make_str($filter_name).");"; + + pidl_code "proto_register_field_array(proto_dcerpc_$x->{NAME}, hf, array_length (hf));"; + pidl_code "proto_register_subtree_array(ett, array_length(ett));"; + } else { + pidl_code "proto_dcerpc = proto_get_id_by_filter_name(\"dcerpc\");"; + pidl_code "proto_register_field_array(proto_dcerpc, hf, array_length(hf));"; + pidl_code "proto_register_subtree_array(ett, array_length(ett));"; + } + + deindent; + pidl_code "}\n"; + pidl_fn_end "proto_register_dcerpc_$x->{NAME}"; +} + +sub RegisterInterfaceHandoff($) +{ + my $x = shift; + + if (defined($x->{UUID})) { + pidl_fn_start "proto_reg_handoff_dcerpc_$x->{NAME}"; + pidl_code "void proto_reg_handoff_dcerpc_$x->{NAME}(void)"; + pidl_code "{"; + indent; + pidl_code "dcerpc_init_uuid(proto_dcerpc_$x->{NAME}, ett_dcerpc_$x->{NAME},"; + pidl_code "\t&uuid_dcerpc_$x->{NAME}, ver_dcerpc_$x->{NAME},"; + pidl_code "\t$x->{NAME}_dissectors, hf_$x->{NAME}_opnum);"; + deindent; + pidl_code "}"; + pidl_fn_end "proto_reg_handoff_dcerpc_$x->{NAME}"; + + $hf_used{"hf_$x->{NAME}_opnum"} = 1; + } +} + +sub ProcessInterface($) +{ + my ($x) = @_; + + push(@{$conformance->{strip_prefixes}}, $x->{NAME}); + + my $define = "__PACKET_DCERPC_" . uc($_->{NAME}) . "_H"; + pidl_hdr "#ifndef $define"; + pidl_hdr "#define $define"; + pidl_hdr ""; + + if (defined $x->{PROPERTIES}->{depends}) { + foreach (split / /, $x->{PROPERTIES}->{depends}) { + next if($_ eq "security"); + pidl_hdr "#include \"packet-dcerpc-$_\.h\"\n"; + } + } + + pidl_def "static gint proto_dcerpc_$x->{NAME} = -1;"; + register_ett("ett_dcerpc_$x->{NAME}"); + register_hf_field("hf_$x->{NAME}_opnum", "Operation", "$x->{NAME}.opnum", "FT_UINT16", "BASE_DEC", "NULL", 0, ""); + + if (defined($x->{UUID})) { + my $if_uuid = $x->{UUID}; + + pidl_def "/* Version information */\n\n"; + + pidl_def "static e_uuid_t uuid_dcerpc_$x->{NAME} = {"; + pidl_def "\t0x" . substr($if_uuid, 1, 8) + . ", 0x" . substr($if_uuid, 10, 4) + . ", 0x" . substr($if_uuid, 15, 4) . ","; + pidl_def "\t{ 0x" . substr($if_uuid, 20, 2) + . ", 0x" . substr($if_uuid, 22, 2) + . ", 0x" . substr($if_uuid, 25, 2) + . ", 0x" . substr($if_uuid, 27, 2) + . ", 0x" . substr($if_uuid, 29, 2) + . ", 0x" . substr($if_uuid, 31, 2) + . ", 0x" . substr($if_uuid, 33, 2) + . ", 0x" . substr($if_uuid, 35, 2) . " }"; + pidl_def "};"; + + my $maj = $x->{VERSION}; + $maj =~ s/\.(.*)$//g; + pidl_def "static guint16 ver_dcerpc_$x->{NAME} = $maj;"; + pidl_def ""; + } + + Interface($x); + + pidl_code "\n".DumpFunctionTable($x); + + # Only register these two return types if they were actually used + if (defined($hf_used{"hf_$x->{NAME}_status"})) { + register_hf_field("hf_$x->{NAME}_status", "Status", "$x->{NAME}.status", "FT_UINT32", "BASE_HEX", "VALS(NT_errors)", 0, ""); + } + + if (defined($hf_used{"hf_$x->{NAME}_werror"})) { + register_hf_field("hf_$x->{NAME}_werror", "Windows Error", "$x->{NAME}.werror", "FT_UINT32", "BASE_HEX", "VALS(DOS_errors)", 0, ""); + } + + RegisterInterface($x); + RegisterInterfaceHandoff($x); + + pidl_hdr "#endif /* $define */"; +} + +sub find_type($) +{ + my $n = shift; + + return $conformance->{types}->{$n}; +} + +sub register_type($$$$$$$) +{ + my ($type,$call,$ft,$base,$mask,$vals,$length) = @_; + + $conformance->{types}->{$type} = { + NAME => $type, + DISSECTOR_NAME => $call, + FT_TYPE => $ft, + BASE_TYPE => $base, + MASK => $mask, + VALSSTRING => $vals, + ALIGNMENT => $length + }; +} + +# Loads the default types +sub Initialize($) +{ + my $cnf_file = shift; + + $conformance = { + imports => {}, + header_fields=> {} + }; + + ReadConformance($cnf_file, $conformance) or print "Warning: No conformance file `$cnf_file'\n"; + + foreach my $bytes (qw(1 2 4 8)) { + my $bits = $bytes * 8; + register_type("uint$bits", "offset = dissect_ndr_uint$bits(tvb, offset, pinfo, tree, drep, \@HF\@,NULL);", "FT_UINT$bits", "BASE_DEC", 0, "NULL", $bytes); + register_type("int$bits", "offset = dissect_ndr_uint$bits(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);", "FT_INT$bits", "BASE_DEC", 0, "NULL", $bytes); + } + + register_type("udlong", "offset = dissect_ndr_duint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);", "FT_UINT64", "BASE_DEC", 0, "NULL", 4); + register_type("bool8", "offset = dissect_ndr_uint8(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT8", "BASE_DEC", 0, "NULL", 1); + register_type("char", "offset = dissect_ndr_uint8(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT8", "BASE_DEC", 0, "NULL", 1); + register_type("long", "offset = dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT32", "BASE_DEC", 0, "NULL", 4); + register_type("dlong", "offset = dissect_ndr_duint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT64", "BASE_DEC", 0, "NULL", 8); + register_type("GUID", "offset = dissect_ndr_uuid_t(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_GUID", "BASE_NONE", 0, "NULL", 4); + register_type("policy_handle", "offset = dissect_nt_policy_hnd(tvb, offset, pinfo, tree, drep, \@HF\@, NULL, NULL, \@PARAM\@&0x01, \@PARAM\@&0x02);","FT_BYTES", "BASE_NONE", 0, "NULL", 4); + register_type("NTTIME", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);","FT_ABSOLUTE_TIME", "BASE_NONE", 0, "NULL", 4); + register_type("NTTIME_hyper", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);","FT_ABSOLUTE_TIME", "BASE_NONE", 0, "NULL", 4); + register_type("time_t", "offset = dissect_ndr_time_t(tvb, offset, pinfo,tree, drep, \@HF\@, NULL);","FT_ABSOLUTE_TIME", "BASE_DEC", 0, "NULL", 4); + register_type("NTTIME_1sec", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);", "FT_ABSOLUTE_TIME", "BASE_NONE", 0, "NULL", 4); + register_type("SID", " + dcerpc_info *di = (dcerpc_info *)pinfo->private_data; + + di->hf_index = \@HF\@; + + offset = dissect_ndr_nt_SID_with_options(tvb, offset, pinfo, tree, drep, param); + ","FT_STRING", "BASE_DEC", 0, "NULL", 4); + register_type("WERROR", + "offset = dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_UINT32", "BASE_DEC", 0, "VALS(NT_errors)", 4); + +} + +##################################################################### +# Generate Wireshark parser and header code +sub Parse($$$$) +{ + my($ndr,$idl_file,$h_filename,$cnf_file) = @_; + Initialize($cnf_file); + + return (undef, undef) if defined($conformance->{noemit_dissector}); + + $tabs = ""; + + %res = (code=>"",def=>"",hdr=>""); + @ett = (); + + my $notice = +"/* DO NOT EDIT + This filter was automatically generated + from $idl_file and $cnf_file. + + Pidl is a perl based IDL compiler for DCE/RPC idl files. + It is maintained by the Samba team, not the Wireshark team. + Instructions on how to download and install Pidl can be + found at http://wiki.wireshark.org/Pidl +*/ + +"; + + pidl_hdr $notice; + + $res{headers} = "\n"; + $res{headers} .= "#ifdef HAVE_CONFIG_H\n"; + $res{headers} .= "#include \"config.h\"\n"; + $res{headers} .= "#endif\n\n"; + $res{headers} .= "#include \n"; + $res{headers} .= "#include \n"; + $res{headers} .= "#include \n\n"; + + $res{headers} .= "#include \"packet-dcerpc.h\"\n"; + $res{headers} .= "#include \"packet-dcerpc-nt.h\"\n"; + $res{headers} .= "#include \"packet-windows-common.h\"\n"; + + my $h_basename = basename($h_filename); + + $res{headers} .= "#include \"$h_basename\"\n"; + pidl_code ""; + + # Wireshark protocol registration + + ProcessInterface($_) foreach (@$ndr); + + $res{ett} = DumpEttDeclaration(); + $res{hf} = DumpHfDeclaration(); + + my $parser = $notice; + $parser.= $res{headers}; + $parser.=$res{ett}; + $parser.=$res{hf}; + $parser.=$res{def}; + $parser.=$conformance->{override}; + $parser.=$res{code}; + + my $header = "/* autogenerated by pidl */\n\n"; + $header.=$res{hdr}; + + CheckUsed($conformance); + + return ($parser,$header); +} + +############################################################################### +# ETT +############################################################################### + +sub register_ett($) +{ + my $name = shift; + + push (@ett, $name); +} + +sub DumpEttList() +{ + my $res = "\tstatic gint *ett[] = {\n"; + foreach (@ett) { + $res .= "\t\t&$_,\n"; + } + + return "$res\t};\n"; +} + +sub DumpEttDeclaration() +{ + my $res = "\n/* Ett declarations */\n"; + foreach (@ett) { + $res .= "static gint $_ = -1;\n"; + } + + return "$res\n"; +} + +############################################################################### +# HF +############################################################################### + +sub register_hf_field($$$$$$$$) +{ + my ($index,$name,$filter_name,$ft_type,$base_type,$valsstring,$mask,$blurb) = @_; + + if (defined ($conformance->{hf_renames}->{$index})) { + $conformance->{hf_renames}->{$index}->{USED} = 1; + return $conformance->{hf_renames}->{$index}->{NEWNAME}; + } + + $conformance->{header_fields}->{$index} = { + INDEX => $index, + NAME => $name, + FILTER => $filter_name, + FT_TYPE => $ft_type, + BASE_TYPE => $base_type, + VALSSTRING => $valsstring, + MASK => $mask, + BLURB => $blurb + }; + + if ((not defined($blurb) or $blurb eq "") and + defined($conformance->{fielddescription}->{$index})) { + $conformance->{header_fields}->{$index}->{BLURB} = + $conformance->{fielddescription}->{$index}->{DESCRIPTION}; + $conformance->{fielddescription}->{$index}->{USED} = 1; + } + + return $index; +} + +sub DumpHfDeclaration() +{ + my $res = ""; + + $res = "\n/* Header field declarations */\n"; + + foreach (keys %{$conformance->{header_fields}}) + { + $res .= "static gint $_ = -1;\n"; + } + + return "$res\n"; +} + +sub DumpHfList() +{ + my $res = "\tstatic hf_register_info hf[] = {\n"; + + foreach (values %{$conformance->{header_fields}}) + { + $res .= "\t{ &$_->{INDEX}, + { ".make_str($_->{NAME}).", ".make_str($_->{FILTER}).", $_->{FT_TYPE}, $_->{BASE_TYPE}, $_->{VALSSTRING}, $_->{MASK}, ".make_str($_->{BLURB}).", HFILL }}, +"; + } + + return $res."\t};\n"; +} + + +############################################################################### +# Function table +############################################################################### + +sub DumpFunctionTable($) +{ + my $if = shift; + + my $res = "static dcerpc_sub_dissector $if->{NAME}\_dissectors[] = {\n"; + foreach (@{$if->{FUNCTIONS}}) { + my $fn_name = $_->{NAME}; + $fn_name =~ s/^$if->{NAME}_//; + $res.= "\t{ $_->{OPNUM}, \"$fn_name\",\n"; + $res.= "\t $if->{NAME}_dissect_${fn_name}_request, $if->{NAME}_dissect_${fn_name}_response},\n"; + } + + $res .= "\t{ 0, NULL, NULL, NULL }\n"; + + return "$res};\n"; +} + +sub CheckUsed($) +{ + my $conformance = shift; + foreach (values %{$conformance->{header_fields}}) { + if (not defined($hf_used{$_->{INDEX}})) { + print "$_->{POS}: warning: hf field `$_->{INDEX}' not used\n"; + } + } + + foreach (values %{$conformance->{hf_renames}}) { + if (not $_->{USED}) { + print "$_->{POS}: warning: hf field `$_->{OLDNAME}' not used\n"; + } + } + + foreach (values %{$conformance->{dissectorparams}}) { + if (not $_->{USED}) { + print "$_->{POS}: warning: dissector param never used\n"; + } + } + + foreach (values %{$conformance->{imports}}) { + if (not $_->{USED}) { + print "$_->{POS}: warning: import never used\n"; + } + } + + foreach (values %{$conformance->{types}}) { + if (not $_->{USED} and defined($_->{POS})) { + print "$_->{POS}: warning: type never used\n"; + } + } + + foreach (values %{$conformance->{fielddescription}}) { + if (not $_->{USED}) { + print "$_->{POS}: warning: description never used\n"; + } + } + + foreach (values %{$conformance->{tfs}}) { + if (not $_->{USED}) { + print "$_->{POS}: warning: True/False description never used\n"; + } + } +} + +1; diff --git a/source4/pidl/pidl b/source4/pidl/pidl index 6b64541156..4d23060f6e 100755 --- a/source4/pidl/pidl +++ b/source4/pidl/pidl @@ -17,7 +17,7 @@ pidl - An IDL compiler written in Perl pidl --help -pidl [--outputdir[=OUTNAME]] [--parse-idl-tree] [--dump-idl-tree] [--dump-ndr-tree] [--header[=OUTPUT]] [--ejs[=OUTPUT]] [--swig[=OUTPUT]] [--uint-enums] [--ndr-parser[=OUTPUT]] [--client] [--server] [--dcom-proxy] [--com-header] [--warn-compat] [--quiet] [--verbose] [--template] [--eth-parser[=OUTPUT]] [--diff] [--dump-idl] [--tdr-parser[=OUTPUT]] [--samba3-header[=OUTPUT]] [--samba3-parser=[OUTPUT]] [--samba3-server=[OUTPUT]] [--samba3-template[=OUTPUT]] [--samba3-client[=OUTPUT]] [--samba3-ndr-client[=OUTPUT]] [.idl]... +pidl [--outputdir[=OUTNAME]] [--parse-idl-tree] [--dump-idl-tree] [--dump-ndr-tree] [--header[=OUTPUT]] [--ejs[=OUTPUT]] [--swig[=OUTPUT]] [--uint-enums] [--ndr-parser[=OUTPUT]] [--client] [--server] [--dcom-proxy] [--com-header] [--warn-compat] [--quiet] [--verbose] [--template] [--ws-parser[=OUTPUT]] [--diff] [--dump-idl] [--tdr-parser[=OUTPUT]] [--samba3-header[=OUTPUT]] [--samba3-parser=[OUTPUT]] [--samba3-server=[OUTPUT]] [--samba3-template[=OUTPUT]] [--samba3-client[=OUTPUT]] [--samba3-ndr-client[=OUTPUT]] [.idl]... =head1 DESCRIPTION @@ -26,13 +26,13 @@ compatible with the midl compiler. IDL is short for "Interface Definition Language". pidl can generate stubs for DCE/RPC server code, DCE/RPC -client code and ethereal dissectors for DCE/RPC traffic. +client code and Wireshark dissectors for DCE/RPC traffic. IDL compilers like pidl take a description of an interface as their input and use it to generate C (though support for other languages may be added later) code that can use these interfaces, pretty print data sent -using these interfaces, or even generate ethereal +using these interfaces, or even generate Wireshark dissectors that can parse data sent over the wire by these interfaces. @@ -93,15 +93,15 @@ the interface. Filename defaults to ndr_OUTNAME_s.c. Generate stubs for a RPC server that implements the interface. Output will be written to stdout. -=item I<--eth-parser> +=item I<--ws-parser> -Generate an Ethereal dissector (in C) and header file. The dissector filename +Generate an Wireshark dissector (in C) and header file. The dissector filename defaults to packet-dcerpc-OUTNAME.c while the header filename defaults to packet-dcerpc-OUTNAME.h. -Pidl will read additional data from an ethereal conformance file if present. +Pidl will read additional data from an Wireshark conformance file if present. Such a file should have the same location as the IDL file but with the -extension I rather than I. See L +extension I rather than I. See L for details on the format of this file. =item I<--diff> @@ -369,8 +369,8 @@ usesgetlasterror, vararg, vi_progid, wire_marshal. =head1 EXAMPLES - # Generating an ethereal parser - $ ./pidl --eth-parser -- atsvc.idl + # Generating an Wireshark parser + $ ./pidl --ws-parser -- atsvc.idl # Generating a TDR parser and header $ ./pidl --tdr-parser --header -- regf.idl @@ -384,7 +384,7 @@ usesgetlasterror, vararg, vi_progid, wire_marshal. =head1 SEE ALSO L, -L, +L, L, L @@ -477,7 +477,7 @@ my($opt_client); my($opt_server); my($opt_ndr_parser); my($opt_tdr_parser); -my($opt_eth_parser); +my($opt_ws_parser); my($opt_swig); my($opt_dcom_proxy); my($opt_com_header); @@ -533,8 +533,8 @@ Samba 3 output: --samba3-ndr-client[=OUTF] create client calls for Samba3 using Samba4's NDR code [cli_BASENAME.c] -Ethereal parsers: - --eth-parser[=OUTFILE] create ethereal parser and header +Wireshark parsers: + --ws-parser[=OUTFILE] create Wireshark parser and header \n"; exit(0); } @@ -560,7 +560,7 @@ my $result = GetOptions ( 'template' => \$opt_template, 'ndr-parser:s' => \$opt_ndr_parser, 'client:s' => \$opt_client, - 'eth-parser:s' => \$opt_eth_parser, + 'ws-parser:s' => \$opt_ws_parser, 'ejs' => \$opt_ejs, 'diff' => \$opt_diff, 'swig:s' => \$opt_swig, @@ -655,7 +655,7 @@ sub process_file($) $pidl = Parse::Pidl::ODL::ODL2IDL($pidl); - if (defined($opt_eth_parser) or + if (defined($opt_ws_parser) or defined($opt_client) or defined($opt_server) or defined($opt_ndr_parser) or defined($opt_ejs) or defined($opt_dump_ndr_tree) or defined($opt_samba3_header) or @@ -744,15 +744,15 @@ $dcom } - if (defined($opt_eth_parser)) { - require Parse::Pidl::Ethereal::NDR; - my($eparser) = ($opt_eth_parser or "$outputdir/packet-dcerpc-$basename.c"); + if (defined($opt_ws_parser)) { + require Parse::Pidl::Wireshark::NDR; + my($eparser) = ($opt_ws_parser or "$outputdir/packet-dcerpc-$basename.c"); my $eheader = $eparser; $eheader =~ s/\.c$/\.h/; my $cnffile = $idl_file; $cnffile =~ s/\.idl$/\.cnf/; - my ($dp, $dh) = Parse::Pidl::Ethereal::NDR::Parse($ndr, $idl_file, $eheader, $cnffile); + my ($dp, $dh) = Parse::Pidl::Wireshark::NDR::Parse($ndr, $idl_file, $eheader, $cnffile); FileSave($eparser, $dp) if defined($dp); FileSave($eheader, $dh) if defined($dh); } -- cgit