sscan 0.8.0

A scriptable file/process/network scanner
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

-- help.lua - The sscani help subsystem.
--
-- This helper library provides the help() function, which can either
-- display generic help, or detailed information if a topic is selected.

-- This table stores all help information.
sscani_help = {}

-- Individual help topics are stored here.
sscani_help.topics = {}

-- Displayed if no topic is provided.
sscani_help.generic = string.format([[

sscani is an interactive %s REPL for sscan.

The REPL accepts single- or multi-line chunks of Lua code, with the
final line terminated by a semicolon. The REPL then evaluates the
chunk. If the chunk returns a value, sscani will attempt to display it.

GLOBAL FUNCTIONS
================
exit()          - Quits sscani. Alias to os.exit(0).
help(['topic']) - Prints either generic help, or help on 'topic'.
license()       - Prints open-source license information.
version()       - Prints sscan version information.

For information on a specific topic, use help('topic');
To list all available topics, use help('topics');

]], _VERSION)

-- Returns a comma-delimited string of table keys.
function sscani_help.gen_table_keys_csv(table_ref, prepend)
    local table_keys = {}
    for key, _ in pairs(table_ref)
    do
        if prepend ~= nil then
            key = prepend .. key
        end
        table.insert(table_keys, key)
    end
    table.sort(table_keys)
    return table.concat(table_keys, ', ')
end


-- Help for the `about` table.
sscani_help.topics.about = string.format([[

TABLE `about`
============

The `about.*` table contains basic version and license information about
the sscan project. All of these keys should be of a printable type.

For example, to access the current version of sscan, use:

  sscan> about.version

The following items are available:

%s

]], sscani_help.gen_table_keys_csv(about, 'about.'))


-- Help for using the rcfile.
sscani_help.topics.rcfile = [[

SSCANI RCFILE
=============

If you'd like to customize the startup or interaction behavior of
sscani, you can do so with an rcfile. On startup, sscani checks the
following locations:

  - ~/.sscanirc
  - ~/.sscanirc.lua
  - ~/.sscani.rc.lua
  - ~/.config/sscanirc
  - ~/.config/sscanirc.lua
  - ~/.config/sscani.rc.lua

If an rcfile is found at one of those paths, sscani runs it to apply
any customizations the user has made.

To generate a default rcfile, use sscani.mkrcfile(). This
function will create a new rcfile at ~/.sscani.rc.lua

]]


-- Additional context for the help('topics') command.
sscani_help.about_topics = [[
The following topics are available. Use help('topic') to select one:

]]

-- Prints either generic help or a topic.
function help(topic)
    -- Print generic help if no topic was provided.
    if topic == nil then
        io.write(sscani_help.generic)
        io.flush()
        return
    end

    -- Return an error if 'topic' is not a string
    if type(topic) ~= 'string' then
        io.write('Error: if `topic` is provided, it must be a string.\n\n')
        io.flush()
        return
    end

    -- Print a list of topics if requested.
    if topic == 'topics' then
        io.write(sscani_help.about_topics)
        io.write(sscani_help.gen_table_keys_csv(sscani_help.topics) .. '\n\n')
        io.flush()
        return
    end

    -- Otherwise, print help on the specified topic
    local help_topic = sscani_help.topics[topic]
    if help_topic == nil then
        io.write("Couldn't find that topic. List all with help('topics').\n\n")
        io.flush()
        return
    end

    io.write(help_topic)
    io.flush()
end