Module: IpAuditor

Defined in:
lib/ip_auditor.rb,
lib/ip_auditor/version.rb

Constant Summary collapse

VERSION = 
"0.0.2"

Class Method Summary collapse

Class Method Details

.audit ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/ip_auditor.rb', line 231

def IpAuditor.audit

  # set the options for this instance
  IpAuditor.set_options

  puts "Opening SSH connection to #{@options.server}..."

  begin

    # open an ssh connection
    Net::SSH.start(@options.server, @options.user, {port: @options.port, password: @options.pass}) do |ssh|

      puts "Connection opened! Finding and parsing apache/passenger files (this may take a while)..."

      # find lines of interest in vhosts, assumes location is /etc/apache2/sites-enabled
      domain_text = ssh.exec!("grep -r '<VirtualHost\\|DocumentRoot\\|<Directory\\|ServerName\\|ServerAlias' /etc/apache2/sites-enabled")

      headers = ['Site','Environment','Directory','Gemset','Rails Version','Virtual Host','Site Statuses']

      puts "Parsing the vhosts files ..." if @options.verbose
      site_data = IpAuditor.get_site_information(ssh)




      # output to .csv file
      if !@options.csv.nil? && @options.csv

        puts "Writing to .csv file..." if @options.verbose
        IpAuditor.write_to_csv(headers,site_data)

        puts "File saved to ./IP Audit - #{@options.csv_name}.csv!"


      # output to terminal
      else
        IpAuditor.write_to_terminal(headers,site_data)

      end

    end

    # catch the basic errors
  rescue SocketError => e
    puts "Socket Error! Is your domain name correct?"
  rescue Net::SSH::AuthenticationFailed
    puts "Authentication Error! Did you correctly type in your username and password?"
  rescue Exception => e
    puts "Error! Have you specified the correct port? Or maybe there's a problem with the code..."
  end

end

.check_site_status(domain) ⇒ Object

use nslookup to get the IP of a given domain



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/ip_auditor.rb', line 119

def IpAuditor.check_site_status(domain)
  lookup = `nslookup #{domain}`

  # strip output to IPs only
  output = lookup[/Non-authoritative answer:(.*)/m,1]
  ip = !output.nil? ? output[/Address: (.*)/m,1] : false

  # output IP address or message saying lookup failed
  if ip
    return ip
  else
    return 'DOMAIN LOOKUP FAILED'
  end
end

.get_passenger_file(ssh, file_name) ⇒ Object

get and parse the yaml passenger config file if available, else return false



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ip_auditor.rb', line 72

def IpAuditor.get_passenger_file(ssh,file_name)

  puts "Getting passenger information for #{file_name}..." if @options.verbose

  yaml_file = ssh.exec!("find /etc/passenger.d -name '#{file_name}.yml' -exec cat {} \\;")

  # if blank, return false
  if yaml_file !~ /[^[:space:]]/
    return false
  else
    begin
      content = YAML.load(yaml_file)
    rescue ArgumentError
      return false
    end
  end

end

.get_password ⇒ Object

prompt for and return password



62
63
64
65
66
67
68
69
 
# File 'lib/ip_auditor.rb', line 62

def IpAuditor.get_password
  if STDIN.respond_to?(:noecho)
    puts "Password: "
    STDIN.noecho(&:gets).chomp
  else
    `read -s -p "Password: " password; echo $password`.chomp
  end
end

.get_rails_information(ssh, file_name) ⇒ Object

get the rails information using passenger, or return false



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/ip_auditor.rb', line 101

def IpAuditor.get_rails_information(ssh,file_name)

  rails_info = get_passenger_file(ssh,file_name)

  # only return info if we're looking for this environment. Return false if rails info exists but
  # we should ignore this environment, nil if there is no rails info
  if rails_info && (rails_info['environment'][@options.environment] || @options.environment == 'all')
    rails_info['rails_version'] = get_rails_version(ssh,rails_info['rvm'])
    return rails_info
  elsif rails_info
    return false
  else
    return nil
  end

end

.get_rails_version(ssh, gemset) ⇒ Object

get the rails version for the site, else return nil



92
93
94
95
96
97
 
# File 'lib/ip_auditor.rb', line 92

def IpAuditor.get_rails_version(ssh,gemset)

  puts "Getting the rails version..." if @options.verbose
  rails_version = ssh.exec!("/usr/local/rvm/bin/rvm #{gemset} do gem list")[/\nrails \((.*?)\)\n/,1]

end

.get_site_information(ssh) ⇒ Object

