:tocdepth: 3

base/bif/types.bif.bro
======================
.. bro:namespace:: GLOBAL
.. bro:namespace:: Input
.. bro:namespace:: Log
.. bro:namespace:: NFS3
.. bro:namespace:: Tunnel

Declaration of various types that the Bro core uses internally.

:Namespaces: GLOBAL, Input, Log, NFS3, Tunnel
:Source File: :download:`/scripts/base/bif/types.bif.bro`

Summary
~~~~~~~
Types
#####
================================================ =
:bro:type:`Input::Event`: :bro:type:`enum`       
:bro:type:`Input::Mode`: :bro:type:`enum`        
:bro:type:`Input::Reader`: :bro:type:`enum`      
:bro:type:`Log::ID`: :bro:type:`enum`            
:bro:type:`Log::Writer`: :bro:type:`enum`        
:bro:type:`NFS3::createmode_t`: :bro:type:`enum` 
:bro:type:`NFS3::file_type_t`: :bro:type:`enum`  
:bro:type:`NFS3::proc_t`: :bro:type:`enum`       
:bro:type:`NFS3::stable_how_t`: :bro:type:`enum` 
:bro:type:`NFS3::status_t`: :bro:type:`enum`     
:bro:type:`Tunnel::Type`: :bro:type:`enum`       
:bro:type:`dce_rpc_if_id`: :bro:type:`enum`      
:bro:type:`dce_rpc_ptype`: :bro:type:`enum`      
:bro:type:`rpc_status`: :bro:type:`enum`         
================================================ =


Detailed Interface
~~~~~~~~~~~~~~~~~~
Types
#####
.. bro:type:: Input::Event

   :Type: :bro:type:`enum`

      .. bro:enum:: Input::EVENT_NEW Input::Event

      .. bro:enum:: Input::EVENT_CHANGED Input::Event

      .. bro:enum:: Input::EVENT_REMOVED Input::Event


.. bro:type:: Input::Mode

   :Type: :bro:type:`enum`

      .. bro:enum:: Input::MANUAL Input::Mode

      .. bro:enum:: Input::REREAD Input::Mode

      .. bro:enum:: Input::STREAM Input::Mode


.. bro:type:: Input::Reader

   :Type: :bro:type:`enum`

      .. bro:enum:: Input::READER_DEFAULT Input::Reader

      .. bro:enum:: Input::READER_ASCII Input::Reader

      .. bro:enum:: Input::READER_RAW Input::Reader

      .. bro:enum:: Input::READER_BENCHMARK Input::Reader

      .. bro:enum:: Input::READER_BINARY Input::Reader

      .. bro:enum:: Input::READER_SQLITE Input::Reader


