ffi-packets 0.1.0

data/lib/ffi/packets/eth.rb

@@ -0,0 +1,74 @@
+
+module FFI::Packets
+
+  module Eth
+    class EthAddr < ::FFI::Struct
+      include ::FFI::DRY::StructHelper
+
+      # struct eth_addr { ... } eth_addr_t;
+      dsl_layout{ array :data, [:uchar, Constants::ETH_ADDR_LEN] }
+
+      # Adds the ability to initialize a new EthAddr with a mac address
+      # string such as 'de:ad:be:ef:ba:be'. This argument is only parsed
+      # if it is passed as the only String argument.
+      def initialize(*args)
+        if args.size == 1 and (s=args[0]).is_a? String
+          super()
+          self.addr = s
+        else
+          super(*args)
+        end
+      end
+
+      def addr=(val)
+        unless val.to_s =~ /^#{Util::RX_MAC_ADDR}$/
+          raise(ArgumentError, "invalid mac address #{val.inspect}")
+        end
+        raw = Util.unhexify(val, /[:-]/)
+        self[:data].to_ptr.write_string(raw, ETH_ADDR_LEN)
+      end
+
+      # Returns the MAC address as an array of unsigned char values.
+      def chars; self[:data].to_a ; end
+
+      # Returns the MAC address as a string with colon-separated hex-bytes.
+      def string; chars.map {|x| "%0.2x" % x }.join(':'); end
+    end
+
+
+    #
+    #   struct :dst,   EthAddr, :desc => 'destination address'
+    #   struct :src,   EthAddr, :desc => 'source address'
+    #   field  :etype, :ushort, :desc => 'ethernet payload type'
+    #
+    class Hdr < ::FFI::Struct
+      include ::FFI::DRY::NetStructHelper
+      
+      module Etype
+        include ::FFI::DRY::ConstMap
+        slurp_constants Constants, "ETH_TYPE_"
+        def list; @@list ||= super();  end
+      end
+
+      dsl_layout do
+        struct :dst,   EthAddr, :desc => 'destination address'
+        struct :src,   EthAddr, :desc => 'source address'
+        field  :etype, :ushort, :desc => 'ethernet payload type'
+      end
+
+      def lookup_etype
+        Etype[ self.etype ]
+      end
+
+      alias _divert_set_eth etype=
+
+      def etype=(val)
+        if val.kind_of? String or val.kind_of? Symbol
+          val = Etype[ val ] or raise(ArgumentError, "invalid eth type #{val}")
+        end
+        _divert_set_eth(val)
+      end
+    end
+
+  end
+end

data/lib/ffi/packets/icmp.rb

