This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Tengo Scripting

Tengo scripting with the Arsenic engine

1 - Arsenic

Arsenic Tengo Module

Module - “arsenic”

arsenic := import("arsenic")

Functions

2 - Builtin functions

Tengo builtin functions

Builtin Functions

TODO: Add content

3 - Cobra

Cobra Tengo Module

Module - “cobra”

cobra := import("cobra")

Functions

4 - Exec

Exec Tengo Module

Module - “exec”

exec := import("exec")

Functions

5 - FFUF

FFUF Tengo Module

Module - “ffuf”

ffuf := import("ffuf")

Functions

6 - Filepath

Filepath Tengo Module

Module - “filepath”

filepath := import("filepath")

Functions

join

join(elem ...string) => string

Joins any number of path elements into a single path.

Example

fmt := import("fmt")
filepath := import("filepath")

// On Unix
fmt.println(filepath.join("a", "b", "c"))
fmt.println(filepath.join("a", "b/c"))
fmt.println(filepath.join("a/b", "c"))
fmt.println(filepath.join("a/b", "/c"))
fmt.println(filepath.join("a/b", "../../../xyz"))

Output:
a/b/c
a/b/c
a/b/c
a/b/c
../xyz

file_exists

file_exists(path string) => bool

Returns whether a file exists at the specified path.

Example

fmt := import("fmt")
filepath := import("filepath")

fmt.println(filepath.file_exists("/etc/passwd"))
fmt.println(filepath.file_exists("/etc/not-a-file"))
fmt.println(filepath.file_exists("/etc"))

Output:
true
false
false

dir_exists

dir_exists(path string) => bool

Returns whether a directory exists at the specified path.

Example

fmt := import("fmt")
filepath := import("filepath")

fmt.println(filepath.dir_exists("/etc/passwd"))
fmt.println(filepath.dir_exists("/etc/not-a-file"))
fmt.println(filepath.dir_exists("/etc"))

Output:
false
false
true

base

base(path string) => string

Returns the last element of the path.

dir

dir(path string) => string

Returns all but the last element of path, typically the path’s directory.

abs

abs(path string) => string/error

Returns an absolute representation of path.

ext

ext(path string) => string

Returns the file name extension used by path.

glob

glob(pattern string) []string/error
glob(pattern string, exclude_re string) []string/error

Returns the names of all files matching the shell pattern or nil if there is no matching file. Optionally can specify a regex string of the files to exclude.

from_slash

from_slash(path string) string

Returns the result of replacing each slash (’/’) character in path with a separator character.

7 - Git

Git Tengo Module

Module - “git”

git := import("git")

Functions

8 - Log

Log Tengo Module

Module - “log”

log := import("log")

Functions

9 - Nmap

Nmap Tengo Module

Module - “nmap”

nmap := import("nmap")

Functions

10 - OS2

OS2 Tengo Module

Module - “os2”

os2 := import("os2")

Functions

11 - Scope

Scope Tengo Module

Module - “scope”

scope := import("scope")

Functions

12 - Script

Script Tengo Module

Module - “script”

script := import("script")

Functions

13 - Scripting

Scripting Tengo Module

Scripting

With arsenic’s custom tengo functions and modules, custom tengo scripts to aid in pentesting operations.

Quick Start

TODO: Add content

14 - Set

Set Tengo Module

Module - “set”

set := import("set")

Functions

15 - Slice

Slice Tengo Module

Module - “slice”

slice := import("slice")

Functions

16 - Stdlib

Stdlib Tengo Module

Standard Library

  • filepath: platform-independent OS filename/path functionality. Implements functions in the path/filepath go module.
  • git: specialized git operations.
  • slice: slice related functions.
  • url: url parsing/manipulating functionality.
  • arsenic: arsenic specific functionality.
  • script: get info, run, find, and stop scripts.
  • exec: run OS commands.
  • os2: additional platform-independent OS functionality not implemented in the tengo os module.
  • set: create/use a simple implementation of the set data structure.
  • cobra: add arguments, commands, and flags to scripts. Wrapper around the Cobra go library.
  • nmap: run nmap scans programmatically with parsed results. Wrapper around the nmap go library.
  • ffuf: run ffuf content discovery scans programmatically. Wrapper around the ffufwrap go library.
  • viper: configuration related functionality. Wrapper around the viper go library with some arsenic related functionality added in.
  • scope: retrieve current scope and filter out of scope hosts.
  • log: logging functionality.

17 - URL

URL Tengo Module

Module - “url”

url := import("url")

Functions

18 - Viper

Viper Tengo Module

Module - “viper”

viper := import("viper")

Functions