.. bro:type:: Log::ID

   :Type: :bro:type:`enum`

      .. bro:enum:: Log::Unknown Log::ID

      .. bro:enum:: Files::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/files/main.bro` is loaded)


         Logging stream for file analysis.

      .. bro:enum:: Reporter::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/reporter/main.bro` is loaded)


      .. bro:enum:: Notice::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/notice/main.bro` is loaded)


         This is the primary logging stream for notices.

      .. bro:enum:: Notice::ALARM_LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/notice/main.bro` is loaded)


         This is the alarm stream.

      .. bro:enum:: Weird::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/notice/weird.bro` is loaded)


      .. bro:enum:: Cluster::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/cluster/main.bro` is loaded)


      .. bro:enum:: DPD::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/dpd/main.bro` is loaded)


      .. bro:enum:: Signatures::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/signatures/main.bro` is loaded)


      .. bro:enum:: PacketFilter::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/packet-filter/main.bro` is loaded)


      .. bro:enum:: Software::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/software/main.bro` is loaded)


      .. bro:enum:: Communication::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/communication/main.bro` is loaded)


      .. bro:enum:: Intel::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/intel/main.bro` is loaded)


      .. bro:enum:: Tunnel::LOG Log::ID

         (present if :doc:`/scripts/base/frameworks/tunnels/main.bro` is loaded)


      .. bro:enum:: Conn::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/conn/main.bro` is loaded)


      .. bro:enum:: DHCP::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/dhcp/main.bro` is loaded)


      .. bro:enum:: DNP3::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/dnp3/main.bro` is loaded)


      .. bro:enum:: DNS::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/dns/main.bro` is loaded)


      .. bro:enum:: FTP::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/ftp/main.bro` is loaded)


      .. bro:enum:: SSL::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/ssl/main.bro` is loaded)


      .. bro:enum:: X509::LOG Log::ID

         (present if :doc:`/scripts/base/files/x509/main.bro` is loaded)


      .. bro:enum:: HTTP::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/http/main.bro` is loaded)


      .. bro:enum:: IRC::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/irc/main.bro` is loaded)


      .. bro:enum:: Modbus::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/modbus/main.bro` is loaded)


      .. bro:enum:: RADIUS::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/radius/main.bro` is loaded)


      .. bro:enum:: SNMP::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/snmp/main.bro` is loaded)


      .. bro:enum:: SMTP::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/smtp/main.bro` is loaded)


      .. bro:enum:: SOCKS::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/socks/main.bro` is loaded)


      .. bro:enum:: SSH::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/ssh/main.bro` is loaded)


      .. bro:enum:: Syslog::LOG Log::ID

         (present if :doc:`/scripts/base/protocols/syslog/main.bro` is loaded)


      .. bro:enum:: Unified2::LOG Log::ID

         (present if :doc:`/scripts/base/files/unified2/main.bro` is loaded)


      .. bro:enum:: Barnyard2::LOG Log::ID

         (present if :doc:`/scripts/policy/integration/barnyard2/main.bro` is loaded)


      .. bro:enum:: AppStats::LOG Log::ID

         (present if :doc:`/scripts/policy/misc/app-stats/main.bro` is loaded)


      .. bro:enum:: CaptureLoss::LOG Log::ID

         (present if :doc:`/scripts/policy/misc/capture-loss.bro` is loaded)


      .. bro:enum:: Traceroute::LOG Log::ID

         (present if :doc:`/scripts/policy/misc/detect-traceroute/main.bro` is loaded)


      .. bro:enum:: Known::DEVICES_LOG Log::ID

         (present if :doc:`/scripts/policy/misc/known-devices.bro` is loaded)


      .. bro:enum:: LoadedScripts::LOG Log::ID

         (present if :doc:`/scripts/policy/misc/loaded-scripts.bro` is loaded)


      .. bro:enum:: Stats::LOG Log::ID

         (present if :doc:`/scripts/policy/misc/stats.bro` is loaded)


      .. bro:enum:: Known::HOSTS_LOG Log::ID

         (present if :doc:`/scripts/policy/protocols/conn/known-hosts.bro` is loaded)


      .. bro:enum:: Known::SERVICES_LOG Log::ID

         (present if :doc:`/scripts/policy/protocols/conn/known-services.bro` is loaded)


      .. bro:enum:: Known::MODBUS_LOG Log::ID

         (present if :doc:`/scripts/policy/protocols/modbus/known-masters-slaves.bro` is loaded)


      .. bro:enum:: Modbus::REGISTER_CHANGE_LOG Log::ID

         (present if :doc:`/scripts/policy/protocols/modbus/track-memmap.bro` is loaded)


      .. bro:enum:: Known::CERTS_LOG Log::ID

         (present if :doc:`/scripts/policy/protocols/ssl/known-certs.bro` is loaded)


      .. bro:enum:: BroxygenExample::LOG Log::ID

         (present if :doc:`/scripts/broxygen/example.bro` is loaded)



.. bro:type:: Log::Writer

   :Type: :bro:type:`enum`

      .. bro:enum:: Log::WRITER_DEFAULT Log::Writer

      .. bro:enum:: Log::WRITER_NONE Log::Writer

      .. bro:enum:: Log::WRITER_ASCII Log::Writer

      .. bro:enum:: Log::WRITER_DATASERIES Log::Writer

      .. bro:enum:: Log::WRITER_SQLITE Log::Writer

      .. bro:enum:: Log::WRITER_ELASTICSEARCH Log::Writer


.. bro:type:: NFS3::createmode_t

   :Type: :bro:type:`enum`

      .. bro:enum:: NFS3::UNCHECKED NFS3::createmode_t

      .. bro:enum:: NFS3::GUARDED NFS3::createmode_t

      .. bro:enum:: NFS3::EXCLUSIVE NFS3::createmode_t


