Class: PassStation::DB

Inherits:
Object
  • Object
show all
Defined in:
lib/pass_station.rb,
lib/pass_station/parse.rb,
lib/pass_station/output.rb,
lib/pass_station/search.rb,
lib/pass_station/source.rb

Overview

Password database handling

Constant Summary collapse

UPSTREAM_DATABASE = 
{
  URL: 'https://raw.githubusercontent.com/ihebski/DefaultCreds-cheat-sheet/main/DefaultCreds-Cheat-Sheet.csv',
  HASH: 'de6a9f7e7ac94fbcd142ec5817efb71d3a0027076266c87ead5158a4960ec708'
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DB

A new instance of Pass Station



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/pass_station.rb', line 32

def initialize
  @storage_location = 'data/'
  @database_name = 'DefaultCreds-Cheat-Sheet.csv'
  @database_path = absolute_db_path
  database_exists?
  @config = {}
  csv_config
  @data = nil
  @search_result = []
end

Instance Attribute Details

#data ⇒ Array<CSV::Row> (readonly)

Get the password database in Array<CSV::Row> format

Returns:

  • (Array<CSV::Row>) —

    pasword database



29
30
31
 
# File 'lib/pass_station.rb', line 29

def data
  @data
end

#database_name ⇒ String

Get / set the password database name

Returns:

  • (String) —

    password database filename. Default to DefaultCreds-Cheat-Sheet.csv.



25
26
27
 
# File 'lib/pass_station.rb', line 25

def database_name
  @database_name
end

#storage_location ⇒ String

Get / set storage location, where will be stored the password database.

Returns:

  • (String) —

    database storage location. Default to data/.



20
21
22
 
# File 'lib/pass_station.rb', line 20

def storage_location
  @storage_location
end

Class Method Details

.check_for_update ⇒ Boolean

Chek if an update is available

Returns:

  • (Boolean) —

    true if there is, false else.



30
31
32
33
34
 
# File 'lib/pass_station/source.rb', line 30

def check_for_update
  file = download_file(UPSTREAM_DATABASE[:URL], Dir.mktmpdir)
  # Same hash = no update
  !check_hash(file, UPSTREAM_DATABASE[:HASH])
end

.check_hash(file, hash) ⇒ Boolean

Check if a file match a SHA256 hash

Parameters:

  • file (String) —

    the path of the file.

  • hash (String) —

    tha SHA256 hash to check against.

Returns:

  • (Boolean) —

    if the hash of the file matched the one provided (true) or not (false).



61
62
63
64
65
66
67
68
 
# File 'lib/pass_station/source.rb', line 61

def check_hash(file, hash)
  if !hash.nil? && File.file?(file)
    computed_h = Digest::SHA256.file(file)
    true if hash.casecmp(computed_h.hexdigest).zero?
  else
    false
  end
end

.download_file(file_url, destination_path, opts = {}) ⇒ String|nil

Download a file.

Parameters:

  • file_url (String) —

    the URL of the file.

  • destination_path (String) —

    the destination path (may overwrite existing file).

  • opts (Hash) (defaults to: {}) —

    the optional downlaod parameters.

Options Hash (opts):

  • :sha256 (String) —

    the SHA256 hash to check, if the file already exist and the hash matches then the download will be skipped.

Returns:

  • (String|nil) —

    the saved file path.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/pass_station/source.rb', line 44

def download_file(file_url, destination_path, opts = {})
  opts[:sha256] ||= nil

  destination_path += '/' unless destination_path[-1] == '/'
  uri = URI(file_url)
  filename = uri.path.split('/').last
  destination_file = destination_path + filename
  # Verify hash to see if it is the latest
  skip_download = check_hash(destination_file, opts[:sha256])
  write_file(destination_file, fetch_file(uri)) unless skip_download
end

.download_upstream(destination_path, opts = {}) ⇒ String|nil

Download upstream password database

Parameters:

  • destination_path (String) —

    the destination path (may overwrite existing file).

  • opts (Hash) (defaults to: {}) —

    the optional downlaod parameters.

Options Hash (opts):

  • :sha256 (String) —

    the SHA256 hash to check, if the file already exist and the hash matches then the download will be skipped.

Returns:

  • (String|nil) —

    the saved file path.



24
25
26
 
# File 'lib/pass_station/source.rb', line 24

def download_upstream(destination_path, opts = {})
  download_file(UPSTREAM_DATABASE[:URL], destination_path, opts)
end

.fetch_file(uri) ⇒ Bytes

Just fetch a file

Parameters:

  • uri (URI) —

    the URI to of the file

Returns:

  • (Bytes) —

    the content of the file



73
74
75
76
77
78
 
# File 'lib/pass_station/source.rb', line 73

def fetch_file(uri)
  res = Net::HTTP.get_response(uri)
  raise "#{file_url} ended with #{res.code} #{res.message}" unless res.is_a?(Net::HTTPSuccess)

  res.body
end

.write_file(destination_file, file_content) ⇒ String

Write a file to disk

Parameters:

  • destination_file (String) —

    the file path where the fiel will be written to disk

  • file_content (String) —

    the content to write in the file

Returns:

  • (String) —

    destination file path



85
86
87
88
89
90
 
# File 'lib/pass_station/source.rb', line 85

def write_file(destination_file, file_content)
  File.open(destination_file, 'wb') do |file|
    file.write(file_content)
  end
  destination_file
end

Instance Method Details

#highlight_found(term, text, sensitive) ⇒ Array<String>

Highlight (colorize) a searched term in the input When used with the search command, it will ignore in which column the search was made, and will instead colorize in every columns.

Parameters:

  • term (String) —

    the searched term

  • text (String) —

    the output in which the colorization must be made

  • sensitive (Boolean) —

    case sensitive or not

Returns:

  • (Array<String>) —

    colorized output



47
48
49
50
51
52
 
# File 'lib/pass_station/output.rb', line 47

def highlight_found(term, text, sensitive)
  text.map do |x|
    rgxp = build_regexp(term, sensitive: sensitive)
    x.gsub(rgxp) { |s| Paint[s, :red] }
  end
end

#output(formatter, data) ⇒ Array<String>

Output the data in the chosen format

Parameters:

  • formatter (String) —

    Engine to use to format the data: table, 'pretty-table', JSON, CSV, YAML

  • data (Array<CSV::Row>)

Returns:

  • (Array<String>) —

    formatted output



18
19
20
21
 
# File 'lib/pass_station/output.rb', line 18

def output(formatter, data)
  # Convert string to class
  Object.const_get("PassStation::Output::#{normalize(formatter)}").format(data)
end

#output_list(formatter) ⇒ Array<String>

Output the data in the chosen format (list command)

Parameters:

  • formatter (String) —

    Engine to use to format the data: table, 'pretty-table', JSON, CSV, YAML

Returns:

  • (Array<String>) —

    formatted output



26
27
28
29
 
# File 'lib/pass_station/output.rb', line 26

def output_list(formatter)
  data_nil?
  output(formatter, @data)
end

#output_search(formatter) ⇒ Array<String>

Output the data in the chosen format (search command)

Parameters:

  • formatter (String) —

    Engine to use to format the data: table, 'pretty-table', JSON, CSV, YAML

Returns:

  • (Array<String>) —

    formatted output



34
35
36
37
38
 
# File 'lib/pass_station/output.rb', line 34

def output_search(formatter)
  return [] if @search_result.empty?

  output(formatter, @search_result)
end

#parse(sort = :productvendor) ⇒ Array<CSV::Row>

Parse, sort and sanitize the password database

Parameters:

  • sort (Symbol) (defaults to: :productvendor) —

    column name to sort by: :productvendor, :username, :password

Returns:

  • (Array<CSV::Row>) —

    table of CSV::Row, each row contains three attributes: :productvendor, :username, :password



28
29
30
31
32
 
# File 'lib/pass_station/parse.rb', line 28

def parse(sort = :productvendor)
  @data = CSV.table(@database_path, **@config).sort_by do |s|
    s[sort].downcase
  end
end

#search(term, col, opts = {}) ⇒ Array<CSV::Row>

Search term in the data table

Parameters:

  • term (String) —

    the searched term

  • col (Symbol) —

    the column to search in: :productvendor | :username | :password | :all (all columns)

Returns:

  • (Array<CSV::Row>) —

    table of CSV::Row, each row contains three attributes: :productvendor, :username, :password

See Also:

  • for +opts+ param description


13
14
15
16
17
18
19
20
 
# File 'lib/pass_station/search.rb', line 13

def search(term, col, opts = {})
  r1 = prepare_search(term, opts)
  condition = column_selector(col, r1)
  @data.each do |row|
    @search_result.push(row) if condition.call(row)
  end
  @search_result
end