get and compile information from /etc/apache2/sites-enabled



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/ip_auditor.rb', line 135

def IpAuditor.get_site_information(ssh)
  data = []
  current_file_path = '--'
  current_file = nil
  directory = ''
  virtual_host = ''
  domain_statuses = []

  # get all relevant lines from vhost files
  domain_text = ssh.exec!("grep -r '<VirtualHost\\|DocumentRoot\\|<Directory\\|ServerName\\|ServerAlias' /etc/apache2/sites-enabled")

  # parse each line for relevant data
  domain_text.each_line do |line|

    # if we're still looking at the same file, get information
    if line[current_file_path]

      domain = nil

      # if line contains a domain, get its status
      if line[/(ServerName|ServerAlias)(.*)/]
        domain = line[/(ServerName|ServerAlias)(.*)/,2].strip
        domain_statuses << [domain,IpAuditor.check_site_status(domain)]

      elsif line[/<VirtualHost/]
        virtual_host = line[/<VirtualHost (.*)>/,1].strip.split(" ").join(", ")

      elsif line[/DocumentRoot/]
        directory = line[/DocumentRoot\s*?"?(.*)"?/,1]
      end

    else
      # if this is a new file, get rails info and push into data array before resetting variables
      if !(current_file.nil?)
        rails_info = IpAuditor.get_rails_information(ssh,current_file)

        # if it has rails info an dit's for the relavant domains
        if rails_info
          data << [current_file, rails_info['environment'], rails_info['cwd'], rails_info['rvm'], rails_info['rails_version'], virtual_host,domain_statuses].flatten
        elsif rails_info.nil?
          data << [current_file,'',directory,'','',virtual_host,domain_statuses].flatten
        end
      end

      # reset the per-file variables
      current_file_path = line[/(.*?):/,1]
      current_file = current_file_path[/.*\/(.*?\.com$)/,1]
      virtual_host = line[/<VirtualHost/] ? line[/<VirtualHost (.*)>/,1].strip.split(" ").join(", ") : ''
      directory = ''
      domain_statuses = []

    end
  end

  data

end

.set_options ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ip_auditor.rb', line 15

def IpAuditor.set_options
  @options = OpenStruct.new

  @options.verbose = false
  @options.environment = 'all'

  # parse the options passed in through the terminal
  OptionParser.new do |opts|
    opts.banner = 'Usage: ip.auditor.rb [server name/IP] [username] [options]'

    # get the port number
    opts.on('-p', '--port [PORT NUMBER]', 'Port (default is 22)') do |p|
      @options.port = p
    end

    # check whether to output data as csv, possibly get the name
    opts.on('-c', '--csv [FILENAME]', 'Output data as CSV file') do |c|
      @options.csv = true
      @options.csv_name = c =~ /[^[:space:]]/ ? c : nil
    end

    # check whether output more information
    opts.on('-v', '--verbose', 'Print out more information about what\'s happening') do |v|
      @options.verbose = true
    end

    # specify the environment we're checking
    opts.on('-e', '--environment [prod|stage|dev|etc.]', 'Print only the sites that have environment specified in their passenger files (default is all)') do |e|
      @options.environment = e
    end

  end.parse!

  # prompt for password
  @options.pass = IpAuditor.get_password
  puts "\n"

  # set the connection variables
  @options.server = ARGV[0] || ''
  @options.user = ARGV[1] || ''
  @options.port = @options.port || 22
  @options.pass = @options.pass || ''
  @options.csv_name = @options.csv_name || @options.server

end

.write_to_csv(headers, csv_data) ⇒ Object 



194
195
196
197
198
199
200
201
202
 
# File 'lib/ip_auditor.rb', line 194

def IpAuditor.write_to_csv(headers,csv_data)
  require 'csv'
  CSV.open("IP Audit - #{@options.csv_name}.csv", "w") do |csv|
    csv << headers
    csv_data.each do |line|
      csv << line
    end
  end
end

.write_to_terminal(headers, site_data) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ip_auditor.rb', line 204

def IpAuditor.write_to_terminal(headers,site_data)
  last_header_index = headers.length - 1

  site_data.each do |site|

    puts "\n\n============\n#{site[0]}\n============"


    (1...site.length).each do |index|
      if site[index] =~ /[^[:space:]]/

        if !headers[index].nil? && index < last_header_index
          puts "#{headers[index]}: #{site[index]}"

        elsif index == last_header_index
          puts "------------\n#{headers[index]}\n------------"
          puts site[index]
        else
          puts site[index]
        end
      end
    end

  end
end