Class: CEF::Event

Inherits:
Object
  • Object
show all
Defined in:
lib/cef/event.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*params) {|_self| ... } ⇒ Event

so we can CEF::Event.new(:foo=>“bar”)

Yields:

  • (_self)

Yield Parameters:

  • _self (CEF::Event) —

    the object that the method was called on



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/cef/event.rb', line 16

def initialize( *params )
  @event_time         = Time.new
  @deviceVendor       = "breed.org"
  @deviceProduct      = "CEF"
  @deviceVersion      = CEF::VERSION
  @deviceEventClassId = "0:event"
  @deviceSeverity     = CEF::SEVERITY_LOW
  @name               = "unnamed event"
  # used to avoid requiring syslog.h on windoze
  #syslog_pri= Syslog::LOG_LOCAL0 | Syslog::LOG_NOTICE
  @syslog_pri         = 131
  @my_hostname        = Socket::gethostname
  @other_attrs={}
  @additional={}
  Hash[*params].each { |k,v| self.send("%s="%k,v) }
  yield self if block_given?
  self
end

Instance Attribute Details

#event_time ⇒ Object

Returns the value of attribute event_time.



3
4
5
 
# File 'lib/cef/event.rb', line 3

def event_time
  @event_time
end

#my_hostname ⇒ Object

Returns the value of attribute my_hostname.



3
4
5
 
# File 'lib/cef/event.rb', line 3

def my_hostname
  @my_hostname
end

#syslog_pri ⇒ Object

Returns the value of attribute syslog_pri.



3
4
5
 
# File 'lib/cef/event.rb', line 3

def syslog_pri
  @syslog_pri
end

Instance Method Details

#attrs ⇒ Object 



11
12
13
 
# File 'lib/cef/event.rb', line 11

def attrs
  CEF::ATTRIBUTES
end

#escape_extension_value(val) ⇒ Object

only equals signs need to be escaped in the extension. i think. TODO: something in the spec about n and some others.



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/cef/event.rb', line 97

def escape_extension_value(val)
  escapes = {
    %r{=}  => '\=',
    %r{\n} => ' ',
    %r{\\} => '\\'
  }
  escapes.reduce(val) do |memo,replace|
    memo=memo.gsub(*replace)
  end
end

#escape_prefix_value(val) ⇒ Object

escape only pipes and backslashes in the prefix. you bet your sweet ass there’s a lot of backslashes in the substitution. you can thank the three levels of lexical analysis/substitution in the ruby interpreter for that.



86
87
88
89
90
91
92
93
 
# File 'lib/cef/event.rb', line 86

def escape_prefix_value(val)
  escapes={
    %r{(\||\\)} => '\\\\\&'
  }
  escapes.reduce(val) do|memo,replace|
    memo=memo.gsub(*replace)
  end
end

#format_extension ⇒ Object

returns a space-delimeted list of attribute=value pairs for all optionals



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/cef/event.rb', line 118

def format_extension
  extensions = CEF::EXTENSION_ATTRIBUTES.keys.map do |meth|
    value = self.send(meth)
    next if value.nil?
    shortname = CEF::EXTENSION_ATTRIBUTES[meth]
    [shortname, escape_extension_value(value)].join("=")
  end

  # make sure time comes out as milliseconds since epoch
  times = CEF::TIME_ATTRIBUTES.keys.map do |meth|
    value = self.send(meth)
    next if value.nil?
    shortname = CEF::TIME_ATTRIBUTES[meth]
    [shortname, escape_extension_value(value)].join("=")
  end
  (extensions + times).compact.join(" ")
end

#format_prefix ⇒ Object

returns a pipe-delimeted list of prefix attributes



109
110
111
112
113
114
115
 
# File 'lib/cef/event.rb', line 109

def format_prefix
  values = CEF::PREFIX_ATTRIBUTES.keys.map { |k| self.send(k) }
  escaped = values.map do |value|
    escape_prefix_value(value)
  end
  escaped.join('|')
end

#get_additional(k, v) ⇒ Object 



53
54
55
 
# File 'lib/cef/event.rb', line 53

def get_additional(k,v)
  @additional[k]
end

#set_additional(k, v) ⇒ Object

used for non-schema fields



50
51
52
 
# File 'lib/cef/event.rb', line 50

def set_additional(k,v)
  @additional[k]=v
end

#to_s ⇒ Object

returns a cef formatted string



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/cef/event.rb', line 36

def to_s
  log_time=event_time.strftime(CEF::LOG_TIME_FORMAT)
  
  sprintf(
    CEF::LOG_FORMAT,
    syslog_pri.to_s,
    log_time,
    my_hostname,
    format_prefix,
    format_extension
  )
end