.. bro:type:: NFS3::file_type_t

   :Type: :bro:type:`enum`

      .. bro:enum:: NFS3::FTYPE_REG NFS3::file_type_t

      .. bro:enum:: NFS3::FTYPE_DIR NFS3::file_type_t

      .. bro:enum:: NFS3::FTYPE_BLK NFS3::file_type_t

      .. bro:enum:: NFS3::FTYPE_CHR NFS3::file_type_t

      .. bro:enum:: NFS3::FTYPE_LNK NFS3::file_type_t

      .. bro:enum:: NFS3::FTYPE_SOCK NFS3::file_type_t

      .. bro:enum:: NFS3::FTYPE_FIFO NFS3::file_type_t


.. bro:type:: NFS3::proc_t

   :Type: :bro:type:`enum`

      .. bro:enum:: NFS3::PROC_NULL NFS3::proc_t

      .. bro:enum:: NFS3::PROC_GETATTR NFS3::proc_t

      .. bro:enum:: NFS3::PROC_SETATTR NFS3::proc_t

      .. bro:enum:: NFS3::PROC_LOOKUP NFS3::proc_t

      .. bro:enum:: NFS3::PROC_ACCESS NFS3::proc_t

      .. bro:enum:: NFS3::PROC_READLINK NFS3::proc_t

      .. bro:enum:: NFS3::PROC_READ NFS3::proc_t

      .. bro:enum:: NFS3::PROC_WRITE NFS3::proc_t

      .. bro:enum:: NFS3::PROC_CREATE NFS3::proc_t

      .. bro:enum:: NFS3::PROC_MKDIR NFS3::proc_t

      .. bro:enum:: NFS3::PROC_SYMLINK NFS3::proc_t

      .. bro:enum:: NFS3::PROC_MKNOD NFS3::proc_t

      .. bro:enum:: NFS3::PROC_REMOVE NFS3::proc_t

      .. bro:enum:: NFS3::PROC_RMDIR NFS3::proc_t

      .. bro:enum:: NFS3::PROC_RENAME NFS3::proc_t

      .. bro:enum:: NFS3::PROC_LINK NFS3::proc_t

      .. bro:enum:: NFS3::PROC_READDIR NFS3::proc_t

      .. bro:enum:: NFS3::PROC_READDIRPLUS NFS3::proc_t

      .. bro:enum:: NFS3::PROC_FSSTAT NFS3::proc_t

      .. bro:enum:: NFS3::PROC_FSINFO NFS3::proc_t

      .. bro:enum:: NFS3::PROC_PATHCONF NFS3::proc_t

      .. bro:enum:: NFS3::PROC_COMMIT NFS3::proc_t

      .. bro:enum:: NFS3::PROC_END_OF_PROCS NFS3::proc_t


.. bro:type:: NFS3::stable_how_t

   :Type: :bro:type:`enum`

      .. bro:enum:: NFS3::UNSTABLE NFS3::stable_how_t

      .. bro:enum:: NFS3::DATA_SYNC NFS3::stable_how_t

      .. bro:enum:: NFS3::FILE_SYNC NFS3::stable_how_t


.. bro:type:: NFS3::status_t

   :Type: :bro:type:`enum`

      .. bro:enum:: NFS3::NFS3ERR_OK NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_PERM NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NOENT NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_IO NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NXIO NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_ACCES NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_EXIST NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_XDEV NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NODEV NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NOTDIR NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_ISDIR NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_INVAL NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_FBIG NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NOSPC NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_ROFS NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_MLINK NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NAMETOOLONG NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NOTEMPTY NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_DQUOT NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_STALE NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_REMOTE NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_BADHANDLE NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NOT_SYNC NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_BAD_COOKIE NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_NOTSUPP NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_TOOSMALL NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_SERVERFAULT NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_BADTYPE NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_JUKEBOX NFS3::status_t

      .. bro:enum:: NFS3::NFS3ERR_UNKNOWN NFS3::status_t