@@ -0,0 +1,294 @@
+
+module FFI::Packets
+  module Icmp
+
+    # ICMP header structure
+    #
+    #   struct icmp_hdr {
+    #     uint8_t    icmp_type;  /* type of message */
+    #     uint8_t    icmp_code;  /* type sub code */
+    #     uint16_t  icmp_cksum;  /* ones complement cksum of struct */
+    #   };
+    #
+    class Hdr < ::FFI::Struct
+      include ::FFI::DRY::NetStructHelper
+    
+      dsl_layout do
+        field :icmp_type,    :uint8
+        field :icmp_code,    :uint8
+        field :icmp_cksum,   :uint16
+      end
+
+      module IcmpType
+        include ::FFI::DRY::ConstFlagsMap
+        slurp_constants(Constants, "ICMP_TYPE_")
+        def list; @@list ||= super(); end
+      end
+
+      module IcmpCode
+        module UNREACH
+          include ::FFI::DRY::ConstFlagsMap
+          slurp_constants(Constants, "ICMP_UNREACH_")
+          def list; @@list ||= super(); end
+        end
+
+        module REDIRECT
+          include ::FFI::DRY::ConstFlagsMap
+          slurp_constants(Constants, "ICMP_REDIRECT_")
+          def list; @@list ||= super(); end
+        end
+
+        module RTRADVERT
+          include ::FFI::DRY::ConstFlagsMap
+          slurp_constants(Constants, "ICMP_RTRADVERT_")
+          def list; @@list ||= super(); end
+        end
+
+        module TIMEEXCEED
+          include ::FFI::DRY::ConstFlagsMap
+          slurp_constants(Constants, "ICMP_TIMEEXCEED_")
+          def list; @@list ||= super(); end
+        end
+
+        module PARAMPROB
+          include ::FFI::DRY::ConstFlagsMap
+          slurp_constants(Constants, "ICMP_PARAMPROB_")
+          def list; @@list ||= super(); end
+        end
+
+        module PHOTURIS
+          include ::FFI::DRY::ConstFlagsMap
+          slurp_constants(Constants, "ICMP_PHOTURIS_")
+          def list; @@list ||= super(); end
+        end
+
+      end # module IcmpCode
+
+      # Various ICMP message structures
+      module Msg
+
+        # Echo message data structure
+        # 
+        #   struct icmp_msg_echo {
+        #     uint16_t  icmp_id;
+        #     uint16_t  icmp_seq;
+        #     uint8_t   icmp_data __flexarr;  /* optional data */
+        #   };
+        # 
+        class Echo < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+      
+          dsl_layout do
+            field :icmp_id, :uint16
+            field :seq,     :uint16
+            field :data,    :uint8    # flexarr ... optional data
+          end
+        end
+
+        # Fragmentation-needed (unreachable) message data structure
+        # 
+        #   struct icmp_msg_needfrag {
+        #     uint16_t  icmp_void;    /* must be zero */
+        #     uint16_t  icmp_mtu;    /* MTU of next-hop network */
+        #     uint8_t   icmp_ip __flexarr;  /* IP hdr + 8 bytes of pkt */
+        #   };
+        # 
+        class NeedFrag < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+      
+          dsl_layout do
+            field :icmp_void, :uint16
+            field :mtu,       :uint16
+            field :ip,        :uint8    # flexarr ... IP hdr + 8 bytes of pkt
+          end
+        end
+
+        # Unreachable, source quench, redirect, time exceeded,
+        # parameter problem message data structure
+        # 
+        #   struct icmp_msg_quote {
+        #     uint32_t  icmp_void;    /* must be zero */
+        #     uint8_t   icmp_ip __flexarr;  /* IP hdr + 8 bytes of pkt */
+        #   };
+        # 
+        class Quote < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+      
+          dsl_layout do
+            field :icmp_void, :uint32 
+            field :ip,        :uint8     # flexxarr ... IP hdr + 8 bytes of pkt
+          end
+        end
+
+        # Router advertisement message data structure, RFC 1256
+        # 
+        #   struct icmp_msg_rtradvert {
+        #     uint8_t    icmp_num_addrs;    /* # of address / pref pairs */
+        #     uint8_t    icmp_wpa;    /* words / address == 2 */
+        #     uint16_t   icmp_lifetime;    /* route lifetime in seconds */
+        #     struct icmp_msg_rtr_data {
+        #       uint32_t  icmp_void;
+        #       uint32_t  icmp_pref;  /* router preference (usu 0) */
+        #     } icmp_rtr __flexarr;      /* variable # of routers */
+        #   };
+        # 
+        class RtrAdvert < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+
+          class RtrData < ::FFI::Struct
+            include ::FFI::DRY::NetStructHelper
+        
+            dsl_layout do
+              field :icmp_void, :uint32
+              field :pref,      :uint32
+            end
+          end
+
+          dsl_layout do
+            field  :num_addrs, :uint8
+            field  :wpa,       :uint8
+            field  :lifetime,  :uint16
+            struct :router,    RtrData    # flexarr ... variable # of routers
+          end
+        end
+
+        # Timestamp message data structure
+        # 
+        #   struct icmp_msg_tstamp {
+        #     uint32_t  icmp_id;    /* identifier */
+        #     uint32_t  icmp_seq;    /* sequence number */
+        #     uint32_t  icmp_ts_orig;    /* originate timestamp */
+        #     uint32_t  icmp_ts_rx;    /* receive timestamp */
+        #     uint32_t  icmp_ts_tx;    /* transmit timestamp */
+        #   };
+        # 
+        class Timestamp < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+      
+          dsl_layout do
+            field :icmp_id, :uint32
+            field :seq,     :uint32
+            field :ts_orig, :uint32
+            field :ts_rx,   :uint32
+            field :ts_tx,   :uint32
+          end
+        end
+
+        # Address mask message data structure, RFC 950
+        # 
+        #   struct icmp_msg_mask {
+        #     uint32_t  icmp_id;    /* identifier */
+        #     uint32_t  icmp_seq;    /* sequence number */
+        #     uint32_t  icmp_mask;    /* address mask */
+        #   };
+        # 
+        class Mask < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+
+          dsl_layout do
+            field :icmp_id, :uint32
+            field :seq,     :uint32
+            field :mask,    :uint32
+          end
+        end
+
+        # Traceroute message data structure, RFC 1393, RFC 1812
+        # 
+        #   struct icmp_msg_traceroute {
+        #     uint16_t  icmp_id;    /* identifier */
+        #     uint16_t  icmp_void;    /* unused */
+        #     uint16_t  icmp_ohc;    /* outbound hop count */
+        #     uint16_t  icmp_rhc;    /* return hop count */
+        #     uint32_t  icmp_speed;    /* link speed, bytes/sec */
+        #     uint32_t  icmp_mtu;    /* MTU in bytes */
+        #   };
+        # 
+        class Traceroute < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+      
+          dsl_layout do
+            field :icmp_id,   :uint16
+            field :icmp_void, :uint16
+            field :ohc,       :uint16
+            field :rhc,       :uint16
+            field :speed,     :uint16
+            field :mtu,       :uint16
+          end
+        end
+
+        # Domain name reply message data structure, RFC 1788
+        # 
+        #   struct icmp_msg_dnsreply {
+        #     uint16_t  icmp_id;    /* identifier */
+        #     uint16_t  icmp_seq;    /* sequence number */
+        #     uint32_t  icmp_ttl;    /* time-to-live */
+        #     uint8_t    icmp_names __flexarr;  /* variable number of names */
+        #   };
+        # 
+        class DnsReply < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+      
+          dsl_layout do
+            field :icmp_id, :uint16
+            field :seq,     :uint16
+            field :ttl,     :uint16
+            field :names,   :uint8    # flexarr ... variable # of names
+          end
+        end
+
+        # Generic identifier, sequence number data structure
+        # 
+        #   struct icmp_msg_idseq {
+        #     uint16_t  icmp_id;
+        #     uint16_t  icmp_seq;
+        #   };
+        # 
+        class IdSeq < ::FFI::Struct
+          include ::FFI::DRY::NetStructHelper
+      
+          dsl_layout do
+            field :icmp_id, :uint16
+            field :seq,     :uint16
+          end
+        end
+
+      end # module Msg
+    end
+
+    # /*
+    #  * ICMP message union
+    #  */
+    # union icmp_msg {
+    #   struct icmp_msg_echo     echo;  /* ICMP_ECHO{REPLY} */
+    #   struct icmp_msg_quote     unreach;  /* ICMP_UNREACH */
+    #   struct icmp_msg_needfrag   needfrag;  /* ICMP_UNREACH_NEEDFRAG */
+    #   struct icmp_msg_quote     srcquench;  /* ICMP_SRCQUENCH */
+    #   struct icmp_msg_quote     redirect;  /* ICMP_REDIRECT (set to 0) */
+    #   uint32_t       rtrsolicit;  /* ICMP_RTRSOLICIT */
+    #   struct icmp_msg_rtradvert  rtradvert;  /* ICMP_RTRADVERT */
+    #   struct icmp_msg_quote     timexceed;  /* ICMP_TIMEXCEED */
+    #   struct icmp_msg_quote     paramprob;  /* ICMP_PARAMPROB */
+    #   struct icmp_msg_tstamp     tstamp;  /* ICMP_TSTAMP{REPLY} */
+    #   struct icmp_msg_idseq     info;  /* ICMP_INFO{REPLY} */
+    #   struct icmp_msg_mask     mask;  /* ICMP_MASK{REPLY} */
+    #   struct icmp_msg_traceroute traceroute;  /* ICMP_TRACEROUTE */
+    #   struct icmp_msg_idseq     dns;    /* ICMP_DNS */
+    #   struct icmp_msg_dnsreply   dnsreply;  /* ICMP_DNSREPLY */
+    # };
+
+    # #define icmp_pack_hdr(hdr, type, code) do {        \
+    #   struct icmp_hdr *icmp_pack_p = (struct icmp_hdr *)(hdr);  \
+    #   icmp_pack_p->icmp_type = type; icmp_pack_p->icmp_code = code;  \
+    # } while (0)
+
+    # #define icmp_pack_hdr_echo(hdr, type, code, id, seq, data, len) do {  \
+    #   struct icmp_msg_echo *echo_pack_p = (struct icmp_msg_echo *)  \
+    #     ((uint8_t *)(hdr) + ICMP_HDR_LEN);      \
+    #   icmp_pack_hdr(hdr, type, code);          \
+    #   echo_pack_p->icmp_id = htons(id);        \
+    #   echo_pack_p->icmp_seq = htons(seq);        \
+    #   memmove(echo_pack_p->icmp_data, data, len);      \
+    # } while (0)
+  end
+
+end

