> For the complete documentation index, see [llms.txt](https://adaptix-framework.gitbook.io/adaptix-framework/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://adaptix-framework.gitbook.io/adaptix-framework/development/axscript/axfunction.md).
# AxFunction
## Data Model
### agents
Get information about all agents calling back to this Adaptix teamserver.
```javascript
AGENT[id] ax.agents();
```
```javascript
// AGENT STRUCT
string agent["id"]
string agent["type"]
string agent["listener"]
string agent["external_ip"]
string agent["internal_ip"]
string agent["domain"]
string agent["computer"]
string agent["username"]
string agent["impersonated"]
string agent["process"]
string agent["arch"]
int agent["pid"]
int agent["tid"]
int agent["gmt"]
int agent["acp"]
int agent["oemcp"]
bool agent["elevated"]
string agent["tags"]
bool agent["async"]
int agent["sleep"]
string agent["os_full"]
```
Example
```javascript
var agents = ax.agents();
for (var id in agents) {
ax.log("Agent ID: " + id);
var agent = agents[id];
for (var key in agent) {
ax.log(" " + key + ": " + agent[key]);
}
}
```
***
### credentials
Returns a list of credentials.
```javascript
CRED[id] ax.credentials()
```
```javascript
// CRED STRUCT
cred["id"]
cred["username"]
cred["password"]
cred["realm"]
cred["type"]
cred["tag"]
cred["date"]
cred["storage"]
cred["agent_id"]
cred["host"]
```
Example
```javascript
var creds = ax.credentials();
for (var id in creds) {
ax.log("Cred ID: " + id);
var cred = creds[id];
for (var key in cred) {
ax.log(" " + key + ": " + cred[key]);
}
}
```
***
### downloads
Returns a list of downloads.
```javascript
DOWNLOAD[id] ax.downloads()
```
```javascript
// DOWNLOAD STRUCT
download["id"]
download["agent_id"]
download["agent_name"]
download["user"]
download["computer"]
download["filename"]
download["recv_size"]
download["total_size"]
download["date"]
download["state"]
```
Example
```javascript
var downloads = ax.downloads();
for (var id in downloads) {
ax.log("Download ID: " + id);
var dw = downloads[id];
for (var key in dw) {
ax.log(" " + key + ": " + dw[key]);
}
}
```
***
### screenshots
Returns a list of screenshots.
```javascript
SCREEN[id] ax.screenshots()
```
```javascript
// SCREEN STRUCT
screen["id"]
screen["user"]
screen["computer"]
screen["note"]
screen["date"]
```
Example
```javascript
var screenshots = ax.screenshots();
for (var id in screenshots) {
ax.log("Screen ID: " + id);
var screen = screenshots[id];
for (var key in screen) {
ax.log(" " + key + ": " + screen[key]);
}
}
```
***
### targets
Returns a list of targets.
```javascript
TARGET[id] ax.targets()
```
```javascript
// TARGET STRUCT
target["id"]
target["computer"]
target["domain"]
target["address"]
target["tag"]
target["date"]
target["info"]
target["alive"]
target["owned"]
target["os"]
target["os_desc"]
```
Example
```javascript
var targets = ax.targets();
for (var id in targets) {
ax.log("Target ID: " + id);
var targ = targets[id];
for (var key in targ) {
ax.log(" " + key + ": " + targ[key]);
}
}
```
***
### tunnels
Returns a list of tunnels.
```javascript
TUNNEL[id] ax.tunnels()
```
```javascript
// TUNNEL STRUCT
tunnel["id"]
tunnel["agent_id"]
tunnel["username"]
tunnel["computer"]
tunnel["process"]
tunnel["type"]
tunnel["info"]
tunnel["interface"]
tunnel["port"]
tunnel["client"]
tunnel["f_port"]
tunnel["f_host"]
```
Example
```javascript
var tunnels = ax.tunnels();
for (var id in tunnels) {
ax.log("Tunn ID: " + id);
var tun = tunnels[id];
for (var key in tun) {
ax.log(" " + key + ": " + tun[key]);
}
}
```
***
## Functions
The following is a list of AxScript's functions:
### agents
[See here](#agents)
***
### agent\_info
Get information from a agent session's metadata.
```javascript
any ax.agent_info(string id, string property)
```
* `id` - agent ID
* `property` - CRED property ([see here](/adaptix-framework/development/axscript/axfunction.md#agents))
Example
```javascript
ax.agent_info("47ca27cf", "username");
ax.agent_info("47ca27cf", "pid");
```
***
### agent\_hide
Hide agents from Sessions Table.
```javascript
void ax.agent_hide(string[] ids)
```
* `ids` - array of agent ids
***
### agent\_remove
Remove agents from server.
```javascript
void ax.agent_hide(string[] ids)
```
* `ids` - array of agent ids
***
### agent\_set\_color
Set color for agent's item in Session Table
```javascript
void ax.agent_set_color(string[] ids, string background, string foreground, bool reset);
```
* `ids` - array of agent ids
* `background` - item background color in hex RGB
* `foreground` - item text color in hex RGB
* `reser` - if true, reset the color to default
Example
```
ax.agent_set_color(["47ca27cf"], "008000", "000000", false);
```
***
### agent\_set\_impersonate
Set impersonate for agent's item in Session Table
```javascript
void ax.agent_set_impersonate(string id, string impersonate, bool elevated);
```
* `id` - agent ID
* `impersonate` - impersonated user
* `elevated` - is impersonated user elevated
Example
```javascript
ax.agent_set_impersonate("47ca27cf", "SYSTEM", true);
```
***
### agent\_set\_mark
Set mark for agent's item in Session Table
```javascript
void ax.agent_set_mark(string id, string mark);
```
* `id` - agent ID
* `mark` - agent's mark ("Terminated", "Inactive", "Disconnect", empty "" for active).
Example
```javascript
ax.agent_set_mark("47ca27cf", "Inactive");
```
***
### agent\_set\_tag
Set tag for agent's item in Session Table
```javascript
void ax.agent_set_tag(string id, string tag);
```
* `id` - agent ID
* `tag` - agent's tag
Example
```javascript
ax.agent_set_tag("47ca27cf", "long");
```
***
### agent\_update\_data
Update/set agent data
```javascript
void ax.agent_update_data(string id, json_property object);
```
* `id` - agent ID
* `json_property` - CRED property ([see here](/adaptix-framework/development/axscript/axfunction.md#agents))
Example
```javascript
ax.agent_update_data("aa26e9d4", {
internal_ip:"192.168.1.1",
domain:"dom.local"
pid: 1234
});
```
***
### arch
Returns the architecture of agent session (e.g., x86 or x64)
```javascript
string ax.arch(string id);
```
* `id` - agent ID
Example
```javascript
ax.arch("47ca27cf");
```
***
### bof\_pack
Pack arguments in a way that's suitable for BOF APIs to unpack. To transmit binary data to the server, the function will encode it in base64.
```javascript
string ax.bof_pack(string types, any[] args);
```
* `types` - a set of comma separated string types for BOF's arguments
* `args` - array of BOF's arguments
Type
Description
Unpack With (C)
bytes
binary data
BeaconDataExtract
int
4-byte integer
BeaconDataInt
short
2-byte short integer
BeaconDataShort
cstr
zero-terminated+encoded string
BeaconDataExtract
wstr
zero-terminated wide-char string
(wchar_t *)BeaconDataExtract
Example
```javascript
ax.bof_pack("bytes,int,short,cstr,wstr", ["bytes_str", 123, 12, "c_string", "w_string"]);
```
***
### copy\_to\_clipboard
Copy `text` to client's clipboard.
```javascript
void ax.copy_to_clipboard(string text);
```
Example
```javascript
ax.copy_to_clipboard("stored data");
```
***
### console\_message
Print an output message and text to the agent console.
```javascript
void ax.console_message(string id, string message, string type = "", string text = "");
```
* `id` - agent ID
* `message` - brief message
* `type` - message type ("info", "success", or "error")
* `text` - text output
Example
```javascript
ax.console_message("47ca27cf", "Info message\n", "info", "This is\nmulti line\ntext");
ax.console_message("47ca27cf", "Error message\n", "error");
```
***
### convert\_to\_code
Convert base64 binary data to code format.
```javascript
void ax.convert_to_code(string language, string base64data, string varName = "shellcode");
```
* `languaage` - programming language ("c", "csharp", "python", "golang", "vbs", "nim", "rust", "powershell")
* `base64data` - base64 data for converting
* `varName` - var's name in code
Example
```javascript
ax.convert_to_code("rust", "dGVzdCBtZXNzYWdlCg==", "shellcode");
```
***
### credentials
[See here](#credentials)
***
### credentials\_add
Save the specified credentials in Credentials Manager
```javascript
void ax.credentials_add(string username, string password, string realm = "", string type = "password", string tag = "", string storage = "manual", string host = "");
```
* `username` - creds username
* `password` - creds secret
* `realm` - creds domain/realm
* `type` - creds type (possible "password", "hash", "rc4", "aes128", "aes256", "token")
* `tag` - creds tag
* `storage` - creds container (possible "browser", "dpapi", "database", "sam", "lsass", "ntds", "manual")
* `host` - the host where the credentials were stored
Example
```javascript
ax.credentials_add("user", "P@ssw0rd", "dom.local", "password", "", "dpapi", `SERVER12`);
```
***
### credentials\_add\_list
Save a list of creds in the Credentials Manager
```javascript
void ax.credentials_add_list(cred[] array);
```
Example
```javascript
var obj = {};
obj.username = "user";
obj.password = "!Q@W3e4r";
obj.realm = "domain";
obj.type = "password";
obj.host = "DB";
var arr = [];
arr.push(obj);
ax.credentials_add_list(arr);
```
***
### create\_command
[See here](/adaptix-framework/development/axscript/axcommand-type.md#command)
***
### create\_commands\_group
[See here](/adaptix-framework/development/axscript/axcommand-type.md#registering-commands)
***
### decode\_data
Return decoded base64 data from algorithm ("hex", "base64", "base32", "zip" or "xor") in base64.
```javascript
string ax.decode_data(string algorithm, string base64data, string key ="");
```
* `algorithm` - "hex", "base64", "base32", "zip" or "xor".
* `base64data` - data in base64
* `key` - encrypt key (for `xor`)
Example
```javascript
ax.decode_data("xor", "GAAaQ1dH", "key123");
```
***
### decode\_file
Return decoded base64 data from algorithm ("hex", "base64", "base32", "zip" or "xor") in base64.
```javascript
string ax.decode_file(string algorithm, string filepath, string key ="");
```
* `algorithm` - "hex", "base64", "base32", "zip" or "xor".
* `filepath` - file with data in base64
* `key` - encrypt key (for `xor`)
Example
```javascript
ax.decode_data("xor", "/tmp/encfile.txt", "key123");
```
***
### encode\_data
Return encoded data ("hex", "base64", "base32", "zip" or "xor") in base64.
```javascript
string ax.encode_data(string algorithm, string data, string key ="");
```
* `algorithm` - "hex", "base64", "base32", "zip" or "xor".
* `data` - data for encoding
* `key` - encrypt key (for `xor`)
Example
```javascript
ax.encode_data("xor", "secret", "key123");
```
***
### encode\_file
Return encoded data ("hex", "base64", "base32", "zip" or "xor") in base64.
```javascript
string ax.encode_data(string algorithm, string filepath, string key ="");
```
* `algorithm` - "hex", "base64", "base32", "zip" or "xor".
* `filepath` - file with data in base64
* `key` - encrypt key (for `xor`)
Example
```javascript
ax.encode_data("xor", "/tmp/encfile.txt", "key123");
```
***
### execute\_alias
[See here](/adaptix-framework/development/axscript/axcommand-type/commands-and-hooks.md#execute_alias)
***
### execute\_browser
[See here](/adaptix-framework/development/axscript/axcommand-type/commands-and-hooks.md#execute_browser)
***
### execute\_command
[See here](/adaptix-framework/development/axscript/axcommand-type/commands-and-hooks.md#execute_command)
***
### file\_basename
Returns the filename
```javascript
string ax.file_basename(string path);
```
* `path` - full filename
Example
```javascript
ax.file_basename("/tmp/test.txt");
```
***
### file\_dirname
Returns the base directory name
```javascript
string ax.file_dirname(string path);
```
* `path` - full filename
Example
```javascript
ax.file_dirname("/tmp/test.txt");
```
***
### file\_exists
Checks if a file exists
```javascript
bool ax.file_exists(string path);
```
* `path` - full filename
Example
```javascript
ax.file_exists("/tmp/test.txt");
```
***
### file\_extension
Checks if a file exists
```javascript
string ax.file_extension(string path);
```
* `path` - full filename
Example
```javascript
ax.file_extension("/tmp/test.txt");
```
***
### file\_read
Reads a file and returns base64 encoded contents
```javascript
string ax.file_read(string path);
```
* `path` - full filename
Example
```javascript
ax.file_read("/tmp/test.txt");
```
***
### file\_size
Return the file size
```javascript
int ax.file_size(string path);
```
* `path` - full filename
Example
```javascript
ax.file_size("/tmp/file.txt");
```
***
### file\_write\_text
Writes text data to a file and returns true if the write is successful.
```javascript
bool ax.file_write_text(string path, string text);
```
* `path` - full filename
* `text` - text data
Example
```javascript
ax.file_write_text("/tmp/test.txt", "this is text");
```
***
### file\_write\_binary
Writes base64 data to a file and returns true if the write is successful.
```javascript
bool ax.file_write_binary(string path, string b64text);
```
* `path` - full filename
* `b64text` - base64 data
Example
```javascript
ax.file_write_binary("/tmp/file2.txt", "dGVzdCBtZXNzYWdlCg==");
```
***
### format\_time
Convert UNIX Epoch Time to date/time string value.
```javascript
string ax.format_time(string format, int unixtime);
```
* `format` - datetime format (e.g. "dd/MM/yyyy hh:mm:ss")
* `unixtime` - UNIX Epoch Time value
Example
```javascript
ax.format_time("dd/MM hh:mm", ax.ticks());
```
***
### format\_size
Converts bytes into a convenient format
```javascript
string ax.format_size(int bytes);
```
Example
***
### get\_commands
Returns a list of available commands for the agent.
```javascript
string[] get_commands(string id);
```
* `id` - agent ID
Example
***
### get\_project
Returns the name of the current project.
```javascript
string get_project();
```
***
### hash
Returns a hash string in hex format.
```javascript
string ax.hash(string algorithm, int length, string data)
```
* `algorithm` - hash "sha1" or "md5";
* `length` - length of the returned string
* `data` - data to be hashed
Example
```javascript
ax.hash("sha1", 8, "data-for-hash");
ax.hash("md5", 32, "data-for-hash");
```
***
### interfaces
Returns a list of network interfaces of the teamserver
```javascript
string[] ax.interfaces()
```
Example
```javascript
ax.interfaces()
```
***
### ids
Returns a list of agent ids
```javascript
string[] ax.ids()
```
Example
***
### is64
Check if a session is on an x64 system or not
```javascript
bool ax.is64(string id);
```
* `id` - agent ID
Example
```javascript
ax.is64("47ca27cf");
```
***
### isactive
Returns true if the agent is active
```javascript
bool ax.isactive(string id);
```
`id` - agent ID
Example
***
### isadmin
Check if a session has admin rights
```javascript
bool ax.isadmin(string id);
```
* `id` - agent ID
Example
```javascript
ax.isadmin("47ca27cf");
```
***
### log / log\_error
Print `text` to AxScript Console.
```javascript
void ax.log(string text);
void ax.log_error(string text);
```
Example
```javascript
ax.log("log");
ax.log_error("log");
```
***
### open\_agent\_console
Open the console to interact with a agent
```javascript
void ax.open_agent_console(string id);
```
* `id` - agent ID
***
### open\_access\_tunnel
Open the tunnel creation dialog window
```javascript
void ax.open_access_tunnel(string id, bool socks4, bool socks5, bool lportfwd, bool rportfwd);
```
* `id` - agent ID
* `socks4` - is agent support socks4
* `socks5` - is agent support socks5
* `lportfwd` - is agent support local port forwarding
* `rportfwd` - is agent support reverse port forwarding
Example
```javascript
ax.open_access_tunnel("47ca27cf", true, true, false, false);
```
***
### open\_browser\_files
Open the File Browser for a agent
```javascript
void ax.open_browser_files(string id);
```
* `id` - agent ID
***
### open\_browser\_process
Open the Process Browser for a agent
```javascript
void ax.open_browser_process(string id);
```
* `id` - agent ID
***
### open\_remote\_terminal
Open the Interactive Terminal for a agent
```javascript
void ax.open_remote_terminal(string id);
```
* `id` - agent ID
***
### open\_remote\_shell
Open the I/O remote shell for a agent
```javascript
void ax.open_remote_shell(string id);
```
* `id` - agent ID
***
### prompt\_confirm
Show a confirm dialog.
```javascript
string prompt_confirm(string caption, string text);
```
* `caption` - title of the dialog
* `text` - Text question
Example
```javascript
ax.prompt_confirm(" ", "Exit main windows?");
```
***
### prompt\_open\_file
Show a file open dialog.
```javascript
string prompt_open_file(string caption = "Select file", string filter = "");
```
* `caption` - title of the dialog
* `filter` - filter for selecting files
Example
```javascript
ax.prompt_open_file("Select AxScript", "AxScript Files (*.axs)");
```
***
### prompt\_open\_dir
Show a directory open dialog.
```javascript
string prompt_open_dir(string caption = "Select directory");
```
* `caption` - title of the dialog
Example
```javascript
ax.prompt_open_dir("Open directory");
```
***
### prompt\_save\_file
Show a file save dialog.
```javascript
string prompt_save_file(string filename, string caption = "Select file", string filter = "");
```
* `filename` - default filename
* `caption` - title of the dialog
* `filter` - filter for selecting files
Example
```javascript
ax.prompt_save_file("/tmp/creds.txt", "Save file");
```
***
### random\_string
Generates a random string of length `len` from a set of characters `set`.
```javascript
string random_string(int len, string set);
```
* `set` - set of characters (`alphanumeric`, `alphabetic`, `numeric` or `hex`)
Example
```javascript
ax.random_string(10, "hex")
ax.random_string(36, "alphanumeric")
```
***
### random\_int
Generates a random int value.
```javascript
int random_int(int min, int max);
```
* `min` - min value
* `max` - max value
Example
```javascript
ax.random_int(2, 1024)
```
***
### register\_commands\_group
[See here](/adaptix-framework/development/axscript/axcommand-type.md#registering-commands)
***
### script\_import
Import AxScript script into current script's env.
```javascript
string script_import(string path);
```
* `path` - path to script file
***
### script\_load
Load a new script to AxScript Manager
```javascript
string script_load(string path);
```
* `path` - path to script file
***
### script\_unload
Unload a script from the AxScript Manager
```javascript
string script_unload(string path);
```
* `path` - path to script file
***
### script\_dir
Returns the directory where the script is located.
```javascript
string script_dir();
```
***
### show\_message
Shows a message to the user in a dialog box. Use this function to relay information.
```javascript
void show_message(string title, string text);
```
* `title` - title of the dialog
* `text` - the message text
Example
```javascript
ax.show_message("Info", "This is text");
```
***
### targets\_add
Save the specified target in Targets Manager
```javascript
void ax.targets_add(string computer, string domain, string address, string os = "unknown", string osDesc = "", string tag = "", string info = "", bool alive = true);
```
* `computer` - computer name
* `domain` - domain name
* `address` - IP address
* `os` - OS type (possible "windows", "linux", "macos")
* `osDesc` - detailed information about OS
* `tag` - tag
* `info` - info
* `alive` - true if the host is alive
Example
```javascript
ax.targets_add("DC", "dom.local", "dom.local", "192.168.1.10", "windows");
```
***
### targets\_add\_list
Save a list of targets in the Targets Manager
```javascript
void ax.targets_add_list(target[] array);
```