.. bro:type:: Tunnel::Type

   :Type: :bro:type:`enum`

      .. bro:enum:: Tunnel::NONE Tunnel::Type

      .. bro:enum:: Tunnel::IP Tunnel::Type

      .. bro:enum:: Tunnel::AYIYA Tunnel::Type

      .. bro:enum:: Tunnel::TEREDO Tunnel::Type

      .. bro:enum:: Tunnel::SOCKS Tunnel::Type

      .. bro:enum:: Tunnel::GTPv1 Tunnel::Type

      .. bro:enum:: Tunnel::HTTP Tunnel::Type


.. bro:type:: dce_rpc_if_id

   :Type: :bro:type:`enum`

      .. bro:enum:: DCE_RPC_unknown_if dce_rpc_if_id

      .. bro:enum:: DCE_RPC_epmapper dce_rpc_if_id

      .. bro:enum:: DCE_RPC_lsarpc dce_rpc_if_id

      .. bro:enum:: DCE_RPC_lsa_ds dce_rpc_if_id

      .. bro:enum:: DCE_RPC_mgmt dce_rpc_if_id

      .. bro:enum:: DCE_RPC_netlogon dce_rpc_if_id

      .. bro:enum:: DCE_RPC_samr dce_rpc_if_id

      .. bro:enum:: DCE_RPC_srvsvc dce_rpc_if_id

      .. bro:enum:: DCE_RPC_spoolss dce_rpc_if_id

      .. bro:enum:: DCE_RPC_drs dce_rpc_if_id

      .. bro:enum:: DCE_RPC_winspipe dce_rpc_if_id

      .. bro:enum:: DCE_RPC_wkssvc dce_rpc_if_id

      .. bro:enum:: DCE_RPC_oxid dce_rpc_if_id

      .. bro:enum:: DCE_RPC_ISCMActivator dce_rpc_if_id


.. bro:type:: dce_rpc_ptype

   :Type: :bro:type:`enum`

      .. bro:enum:: DCE_RPC_REQUEST dce_rpc_ptype

      .. bro:enum:: DCE_RPC_PING dce_rpc_ptype

      .. bro:enum:: DCE_RPC_RESPONSE dce_rpc_ptype

      .. bro:enum:: DCE_RPC_FAULT dce_rpc_ptype

      .. bro:enum:: DCE_RPC_WORKING dce_rpc_ptype

      .. bro:enum:: DCE_RPC_NOCALL dce_rpc_ptype

      .. bro:enum:: DCE_RPC_REJECT dce_rpc_ptype

      .. bro:enum:: DCE_RPC_ACK dce_rpc_ptype

      .. bro:enum:: DCE_RPC_CL_CANCEL dce_rpc_ptype

      .. bro:enum:: DCE_RPC_FACK dce_rpc_ptype

      .. bro:enum:: DCE_RPC_CANCEL_ACK dce_rpc_ptype

      .. bro:enum:: DCE_RPC_BIND dce_rpc_ptype

      .. bro:enum:: DCE_RPC_BIND_ACK dce_rpc_ptype

      .. bro:enum:: DCE_RPC_BIND_NAK dce_rpc_ptype

      .. bro:enum:: DCE_RPC_ALTER_CONTEXT dce_rpc_ptype

      .. bro:enum:: DCE_RPC_ALTER_CONTEXT_RESP dce_rpc_ptype

      .. bro:enum:: DCE_RPC_SHUTDOWN dce_rpc_ptype

      .. bro:enum:: DCE_RPC_CO_CANCEL dce_rpc_ptype

      .. bro:enum:: DCE_RPC_ORPHANED dce_rpc_ptype


.. bro:type:: rpc_status

   :Type: :bro:type:`enum`

      .. bro:enum:: RPC_SUCCESS rpc_status

      .. bro:enum:: RPC_PROG_UNAVAIL rpc_status

      .. bro:enum:: RPC_PROG_MISMATCH rpc_status

      .. bro:enum:: RPC_PROC_UNAVAIL rpc_status

      .. bro:enum:: RPC_GARBAGE_ARGS rpc_status

      .. bro:enum:: RPC_SYSTEM_ERR rpc_status

      .. bro:enum:: RPC_TIMEOUT rpc_status

      .. bro:enum:: RPC_VERS_MISMATCH rpc_status

      .. bro:enum:: RPC_AUTH_ERROR rpc_status

      .. bro:enum:: RPC_UNKNOWN_ERROR rpc_status



