SN0INT(1)

NAME
sn0int - Semi-automatic OSINT framework and package manager

todo

RUNNING YOUR FIRST INVESTIGATION

This page is going to guide you through the process of setting up your environment and running your first investigation.

  Installing the default modules

By default, sn0int doesn't have any modules installed. If you start up sn0int it's going to download some files that it needs and then suggests to install a number of recommended modules:

    $ sn0int
                       ___/           .
         ____ , __   .'  /\ ` , __   _/_
        (     |'  `. |  / | | |'  `.  |
        `--.  |    | |,'  | | |    |  |
       \___.' /    | /`---' / /    |  \__/
            osint | recon | security
          irc.hackint.org:6697/#sn0int
    [+] Connecting to database
    [+] Downloading public suffix list
    [+] Downloading "GeoLite2-City.mmdb"
    [+] Downloading "GeoLite2-ASN.mmdb"
    [+] Loaded 0 modules
    [*] No modules found, run pkg quickstart to install default modules
    [sn0int][default] >

Typing pkg quickstart is going to get you a fair number of featured modules:

    [sn0int][default] > pkg quickstart
    [+] Installing kpcyrd/asn
    [+] Installing kpcyrd/ctlogs
    [+] Installing kpcyrd/dns-resolve
    [+] Installing kpcyrd/geoip
    [+] Installing kpcyrd/hackertarget-subdomains
    [+] Installing kpcyrd/otx-subdomains
    [+] Installing kpcyrd/passive-spider
    [+] Installing kpcyrd/pgp-keyserver
    [+] Installing kpcyrd/threatminer-ipaddr
    [+] Installing kpcyrd/threatminer-subdomains
    [+] Installing kpcyrd/url-scan
    [+] Installing kpcyrd/waybackurls
    [+] Loaded 12 modules
    [sn0int][default] >

  Adding something to scope

You probably want to separate your investigations so you should select a workspace where your results should go:

    [sn0int][default] > workspace demo
    [+] Connecting to database
    [sn0int][demo] >

Next, we have to start somewhere and add the first entity to our scope:

    [sn0int][demo] > add domain
    Domain: example.com
    [sn0int][demo] >

Note: There is a concept of a domain vs a subdomain. We are referring to a domain as everything that is a subdomain of a public suffix <https://publicsuffix.org/>. For example, .com is a public suffix, which makes example.com a domain in sn0int terms. Every subdomain of that, like www.example.com, is referred to as a subdomain.

Note that example.com can be added as a subdomain as well since it can hold records. In that case, example.com is both the name of the dns zone, while also being an entity in that zone.

You can confirm this by running a select on the domains we now have:

    [sn0int][demo] > select domains
    #1, "example.com"
    [sn0int][demo] >

Something we don't need right now, but is going to be useful later on is the ability to filter your entities:

    [sn0int][demo] > select domains where id=1
    #1, "example.com"
    [sn0int][demo] >
    [sn0int][demo] > select domains where value like %.com
    #1, "example.com"
    [sn0int][demo] >
    [sn0int][demo] > select domains where ( value like e% and value like %m ) or false
    #1, "example.com"
    [sn0int][demo] >

Note: Almost all entities have a value column that holds the primary value of the entity.

  Running a module

Now that we have something to get started with, we can run our first module. First lets list all modules we have:

    [sn0int][demo] > pkg list
    kpcyrd/asn (0.1.0)
        Run a asn lookup for an ip address
    kpcyrd/ctlogs (0.1.0)
        Query certificate transparency logs to discover subdomains
    kpcyrd/dns-resolve (0.1.0)
        Query subdomains to discovery ip addresses and verify the record is visible
    kpcyrd/geoip (0.1.0)
        Run a geoip lookup for an ip address
    kpcyrd/hackertarget-subdomains (0.1.0)
        Query hackertarget for subdomains of a domain
    kpcyrd/otx-subdomains (0.1.0)
        Query alienvault otx passive dns for subdomains of a domain
    kpcyrd/passive-spider (0.1.0)
        Scrape known http responses for urls
    kpcyrd/pgp-keyserver (0.1.0)
        Query pgp keyserver for email addresses
    kpcyrd/threatminer-ipaddr (0.1.0)
        Query ThreatMiner passive dns for subdomains of an ip address
    kpcyrd/threatminer-subdomains (0.1.0)
        Query ThreatMiner passive dns for subdomains of a domain
    kpcyrd/url-scan (0.1.0)
        Scan subdomains for websites
    kpcyrd/waybackurls (0.1.0)
        Discover subdomains from wayback machine
    [sn0int][demo] >

Let's start by querying certificate transparency logs:

    [sn0int][demo] > use ctlogs
    [sn0int][demo][kpcyrd/ctlogs] > run
    [*] "example.com"                                     : Subdomain: "www.example.com"
    [*] "example.com"                                     : Subdomain: "m.example.com"
    [*] "example.com"                                     : Subdomain: "dev.example.com"
    [*] "example.com"                                     : Subdomain: "products.example.com"
    [*] "example.com"                                     : Subdomain: "support.example.com"
    [+] Finished kpcyrd/ctlogs
    [sn0int][demo][kpcyrd/ctlogs] >

Looks like we've discovered some subdomains here. It might be tempting to throw some of them in a browser but hold on, there's a more efficient way to approach this.

Hint: You can run the modules concurrently with run -j3.

  Running followup modules on the results

A lot of time has been spent on the database part. While it sort of feels like a no-sql database we are actually enforcing a schema for a reason instead of just using generic dictionaries and calling it a day.

It's crucial that entities created by one module can be picked up by another module, like LEGOs. Let's continue with a module to query the dns records:

    [sn0int][demo][kpcyrd/ctlogs] > use dns-resolve
    [sn0int][demo][kpcyrd/dns-resolve] > run
    [*] "www.example.com"                                 : Updating "www.example.com" (resolvable => true)
    [*] "www.example.com"                                 : IpAddr: 93.184.216.34
    [*] "www.example.com"                                 : "www.example.com" -> 93.184.216.34
    [*] "m.example.com"                                   : Updating "m.example.com" (resolvable => false)
    [*] "dev.example.com"                                 : Updating "dev.example.com" (resolvable => false)
    [*] "products.example.com"                            : Updating "products.example.com" (resolvable => false)
    [*] "support.example.com"                             : Updating "support.example.com" (resolvable => false)
    [+] Finished kpcyrd/dns-resolve
    [sn0int][demo][kpcyrd/dns-resolve] >

Two things happened here: We've discovered some IP addresses and added them to scope, and we also updated our subdomain entities with new information, since we now know which of them are resolvable and which aren't.

Let's run the next module, which is actually going to check for websites on them, but let's only target subdomains that we know are resolvable:

    [sn0int][demo][kpcyrd/dns-resolve] > use url-scan
    [sn0int][demo][kpcyrd/url-scan] > target
    #1, "www.example.com"
        93.184.216.34
    #2, "m.example.com"
    #3, "dev.example.com"
    #4, "products.example.com"
    #5, "support.example.com"
    [sn0int][demo][kpcyrd/url-scan] > target where resolvable
    [+] 1 entities selected
    [sn0int][demo][kpcyrd/url-scan] > target
    #1, "www.example.com"
        93.184.216.34
    [sn0int][demo][kpcyrd/url-scan] >

We can both preview and limit the targets that are going to be passed to the module with the target command. Once we are satisfied with our selection we can run this module:

    [sn0int][demo][kpcyrd/url-scan] > run
    [*] "www.example.com"                                 : Url: "http://www.example.com/" (200)
    [*] "www.example.com"                                 : Url: "https://www.example.com/" (200)
    [+] Finished kpcyrd/url-scan
    [sn0int][demo][kpcyrd/url-scan] >

We've now probed both port 80 and port 443 for each subdomain and found two http responses this way. If you want a list of urls you may want to visit in your browser can now query them:

    [sn0int][demo][kpcyrd/url-scan] > select urls
    #1, "http://www.example.com/" (200)
    #2, "https://www.example.com/" (200)
    [sn0int][demo][kpcyrd/url-scan] >

  Unscoping entities

Something you are going to run into is that modules are too greedy and add things to the scope we are not interested in. You can delete them using the delete command, but those are likely picked up by a module again.

What you can do instead is setting a flag on an entity that removes it from our scope. This is done using the noscope command:

    [sn0int][demo] > use ctlogs
    [sn0int][demo][kpcyrd/ctlogs] > target
    #1, "example.com"
    [sn0int][demo][kpcyrd/ctlogs] > add domain
    Domain: google.com
    [sn0int][demo][kpcyrd/ctlogs] > target
    #1, "example.com"
    #2, "google.com"
    [sn0int][demo][kpcyrd/ctlogs] > noscope domains where value=google.com
    [+] Updated 1 rows
    [sn0int][demo][kpcyrd/ctlogs] > target
    #1, "example.com"
    [sn0int][demo][kpcyrd/ctlogs] >

Entities that are unscoped are automatically ignored by all modules.

You can reverse this using the scope command:

    [sn0int][demo][kpcyrd/ctlogs] > target
    #1, "example.com"
    [sn0int][demo][kpcyrd/ctlogs] > scope domains where true
    [+] Updated 2 rows
    [sn0int][demo][kpcyrd/ctlogs] > target
    #1, "example.com"
    #2, "google.com"
    [sn0int][demo][kpcyrd/ctlogs] >

Hint: All entities have this field, you can refer to it in queries using unscoped=1.

CONFIGURATION

This section documents the config file. By default this file does not exist and a default configuration is used instead.

Linux/BSD
    ~/.config/sn0int.toml

OSX ~/Library/Preferences/sn0int.toml

Windows
    %APPDATA%/sn0int.toml

  [core]

registry
    Configure the registry you want to use. Defaults to https://sn0int.com.

no-autoupdate
    sn0int is going to check if your modules are outdated during startout once a week. Set this option to true to disable this.

  [namespaces]

By default sn0int modules are assumed to be installed from the registry. You may want to keep a local directory with private modules, especially during development. You can configure a folder that contains modules that aren't managed by sn0int by adding a namespace section to the config file:

    [namespaces]
    foo = "/opt/sn0int/foo"
    bar = "~/repos/a/b/c/sn0int-modules"

This is going to load modules from these two folders and register them in the foo and bar namespace.

Note that sn0int is also going to assume that symlinks in ~/.local/share/sn0int/modules and folders containing a .git folder are externally managed.

  [network]

To enable a proxy, add the following to your config file:

    [network]
    proxy = "127.0.0.1:9050"

This forces everything through tor (or any other socks5 proxy) and restricts all other functions that depend on the network. For example the dns function is fully disabled if a proxy is configured.

FUNCTION REFERENCE

  asn_lookup

Run an ASN lookup for a given ip address. The function returns asn and as_org. This function may fail.

    lookup = asn_lookup('1.1.1.1')
    if last_err() then return end

  base64_decode

Decode a base64 string with the default alphabet+padding.

    base64_decode("ww==")

  base64_encode

Encode a binary array with base64 and the default alphabet+padding.

    base64_encode("\x00\xff")

  base64_custom_decode

Decode a base64 string with custom alphabet+padding.

    -- base64
    base64_custom_decode('b2hhaQ==', 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/', '=')
    -- base64 no padding
    base64_custom_decode('b2hhaQ', 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/', '')
    -- base64 url safe
    base64_custom_decode('b2hhaQ==', 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_', '=')

  base64_custom_encode

Encode a binary array with base64 and custom alphabet+padding.

    -- base64
    base64_custom_encode('ohai', 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/', '=')
    -- base64 no padding
    base64_custom_encode('ohai', 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/', '')
    -- base64 url safe
    base64_custom_encode('ohai', 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_', '=')

  base32_custom_decode

Decode a base32 string with custom alphabet+padding.

    -- rfc-4648 base32
    base32_custom_decode('N5UGC2I=', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567', '=')
    -- z-base-32
    base32_custom_decode('p7wgn4e', 'ybndrfg8ejkmcpqxot1uwisza345h769', '')

  base32_custom_encode

Encode a binary array with base32 and custom alphabet+padding.

    -- rfc-4648 base32
    x = base32_custom_encode('ohai', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567', '=')
    -- z-base-32
    x = base32_custom_encode('ohai', 'ybndrfg8ejkmcpqxot1uwisza345h769', '')

  clear_err

Clear the last recorded error from the internal state. See also last_err.

    if last_err() then
        -- ignore this error
        clear_err()
    end

  create_blob

Push a byte array into persistent blob storage. This allows passing those bytes to functions operating on blob storage. Returns a blob identifier that is deterministic based on the blob content. Blobs are immutable.

    blob = create_blob("some bytes")
    debug(blob)

  datetime

Return current time in UTC. This function is suitable to determine datetimes for DATETIME database fields.

    now = datetime()

Note: This format is sn0int specific, to get the current time for scripting use time_unix instead.

Warning: This function is going to be deprecated at some point. Prefer sn0int_time for new scripts.

  db_add

Add an entity to the database or update it if it already exists. This function may fail or return nil. See db_add <database.html#db-add> for details.

    domain_id = db_add('domain', {
        value='example.com',
    })

  db_add_ttl

Add a temporary entity to the database. This is commonly used to insert temporary links that automatically expire over time. If the entity already exists and is also marked as temporary the new ttl is going to replace the old ttl. If the entity already exists but never expires we are not going to add a ttl.

    -- this link is valid for 2min
    domain_id = db_add_ttl('network-device', {
        network_id=1,
        device_id=13,
    }, 120)

  db_activity

Log an activity event. A basic event looks like this:

    db_activity({
        topic='harness/activity-ping:dummy',
        time=sn0int_time(),
        content={
            a='b',
            foo={
                bar=1337,
            },
            msg='ohai',
        },
    })

This function is explained in detail in the activity <activity.html> section.

  db_select

Checks if a target is in scope. If non-nil is returned, this entity is in scope. This function may fail. See db_select <database.html#db-select> for details.

    domain_id = db_select('domain', 'example.com')
    if domain_id ~= nil then
        -- do something
    end

  db_update

Update an entity in the database. This function may fail. See db_update <database.html#db-update> for details.

    db_update('ipaddr', arg, {
        asn=lookup['asn'],
        as_org=lookup['as_org'],
    })

  dns

Resolve a dns record. If the dns query was successful and the dns reply is NoError then x['error'] is nil. The records of the reply are in x['answers']. This function may fail.

This function accepts the following options:

record
    The query_type, can be any of A, AAAA, MX, AXFR, etc.

nameserver
    The server that should be used for the lookup. Defaults to your system resolver.

tcp If the lookup should use tcp, true/false.

timeout
    The time until the query times out in milliseconds.

        records = dns('example.com', {
            record='A',
        })
        if last_err() then return end
        if records['error'] ~= nil then return end
        records = records['answers']

    Note: DNS replies with an error code set are not causing a change to last_err(). You have to test for this explicitly.

    Note: This function is unavailable if a socks5 proxy is configured.

  error

Log an error to the terminal.

    error('ohai')

  geoip_lookup

Run a geoip lookup for a given ip address. The function returns:

•   continent

•   continent_code

•   country

•   country_code

•   city

•   latitude

•   longitude

    This function may fail.

        lookup = geoip_lookup('1.1.1.1')
        if last_err() then return end

  hex

Hex encode a list of bytes.

    hex("\x6F\x68\x61\x69\x0A\x00")

  hmac_md5

Calculate an hmac with md5. Returns a binary array.

    hmac_md5("secret", "my authenticated message")

  hmac_sha1

Calculate an hmac with sha1. Returns a binary array.

    hmac_sha1("secret", "my authenticated message")

  hmac_sha2_256

Calculate an hmac with sha2_256. Returns a binary array.

    hmac_sha2_256("secret", "my authenticated message")

  hmac_sha2_512

Calculate an hmac with sha2_512. Returns a binary array.

    hmac_sha2_512("secret", "my authenticated message")

  hmac_sha3_256

Calculate an hmac with sha3_256. Returns a binary array.

    hmac_sha3_256("secret", "my authenticated message")

  hmac_sha3_512

Calculate an hmac with sha3_512. Returns a binary array.

    hmac_sha3_512("secret", "my authenticated message")

  html_select

Parses an html document and returns the first element that matches the css selector. The return value is a table with text being the inner text and attrs being a table of the elements attributes.

    csrf = html_select(html, 'input[name="csrf"]')
    token = csrf["attrs"]["value"]

  html_select_list

Same as html_select but returns all matches instead of the first one.

    html_select_list(html, 'input[name="csrf"]')

  http_mksession

Create a session object. This is similar to requests.Session in python-requests and keeps track of cookies.

    session = http_mksession()

  http_request

Prepares an http request. The first argument is the session reference and cookies from that session are copied into the request. After the request has been sent, the cookies from the response are copied back into the session.

The next arguments are the method, the url and additional options. Please note that you still need to specify an empty table {} even if no options are set. The following options are available:

query
    A map of query parameters that should be set on the url.

headers
    A map of headers that should be set.

basic_auth
    Configure the basic auth header with {"user, "password"}.

user_agent
    Overwrite the default user agent with a string.

json
    The request body that should be json encoded.

form
    The request body that should be form encoded.

follow_redirects
    Automatically follow redirects, up to the specified number. If set to 1, only one redirect is going to be followed. Defaults to 0 so redirects aren't followed.

body
    The raw request body as string.

into_blob
    If true, the response body is stored in blob storage and a blob reference is returned as blob instead of the full body.

proxy
    Use a socks5 proxy in the format 127.0.0.1:9050. This option only works if it doesn't conflict with the global proxy settings.

binary
    Set to true to get the http response as raw bytes.

    This function may fail.

        req = http_request(session, 'POST', 'https://httpbin.org/post', {
            json={
                user=user,
                password=password,
            }
        })
        resp = http_send(req)
        if last_err() then return end
        if resp['status'] ~= 200 then return 'http status error: ' .. resp['status'] end

  http_send

Send the request that has been built with http_request. Returns a table with the following keys:

status
    The http status code

headers
    A table of headers

text
    The response body as string

binary
    The response body as bytes (if binary=true)

blob
    If into_blob was enabled for the request the body is downloaded into blob storage with a reference to the body in this field.

        req = http_request(session, 'POST', 'https://httpbin.org/post', {
            json={
                user=user,
                password=password,
            }
        })
        resp = http_send(req)
        if last_err() then return end
        if resp['status'] ~= 200 then return 'http status error: ' .. resp['status'] end

  http_fetch

This does an http_send and also automatically validate the status code.

Note: You almost always want this when setting the into_blob option since this function validates the status code before inserting the response body into blob storage.

    -- short form
    data = http_fetch(req)
    if last_err() then return end
    -- long form
    resp = http_send(req)
    if last_err() then return end
    if resp['status'] ~= 200 then return 'http status error: ' .. resp['status'] end

  http_fetch_json

Identical to http_fetch but also automatically parses the response body as json.

    -- short form
    data = http_fetch_json(req)
    if last_err() then return end
    -- long form
    resp = http_send(req)
    if last_err() then return end
    if resp['status'] ~= 200 then return 'http status error: ' .. resp['status'] end
    data = json_decode(resp['text'])
    if last_err() then return end

  img_load

Attempt to decode a blob as an image and return some basic metadata like the mime type, height and width.

    img = img_load(blob)
    if last_err() then return end
    debug(img)

  img_exif

Extract exif metadata from an image.

    exif = img_exif(blob)
    if last_err() then return end
    debug(exif)

  img_ahash

Calculate the Mean (aHash) perceptual hash.

    hash = img_ahash(blob)
    if last_err() then return end
    debug(hash)

  img_dhash

Calculate the Gradient (dHash) perceptual hash.

    hash = img_dhash(blob)
    if last_err() then return end
    debug(hash)

  img_phash

Calculate the DCT (pHash) perceptual hash.

    hash = img_phash(blob)
    if last_err() then return end
    debug(hash)

  img_nudity

Classify an image for nudity. The score goes from 0 to 2. A score above 1 means nudity has been detected.

    nudity = img_nudity(blob)
    if last_err() then return end
    debug(nudity)

  info

Log an info to the terminal.

    info('ohai')

  intval

Parse a number from a string. x = strval('1234')

  json_decode

Decode a lua value from a json string.

    json_decode("{\"data\":{\"password\":\"fizz\",\"user\":\"bar\"},\"list\":[1,3,3,7]}")

  json_decode_stream

Very similar to json_decode, but works with multiple json objects directly concatenated to each other or separated by newlines.

    json_decode_stream("{\"data\":1}{\"data\":2}")

  json_encode

Encode a datastructure into a string.

    x = json_encode({
        some=1,
        fancy={
            data='structures',
        }
    })
    print(x)

  key_trunc_pad

Truncate/pad a key to a given length.

    -- if longer than 32 bytes: truncate to 32
    -- if shorter than 32 bytes: pad with \x00
    local key = key_trunc_pad(password, 32, 0)

  keyring

Request all keys from a given namespace. See the keyring <keyring.html> section for details.

    creds = keyring('aws')
    print(creds[1]['accesskey'])
    print(creds[1]['secretkey'])

  last_err

Returns infos about the last error we've observed, if any. Returns nil otherwise.

    if last_err() then
        -- Something went wrong, abort
        return
    end

  md5

Hash a byte array with md5 and return the results as bytes.

    hex(md5("\x00\xff"))

  mqtt_connect

Connect to an mqtt broker.

    local sock = mqtt_connect('mqtts://mqtt.example.com', {
        username='foo',
        password='secret',
    })
    if last_err() then return end

  mqtt_subscribe

Subscribe to a topic. Right now only QoS 0 is supported.

    mqtt_subscribe(sock, '#', 0)
    if last_err() then return end

  mqtt_recv

Receive an mqtt packet. This is not necessarily a publish packet and more packets might be added in the future, so you need to check the type specifically.

If a read timeout has been set with mqtt_connect this function returns nil in case of a read timeout.

    local pkt = mqtt_recv(sock)
    if last_err() then return end
    if pkt == nil then
        -- read timeout, consider sending a ping or disconnect if the previous ping failed
    elseif pkt['type'] == 'pong' then
        -- broker sent a pong
    elseif pkt['type'] == 'publish' then
        local payload = utf8_decode(pkt['body'])
        if last_err() then return end
        info(payload)
    end

  mqtt_ping

Send a pingreq packet, causing the broker to send a pingresp. This is used to make sure the connection is still working correctly.

    mqtt_ping(sock)
    if last_err() then return end

  pgp_pubkey

Same as pgp_pubkey_armored, but without the unarmor step.

  pgp_pubkey_armored

Extract uids, sigs and the fingerprint out of an rfc 4880 pgp public key. This function may fail.

    key = pgp_pubkey_armored([===[
    -----BEGIN PGP PUBLIC KEY BLOCK-----
    Version: GnuPG v2
    vA==
    =kRIv
    -----END PGP PUBLIC KEY BLOCK-----
    ]===])
    if last_err() then return end
    print(key)

  print

Write something directly to the terminal.

    print({
        some=1,
        fancy={
            data='structures',
        }
    })

Warning: This function writes directly to the terminal and can interfere with other terminal features. This function should be used during development only.

  psl_domain_from_dns_name

Returns the parent domain according to the public suffix list. For www.a.b.c.d.example.co.uk this is going to be example.co.uk.

    domain = psl_domain_from_dns_name('www.a.b.c.d.example.co.uk')
    print(domain == 'example.co.uk')

  ratelimit_throttle

Create a ratelimit that can only be passed x times every y milliseconds. This limit is global for a single run and also works with threads.

    -- allow this to pass every 250ms
    ratelimit_throttle('foo', 1, 250)
    -- allow this to pass not more than 4 times per second
    ratelimit_throttle('foo', 4, 1000)

This is useful if you need to coordinate your executions to stay below a certain request threshold.

  regex_find

Apply a regex to some text. Returns nil if the regex didn't match and the capture groups if it did.

    m = regex_find(".(.)", "abcdef")
    if m == nil then
        print('No captures')
    end
    print(m[1] == 'ab')
    print(m[2] == 'b')

  regex_find_all

Same as regex_find, but returns all matches.

    m = regex_find_all(".(.)", "abcdef")
    print(m[1][1] == 'ab')
    print(m[1][2] == 'b')
    print(m[2][1] == 'cd')
    print(m[2][2] == 'd')
    print(m[3][1] == 'ef')
    print(m[3][2] == 'f')

  semver_match

Compare a version to a version requirement. This can be used with sn0int_version to test for certain features or behavior.

    semver_match('=0.11.2', sn0int_version())
    semver_match('>0.11.2', sn0int_version())
    semver_match('<0.11.2', sn0int_version())
    semver_match('~0.11.2', sn0int_version())
    semver_match('^0.11.2', sn0int_version())
    semver_match('0.11.2', sn0int_version()) -- synonym for ^0.11.2
    semver_match('<=0.11.2', sn0int_version())
    semver_match('>=0.11.2', sn0int_version())
    semver_match('>=0.4.0, <=0.10.0', sn0int_version())

  set_err

Manipulate the global error object. If you want to exit the main run function with an error you can simply return a string, but those are difficult to propagate through functions. set_err specifically assigns an error to the global error object that are also used by all other rust functions.

    function foo()
        set_err("something failed")
    end
    foo()
    if last_err() then return end

  sha1

Hash a byte array with sha1 and return the results as bytes.

    hex(sha1("\x00\xff"))

  sha2_256

Hash a byte array with sha2_256 and return the results as bytes.

    hex(sha2_256("\x00\xff"))

  sha2_512

Hash a byte array with sha2_512 and return the results as bytes.

    hex(sha2_512("\x00\xff"))

  sha3_256

Hash a byte array with sha3_256 and return the results as bytes.

    hex(sha3_256("\x00\xff"))

  sha3_512

Hash a byte array with sha3_512 and return the results as bytes.

    hex(sha3_512("\x00\xff"))

  sleep

Pause the current program for the specified number of seconds. This is usually only used for debugging.

    sleep(1)

  sn0int_time

Return current time in UTC. This function is suitable to determine datetimes for DATETIME database fields.

    now = sn0int_time()

Note: This format is sn0int specific, to get the current time for scripting use time_unix instead.

  sn0int_time_from

Identical to sn0int_time but uses a unix timestamp in seconds instead of the current time. This function is compatible with time_unix and strptime.

    time = sn0int_time_from(1567931337)

  sn0int_version

Get the current sn0int version string. This can be used with semver_match to test for certain features or behavior.

    info(sn0int_version())

  sock_connect

Create a tcp connection.

The following options are available:

tls Set to true to enable tls (certificates are validated)

sni_value
    Instead of the host argument, use a custom string for the sni extension.

disable_tls_verify
    Danger: disable tls verification. This disables all security on the connection. Note that sn0int is still rather strict, you're going to run into issues if you need support for insecure ciphers.

proxy
    Use a socks5 proxy in the format 127.0.0.1:9050. This option only works if it doesn't conflict with the global proxy settings.

connect_timeout
    Abort tcp connection attempts after n seconds.

read_timeout
    Abort read attempts after n seconds. This can be used to wake up connections periodically.

write_timeout
    Abort write attempts after n seconds.

        sock = sock_connect("127.0.0.1", 1337, {
            tls=true,
        })

  sock_upgrade_tls

Take an existing tcp connection and start a tls handshake. The options are the same as sock_connect but the tls value is always assumed to be true.

The sni value needs to be set specifically, otherwise the sni extension is disabled.

Using this function specifically returns some extra information that is discarded when using sock_connect directly with tls=true.

    sock = sock_connect("127.0.0.1", 1337, {})
    if last_err() then return end
    tls = sock_upgrade_tls(sock, {
        sni_value='example.com',
    })
    if last_err() then return end
    info(tls)

  sock_options

Update options of an existing connection:

read_timeout
    Abort read attempts after n seconds. This can be used to wake up connections periodically.

write_timeout
    Abort write attempts after n seconds.

        sock_options(sock, {
            read_timeout=3,
        })

  sock_send

Send data to the socket.

    sock_send(sock, "hello world")

  sock_recv

Receive up to 4096 bytes from the socket.

    x = sock_recv(sock)

  sock_sendline

Send a string to the socket. A newline is automatically appended to the string.

    sock_sendline(sock, line)

  sock_recvline

Receive a line from the socket. The line includes the newline.

    x = sock_recvline(sock)

  sock_recvall

Receive all data from the socket until EOF.

    x = sock_recvall(sock)

  sock_recvline_contains

Receive lines from the server until a line contains the needle, then return this line.

    x = sock_recvline_contains(sock, needle)

  sock_recvline_regex

Receive lines from the server until a line matches the regex, then return this line.

    x = sock_recvline_regex(sock, "^250 ")

  sock_recvn

Receive exactly n bytes from the socket.

    x = sock_recvn(sock, 4)

  sock_recvuntil

Receive until the needle is found, then return all data including the needle.

    x = sock_recvuntil(sock, needle)

  sock_sendafter

Receive until the needle is found, then write data to the socket.

    sock_sendafter(sock, needle, data)

  sock_newline

Overwrite the default \n newline.

    sock_newline(sock, "\r\n")

  sodium_secretbox_open

Use authenticated symetric crypto to decrypt a given message.

Internally this is crypto_secretbox_xsalsa20poly1305.

The key must be 32 bytes, see key_trunc_pad if necessary.

The first 24 bytes of the encrypted message are expected to be the nonce.

    plain = sodium_secretbox_open(encrypted, key)
    if last_err() then return end
    txt = utf8_decode(plain)
    if last_err() then return end
    info(txt)

  status

Update the label of the progress indicator.

    status('ohai')

  stdin_readline

Read a line from stdin. The final newline is not removed.

    stdin_readline()

Note: This only works with sn0int run --stdin.

  stdin_read_to_end

Read stdin until EOF as a utf-8 string.

    stdin_read_to_end()

Note: This only works with sn0int run --stdin.

  str_find

Returns the byte index of the first character that matches the pattern. This is explicitly a literal match instead of a lua pattern.

If no match is found, returns nil.

    x = str_find('asdf', 'sd')
    print(x == 2)

  str_replace

Replaces all matches of a pattern in a string. This is explicitly a literal match instead of a lua pattern.

If no match is found, an unmodified copy is returned.

    x = str_replace('this is old', 'old', 'new')
    print(x == 'this is new')

  strftime

Format a timestamp generated with time_unix into a date, see strftime rules <https://docs.rs/chrono/0.4.6/chrono/format/strftime/index.html>.

    t = strftime('%d/%m/%Y %H:%M', 1558584994)

  strptime

Parse a date into a unix timestamp, see strftime rules <https://docs.rs/chrono/0.4.6/chrono/format/strftime/index.html>.

    t = strptime('%d/%m/%Y %H:%M', '23/05/2019 04:16')

  strval

Convert a number into a string. x = strval(1234)

  time_unix

Get the current time as seconds since January 1, 1970 0:00:00 UTC, also known as UNIX timestamp. This timestamp can be formated using strftime.

    now = time_unix()

  url_decode

Parse a query string into a map. For raw percent decoding see url_unescape.

    v = url_decode('a=b&c=d')
    print(v['a'] == 'b')
    print(v['c'] == 'd')

  url_encode

Encode a map into a query string. For raw percent encoding see url_escape.

    v = url_encode({
        a='b',
        c='d',
    })
    print(v == 'a=b&c=d')

  url_escape

Apply url escaping to a string.

    v = url_escape('foo bar?')
    print(v == 'foo%20bar%3F')

  url_join

Join a relative link to an absolute link. If both links are absolute we just return the first one:

    x = url_join('https://example.com/x', '/foo')
    print(x == 'https://example.com/foo')
    x = url_join('https://example.com/x', 'https://github.com/')
    print(x == 'https://github.com/')

  url_parse

Parse a url into its components. The following components are returned:

•   scheme

•   host

•   port

•   path

•   query

•   fragment

•   params

        url = url_parse('https://example.com')
        print(url['scheme'] == 'https')
        print(url['host'] == 'example.com')
        print(url['path'] == '/')

  url_unescape

Remove url escaping of a string.

    v = url_unescape('foo%20bar%3F')
    print(v == 'foo bar?')

  utf8_decode

Decodes a list of bytes/numbers into a string. This function might fail.

    x = utf8_decode({65, 65, 65, 65})
    if last_err() then return end
    print(x == 'AAAA')

  warn

Log a warning to the terminal.

    warn('ohai')

  warn_once

Log a warning to the terminal once. This can be used to print a warning to the user without printing the same warning for each struct we're processing during a run execution.

    warn_once('ohai')
    warn_once('ohai')

  ws_connect

Create a websocket connection. The url format is ws://example.com/asdf, wss:// is also supported.

The following options are available:

headers
    A map of additional headers that should be set for the request.

proxy
    Use a socks5 proxy in the format 127.0.0.1:9050. This option only works if it doesn't conflict with the global proxy settings.

connect_timeout
    Abort tcp connection attempts after n seconds.

read_timeout
    Abort read attempts after n seconds. This can be used to wake up connections periodically.

write_timeout
    Abort write attempts after n seconds.

        sock = ws_connect("wss://example.com/asdf", {})

  ws_options

Update options of an existing connection:

read_timeout
    Abort read attempts after n seconds. This can be used to wake up connections periodically.

write_timeout
    Abort write attempts after n seconds.

        ws_options(sock, {
            read_timeout=3,
        })

  ws_recv_text

Wait until the server sends a text frame. A binary frame is considered an error. Ping requests are answered automatically.

    msg = ws_recv_text(sock)

  ws_recv_binary

Wait until the server sends a binary frame. A text frame is considered an error. Ping requests are answered automatically.

    msg = ws_recv_binary(sock)

  ws_recv_json

Identical to ws_send_text but automatically runs json_decode on the response.

    msg = ws_recv_json(sock)

  ws_send_text

Send a text frame on the websocket connection.

    ws_send_text(sock, "ohai!")

  ws_send_binary

Send a binary frame on the websocket connection.

    ws_send_binary(sock, "\x00\x01\x02")

  ws_send_json

Encode the object as json string and send it as a text frame on the websocket connection.

    ws_send_text(sock, {
        foo="ohai!",
        x={
            y={1,3,3,7},
        },
    })

  x509_parse_pem

Parse a pem encoded certificate. This function might fail.

    x = x509_parse_pem([[-----BEGIN CERTIFICATE-----
    ZkZZmqNn2Q8=
    -----END CERTIFICATE-----
    ]])
    if last_err() then return end
    print(x)

  xml_decode

Decode a lua value from an xml document.

    x = xml_decode('<body><foo fizz="buzz">bar</foo></body>')
    if last_err() then return end
    body = x['children'][1]
    foo = body['children'][1]
    print(foo['attrs']['fizz'])
    print(foo['text'])

  xml_named

Get a named child element from a parent element.

    x = xml_decode('<body><foo fizz="buzz">bar</foo></body>')
    if last_err() then return end
    body = x['children'][1]
    foo = xml_named(body, 'foo')
    if foo ~= nil then
        print(foo)
    end

Author
kpcyrd

Copyright
2018-2020, kpcyrd