data/lib/ffi/packets/ip.rb

@@ -0,0 +1,227 @@
+
+module FFI::Packets
+
+  module Ip
+    # Protocols (proto) - http://www.iana.org/assignments/protocol-numbers
+    #
+    # Contains mappings for all the IP_PROTO_[A-Z].* constants 
+    # (defined in constants.rb)
+    module Proto
+      include ::FFI::DRY::ConstMap
+      slurp_constants(Constants, "IP_PROTO_")
+      def self.list;  @@list ||= super(); end
+    end
+
+    # IP header, without options
+    #
+    #   field :v_hl,    :uint8,   :desc => 'v=vers(. & 0xf0) / '+
+    #                                      'hl=hdr len(. & 0x0f)'
+    #   field :tos,     :uint8,   :desc => 'type of service'
+    #   field :len,     :uint16,  :desc => 'total length (incl header)'
+    #   field :id,      :uint16,  :desc => 'identification'
+    #   field :off,     :uint16,  :desc => 'fragment offset and flags'
+    #   field :ttl,     :uint8,   :desc => 'time to live'
+    #   field :proto,   :uint8,   :desc => 'protocol'
+    #   field :sum,     :uint16,  :desc => 'checksum'
+    #   field :src,     :uint32,  :desc => 'source address'
+    #   field :dst,     :uint32,  :desc => 'destination address'
+    #
+    class Hdr < ::FFI::Struct
+      include ::FFI::DRY::NetStructHelper
+    
+      dsl_layout do
+        field :v_hl,    :uint8,   :desc => 'v=vers(. & 0xf0) / '+
+                                           'hl=hdr len(. & 0x0f)'
+        field :tos,     :uint8,   :desc => 'type of service'
+        field :len,     :uint16,  :desc => 'total length (incl header)'
+        field :id,      :uint16,  :desc => 'identification'
+        field :off,     :uint16,  :desc => 'fragment offset and flags'
+        field :ttl,     :uint8,   :desc => 'time to live'
+        field :proto,   :uint8,   :desc => 'protocol'
+        field :sum,     :uint16,  :desc => 'checksum'
+        field :src,     :uint32,  :desc => 'source address'
+        field :dst,     :uint32,  :desc => 'destination address'
+      end
+
+      # Overrides set_fields to supply a default value for the 'v_hl' field.
+      #
+      #   v  = 4
+      #   hl = 5 # number of 32-bit words - 20 bytes (size of hdr without opts)
+      #
+      def set_fields(params=nil)
+        params ||= {}
+        super({:v_hl => 0x45}.merge(params))
+      end
+
+      # Sets the value of the hl field. This field is a 4-bit value occupying
+      # the lower 4 bits of the 'v_hl' field.
+      #
+      # This value is the size of the IP header (including opts if present)
+      # in 32-bit words. The byte size maximum is 15*4 - 60 bytes.
+      def hl=(val)
+        raise(ArgumentError, "value for header length too high") if val > 0xf
+        self[:v_hl] &= 0xf0
+        self[:v_hl] += val
+      end
+
+      # Returns the value of the hl field. This field is a 4-bit value occupying
+      # the lower 4 bits of the 'v_hl' field.
+      #
+      # This value is the size of the IP header (including opts if present)
+      # in 32-bit words. The byte size maximum is 15*4 - 60 bytes.
+      def hl
+        self[:v_hl] & 0x0f
+      end
+
+      # Type of service (ip_tos), RFC 1349 ("obsoleted by RFC 2474")
+      #
+      # Contains mappings for all the IP_TOS_[A-Z].* flags constants
+      module Tos
+        include ::FFI::DRY::ConstFlagsMap
+        slurp_constants(Constants, "IP_TOS_")
+        def self.list;  @@list ||= super(); end
+      end
+
+      def lookup_tos;  Tos[ self.tos ]; end
+
+      # Alias to Ip::Proto
+      Proto = Ip::Proto
+
+      def lookup_proto; Proto[ self.proto ]; end
+
+      # Sets source IP address in the header from an IPv4 address string or 
+      # 32-bit number.
+      def src=(val)
+        val = Util.ipv4_atol(val) if val.kind_of? String
+        self[:src] = Util.htonl(val)
+      end
+
+      # Returns the source IP address as an IPv4 address string as an IPv4 
+      # address string.
+      def src
+        Util.ipv4_ltoa( Util.ntohl( self[:src] ))
+      end
+
+      # Sets destination IP address in the header from an IPv4 address string 
+      # or 32-bit number.
+      def dst=(val)
+        val = Util.ipv4_atol(val) if val.kind_of? String
+        self[:dst] = Util.htonl(val)
+      end
+
+      # Returns the destination IP address from the header as an IPv4 address 
+      # string.
+      def dst
+        Util.ipv4_ltoa( Util.ntohl( self[:dst] ))
+      end
+
+    end # class Hdr
+
+
+    # IP option (following IP header)
+    #
+    #   array :otype, :uint8,            :desc => 'option type'
+    #   array :len,   :uint8,            :desc => 'option length >= IP_OPE_LEN'
+    #   array :data, [:uint8, DATA_LEN], :desc => 'option message data '
+    #
+    class Opt < ::FFI::Struct
+      include ::FFI::DRY::NetStructHelper
+
+      IP_OPT_LEN = Constants::IP_OPT_LEN
+      IP_OPT_LEN_MAX = Constants::IP_OPT_LEN_MAX
+
+      DATA_LEN = IP_OPT_LEN_MAX - IP_OPT_LEN
+    
+      dsl_layout do
+        field :otype, :uint8,   :desc => 'option type'
+        field :len,   :uint8,   :desc => 'option length >= IP_OPE_LEN'
+        array :data, [:uint8, DATA_LEN], :desc => 'option message data '
+      end
+
+      # Option types (otype) - http://www.iana.org/assignments/ip-parameters
+      #
+      # Contains mappings for all the IP_OTYPE_[A-Z].* constants
+      module Otype
+        include ::FFI::DRY::ConstMap
+        slurp_constants(Constants, "IP_OTYPE_")
+        def self.list;  @@list ||= super(); end
+      end
+
+      # Security option data - RFC 791, 3.1
+      #
+      #   field :sec,   :uint16,     :desc => 'security'
+      #   field :cpt,   :uint16,     :desc => 'compartments'
+      #   field :hr,    :uint16,     :desc => 'handling restrictions'
+      #   array :tcc,   [:uint8, 3], :desc => 'transmission control code'
+      #
+      class DataSEC < ::FFI::Struct
+        include ::FFI::DRY::NetStructHelper
+ 
+        dsl_layout do
+          field :sec,   :uint16,     :desc => 'security'
+          field :cpt,   :uint16,     :desc => 'compartments'
+          field :hr,    :uint16,     :desc => 'handling restrictions'
+          array :tcc,   [:uint8, 3], :desc => 'transmission control code'
+        end
+
+      end
+
+      # Timestamp option data - RFC 791, 3.1
+      #
+      #   field :ptr,       :uint8,  :desc => 'from start of option'
+      #   field :oflw_flg,  :uint8,  :desc => 'oflw = number of IPs skipped /'+
+      #                                       'flg  = address/timestamp flag'
+      #   field :iptspairs, :uint32, :desc => 'IP addr/ts pairs, var-length'
+      #
+      class DataTS < ::FFI::Struct
+        include ::FFI::DRY::NetStructHelper
+
+        dsl_layout do
+          field :ptr,       :uint8,  :desc => 'from start of option'
+          field :oflw_flg,  :uint8,  :desc => 'oflw = number of IPs skipped /'+
+                                              'flg  = address/timestamp flag'
+          field :iptspairs, :uint32, :desc => 'IP addr/ts pairs, var-length'
+        end
+
+      end
+
+      # (Loose Source/Record/Strict Source) Route option data - RFC 791, 3.1
+      #
+      #   field :ptr,     :uint8,   :desc => 'from start of option'
+      #   field :iplist,  :uint32,  :desc => 'var-length list of IPs'
+      #
+      class DataRR < ::FFI::Struct
+        include ::FFI::DRY::NetStructHelper
+      
+        dsl_layout do
+          field :ptr,     :uint8,   :desc => 'from start of option'
+          field :iplist,  :uint32,  :desc => 'var-length list of IPs'
+        end
+
+      end
+
+      #  Traceroute option data - RFC 1393, 2.2
+      #
+      #   struct ip_opt_data_tr {
+      #     uint16_t  id;     /* ID number */
+      #     uint16_t  ohc;    /* outbound hop count */
+      #     uint16_t  rhc;    /* return hop count */
+      #     uint32_t  origip; /* originator IP address */
+      #   } __attribute__((__packed__));
+      #
+      class DataTR < ::FFI::Struct
+        include ::FFI::DRY::NetStructHelper
+      
+        dsl_layout do
+          field :id,      :uint16, :desc => 'ID number'
+          field :ohc,     :uint16, :desc => 'outbound hop count'
+          field :rhc,     :uint16, :desc => 'return hop count'
+          field :origip,  :uint32, :desc => 'originator IP address'
+        end
+      end
+
+    end # class Opt
+
+  end # module Ip
+end
+