Synchronet JavaScript Object Model Reference

Generated for Synchronet v3.21f, master/23330fc0d2 (Mar 25 2026 13:27) compiled Mar 25 2026 15:44

Property and Method version numbers (when available) indicate the Synchronet version when the item was added or modified.
Optional method arguments are specified in [brackets] in the 'Usage' column.
Method argument types (e.g. bool, string, number, object), when significant, are specified in italics in the 'Usage' column.
Methods documented as returning 'void' will always return undefined.
Methods documented as returning 'undefined' may return one of multiple value types.

[+] global object
- methods
- properties
[+] js object
- methods
- properties
[+] system object
- methods
- properties
[+] File class
- methods
- properties
[+] Archive class
- methods
- properties
[+] Queue class
- methods
- properties
[+] Socket class
- methods
- properties
- Socket class object
  - properties
[+] ConnectedSocket class
[+] ListeningSocket class
[+] COM class
- methods
- properties
[+] conio object
- methods
- properties
[+] CryptContext class
- methods
- properties
- CryptContext class object
  - CryptContext.ALGO object
    - properties
  - CryptContext.MODE object
    - properties
[+] CryptKeyset class
- methods
- CryptKeyset class object
  - CryptKeyset.KEYOPT object
    - properties
[+] CryptCert class
- methods
- properties
- CryptCert class object
  - CryptCert.CURSOR object
    - properties
  - CryptCert.TYPE object
    - properties
  - CryptCert.FORMAT object
    - properties
  - CryptCert.ATTR object
    - properties
[+] uifc object
- methods
- properties

global object
Top-level functions and properties (common to all servers, services, and JSexec) - introduced in v3.10

**`global` methods**
Name	Returns	Usage	Ver	Description
log	string	`log([number level=LOG_INFO,] value [,value])`	3.11	Add a line of text to the server and/or system log. values are typically string constants or variables (each logged as a separate log message), level is the severity of the message to be logged, one of the globally-defined values, in decreasing severity: `LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, and LOG_DEBUG` (default: `LOG_INFO`)
read	string	`read([count=128])`	3.11	Read up to `count` characters from input stream and return as a string or `undefined` upon error
readln	string	`readln([count=128])`	3.11	Read a single line, up to `count` characters, from input stream and return as a string or `undefined` upon error
write	void	`write(value [,value])`	3.11	Send one or more values (typically strings) to the output stream
writeln	void	`writeln(value [,value])`	3.11	Send a line of text to the output stream with automatic line termination (CRLF), values are typically string constants or variables (AKA print)
printf	string	`printf(string format [,value][,value])`	3.10	Send a C-style formatted string of text to the output stream. See also the `format()` function.
alert	void	`alert(value)`	3.10	Send an alert message (ala client-side JS) to the output stream
prompt	string	`prompt([string text] [,string value] [,number k_mode=K_EDIT])`	3.10	Display a prompt (`text`) and return a string of user input (ala client-side JS) or `null` upon no-input `value` is an optional default string to be edited (used with the `k_mode K_EDIT` flag) See `sbbsdefs.js` for all valid `K_` (keyboard-input) mode flags.
confirm	boolean	`confirm(value)`	3.10	Display a Yes/No prompt and return `true` or `false` based on user's confirmation (ala client-side JS, `true` = yes) see also `console.yesno()`
deny	boolean	`deny(value)`	3.15b	Display a No/Yes prompt and returns `true` or `false` based on user's denial (`true` = no) see also `console.noyes()`
chdir	void	`chdir(undefined)`	undefined
putenv	void	`putenv(undefined)`	undefined
assertEq	void	`assertEq(undefined)`	undefined
exit	void	`exit([number exit_code=0])`	3.11	Stop script execution, optionally setting the global property `exit_code` to the specified numeric value
load	undefined	`load([bool background or object scope,] string filename [,args])`	3.12	Load and execute a JavaScript module (filename), optionally specifying a target scope object (default: this) and a list of arguments to pass to the module (as argv). Returns the result (last executed statement) of the executed script or a newly created Queue object if background is `true`). Background: When the background parameter is `true`, the loaded script runs in the background (in a child thread) but may communicate with the parent script/thread by reading from and/or writing to the parent_queue (an automatically created Queue object). The result (last executed statement) of the executed script (or the optional exit_code passed to the exit() function) will be automatically written to the parent_queue which may be read later by the parent script (using load_result.read(), for example).
require	undefined	`require([object scope,] string filename, propname [,args])`	3.17	Load and execute a JavaScript module (filename), optionally specifying a target scope object (default: this) and a list of arguments to pass to the module (as argv) IF AND ONLY IF the property named propname is not defined in the target scope (a defined symbol with a value of undefined will not cause the script to be loaded). Returns the result (last executed statement) of the executed script or null if the script is not executed.
mswait	number	`mswait([milliseconds=1])`	3.13	Pause execution for the specified number of milliseconds (AKA sleep), returns elapsed duration, in seconds
yield	void	`yield([forced=true])`	3.11	Release current thread time-slice, a forced yield will yield to all other pending tasks (lowering CPU utilization), a non-forced yield will yield only to pending tasks of equal or higher priority. forced defaults to `true`
random	number	`random([max_number=100])`	3.10	Return random integer between `0` and max_number-1
time	number	`time()`	3.10	Return current time and date in Unix (time_t) format (number of seconds since January 1st, 1970 UTC)
beep	void	`beep([frequency=500] [,duration=500])`	3.10	Produce a tone on the local speaker at specified frequency for specified duration (in milliseconds)
sound	boolean	`sound([filename])`	3.10	Play a waveform (.wav) sound file (currently, on Windows platforms only)
ctrl	string	`ctrl(number or string value)`	3.11	Return ASCII control character representing character value passed - Example: `ctrl('C')` returns string containing the single character string: `'\3'`
ascii	undefined	`ascii([string text] or [number value])`	3.10	Convert single character to numeric ASCII value or vice-versa, returns number OR string, or `null` or `undefined` if passed those values
ascii_str	string	`ascii_str(text)`	3.10	Convert extended-ASCII (CP437) characters in text string to plain US-ASCII equivalent, returns modified string or `null` or `undefined` if passed those values
strip_ctrl	string	`strip_ctrl(text)`	3.10	Strip all control characters and Ctrl-A (attribute) sequences from string, returns modified string or `null` or `undefined` if passed those values
strip_ctrl_a	string	`strip_ctrl_a(text)`	3.20	Strip all Ctrl-A (attribute) sequences from string, returns modified string or `null` or `undefined` if passed those values
strip_ansi	string	`strip_ansi(text)`	3.18c	Strip all ANSI terminal control sequences from string, returns modified string or `null` or `undefined` if passed those values
strip_exascii	string	`strip_exascii(text)`	3.10	Strip all extended-ASCII characters from string, returns modified string or `null` or `undefined` if passed those values
skipsp	string	`skipsp(text)`	3.15	Skip (trim) white-space characters off beginning of string, returns modified string or `null` or `undefined` if passed those values
truncsp	string	`truncsp(text)`	3.10	Truncate (trim) white-space characters off end of string, returns modified string or `null` or `undefined` if passed those values
truncstr	string	`truncstr(text, charset)`	3.10	Truncate (trim) string at first char in charset, returns modified string or `null` or `undefined` if passed those values
lfexpand	string	`lfexpand(text)`	3.10	Expand sole line-feeds (LF) to carriage-return/line-feed sequences (CRLF), returns modified string or `null` or `undefined` if passed those values
wildmatch	boolean	`wildmatch([bool case_sensitive=false,] filename [,pattern='*'] [,path=false])`	3.14	Return `true` if the filename matches the wildcard pattern (wildcard characters supported are '' and '?'), if path* is `true`, '*' will not match path delimiter characters (e.g. '/')
backslash	string	`backslash(path)`	3.12	Return directory path with trailing (platform-specific) path delimiter (i.e. "slash" or "backslash")
fullpath	string	`fullpath(path)`	3.15	Create and return an absolute or full path name for the specified relative path name.
file_getname	string	`file_getname(path/filename)`	3.11	Return filename portion of passed path string
file_getext	string	`file_getext(path/filename)`	3.11	Return file extension portion of passed path/filename string (including '.') or `undefined` if no extension is found
file_getcase	string	`file_getcase(path/filename)`	3.11	Return correct case of filename (long version of filename on Windows) or `undefined` if the file doesn't exist
file_cfgname	string	`file_cfgname(path, filename)`	3.12	Return completed configuration filename from supplied path and filename, optionally including the local hostname (e.g. `path/file.host.domain.ext` or `path/file.host.ext`) if such a variation of the filename exists
file_getdosname	string	`file_getdosname(path/filename)`	3.15	Return DOS-compatible (Micros~1 shortened) version of specified path/filename(on Windows only) return unmodified path/filename on other platforms
file_exists	boolean	`file_exists(path/filename)`	3.10	Verify a file's existence
file_remove	boolean	`file_remove(path/filename)`	3.10	Delete a file
file_removecase	boolean	`file_removecase(path/filename)`	3.14	Delete files case insensitively
file_rename	boolean	`file_rename(path/oldname, path/newname)`	3.11	Rename a file, possibly moving it to another directory in the process
file_copy	boolean	`file_copy(path/source, path/destination)`	3.11	Copy a file from one directory or filename to another
file_backup	boolean	`file_backup(path/filename [,level=5] [,rename=false])`	3.11	Back up the specified filename as `filename.number.extension` where number is the backup number 0 through level-1 (default backup level is 5), if rename is `true`, the original file is renamed instead of copied (default is `false`)
file_isdir	boolean	`file_isdir(path/filename)`	3.10	Check if specified filename is a directory
file_attrib	number	`file_attrib(path/filename)`	3.10	Get a file's attributes (same as file_mode() on nix). On Windows, the return value corresponds with `_finddata_t.attrib` (includes DOS/Windows file system-specific attributes, like hidden, and archive). Returns `-1` if the path/filename* does not exist.
file_mode	number	`file_mode(path/filename)`	3.17c	Get a file's type and mode flags (e.g. read/write/execute permissions). The return value corresponds with `struct stat.st_mode`. Returns `-1` if the path/filename does not exist.
file_chmod	boolean	`file_chmod(path/filename, number mode)`	3.17c	Set a file's permissions flags. The supported mode bit values are system-dependent (e.g. Windows only supports setting or clearing the user-write/0x80 mode flag). Returns `true` if the requested change was successful.
file_date	number	`file_date(path/filename)`	3.10	Get a file's last modified date/time (in time_t format). Returns `-1` if the path/filename does not exist.
file_cdate	number	`file_cdate(path/filename)`	3.17	Get a file's creation date/time (in time_t format). Returns `-1` if the path/filename does not exist.
file_size	number	`file_size(path/filename)`	3.10	Get a file's length (in bytes). Returns `-1` if the path/filename does not exist.
file_utime	boolean	`file_utime(path/filename [,access_time=current] [,mod_time=current])`	3.11	Change a file's last accessed and modification date/time (in time_t format), or change to current time
file_touch	boolean	`file_touch(path/filename)`	3.11	Update a file's last modification date/time to current time, creating an empty file if it doesn't already exist
file_mutex	boolean	`file_mutex(path/filename [,string text=local_hostname] [,number max_age=0])`	3.12	Attempt to create an mutual-exclusion (e.g. lock) file, optionally with the contents of text. If a non-zero max_age is specified and the lock file exists, but is older than this value (in seconds), it is presumed stale and removed/over-written
file_compare	boolean	`file_compare(path/file1, path/file2)`	3.14	Compare 2 files, returning `true` if they are identical, `false` otherwise
directory	array	`directory(path/pattern [,flags=GLOB_MARK])`	3.10	Return an array of directory entries, pattern is the path and filename or wildcards to search for (e.g. '/subdir/.txt'), flags* is a set of optional `glob` bit-flags (default is `GLOB_MARK`)
dir_freespace	number	`dir_freespace(directory [,unit_size=1])`	3.11	Return the amount of available disk space in the specified directory using the specified unit_size in bytes (default: 1), specify a unit_size of `1000` to return the available space in kilobytes or `1024 for kibibytes.`
disk_size	number	`disk_size(directory [,unit_size=1])`	3.14	Return the total disk size of the specified directory using the specified unit_size in bytes (default: 1), specify a unit_size of `1000` to return the total disk size in kilobytes or `1024 for kibibytes.`
socket_select	array	`socket_select([array of socket objects or descriptors] [,number timeout=0] [,bool write=false])`	3.11	Check an array of socket objects or descriptors for read or write ability (default is read), default timeout value is 0.0 seconds (immediate timeout), returns an array of 0-based index values into the socket array, representing the sockets that were ready for reading or writing, or `null` on error. If multiple arrays of sockets are passed, they are presumed to be in the order of read, write, and except. In this case, the write parameter is ignored and an object is returned instead with up to three properties "read", "write", and "except", corresponding to the passed arrays. Empty passed arrays will not have a corresponding property in the returned object.
socket_strerror	string	`socket_strerror(error)`	3.18c	Get the description(string representation) of a numeric socket error value (e.g. `socket_errno`)
strerror	string	`strerror(error)`	3.18c	Get the description(string representation) of a numeric system error value (e.g. `errno`)
mkdir	boolean	`mkdir(path/directory)`	3.10	Make a directory on a local file system
mkpath	boolean	`mkpath(path/directory)`	3.15	Make a path to a directory (creating all necessary sub-directories). Returns `true` if the directory already exists.
rmdir	boolean	`rmdir(path/directory)`	3.10	Remove a directory
rmfiles	boolean	`rmfiles(path/directory [,file-spec='*'] [,files-to-keep=0])`	3.20	Remove all files and sub-directories in the specified directory, recursively - use with caution!
strftime	string	`strftime(format [,time=current])`	3.10	Return a formatted time string (ala the standard C `strftime` function)
format	string	`format(format [,args])`	3.10	Return a C-style formatted string (ala the standard C `sprintf` function)
html_encode	string	`html_encode(text [,bool ex_ascii=true] [,bool white_space=true] [,bool ansi=true] [,bool ctrl_a=true] [, state (object)])`	3.11	Return an HTML-encoded text string (using standard HTML character entities), escaping IBM extended-ASCII (CP437), white-space characters, ANSI codes, and CTRL-A codes by default.Optionally storing the current ANSI state in state object
html_decode	string	`html_decode(html)`	3.11	Return a decoded HTML-encoded text string, translating HTML character entities into CP437 character equivalents
word_wrap	string	`word_wrap(text [,line_length=79 [,orig_line_length=79 [,bool handle_quotes=true [,number pmode=0]]]])`	3.11	Return a word-wrapped version of the text string argument optionally handing quotes magically, line_length defaults to 79, orig_line_length defaults to `79`, handle_quotes defaults to `true`, pmode defaults to `0`, `P_UTF8` and `P_RENEGADE` pmode bit-flags are supported and may be optionally specified as a set of bool values. Note: if the original text does not contain any carriage-return (CR) characters, lines are wrapped with sole line-feed (LF) characters.
quote_msg	string	`quote_msg(text [,line_length=79] [,prefix=" > "])`	3.11	Return a quoted version of the message text string argument, line_length defaults to `79`, prefix defaults to `" > "`
rot13_translate	string	`rot13_translate(text)`	3.11	Return ROT13-translated version of text string (will encode or decode text)
base64_encode	string	`base64_encode(text)`	3.11	Return base64-encoded version of text string or `null` on error
base64_decode	string	`base64_decode(text)`	3.11	Return base64-decoded text string or `null` on error
crc16_calc	number	`crc16_calc(text)`	3.11	Calculate and return 16-bit CRC of text string
crc32_calc	number	`crc32_calc(text)`	3.11	Calculate and return 32-bit CRC of text string
chksum_calc	number	`chksum_calc(text)`	3.11	Calculate and return 32-bit checksum of text string
md5_calc	string	`md5_calc(text [,bool hex=false])`	3.11	Calculate and return 128-bit MD5 digest of text string, result encoded in base64 (default) or hexadecimal (32 hex digits)
sha1_calc	string	`sha1_calc(text [,bool hex=false])`	3.19	Calculate and return 160-bit SHA-1 digest of text string, result encoded in base64 (default) or hexadecimal (40 hex digits)
resolve_ip	string	`resolve_ip(string hostname [,bool array=false])`	3.11	Resolve IP address of specified hostname (AKA gethostbyname). If array is `true`, will return an array of all addresses rather than just the first one (upon success). Returns `null` if unable to resolve address.
resolve_host	string	`resolve_host(ip_address)`	3.11	Resolve hostname of specified IP address (AKA gethostbyaddr). Returns `null` if unable to resolve address.
netaddr_type	number	`netaddr_type(email_address)`	3.12	Return the proper message net_type for the specified email_address, (e.g. `NET_INTERNET` for Internet e-mail or `NET_NONE` for local e-mail)
list_named_queues	array	`list_named_queues()`	3.12	Return an array of named queues (created with the Queue constructor)
flags_str	undefined	`flags_str(string or number)`	3.13	Convert a string of security flags (letters) into their numeric value or vice-versa, returns number OR string
utf8_encode	string	`utf8_encode([string CP437] or [string UTF16] or [number codepoint])`	3.17c	Return UTF-8 encoded version of the specified CP437 text string, UTF-16 encoded text string, or a single Unicode codepoint
utf8_decode	string	`utf8_decode(text)`	3.17c	Return CP437 representation of UTF-8 encoded text string or `null` on error (invalid UTF-8)
utf8_get_width	number	`utf8_get_width(text)`	3.17c	Return the fixed printed-width of the specified string of UTF-8 encoded characters
str_is_utf8	boolean	`str_is_utf8(text)`	3.17c	Return `true` if the specified string contains only valid UTF-8 encoded and US-ASCII characters
str_is_utf16	boolean	`str_is_utf16(text)`	3.17c	Return `true` if the specified string contains one or more UTF-16 encoded characters
str_is_ascii	boolean	`str_is_ascii(text)`	3.17c	Return `true` if the specified string contains only US-ASCII (no CP437 or UTF-8) characters
str_has_ctrl	boolean	`str_has_ctrl(text)`	3.17c	Return `true` if the specified string contains any control characters (ASCII 0x01 - 0x1F)

**`global` properties**
Name	Type	Ver	Description
user	User	N/A	Instance of the User class representing the current user 'online'
argc	number	N/A	Count of arguments passed to the script
argv	array	N/A	Array of argument strings (argv.length == argc)
errno	number	3.10h	Last system error number
errno_str	string	3.10h	Description of last system error
socket_errno	number	3.13a	Last socket-related error number (same as errno on Unix platforms)
socket_errno_str	string	3.18a	Description of last socket-related error (same as errno_str on Unix platforms)

js object
JavaScript engine internal control object - introduced in v3.11

**`js` methods**
Name	Returns	Usage	Ver	Description
eval	undefined	`js.eval(script)`	3.11	Evaluate a JavaScript string in its own (secure) context, returning the result
gc	void	`js.gc(forced=true)`	3.11	Perform a garbage collection operation (freeing memory for unused allocated objects), if forced is `true` (the default) a garbage collection is always performed, otherwise it is only performed if deemed appropriate by the JavaScript engine
on_exit	void	`js.on_exit(to_eval)`	3.13	Add a string to evaluate/execute (LIFO stack) upon script's termination (e.g. call of `exit()`)
report_error	void	`js.report_error(error [,fatal=false])`	3.13	Report an error using the standard JavaScript error reporting mechanism (including script filename and line number), if fatal is `true`, immediately terminates script
flatten_string	void	`js.flatten_string(string value)`	3.16	Flatten a string, optimizing allocated memory used for concatenated strings
exec	number	`js.exec(string filename [,string startup_dir], object scope [,...])`	3.17c	Execute a script within the specified scope. The main difference between this method and `load()` is that scripts invoked in this way can call `exit()` without terminating the caller. If it does, any `on_exit()` handlers will be evaluated in the script's scope when the script exits. NOTE: to get a child of the current scope, you need to create an object in the current scope. An anonymous object can be created using '`new function(){}`'. TIP: Use `js.exec.apply()` if you need to pass a variable number of arguments to the executed script.
setTimeout	number	`js.setTimeout(callback, time [,thisObj])`	3.19	Install a timeout timer. `callback()` will be called `time` (milliseconds) after this function is called. Returns an id which can be passed to `clearTimeout()`
setInterval	number	`js.setInterval(callback, period [,thisObj])`	3.19	Install an interval timer. `callback()` will be called every `period` (milliseconds) after `setInterval()` is called. Returns an id which can be passed to `clearInterval()`
clearTimeout	void	`js.clearTimeout(id)`	3.19	Remove a timeout timer
clearInterval	void	`js.clearInterval(id)`	3.19	Remove an interval timer
addEventListener	number	`js.addEventListener(eventName, callback)`	3.19	Add a listener that is ran after `js.dispatchEvent(eventName)` is called. Returns an id to be passed to `js.removeEventListener()`
removeEventListener	void	`js.removeEventListener(id)`	3.19	Remove listeners added with `js.addEventListener()`. `id` can be a string or an id returned by `addEventListener()`. This does not remove already triggered callbacks from the run queue.
dispatchEvent	void	`js.dispatchEvent(eventName [,object thisObj])`	3.19	Add all listeners of eventName to the end of the run queue. If `thisObj` is passed, specifies `this` in the callback (the `js` object is used otherwise).
setImmediate	void	`js.setImmediate(callback [,thisObj])`	3.19	Add `callback` to the end of the run queue, where it will be called after all pending events are processed

**`js` properties**
Name	Type	Ver	Description
version	string	3.11	JavaScript engine version information (AKA system.js_version) - READ ONLY
auto_terminate	boolean	3.11	Set to false to disable the automatic termination of the script upon external request or user disconnection
terminated	boolean	3.11	Termination has been requested (stop execution as soon as possible)
counter	number	3.16	Number of operation callbacks performed in this runtime
time_limit	number	3.16	Maximum number of operation callbacks, used for infinite-loop detection (0=disabled)
yield_interval	number	3.11	Interval of periodic time-slice yields (lower number=higher frequency, 0=disabled)
gc_interval	number	3.11	Interval of periodic garbage collection attempts (lower number=higher frequency, 0=disabled)
gc_attempts	number	3.11	Number of garbage collections attempted in this runtime - READ ONLY
global	object	3.14	Global (top level) object - READ ONLY
options	number	3.18c	Option flags - READ ONLY
do_callbacks	boolean	3.19	Do callbacks after script finishes running
load_path_list	object	N/A	`load()` search path array. For relative load paths (e.g. not beginning with '/' or '\'), the path is assumed to be a sub-directory of the (configurable) mods or exec directories and is searched accordingly. So, by default, `load("somefile.js")` will search in this order:`mods/load/somefile.js exec/load/somefile.js mods/somefile.js exec/somefile.js`
exec_path	string	N/A	Full path and filename of JS file executed
exec_file	string	N/A	JS filename executed (with no path)
exec_dir	string	N/A	Directory of executed JS file
startup_dir	string	N/A	Either the configured startup directory in SCFG (for externals) or the CWD when jsexec was started
scope	object	N/A	Global scope for this script

system object
Global system-related properties and methods - introduced in v3.10

**`system` methods**
Name	Returns	Usage	Ver	Description
trashcan	boolean	`system.trashcan(basename, find_string)`	3.10	Search `text/basename.can` for pseudo-regexp
findstr	boolean	`system.findstr(path/filename or array of strings, find_string)`	3.10	Search any trashcan/filter file or array of pattern strings (in `.can` format) for find_string*
zonestr	string	`system.zonestr([timezone=local])`	3.10	Convert time zone integer to string, defaults to system timezone if timezone not specified
timestr	string	`system.timestr([time=current])`	3.10	Convert time_t integer into a time string, defaults to current time if time not specified
datestr	string	`system.datestr([time=current])`	3.10	Convert time_t integer into a short (8 character) date string, in either numeric or verbal format (depending on system preference), defaults to current date if time not specified. If time is a string in numeric date format, returns the parsed time_t value as a number.
secondstr	string	`system.secondstr(seconds [,bool verbose=true])`	3.10	Convert a duration in seconds into a string in `hh:mm:ss` format
minutestr	string	`system.minutestr(minutes [,bool estimate=false] [,bool words=false])`	3.21	Convert a duration in minutes into a string in `'DDd HHh MMm'`, `'X.Yh'` or `'X.h hours'` format
exec	number	`system.exec(command-line)`	3.11	Execute a native system/shell command-line, returns 0 on success
popen	array	`system.popen(command-line)`	3.11	Execute a native system/shell command-line, returns array of captured output lines on success (only functional on UNIX systems)
check_pid	boolean	`system.check_pid(process-ID)`	3.15	Check that the provided process ID is a valid executing process on the system, returns `true` if it is valid
terminate_pid	boolean	`system.terminate_pid(process-ID)`	3.15	Terminate executing process on the system with the specified process ID, returns `true` on success
text	string	`system.text(number index or string id)`	3.18c	Return specified text string (see `bbs.text()` for details) or `null` if invalid index or id specified. The string id support was added in v3.20.

**`system` properties**
Name	Type	Ver	Description
freediskspace	number	3.10	Amount of free disk space (in bytes)
freediskspacek	number	3.10	Amount of free disk space (in kibibytes)
ctrl_dir	string	3.10	Control file directory
data_dir	string	3.10	Data file directory
text_dir	string	3.10	Text file directory
temp_dir	string	3.10	Temporary file directory
exec_dir	string	3.10	Executable file directory
mods_dir	string	3.10	Modified modules directory (optional)
logs_dir	string	3.10	Log file directory
devnull	string	3.11	Platform-specific "null" device filename
temp_path	string	3.12	Platform-specific temporary file directory
cmd_shell	string	3.14	Platform-specific command processor/shell
clock_ticks	number	3.11	Amount of elapsed time in clock 'ticks'
clock_ticks_per_second	number	3.11	Number of clock ticks per second
timer	number	3.14	High-resolution timer, in seconds (fractional seconds supported)
stats_interval	number	3.21	System statistics interval (cache duration) in seconds
local_host_name	string	3.11	Private host name that uniquely identifies this system on the local network
name_servers	object	3.18c	Array of nameservers in use by the system
socket_lib	string	N/A	Public host name that uniquely identifies this system on the Internet (usually the same as system.inet_addr)
uptime	number	N/A	Socket library version information
full_version	string	N/A	Time/date system was brought online (in time_t format)
git_branch	string	N/A	Synchronet full version information (e.g. '3.10k Beta Debug')
git_hash	string	N/A	Synchronet Git repository branch name
git_date	string	N/A	Synchronet Git repository commit hash
compiled_when	string	N/A	Synchronet Git repository commit date/time
version	string	N/A	Date and time compiled
revision	string	N/A	Synchronet version number (e.g. '3.10')
beta_version	string	N/A	Synchronet revision letter (e.g. 'k')
version_notice	string	N/A	Synchronet alpha/beta designation (e.g. ' beta')
version_num	number	N/A	Synchronet version notice (includes version and platform)
version_hex	number	N/A	Synchronet version number in decimal (e.g. 31301 for v3.13b)
git_time	number	N/A	Synchronet version number in hexadecimal (e.g. 0x31301 for v3.13b)
platform	string	N/A	Synchronet Git repository commit date/time (seconds since Unix epoch)
architecture	string	N/A	Platform description (e.g. 'Win32', 'Linux', 'FreeBSD')
msgbase_lib	string	N/A	Architecture description (e.g. 'i386', 'i686', 'x86_64')
compiled_with	string	N/A	Message base library version information
copyright	string	N/A	Compiler used to build Synchronet
js_version	string	N/A	Synchronet copyright display
os_version	string	N/A	JavaScript engine version information

File class
Class used for opening, creating, reading, or writing files on the local file system
Special features include:

Exclusive-access files (default) or shared files
1. optional record-locking
2. buffered or non-buffered I/O
Support for binary files
1. native or network byte order (endian)
2. automatic Unix-to-Unix (UUE), yEncode (yEnc) or Base64 encoding/decoding
Support for ASCII text files
1. supports line-based I/O
  1. entire file may be read or written as an array of strings
  2. individual lines may be read or written one line at a time
2. supports fixed-length records
  1. optional end-of-text (etx) character for automatic record padding/termination
  2. Synchronet .dat files use an etx value of 3 (Ctrl-C)
3. supports .ini formatted configuration files
Dynamically-calculated industry standard checksums (e.g. CRC-16, CRC-32, MD5)

- introduced in v3.10

To create a new File object: var f = new File(filename)

**`File` methods**
Name	Returns	Usage	Ver	Description
open	boolean	`File.open([string mode="w+"] [,bool shareable=false] [,number buffer_length])`	3.10	Open file, shareable defaults to false, buffer_length defaults to 2048 bytes, mode (default: `'w+'`) specifies the type of access requested for the file, as follows: `r` open for reading; if the file does not exist or cannot be found, the open call fails `w` open an empty file for writing; if the given file exists, its contents are destroyed `a` open for writing at the end of the file (appending); creates the file first if it doesn't exist `r+` open for both reading and writing (the file must exist) `w+` open an empty file for both reading and writing; if the given file exists, its contents are destroyed `a+` open for reading and appending `b` open in binary (untranslated) mode; translations involving carriage-return and linefeed characters are suppressed (e.g. `r+b`) `x` open a non-shareable file (that must not already exist) for exclusive access Note: When using the `iniSet` methods to modify a `.ini` file, the file must be opened for both reading and writing. Note: To open an existing or create a new file for both reading and writing (e.g. updating an `.ini` file) use the exists property like so: `file.open(file.exists ? 'r+':'w+');` Note: When shareable is `false`, uses the Synchronet `nopen()` function which will lock the file and perform automatic retries. The lock mode is as follows: `r` DENYWRITE - Allows other scripts to open the file for reading, but not for writing. `w` DENYALL - Does not allow other scripts to open the file when shareable is set to true `a` DENYALL - Does not allow other scripts to open the file when shareable is set to true `r+` DENYALL - Does not allow other scripts to open the file when shareable is set to true `w+` DENYALL - Does not allow other scripts to open the file when shareable is set to true `a+` DENYALL - Does not allow other scripts to open the file when shareable is set to true When shareable is `true` uses the standard C `fopen()` function, and will only attempt to open the file once and will perform no locking. The behavior when one script has a file opened with shareable set to a different value than is used with a new call is OS specific. On Windows, the second open will always fail and on *nix, the second open will always succeed.
popen	boolean	`File.popen([string mode="r+"] [,number buffer_length])`	3.15	Open pipe to command, buffer_length defaults to 2048 bytes, mode (default: `'r+'`) specifies the type of access requested for the file, as follows: `r` read the programs stdout; `w` write to the programs stdin `r+` open for both reading stdout and writing stdin (only functional on UNIX systems)
close	void	`File.close()`	3.10	Close file
remove	boolean	`File.remove()`	3.10	Remove the file from the disk
clear_error	boolean	`File.clear_error()`	3.10	Clears the current error value (AKA clearError)
flush	boolean	`File.flush()`	3.10	Flush/commit buffers to disk
rewind	boolean	`File.rewind()`	3.11	Repositions the file pointer (position) to the beginning of a file and clears error and end-of-file indicators
truncate	boolean	`File.truncate([length=0])`	3.14	Changes the file length (default: 0) and repositions the file pointer (position) to the new end-of-file
lock	boolean	`File.lock([offset=0] [,length=file_length-offset])`	3.10	Lock file record for exclusive access (file must be opened shareable)
unlock	boolean	`File.unlock([offset=0] [,length=file_length-offset])`	3.10	Unlock file record for exclusive access
read	string	`File.read([maxlen=file_length-file_position])`	3.10	Read a string from file (optionally unix-to-unix or base64 encoding in the process), maxlen defaults to the current length of the file minus the current file position
readln	string	`File.readln([maxlen=512])`	3.10	Read a line-feed terminated string, maxlen defaults to 512 characters. Returns null upon end of file.
readBin	number	`File.readBin([bytes=4 [,count=1]])`	3.10	Read one or more binary integers from the file, default number of bytes is 4 (32-bits). if count is not equal to 1, an array is returned (even if no integers were read)
readAll	array	`File.readAll([maxlen=512])`	3.10	Read all lines into an array of strings, maxlen defaults to 512 characters
raw_read	string	`File.raw_read([maxlen=1])`	3.17	Read a string from underlying file descriptor. Undefined results when mixed with any other read/write methods except raw_write, including indirect ones. maxlen defaults to one
raw_pollin	boolean	`File.raw_pollin([timeout])`	3.17	Waits up to timeout milliseconds (or forever if timeout is not specified) for data to be available via raw_read().
write	boolean	`File.write(text [,length=text_length])`	3.10	Write a string to the file (optionally unix-to-unix or base64 decoding in the process). If the specified length is longer than the text, the remaining length will be written as NUL bytes.
writeln	boolean	`File.writeln([text])`	3.10	Write a new-line terminated string (a line of text) to the file
writeBin	boolean	`File.writeBin(value(s) [,bytes=4])`	3.10	Write one or more binary integers to the file, default number of bytes is 4 (32-bits). If value is an array, writes the entire array to the file.
writeAll	boolean	`File.writeAll(array lines)`	3.10	Write an array of new-line terminated strings (lines of text) to the file
raw_write	boolean	`File.raw_write(text)`	3.17	Write a string to the underlying file descriptor. Undefined results when mixed with any other read/write methods except raw_read, including indirect ones.
printf	number	`File.printf(format [,args])`	3.10	Write a C-style formatted string to the file (ala the standard C `fprintf` function)
iniGetSections	array	`File.iniGetSections([prefix=none])`	3.11	Parse all section names from a `.ini` file (format = '`[section]`') and return the section names as an array of strings, optionally, only those section names that begin with the specified prefix
iniGetKeys	array	`File.iniGetKeys([section=root])`	3.11	Parse all key names from the specified section in a `.ini` file and return the key names as an array of strings. if section is undefined, returns key names from the root section
iniGetValue	undefined	`File.iniGetValue(section, key [,default=none])`	3.11	Parse a key from a `.ini` file and return its value (format = '`key = value`'). To parse a key from the root section, pass null for section. Returns the specified default value if the key or value is missing or invalid. Returns a bool, number, string, date, or an array of strings determined by the type of default value specified. Note: To insure that any/all values are returned as a string (e.g. numeric passwords are not returned as a number), pass an empty string ('') for the default value.
iniSetValue	boolean	`File.iniSetValue(section, key, [value=none])`	3.12	Set the specified key to the specified value in the specified section of a `.ini` file. to set a key in the root section, pass null for section.
iniGetObject	object	`File.iniGetObject([section=root] [,bool lowercase=false] [,bool blanks=false])`	3.11	Parse an entire section from a .ini file and return all of its keys (optionally lowercased) and values as properties of an object. If section is `null` or `undefined`, returns keys and values from the root section. If blanks is `true` then empty string (instead of `undefined`) values may included in the returned object. Returns null if the specified section does not exist in the file or the file has not been opened.
iniSetObject	boolean	`File.iniSetObject(section, object object)`	3.12	Write all the properties of the specified object as separate `key=value` pairs in the specified section of a `.ini` file. To write an object in the root section, pass null for section. Note: this method does not remove unreferenced keys from an existing section. If your intention is to replace an existing section, use the `iniRemoveSection` function first.
iniGetAllObjects	array	`File.iniGetAllObjects([string name_property] [,string prefix=none] [,bool lowercase=false] [,blanks=false])`	3.11	Parse all sections from a .ini file and return all (non-root) sections in an array of objects with each section's keys (optionally lowercased) as properties of each object. name_property is the name of the property to create to contain the section's name (optionally lowercased, default is `"name"`), the optional prefix has the same use as in the `iniGetSections` method. If a (String) prefix is specified, it is removed from each section's name. If blanks is `true` then empty string (instead of `undefined`) values may be included in the returned objects.
iniSetAllObjects	boolean	`File.iniSetAllObjects(object array [,name_property="name"])`	3.12	Write an array of objects to a .ini file, each object in its own section named after the object's name_property (default: `name`)
iniRemoveKey	boolean	`File.iniRemoveKey(section, key)`	3.14	Remove specified key from specified section in `.ini` file.
iniRemoveSection	boolean	`File.iniRemoveSection(section)`	3.14	Remove specified section from `.ini` file.
iniRemoveSections	boolean	`File.iniRemoveSections([prefix])`	3.20	Remove all sections from `.ini` file, optionally only sections with the specified section name prefix.
iniReadAll	array	`File.iniReadAll()`	3.18c	Read entire `.ini` file into an array of strings (with `!include`ed files).

**`File` properties**
Name	Type	Ver	Description
name	string	3.10	Filename specified in constructor - READ ONLY
mode	string	3.10	Mode string specified in open call - READ ONLY
exists	boolean	3.10	true if the file is open or exists (case-insensitive) - READ ONLY
is_open	boolean	3.10	true if the file has been opened successfully - READ ONLY
eof	boolean	3.10	true if the current file position is at the end of file - READ ONLY
error	number	3.10	The last occurred error value (use clear_error to clear) - READ ONLY
descriptor	number	3.10	The open file descriptor (advanced use only) - READ ONLY
etx	number	3.10	End-of-text character (advanced use only), if non-zero used by read, readln, and write
debug	boolean	3.10	Set to true to enable debug log output
position	number	3.10	The current file position (offset in bytes), change value to seek within file
date	number	3.11	Last modified date/time (in time_t format)
length	number	3.10	The current length of the file (in bytes)
attributes	number	3.10	File type/mode flags (i.e. `struct stat.st_mode` value, compatible with `file_chmod()`)
network_byte_order	boolean	3.11	Set to true if binary data is to be written and read in Network Byte Order (big end first)
rot13	boolean	3.11	Set to true to enable automatic ROT13 translation of text
uue	boolean	3.11	Set to true to enable automatic Unix-to-Unix encode and decode on `read` and `write` calls
yenc	boolean	3.11	Set to true to enable automatic yEnc encode and decode on `read` and `write` calls
base64	boolean	3.11	Set to true to enable automatic Base64 encode and decode on `read` and `write` calls
crc16	number	3.11	Calculated 16-bit CRC of file contents - READ ONLY
crc32	number	3.11	Calculated 32-bit CRC of file contents - READ ONLY
chksum	number	3.11	Calculated 32-bit checksum of file contents - READ ONLY
md5_hex	undefined	3.11	Calculated 128-bit MD5 digest of file contents as hexadecimal string - READ ONLY
md5_base64	undefined	3.11	Calculated 128-bit MD5 digest of file contents as base64-encoded string - READ ONLY
sha1_hex	undefined	3.19	Calculated 160-bit SHA1 digest of file contents as hexadecimal string - READ ONLY
sha1_base64	undefined	3.19	Calculated 160-bit SHA1 digest of file contents as base64-encoded string - READ ONLY
ini_key_len	number	3.17	Ini style: minimum key length (for left-justified white-space padded keys)
ini_key_prefix	object	3.17	Ini style: key prefix (e.g. '\t', null = default prefix)
ini_section_separator	object	3.17	Ini style: section separator (e.g. '\n', null = default separator)
ini_value_separator	object	3.17	Ini style: value separator (e.g. ' = ', null = default separator)
ini_bit_separator	object	3.17	Ini style: bit separator (e.g. ' \| ', null = default separator)
ini_literal_separator	object	3.17	Ini style: literal separator (null = default separator)

Archive class
Class used for creating, reading, or extracting archive files on the local file system
Note: cannot be used to update (e.g. add/remove/replace files in) an existing archive. - introduced in v3.19

To create a new Archive object: var a = new Archive(filename)

Name Returns Usage Ver Description

create number Archive.create([string format] [,bool with_path=false] [,array file_list]) 3.19 Create an archive of the specified format (e.g. 'zip', '7z', 'tgz').
Returns the number of files archived.
Will throw exception upon error.

read string Archive.read(string path/filename) 3.19 Read and return the contents of the specified archived text file.

extract number Archive.extract(output_directory [,bool with_path=false] [,bool overwrite=true] [,number max_files=0] [,string file/pattern [...]] [,bool recurse=false]) 3.19 Extract files from an archive to specified output directory.
Returns the number of files extracted.
Will throw exception upon error.

list

array

Archive.list([,bool hash=false] [,string file/pattern])

3.19

Get list of archive contents as an array of objects, optionally filtered by a specified path/filename pattern.

Archived object properties:
Name Type Description
type string Item type: 'file', 'link', or 'directory'
name string Item path/name
path string Source path
symlink string
hardlink string
size number Item size in bytes
time number Modification date/time in time_t format
mode number Permissions/mode flags
user string Owner name
group string Owner group
format string Archive format
compression string Compression method
fflags string
crc16 number 16-bit CRC, when hash is true and type is 'file'
crc32 number 32-bit CRC, when hash is true and type is 'file'
md5 string Hexadecimal MD-5 sum, when hash is true and type is 'file'
sha1 string Hexadecimal SHA-1 sum, when hash is true and type is 'file'

When the hash parameter is true, calculates and returns hash/digest values of files in stored archive.

**`Archive` properties**
Name	Type	Description
type	string	Format/compression type of archive file - READ ONLY
name	string	Filename specified in constructor - READ ONLY

Queue class
Class for bi-directional message queues. Used for inter-thread/module communications. - introduced in v3.12

To create a new (named) Queue object: var q = new Queue(name)

**`Queue` methods**
Name	Returns	Usage	Ver	Description
poll	undefined	`Queue.poll([number timeout=0])`	3.12	Wait for any value to be written to the queue for up to timeout milliseconds (default: 0), returns `true` or the name (string) of the value waiting (if it has one), or `false` if no values are waiting
read	undefined	`Queue.read([string name] or [numbertimeout=0])`	3.13	Read a value from the queue, if name not specified, reads next value from the bottom of the queue (waiting up to timeout milliseconds)
peek	undefined	`Queue.peek([number timeout=0])`	3.13	Peek at the value at the bottom of the queue, wait up to timeout milliseconds for any value to be written (default: 0)
write	boolean	`Queue.write(value [,name=none])`	3.12	Write a value (optionally named) to the queue

**`Queue` properties**
Name	Type	Ver	Description
name	undefined	3.12	Name of the queue (if it has one)
data_waiting	boolean	3.12	`true` if data is waiting to be read from queue
read_level	number	3.12	Number of values in the read queue
write_level	number	3.12	Number of values in the write queue
owner	boolean	3.16	`true` if current thread is the owner/creator of the queue
orphan	boolean	3.17c	`true` if the owner of the queue has detached from the queue

Socket class
Class used for TCP/IP socket communications - introduced in v3.10

To create a new Socket object: load('sockdefs.js'); var s = new Socket(type, protocol ,ipv6=false)
where type = SOCK_STREAM for TCP (default) or SOCK_DGRAM for UDP
and protocol (optional) = the name of the protocol or service the socket is to be used for
To create a socket from an existing socket descriptor: var s = new Socket(true, descriptor)
where descriptor is the numerical value of an existing valid socket descriptor

**`Socket` methods**
Name	Returns	Usage	Ver	Description
close	void	`Socket.close()`	3.10	Close (shutdown) the socket immediately
bind	boolean	`Socket.bind([port] [,ip_address])`	3.11	Bind socket to a TCP or UDP port (number or service name), optionally specifying a network interface (via ip_address)
connect	boolean	`Socket.connect(host, port [,timeout=10] [,callback])`	3.11	Connect to a remote port (number or service name) on the specified host (IP address or host name), default timeout value is 10 (seconds). Instead of a timeout, you can pass a callback which is called when the connection completes with the Socket object as the only parameter.
listen	boolean	`Socket.listen()`	3.10	Place socket in a state to listen for incoming connections (use before an accept)
accept	object	`Socket.accept()`	3.10	Accept an incoming connection, returns a new Socket object representing the new connection
send	number	`Socket.send(data)`	3.10	Send a string (AKA write). Returns the number of bytes sent or undefined if an error occured. Versions before 3.17 returned a bool true if all bytes were sent and false otherwise.
sendline	boolean	`Socket.sendline(data)`	3.17	Send a string (AKA write) with a carriage return line feed appended
sendto	boolean	`Socket.sendto(data, address, port)`	3.10	Send data to a specific host (IP address or host name) and port (number or service name), for UDP sockets
sendfile	boolean	`Socket.sendfile(path/filename)`	3.10	Send an entire file over the socket
sendBin	boolean	`Socket.sendBin(value [,bytes=4])`	3.11	Send a binary integer over the socket, default number of bytes is 4 (32-bits)
recv	string	`Socket.recv([maxlen=512, [timeout_sec=120]])`	3.10	Receive a string, default maxlen is 512 characters (AKA read)
peek	string	`Socket.peek([maxlen=512])`	3.10	Receive a string, default maxlen is 512 characters, leaves string in receive buffer (TLS sockets will never return more than one byte)
recvline	string	`Socket.recvline([maxlen=512] [,timeout=30])`	3.10	Receive a line-feed terminated string, default maxlen is 512 characters, default timeout is 30 seconds (AKA readline and readln)
recvfrom	object	`Socket.recvfrom([binary=false] [,maxlen=512 or int_size=4])`	3.11	Receive data (string or integer) from a socket (typically UDP) returns object with ip_address and port of sender along with data properties binary defaults to `false`, maxlen defaults to 512 chars, int_size defaults to 4 bytes (32-bits)
recvBin	number	`Socket.recvBin([bytes=4])`	3.11	Receive a binary integer from the socket, default number of bytes is 4 (32-bits)
getoption	number	`Socket.getoption(option)`	3.10	Get socket option value, option may be socket option name (see `sockopts` in `sockdefs.js`) or number
setoption	boolean	`Socket.setoption(option, value)`	3.10	Set socket option value, option may be socket option name (see `sockopts` in `sockdefs.js`) or number
ioctl	number	`Socket.ioctl(command [,argument=0])`	3.10	Send socket IOCTL (advanced)
poll	number	`Socket.poll([timeout=0] [,write=false])`	3.10	Poll socket for read or write ability (default is read), default timeout value is 0.0 seconds (immediate timeout) returns -1 on error, 0 if the timeout passes without the event triggering, and 1 if the socket is ready
on	number	`Socket.on(('read' \| 'write'), callback)`	3.19	Execute callback whenever socket is readable/writable. Returns an id to be passed to `js.clearOn()`
once	number	`Socket.once(('read' \| 'write'), callback)`	3.19	Execute callback next time socket is readable/writable Returns and id to be passed to `js.clearOnce()`
clearOn	number	`Socket.clearOn(('read' \| 'write'), id)`	3.19	Remove callback installed by Socket.on()
clearOnce	number	`Socket.clearOnce(('read' \| 'write'), id)`	3.19	Remove callback installed by Socket.once()

**`Socket` properties**
Name	Type	Ver	Description
error	number	3.11	Error status for the last socket operation that failed - READ ONLY
error_str	string	3.18	Error description for the last socket operation that failed - READ ONLY
is_connected	boolean	3.10	`true` if socket is in a connected state - READ ONLY
is_writeable	boolean	3.11	`true` if socket can accept written data - Setting to false will shutdown the write end of the socket.
is_writable	boolean	3.12	Alias for is_writeable
data_waiting	boolean	3.10	`true` if data is waiting to be read from socket - READ ONLY
nread	number	3.10	Number of bytes waiting to be read - TLS sockets will never return more than 1 - READ ONLY
debug	number	3.10	Enable debug logging
descriptor	number	3.10	Socket descriptor (advanced uses only)
nonblocking	boolean	3.10	Use non-blocking operation (default is `false`)
local_ip_address	undefined	3.10	Local IP address (string in dotted-decimal format)
local_port	undefined	3.10	Local TCP or UDP port number
remote_ip_address	undefined	3.10	Remote IP address (string in dotted-decimal format)
remote_port	undefined	3.10	Remote TCP or UDP port number
type	number	3.10	Socket type, `SOCK_STREAM` (TCP) or `SOCK_DGRAM` (UDP)
family	undefined	3.18	Socket protocol family, `PF_INET` (IPv4) or `PF_INET6` (IPv6)
network_byte_order	boolean	3.11	`true` if binary data is to be sent in Network Byte Order (big end first), default is `true`
ssl_session	boolean	3.16	Set to `true` to enable SSL as a client on the socket
ssl_server	boolean	3.16	Set to `true` to enable SSL as a server on the socket
tls_minver	number	3.20	Set to 100 to support TLS 1.0, 101 to support TLS 1.1 and 102 (default) for TLS 1.2, must be set before enabling TLS
tls_psk	undefined	3.20c	Set to an object with id: key pairs for TLS PSK auth, must be set before enabling TLS
tls_psk_id	undefined	3.20c	If TLS PSK is used, indicates which entry in tls_psk was used by the remote
tls_nameverify	boolean	3.21b	Enables/Disables TLS server name verification, must be set before enabling TLS
tls_certverify	boolean	3.21b	Enables/Disables TLS certificate verification, must be set before enabling TLS
tls_client_auth	boolean	3.21b	Enables/Disables TLS client authentication, must be set before enabling TLS
tls_enhanced_certcheck	boolean	3.21b	Enables/Disables Enhanced check of TLS certificates
option_list	object	N/A	Array of socket option names supported by the current platform

Socket class object

**`Socket` properties**
Name	Type	Description
AF_INET	number
AF_INET6	number
IPPROTO_IP	number
PF_INET	number
PF_INET6	number
PF_UNSPEC	number
SOCK_DGRAM	number
SOCK_STREAM	number

ConnectedSocket class
Class used for outgoing TCP/IP socket communications - introduced in v3.17

To create a new ConnectedSocket object: load('sockdefs.js'); var s = new ConnectedSocket(hostname, port, {domain:domain, proto:proto ,type:type, protocol:protocol, timeout:timeout, bindport:port, bindaddrs:bindaddrs})
where domain (optional) = PF_UNSPEC (default) for IPv4 or IPv6, PF_INET for IPv4, or PF_INET6 for IPv6
proto (optional) = IPPROTO_IP (default)
type (optional) = SOCK_STREAM for TCP (default) or SOCK_DGRAM for UDP
protocol (optional) = the name of the protocol or service the socket is to be used for
timeout (optional) = 10 (default) the number of seconds to wait for each connect() call to complete.
bindport (optional) = the name or number of the source port to bind to
bindaddrs (optional) = the name or number of the source addresses to bind to. The first of each IPv4 or IPv6 type is used for that family.

ListeningSocket class
Class used for incoming TCP/IP socket communications - introduced in v3.17

To create a new ListeningSocket object: load('sockdefs.js'); var s = new ListeningSocket(interface, port ,protocol, {domain:domain, type:type, proto:proto, retry_count:retry_count, retry_delay:retry_delay})
where interface = A array or strings or a single string of hostnames or address optionally including a :port suffix
port = a port to use when the interface doesn't specify one
protocol = protocol name, used for socket options and logging.
domain (optional) = PF_UNSPEC (default) for IPv4 or IPv6, AF_INET for IPv4, or AF_INET6 for IPv6
proto (optional) = IPPROTO_IP (default)
type (optional) = SOCK_STREAM for TCP (default) or SOCK_DGRAM for UDP
retry_count (optional) = 0 (default) number of times to retry binding
and retry_delay (optional) = 15 (default) seconds to wait before a retry

COM class
Class used for serial port communications - introduced in v3.15b

To create a new COM object: var c = new COM(device)
where device = COMx (e.g. COM1) for Win32 or /dev/ttyXY for *nix (e.g. /dev/ttyu0)

**`COM` methods**
Name	Returns	Usage	Ver	Description
close	void	`COM.close()`	3.15	Close the port immediately
open	boolean	`COM.open()`	3.15	Connect to a COM port
send	boolean	`COM.send(data)`	3.15	Send a string (AKA write)
sendfile	boolean	`COM.sendfile(path/filename)`	3.15	Send an entire file over the port
sendBin	boolean	`COM.sendBin(value [,bytes=4])`	3.15	Send a binary integer over the port, default number of bytes is 4 (32-bits)
recv	string	`COM.recv([maxlen=512 [,timeout=30]])`	3.15	Receive a string, default maxlen is 512 characters, default timeout is 30 seconds (AKA read)
recvline	string	`COM.recvline([maxlen=512] [,timeout=30.0])`	3.15	Receive a line-feed terminated string, default maxlen is 512 characters, default timeout is 30 seconds (AKA readline and readln)
recvBin	number	`COM.recvBin([bytes=4 [,timeout=30])`	3.15	Receive a binary integer from the port, default number of bytes is 4 (32-bits), default timeout is 30 seconds

**`COM` properties**
Name	Type	Ver	Description
error	number	3.15	Error status for the last COM operation that failed - READ ONLY
is_open	boolean	3.15	`true` if port is in a connected state - READ ONLY
debug	boolean	3.15	Enable debug logging
descriptor	number	3.15	COM handle (advanced uses only)
network_byte_order	boolean	3.15	`true` if binary data is to be sent in Network Byte Order (big end first), default is `true`
baud_rate	number	3.15	COM port Baud rate
device	string	3.15	Device name
dtr	boolean	3.15	Data Terminal Ready
cts	boolean	3.15	Clear To Send
dsr	boolean	3.15	Data Set Ready
ring	boolean	3.15	Ring Indicator
dcd	boolean	3.15	Data Carrier Detect

conio object
Console Input/Output Object (DOS conio library functionality for jsexec) - introduced in v3.15

Name Returns Usage Ver Description

init

boolean

conio.init([mode])

3.15

Initialize the conio library and creates a window if needed. Mode is a string with one of the following values:

"AUTO" (default)	Automatically select the "best" output mode.

"ANSI"	Use ANSI escape sequences directly

"STDIO"	Use stdio, worst, but most compatible mode.

"X"	Use X11 output *nix only)

"CONIO"	Use the native conio library (Windows only)

"CONIO_FULLSCREEN"	Use the native conio library and request full-screen (full-screen does not work on all versions of Windows) (Windows only)

"CURSES"	Use the curses terminal library (*nix only)

"CURSES_IBM"	Use the curses terminal library and write extended ASCII characters directly as-is, assuming the terminal is using CP437. (*nix only)

"CURSES_ASCII"	Use the curses terminal library and write US-ASCII characters only. (*nix only)

"SDL"	Use the SDL library for output.

"SDL_FULLSCREEN"	Use the SDL library for output (fullscreen).

suspend void conio.suspend() 3.15 Suspend conio in CONIO or CURSES modes so the terminal can be used for other things.

clreol void conio.clreol() 3.15 Clear to end of line

clrscr void conio.clrscr() 3.15 Clear the screen

wscroll void conio.wscroll() 3.15 Scroll the currently defined window up by one line.

delline void conio.delline() 3.15 Delete the current line and moves lines below up by one line.

insline void conio.insline() 3.15 Insert a new blank line on the current line and scrolls lines below down to make room.

normvideo void conio.normvideo() 3.15 Set the current attribute to "normal" (light grey on black)

getch number conio.getch() 3.15 Wait for and returns a character from the user. Extended keys are returned as two characters.

getche number conio.getche() 3.15 Wait for a character from the user, then echos it. Extended keys can not be returned and are lost.

beep void conio.beep() 3.15 Beep.

getfont number conio.getfont(fnum) 3.15 Return the current font ID or -1 if fonts aren't supported.

hidemouse number conio.hidemouse() 3.15 Hide the mouse cursor. Returns -1 if it cannot be hidden.

showmouse number conio.showmouse() 3.15 Show the mouse cursor. Returns -1 if it cannot be shown.

setcursortype

void

conio.setcursortype(type)

3.15

Set the cursor type. Legal values:

0	No cursor
1	Solid cursor (fills whole cell)
2	Normal cursor

gotoxy void conio.gotoxy(x, y) 3.15 Move the cursor to the given x/y position.

putch number conio.putch(charcode) 3.15 Put the character with the specified ASCII character on the screen and advances the cursor. Returns the character code passed in.

ungetch number conio.ungetch(charcode) 3.15 Push the specified charcode into the input buffer. The next getch() call will get this character.

loadfont void conio.loadfont(filename) 3.15 Load the filename as the current font. Returns -1 on failure.

settitle void conio.settitle(title) 3.15 Set the window title if possible.

setname void conio.setname(name) 3.15 Set the application name. In some modes, this overwrites the window title.

cputs void conio.cputs(string) 3.15 Output string to the console.

setfont

number

conio.setfont(font [, force, fnum])

3.15

Set a current font to the specified font. If force is set, will change video modes if the current one callot use the specified font. fnum selects which current font to change:

0	Default font
1	Main font
2	First alternate font
3	Second alternate font
4	Third alternate font

Returns -1 on failure

getpass string conio.getpass(prompt) 3.15 Prompt for a password, and waits for it to be entered. Characters are not echoed to the screen.

window void conio.window(start_x, start_y, end_x, end_y) 3.15 Set the current window.

cgets void conio.cgets(max_len) 3.15 Input a string, echoing as it's typed, with the specified max_len (up to 255).

movetext void conio.movetext(start_x, start_y, end_x, end_y, dest_x, dest_y) 3.15 Copy the specified screen contents to dest_x/dest_y.

puttext boolean conio.puttext(start_x, start_y, end_x, end_y, bytes) 3.15 Put the contents of the bytes array onto the screen filling the specified rectange. The array is a sequences if integers between 0 and 255 specifying first the ascii character code, then the attribute for that character.

gettext array conio.gettext(start_x, start_y, end_x, end_y) 3.15 Return an array containing the characters and attributes for the specified rectangle.

**`conio` properties**
Name	Type	Ver	Description
wscroll	boolean	3.15	Allows windows to scroll
directvideo	boolean	3.15	Enables direct video writes (does nothing)
hold_update	boolean	3.15	Do not update the screen when characters are printed
puttext_can_move	boolean	3.15	Calling puttext() (and some other things implemented using it) can move the cursor position
mode	number	3.15	The current video mode - READ ONLY
mouse	boolean	3.15	Mouse enabled (1) or disabled (0) - READ ONLY
ESCDELAY	number	3.15	Delay in MS after getting an escape character before assuming it is not part of a sequence. For curses and ANSI modes
textattr	number	3.15	Current text attribute
kbhit	boolean	3.15	True if a keystroke is pending - READ ONLY
wherex	number	3.15	Current x position on the screen
wherey	number	3.15	Current y position on the screen
textmode	number	3.15	Current text mode
winleft	number	3.15	Left column of current window - READ ONLY
wintop	number	3.15	Top row of current window - READ ONLY
winright	number	3.15	Right column of current window - READ ONLY
winbottom	number	3.15	Bottom row of current window - READ ONLY
screenwidth	number	3.15	Width of the screen - READ ONLY
screenheight	number	3.15	Height of the screen - READ ONLY
normattr	number	3.15	Attribute considered "normal" - READ ONLY
textbackground	number	3.15	Background colour
textcolor	number	3.15	Foreground colour
clipboard	string	3.15	Text in the clipboard
lowvideo	boolean	3.15	Current attribute is low intensity
highvideo	boolean	3.15	Current attribute is high intensity

CryptContext class
Class used for encryption/decryption - introduced in v3.16b

To create a new CryptContext object: var c = new CryptContext(algorithm)
where algorithm is a property of CryptContext.ALGO

**`CryptContext` methods**
Name	Returns	Usage	Ver	Description
generate_key	void	`CryptContext.generate_key()`	3.16	Generate a new key for the context.
set_key	void	`CryptContext.set_key(key_str)`	3.16	Set the key for the context directly.
derive_key	void	`CryptContext.derive_key(keying_data)`	3.16	Derive the key from the keying data using keying_algo, keying_iterations, and keying_salt.
encrypt	string	`CryptContext.encrypt(plaintext)`	3.16	Encrypt the string and return as a new string.
decrypt	string	`CryptContext.decrypt(ciphertext)`	3.16	Decrypt the string and return as a new string.
create_signature	string	`CryptContext.create_signature(sigContext)`	3.16	Create a signature signed with the sigContext CryptContext object.

**`CryptContext` properties**
Name	Type	Ver	Description
algo	number	3.16	Algorithm constant (CryptContext.ALGO.XXX)
blocksize	number	3.16	Cipher block size in bytes
hashvalue	undefined	3.16	Output of hasing algorithms (ie: MD5, SHA1, etc)
iv	undefined	3.16	Cipher IV
ivsize	number	3.16	Cipher IV size in bytes
keying_algo	undefined	3.16	The keying algorithm used to derive the key
keying_iterations	number	3.16	The number of iterates used to derive the key
keying_salt	undefined	3.16	The salt value used to derive an encryption key from a key (Length must be between 8 and 64)
keysize	number	3.16	Key size in bytes
label	undefined	3.16	Key label
mode	number	3.16	Mode constant (CryptContext.MODE.XXX)
algo_name	string	3.16	Algorithm name
mode_name	string	3.16	Mode name

CryptContext class object

CryptContext.ALGO object
Associative array of crypto algorithm constants - introduced in v3.18

**`CryptContext.ALGO` properties**
Name	Type	Description
None	number	No encryption
DES	number	DES is a 64-bit block cipher with a 56-bit key. Note that this algorithm is no longer considered secure and should not be used. It is present in cryptlib only for compatibility with legacy applications. Although cryptlib uses 64-bit DES keys, only 56 bits of the key are actually used. The least significant bit in each byte is used as a parity bit (cryptlib will set the correct parity values for you, so you don't have to worry about this). You can treat the algorithm as having a 64-bit key, but bear in mind that only the high 7 bits of each byte are actually used as keying material. Loading a key will return a CRYPT_ERROR_PARAM3 error if the key is a weak key. cryptExportKey will export the correct parity-adjusted version of the key.
3DES	number	Triple DES is a 64-bit block cipher with a 112/168-bit key. Although cryptlib uses 128, or 192-bit DES keys (depending on whether two- or three-key triple DES is being used), only 112 or 168 bits of the key are actually used. The least significant bit in each byte is used as a parity bit (cryptlib will set the correct parity values for you, so you don't have to worry about this). You can treat the algorithm as having a 128 or 192-bit key, but bear in mind that only the high 7 bits of each byte are actually used as keying material. Loading a key will return a CRYPT_ERROR_PARAM3 error if the key is a weak key. cryptExportKey will export the correct parity-adjusted version of the key.
IDEA	number	IDEA is a 64-bit block cipher with a 128-bit key. IDEA was formerly covered by patents, but these have now all expired.
CAST	number	CAST-128 is a 64-bit block cipher with a 128-bit key
RC2	number	RC2 (disabled by default, used for PKCS #12)
RC4	number	RC4 is an 8-bit stream cipher with a key of up to 1024 bits. Some weaknesses have been found in this algorithm, and it's proven to be extremely difficult to employ in a safe manner. For this reason it should not be used any more except for legacy application support, and is disabled by default. The term "RC4" is trademarked in the US. It may be necessary to refer to it as "an algorithm compatible with RC4" in products that use RC4 and are distributed in the US. Common practice is to refer to it as ArcFour.
AES	number	AES is a 128-bit block cipher with a 128-bit key.
ChaCha20	number	ChaCha20 is a 512-bit state stream cipher with a 128 or 256-bit key size.
DH	number	Diffie-Hellman is a key-agreement algorithm with a key size of up to 4096 bits. Diffie-Hellman was formerly covered by a patent in the US, this has now expired.
RSA	number	RSA is a public-key encryption/digital signature algorithm with a key size of up to 4096 bits. RSA was formerly covered by a patent in the US, this has now expired.
DSA	number	DSA is a digital signature algorithm with a key size of up to 1024 bits and has the cryptlib algorithm identifier CRYPT_ALGO_DSA. DSA is covered by US patent 5,231,668, with the patent held by the US government. This patent has been made available royalty-free to all users world-wide. The US Department of Commerce is not aware of any other patents that would be infringed by the DSA. US patent 4,995,082, "Method for identifying subscribers and for generating and verifying electronic signatures in a data exchange system" ("the Schnorr patent") relates to the DSA algorithm but only applies to a very restricted set of smart-card based applications and does not affect the DSA implementation in cryptlib.
ELGAMAL	number	Elgamal is a public-key encryption/digital signature algorithm with a key size of up to 4096 bits. Elgamal was formerly covered (indirectly) by a patent in the US, this has now expired.
ECDSA	number	ECDSA is a digital signature algorithm with a key size of up to 521 bits.
ECDH	number	ECDH is a key-agreement algorithm with a key size of up to 521 bits.
EDDSA	number	EDDSA is a digital signature scheme using a variant of Schnorr signature based on twisted Edwards curves.
X25519	number	X25519 is a digital signature scheme using one of the fastest curves in ECC, and is not covered by any known patents.
MD5	number	MD5 (only used for TLS 1.0/1.1)
SHA1	number	SHA1 is a message digest/hash algorithm with a digest/hash size of 160 bits. This algorithm has poor long-term security prospects and should be deprecated in favour of SHA-2.
SHA2	number	SHA2/SHA256 is a message digest/hash algorithm with a digest/hash size of 256 bits.
SHAng	number	Future SHA-nextgen standard
HMAC-SHA1	number	HMAC-SHA1 is a MAC algorithm with a key size of up to 1024 bits.
HMAC-SHA2	number	HMAC-SHA2 is a MAC algorithm with a key size of up to 1024 bits.
HMAC-SHAng	number	HMAC-future-SHA-nextgen
Poly1305	number	Poly1305 is a universal hash family designed for use in cryptography.

CryptContext.MODE object
Associative array of crypto mode constants - introduced in v3.18

**`CryptContext.MODE` properties**
Name	Type	Description
None	number	No encryption mode
ECB	number	ECB
CBC	number	CBC
CFB	number	CFB
GCM	number	GCM

CryptKeyset class
Class used for storing CryptContext keys - introduced in v3.16b

To create a new CryptKeyset object: var c = new CryptKeyset(filename [ opts = CryptKeyset.KEYOPT.NONE ])
where filename is the name of the file to create, and opts is a value from CryptKeyset.KEYOPT

**`CryptKeyset` methods**
Name	Returns	Usage	Ver	Description
add_private_key	void	`CryptKeyset.add_private_key(CryptContext, password)`	3.16	Add a private key to the keyset, encrypting it with <password>.
add_public_key	void	`CryptKeyset.add_public_key(CryptCert)`	3.16	Add a public key (certificate) to the keyset.
close	void	`CryptKeyset.close()`	3.16	Close the keyset.
delete_key	void	`CryptKeyset.delete_key(label)`	3.16	Delete the key with <label> from the keyset.
get_private_key	object	`CryptKeyset.get_private_key(label, password)`	3.16	Return a CryptContext from the private key with encrypted with <password>.
get_public_key	object	`CryptKeyset.get_public_key(label)`	3.16	Return a CryptCert from the public key with <label>.

CryptKeyset class object

CryptKeyset.KEYOPT object
Associative array of keyset option constants - introduced in v3.18

**`CryptKeyset.KEYOPT` properties**
Name	Type	Description
NONE	number	No special access options (this option implies read/write access).
READONLY	number	Read-only keyset access. This option is automatically enabled by cryptlib for keyset types that have read-only restrictions enforced by the nature of the keyset, the operating system, or user access rights. Unless you specifically require write access to the keyset, you should use this option since it allows cryptlib to optimise its buffering and access strategies for the keyset.
CREATE	number	Create a new keyset. This option is only valid for writeable keyset types, which includes keysets implemented as databases and cryptlib key files.

CryptCert class
Class used for Certificates - introduced in v3.16b

To create a new CryptCert object: var c = new CryptCert(type | cert)
where type is a value from CryptCert.TYPE and cert is a DER encoded certificate string

**`CryptCert` methods**
Name	Returns	Usage	Ver	Description
add_extension	void	`CryptCert.add_extension(oid, critical, extension)`	3.16	Adds a DER encoded certificate extension.
check	boolean	`CryptCert.check()`	3.16	Checks the certificate for validity.
destroy	void	`CryptCert.destroy()`	3.16	Destroys the certificate.
export_cert	string	`CryptCert.export_cert(format)`	3.16	Exports the certificate in the format chosen from CryptCert.FORMAT.
get_attribute	void	`CryptCert.get_attribute(attr)`	3.16	Gets the specified attribute as an integer
get_attribute_string	void	`CryptCert.get_attribute_string(attr)`	3.16	Gets the specified attribute as a string
get_attribute_time	void	`CryptCert.get_attribute_time(attr)`	3.16	Gets the specified attribute as a time
set_attribute	void	`CryptCert.set_attribute(attr, value)`	3.16	Sets the specified attribute to the specified value
set_attribute_string	void	`CryptCert.set_attribute_string(attr, value)`	3.16	Sets the specified attribute to the specified value
set_attribute_time	void	`CryptCert.set_attribute_time(attr, value)`	3.16	Sets the specified attribute to the specified value
sign	void	`CryptCert.sign(key)`	3.16	Signs the certificate with the specified CryptContext

**`CryptCert` properties**
Name	Type	Ver
selfsigned	number	3.16
immutable	number	3.16
xyzzy	number	3.16
certtype	number	3.16
fingerprint_sha1	undefined	3.16
fingerprint_sha2	undefined	3.16
fingerprint_shang	undefined	3.16
current_certificate	undefined	3.16
trusted_usage	undefined	3.16
trusted_implicit	undefined	3.16
signaturelevel	undefined	3.16
version	number	3.16
serialnumber	undefined	3.16
subjectpublickeyinfo	undefined	3.16
certificate	undefined	3.16
cacertificate	undefined	3.16
issuername	undefined	3.16
validfrom	undefined	3.16
validto	undefined	3.16
subjectname	undefined	3.16
issueruniqueid	undefined	3.16
subjectuniqueid	undefined	3.16
certrequest	undefined	3.16
thisupdate	undefined	3.16
nextupdate	undefined	3.16
revocationdate	undefined	3.16
revocationstatus	undefined	3.16
certstatus	undefined	3.16
dn	undefined	3.16
pkiuser_id	undefined	3.16
pkiuser_issuepassword	undefined	3.16
pkiuser_revpassword	undefined	3.16
pkiuser_ra	undefined	3.16
countryname	undefined	3.16
stateorprovincename	undefined	3.16
localityname	undefined	3.16
organizationname	undefined	3.16
organizationalunitname	undefined	3.16
commonname	undefined	3.16
othername_typeid	undefined	3.16
othername_value	undefined	3.16
rfc822name	undefined	3.16
dnsname	undefined	3.16
directoryname	undefined	3.16
edipartyname_nameassigner	undefined	3.16
edipartyname_partyname	undefined	3.16
uniformresourceidentifier	undefined	3.16
ipaddress	undefined	3.16
registeredid	undefined	3.16
challengepassword	undefined	3.16
crlextreason	undefined	3.16
keyfeatures	undefined	3.16
authorityinfoaccess	undefined	3.16
authorityinfo_rtcs	undefined	3.16
authorityinfo_ocsp	undefined	3.16
authorityinfo_caissuers	undefined	3.16
authorityinfo_certstore	undefined	3.16
authorityinfo_crls	undefined	3.16
biometricinfo	undefined	3.16
biometricinfo_type	undefined	3.16
biometricinfo_hashalgo	undefined	3.16
biometricinfo_hash	undefined	3.16
biometricinfo_url	undefined	3.16
qcstatement	undefined	3.16
qcstatement_semantics	undefined	3.16
qcstatement_registrationauthority	undefined	3.16
ipaddressblocks	undefined	3.16
ipaddressblocks_addressfamily	undefined	3.16
ipaddressblocks_prefix	undefined	3.16
ipaddressblocks_min	undefined	3.16
ipaddressblocks_max	undefined	3.16
autonomoussysids	undefined	3.16
autonomoussysids_asnum_id	undefined	3.16
autonomoussysids_asnum_min	undefined	3.16
autonomoussysids_asnum_max	undefined	3.16
ocsp_nonce	undefined	3.16
ocsp_response	undefined	3.16
ocsp_response_ocsp	undefined	3.16
ocsp_nocheck	undefined	3.16
ocsp_archivecutoff	undefined	3.16
subjectinfoaccess	undefined	3.16
subjectinfo_timestamping	undefined	3.16
subjectinfo_carepository	undefined	3.16
subjectinfo_signedobjectrepository	undefined	3.16
subjectinfo_rpkimanifest	undefined	3.16
subjectinfo_signedobject	undefined	3.16
sigg_dateofcertgen	undefined	3.16
sigg_procuration	undefined	3.16
sigg_procure_country	undefined	3.16
sigg_procure_typeofsubstitution	undefined	3.16
sigg_procure_signingfor	undefined	3.16
sigg_admissions	undefined	3.16
sigg_admissions_authority	undefined	3.16
sigg_admissions_namingauthid	undefined	3.16
sigg_admissions_namingauthurl	undefined	3.16
sigg_admissions_namingauthtext	undefined	3.16
sigg_admissions_professionitem	undefined	3.16
sigg_admissions_professionoid	undefined	3.16
sigg_admissions_registrationnumber	undefined	3.16
sigg_monetarylimit	undefined	3.16
sigg_monetary_currency	undefined	3.16
sigg_monetary_amount	undefined	3.16
sigg_monetary_exponent	undefined	3.16
sigg_declarationofmajority	undefined	3.16
sigg_declarationofmajority_country	undefined	3.16
sigg_restriction	undefined	3.16
sigg_certhash	undefined	3.16
sigg_additionalinformation	undefined	3.16
strongextranet	undefined	3.16
strongextranet_zone	undefined	3.16
strongextranet_id	undefined	3.16
subjectdirectoryattributes	undefined	3.16
subjectdir_type	undefined	3.16
subjectdir_values	undefined	3.16
subjectkeyidentifier	undefined	3.16
keyusage	undefined	3.16
privatekeyusageperiod	undefined	3.16
privatekey_notbefore	undefined	3.16
privatekey_notafter	undefined	3.16
subjectaltname	undefined	3.16
issueraltname	undefined	3.16
basicconstraints	undefined	3.16
ca	undefined	3.16
pathlenconstraint	undefined	3.16
crlnumber	undefined	3.16
crlreason	undefined	3.16
holdinstructioncode	undefined	3.16
invaliditydate	undefined	3.16
deltacrlindicator	undefined	3.16
issuingdistributionpoint	undefined	3.16
issuingdist_fullname	undefined	3.16
issuingdist_usercertsonly	undefined	3.16
issuingdist_cacertsonly	undefined	3.16
issuingdist_somereasonsonly	undefined	3.16
issuingdist_indirectcrl	undefined	3.16
certificateissuer	undefined	3.16
nameconstraints	undefined	3.16
permittedsubtrees	undefined	3.16
excludedsubtrees	undefined	3.16
crldistributionpoint	undefined	3.16
crldist_fullname	undefined	3.16
crldist_reasons	undefined	3.16
crldist_crlissuer	undefined	3.16
certificatepolicies	undefined	3.16
certpolicyid	undefined	3.16
certpolicy_cpsuri	undefined	3.16
certpolicy_organization	undefined	3.16
certpolicy_noticenumbers	undefined	3.16
certpolicy_explicittext	undefined	3.16
policymappings	undefined	3.16
issuerdomainpolicy	undefined	3.16
subjectdomainpolicy	undefined	3.16
authoritykeyidentifier	undefined	3.16
authority_keyidentifier	undefined	3.16
authority_certissuer	undefined	3.16
authority_certserialnumber	undefined	3.16
policyconstraints	undefined	3.16
requireexplicitpolicy	undefined	3.16
inhibitpolicymapping	undefined	3.16
extkeyusage	undefined	3.16
extkey_ms_individualcodesigning	undefined	3.16
extkey_ms_commercialcodesigning	undefined	3.16
extkey_ms_certtrustlistsigning	undefined	3.16
extkey_ms_timestampsigning	undefined	3.16
extkey_ms_servergatedcrypto	undefined	3.16
extkey_ms_encryptedfilesystem	undefined	3.16
extkey_serverauth	undefined	3.16
extkey_clientauth	undefined	3.16
extkey_codesigning	undefined	3.16
extkey_emailprotection	undefined	3.16
extkey_ipsecendsystem	undefined	3.16
extkey_ipsectunnel	undefined	3.16
extkey_ipsecuser	undefined	3.16
extkey_timestamping	undefined	3.16
extkey_ocspsigning	undefined	3.16
extkey_directoryservice	undefined	3.16
extkey_anykeyusage	undefined	3.16
extkey_ns_servergatedcrypto	undefined	3.16
extkey_vs_servergatedcrypto_ca	undefined	3.16
crlstreamidentifier	undefined	3.16
freshestcrl	undefined	3.16
freshestcrl_fullname	undefined	3.16
freshestcrl_reasons	undefined	3.16
freshestcrl_crlissuer	undefined	3.16
orderedlist	undefined	3.16
baseupdatetime	undefined	3.16
deltainfo	undefined	3.16
deltainfo_location	undefined	3.16
deltainfo_nextdelta	undefined	3.16
inhibitanypolicy	undefined	3.16
toberevoked	undefined	3.16
toberevoked_certissuer	undefined	3.16
toberevoked_reasoncode	undefined	3.16
toberevoked_revocationtime	undefined	3.16
toberevoked_certserialnumber	undefined	3.16
revokedgroups	undefined	3.16
revokedgroups_certissuer	undefined	3.16
revokedgroups_reasoncode	undefined	3.16
revokedgroups_invaliditydate	undefined	3.16
revokedgroups_startingnumber	undefined	3.16
revokedgroups_endingnumber	undefined	3.16
expiredcertsoncrl	undefined	3.16
aaissuingdistributionpoint	undefined	3.16
aaissuingdist_fullname	undefined	3.16
aaissuingdist_somereasonsonly	undefined	3.16
aaissuingdist_indirectcrl	undefined	3.16
aaissuingdist_userattrcerts	undefined	3.16
aaissuingdist_aacerts	undefined	3.16
aaissuingdist_soacerts	undefined	3.16
ns_certtype	undefined	3.16
ns_baseurl	undefined	3.16
ns_revocationurl	undefined	3.16
ns_carevocationurl	undefined	3.16
ns_certrenewalurl	undefined	3.16
ns_capolicyurl	undefined	3.16
ns_sslservername	undefined	3.16
ns_comment	undefined	3.16
set_hashedrootkey	undefined	3.16
set_rootkeythumbprint	undefined	3.16
set_certificatetype	undefined	3.16
set_merchantdata	undefined	3.16
set_merid	undefined	3.16
set_meracquirerbin	undefined	3.16
set_merchantlanguage	undefined	3.16
set_merchantname	undefined	3.16
set_merchantcity	undefined	3.16
set_merchantstateprovince	undefined	3.16
set_merchantpostalcode	undefined	3.16
set_merchantcountryname	undefined	3.16
set_mercountry	undefined	3.16
set_merauthflag	undefined	3.16
set_certcardrequired	undefined	3.16
set_tunneling	undefined	3.16
set_tunnelingflag	undefined	3.16
set_tunnelingalgid	undefined	3.16
cms_contenttype	undefined	3.16
cms_messagedigest	undefined	3.16
cms_signingtime	undefined	3.16
cms_countersignature	undefined	3.16
cms_signingdescription	undefined	3.16
cms_smimecapabilities	undefined	3.16
cms_smimecap_3des	undefined	3.16
cms_smimecap_aes	undefined	3.16
cms_smimecap_cast128	undefined	3.16
cms_smimecap_shang	undefined	3.16
cms_smimecap_sha2	undefined	3.16
cms_smimecap_sha1	undefined	3.16
cms_smimecap_hmac_shang	undefined	3.16
cms_smimecap_hmac_sha2	undefined	3.16
cms_smimecap_hmac_sha1	undefined	3.16
cms_smimecap_authenc256	undefined	3.16
cms_smimecap_authenc128	undefined	3.16
cms_smimecap_rsa_shang	undefined	3.16
cms_smimecap_rsa_sha2	undefined	3.16
cms_smimecap_rsa_sha1	undefined	3.16
cms_smimecap_dsa_sha1	undefined	3.16
cms_smimecap_ecdsa_shang	undefined	3.16
cms_smimecap_ecdsa_sha2	undefined	3.16
cms_smimecap_ecdsa_sha1	undefined	3.16
cms_smimecap_prefersigneddata	undefined	3.16
cms_smimecap_cannotdecryptany	undefined	3.16
cms_smimecap_preferbinaryinside	undefined	3.16
cms_receiptrequest	undefined	3.16
cms_receipt_contentidentifier	undefined	3.16
cms_receipt_from	undefined	3.16
cms_receipt_to	undefined	3.16
cms_securitylabel	undefined	3.16
cms_seclabel_policy	undefined	3.16
cms_seclabel_classification	undefined	3.16
cms_seclabel_privacymark	undefined	3.16
cms_seclabel_cattype	undefined	3.16
cms_seclabel_catvalue	undefined	3.16
cms_mlexpansionhistory	undefined	3.16
cms_mlexp_entityidentifier	undefined	3.16
cms_mlexp_time	undefined	3.16
cms_mlexp_none	undefined	3.16
cms_mlexp_insteadof	undefined	3.16
cms_mlexp_inadditionto	undefined	3.16
cms_contenthints	undefined	3.16
cms_contenthint_description	undefined	3.16
cms_contenthint_type	undefined	3.16
cms_equivalentlabel	undefined	3.16
cms_eqvlabel_policy	undefined	3.16
cms_eqvlabel_classification	undefined	3.16
cms_eqvlabel_privacymark	undefined	3.16
cms_eqvlabel_cattype	undefined	3.16
cms_eqvlabel_catvalue	undefined	3.16
cms_signingcertificate	undefined	3.16
cms_signingcert_esscertid	undefined	3.16
cms_signingcert_policies	undefined	3.16
cms_signingcertificatev2	undefined	3.16
cms_signingcertv2_esscertidv2	undefined	3.16
cms_signingcertv2_policies	undefined	3.16
cms_signaturepolicyid	undefined	3.16
cms_sigpolicyid	undefined	3.16
cms_sigpolicyhash	undefined	3.16
cms_sigpolicy_cpsuri	undefined	3.16
cms_sigpolicy_organization	undefined	3.16
cms_sigpolicy_noticenumbers	undefined	3.16
cms_sigpolicy_explicittext	undefined	3.16
cms_sigtypeidentifier	undefined	3.16
cms_sigtypeid_originatorsig	undefined	3.16
cms_sigtypeid_domainsig	undefined	3.16
cms_sigtypeid_additionalattributes	undefined	3.16
cms_sigtypeid_reviewsig	undefined	3.16
cms_nonce	undefined	3.16
scep_messagetype	undefined	3.16
scep_pkistatus	undefined	3.16
scep_failinfo	undefined	3.16
scep_sendernonce	undefined	3.16
scep_recipientnonce	undefined	3.16
scep_transactionid	undefined	3.16
cms_spcagencyinfo	undefined	3.16
cms_spcagencyurl	undefined	3.16
cms_spcstatementtype	undefined	3.16
cms_spcstmt_individualcodesigning	undefined	3.16
cms_spcstmt_commercialcodesigning	undefined	3.16
cms_spcopusinfo	undefined	3.16
cms_spcopusinfo_name	undefined	3.16
cms_spcopusinfo_url	undefined	3.16

CryptCert class object

CryptCert.CURSOR object
Associative array of cursor constants - introduced in v3.18

**`CryptCert.CURSOR` properties**
Name	Type	Description
FIRST	number	Move the cursor to the first group or attribute.
PREVIOUS	number	Move the cursor to the last group or attribute.
NEXT	number	Move the cursor to the next group or attribute.
LAST	number	Move the cursor to the previous group or attribute.
CURRENT_GROUP	number
CURRENT	number
CURRENT_INSTANCE	number
CURRENT_CERTIFICATE	number

CryptCert.TYPE object
Associative array of certificate type constants - introduced in v3.18

**`CryptCert.TYPE` properties**
Name	Type	Description
NONE	number	No certificate type
CERTIFICATE	number	Certificate.
ATTRIBUTE_CERT	number	Attribute certificate.
CERTCHAIN	number	PKCS #7 certificate chain.
CERTREQUEST	number	PKCS #10 certification request.
REQUEST_CERT	number	CRMF certificate request
REQUEST_REVOCATION	number	CRMF certificate revocation request
CRL	number	CRL
CMS_ATTRIBUTES	number	PKCS #7/CMS attributes.
RTCS_REQUEST	number	RTCS request
RTCS_RESPONSE	number	RTCS response
OCSP_REQUEST	number	OCSP request
OCSP_RESPONSE	number	OCSP response
PKIUSER	number	PKI user information.

CryptCert.FORMAT object
Associative array of certificate format constants - introduced in v3.18

**`CryptCert.FORMAT` properties**
Name	Type	Description
NONE	number	No certificate format
CERTIFICATE	number	A certification request, certificate, or CRL in binary data format. The certificate object is encoded according to the ASN.1 distinguished encoding rules. This is the normal certificate encoding format.
CERTCHAIN	number	A certificate encoded as a PKCS #7 certificate chain.
TEXT_CERTIFICATE	number	As CERTIFICATE but with base64 armouring of the binary data.
TEXT_CERTCHAIN	number	As CERTCHAIN but with base64 armouring of the binary data.
XML_CERTIFICATE	number	XML wrapped cert
XML_CERTCHAIN	number	XML wrapped certchain

CryptCert.ATTR object
Associative array of certificate attribute constants - introduced in v3.18

**`CryptCert.ATTR` properties**
Name	Type	Description
SELFSIGNED	number
IMMUTABLE	number
XYZZY	number
CERTTYPE	number
FINGERPRINT_SHA1	number
FINGERPRINT_SHA2	number
FINGERPRINT_SHAng	number
CURRENT_CERTIFICATE	number
TRUSTED_USAGE	number
TRUSTED_IMPLICIT	number
SIGNATURELEVEL	number
VERSION	number
SERIALNUMBER	number
SUBJECTPUBLICKEYINFO	number
CERTIFICATE	number
CACERTIFICATE	number
ISSUERNAME	number
VALIDFROM	number
VALIDTO	number
SUBJECTNAME	number
ISSUERUNIQUEID	number
SUBJECTUNIQUEID	number
CERTREQUEST	number
THISUPDATE	number
NEXTUPDATE	number
REVOCATIONDATE	number
REVOCATIONSTATUS	number
CERTSTATUS	number
DN	number
PKIUSER_ID	number
PKIUSER_ISSUEPASSWORD	number
PKIUSER_REVPASSWORD	number
PKIUSER_RA	number
COUNTRYNAME	number
STATEORPROVINCENAME	number
LOCALITYNAME	number
ORGANIZATIONNAME	number
ORGANIZATIONALUNITNAME	number
COMMONNAME	number
OTHERNAME_TYPEID	number
OTHERNAME_VALUE	number
RFC822NAME	number
DNSNAME	number
DIRECTORYNAME	number
EDIPARTYNAME_NAMEASSIGNER	number
EDIPARTYNAME_PARTYNAME	number
UNIFORMRESOURCEIDENTIFIER	number
IPADDRESS	number
REGISTEREDID	number
CHALLENGEPASSWORD	number
CRLEXTREASON	number
KEYFEATURES	number
AUTHORITYINFOACCESS	number
AUTHORITYINFO_RTCS	number
AUTHORITYINFO_OCSP	number
AUTHORITYINFO_CAISSUERS	number
AUTHORITYINFO_CERTSTORE	number
AUTHORITYINFO_CRLS	number
BIOMETRICINFO	number
BIOMETRICINFO_TYPE	number
BIOMETRICINFO_HASHALGO	number
BIOMETRICINFO_HASH	number
BIOMETRICINFO_URL	number
QCSTATEMENT	number
QCSTATEMENT_SEMANTICS	number
QCSTATEMENT_REGISTRATIONAUTHORITY	number
IPADDRESSBLOCKS	number
IPADDRESSBLOCKS_ADDRESSFAMILY	number
IPADDRESSBLOCKS_PREFIX	number
IPADDRESSBLOCKS_MIN	number
IPADDRESSBLOCKS_MAX	number
AUTONOMOUSSYSIDS	number
AUTONOMOUSSYSIDS_ASNUM_ID	number
AUTONOMOUSSYSIDS_ASNUM_MIN	number
AUTONOMOUSSYSIDS_ASNUM_MAX	number
OCSP_NONCE	number
OCSP_RESPONSE	number
OCSP_RESPONSE_OCSP	number
OCSP_NOCHECK	number
OCSP_ARCHIVECUTOFF	number
SUBJECTINFOACCESS	number
SUBJECTINFO_TIMESTAMPING	number
SUBJECTINFO_CAREPOSITORY	number
SUBJECTINFO_SIGNEDOBJECTREPOSITORY	number
SUBJECTINFO_RPKIMANIFEST	number
SUBJECTINFO_SIGNEDOBJECT	number
SIGG_DATEOFCERTGEN	number
SIGG_PROCURATION	number
SIGG_PROCURE_COUNTRY	number
SIGG_PROCURE_TYPEOFSUBSTITUTION	number
SIGG_PROCURE_SIGNINGFOR	number
SIGG_ADMISSIONS	number
SIGG_ADMISSIONS_AUTHORITY	number
SIGG_ADMISSIONS_NAMINGAUTHID	number
SIGG_ADMISSIONS_NAMINGAUTHURL	number
SIGG_ADMISSIONS_NAMINGAUTHTEXT	number
SIGG_ADMISSIONS_PROFESSIONITEM	number
SIGG_ADMISSIONS_PROFESSIONOID	number
SIGG_ADMISSIONS_REGISTRATIONNUMBER	number
SIGG_MONETARYLIMIT	number
SIGG_MONETARY_CURRENCY	number
SIGG_MONETARY_AMOUNT	number
SIGG_MONETARY_EXPONENT	number
SIGG_DECLARATIONOFMAJORITY	number
SIGG_DECLARATIONOFMAJORITY_COUNTRY	number
SIGG_RESTRICTION	number
SIGG_CERTHASH	number
SIGG_ADDITIONALINFORMATION	number
STRONGEXTRANET	number
STRONGEXTRANET_ZONE	number
STRONGEXTRANET_ID	number
SUBJECTDIRECTORYATTRIBUTES	number
SUBJECTDIR_TYPE	number
SUBJECTDIR_VALUES	number
SUBJECTKEYIDENTIFIER	number
KEYUSAGE	number
PRIVATEKEYUSAGEPERIOD	number
PRIVATEKEY_NOTBEFORE	number
PRIVATEKEY_NOTAFTER	number
SUBJECTALTNAME	number
ISSUERALTNAME	number
BASICCONSTRAINTS	number
CA	number
PATHLENCONSTRAINT	number
CRLNUMBER	number
CRLREASON	number
HOLDINSTRUCTIONCODE	number
INVALIDITYDATE	number
DELTACRLINDICATOR	number
ISSUINGDISTRIBUTIONPOINT	number
ISSUINGDIST_FULLNAME	number
ISSUINGDIST_USERCERTSONLY	number
ISSUINGDIST_CACERTSONLY	number
ISSUINGDIST_SOMEREASONSONLY	number
ISSUINGDIST_INDIRECTCRL	number
CERTIFICATEISSUER	number
NAMECONSTRAINTS	number
PERMITTEDSUBTREES	number
EXCLUDEDSUBTREES	number
CRLDISTRIBUTIONPOINT	number
CRLDIST_FULLNAME	number
CRLDIST_REASONS	number
CRLDIST_CRLISSUER	number
CERTIFICATEPOLICIES	number
CERTPOLICYID	number
CERTPOLICY_CPSURI	number
CERTPOLICY_ORGANIZATION	number
CERTPOLICY_NOTICENUMBERS	number
CERTPOLICY_EXPLICITTEXT	number
POLICYMAPPINGS	number
ISSUERDOMAINPOLICY	number
SUBJECTDOMAINPOLICY	number
AUTHORITYKEYIDENTIFIER	number
AUTHORITY_KEYIDENTIFIER	number
AUTHORITY_CERTISSUER	number
AUTHORITY_CERTSERIALNUMBER	number
POLICYCONSTRAINTS	number
REQUIREEXPLICITPOLICY	number
INHIBITPOLICYMAPPING	number
EXTKEYUSAGE	number
EXTKEY_MS_INDIVIDUALCODESIGNING	number
EXTKEY_MS_COMMERCIALCODESIGNING	number
EXTKEY_MS_CERTTRUSTLISTSIGNING	number
EXTKEY_MS_TIMESTAMPSIGNING	number
EXTKEY_MS_SERVERGATEDCRYPTO	number
EXTKEY_MS_ENCRYPTEDFILESYSTEM	number
EXTKEY_SERVERAUTH	number
EXTKEY_CLIENTAUTH	number
EXTKEY_CODESIGNING	number
EXTKEY_EMAILPROTECTION	number
EXTKEY_IPSECENDSYSTEM	number
EXTKEY_IPSECTUNNEL	number
EXTKEY_IPSECUSER	number
EXTKEY_TIMESTAMPING	number
EXTKEY_OCSPSIGNING	number
EXTKEY_DIRECTORYSERVICE	number
EXTKEY_ANYKEYUSAGE	number
EXTKEY_NS_SERVERGATEDCRYPTO	number
EXTKEY_VS_SERVERGATEDCRYPTO_CA	number
CRLSTREAMIDENTIFIER	number
FRESHESTCRL	number
FRESHESTCRL_FULLNAME	number
FRESHESTCRL_REASONS	number
FRESHESTCRL_CRLISSUER	number
ORDEREDLIST	number
BASEUPDATETIME	number
DELTAINFO	number
DELTAINFO_LOCATION	number
DELTAINFO_NEXTDELTA	number
INHIBITANYPOLICY	number
TOBEREVOKED	number
TOBEREVOKED_CERTISSUER	number
TOBEREVOKED_REASONCODE	number
TOBEREVOKED_REVOCATIONTIME	number
TOBEREVOKED_CERTSERIALNUMBER	number
REVOKEDGROUPS	number
REVOKEDGROUPS_CERTISSUER	number
REVOKEDGROUPS_REASONCODE	number
REVOKEDGROUPS_INVALIDITYDATE	number
REVOKEDGROUPS_STARTINGNUMBER	number
REVOKEDGROUPS_ENDINGNUMBER	number
EXPIREDCERTSONCRL	number
AAISSUINGDISTRIBUTIONPOINT	number
AAISSUINGDIST_FULLNAME	number
AAISSUINGDIST_SOMEREASONSONLY	number
AAISSUINGDIST_INDIRECTCRL	number
AAISSUINGDIST_USERATTRCERTS	number
AAISSUINGDIST_AACERTS	number
AAISSUINGDIST_SOACERTS	number
NS_CERTTYPE	number
NS_BASEURL	number
NS_REVOCATIONURL	number
NS_CAREVOCATIONURL	number
NS_CERTRENEWALURL	number
NS_CAPOLICYURL	number
NS_SSLSERVERNAME	number
NS_COMMENT	number
SET_HASHEDROOTKEY	number
SET_ROOTKEYTHUMBPRINT	number
SET_CERTIFICATETYPE	number
SET_MERCHANTDATA	number
SET_MERID	number
SET_MERACQUIRERBIN	number
SET_MERCHANTLANGUAGE	number
SET_MERCHANTNAME	number
SET_MERCHANTCITY	number
SET_MERCHANTSTATEPROVINCE	number
SET_MERCHANTPOSTALCODE	number
SET_MERCHANTCOUNTRYNAME	number
SET_MERCOUNTRY	number
SET_MERAUTHFLAG	number
SET_CERTCARDREQUIRED	number
SET_TUNNELING	number
SET_TUNNELINGFLAG	number
SET_TUNNELINGALGID	number
CMS_CONTENTTYPE	number
CMS_MESSAGEDIGEST	number
CMS_SIGNINGTIME	number
CMS_COUNTERSIGNATURE	number
CMS_SIGNINGDESCRIPTION	number
CMS_SMIMECAPABILITIES	number
CMS_SMIMECAP_3DES	number
CMS_SMIMECAP_AES	number
CMS_SMIMECAP_CAST128	number
CMS_SMIMECAP_SHAng	number
CMS_SMIMECAP_SHA2	number
CMS_SMIMECAP_SHA1	number
CMS_SMIMECAP_HMAC_SHAng	number
CMS_SMIMECAP_HMAC_SHA2	number
CMS_SMIMECAP_HMAC_SHA1	number
CMS_SMIMECAP_AUTHENC256	number
CMS_SMIMECAP_AUTHENC128	number
CMS_SMIMECAP_RSA_SHAng	number
CMS_SMIMECAP_RSA_SHA2	number
CMS_SMIMECAP_RSA_SHA1	number
CMS_SMIMECAP_DSA_SHA1	number
CMS_SMIMECAP_ECDSA_SHAng	number
CMS_SMIMECAP_ECDSA_SHA2	number
CMS_SMIMECAP_ECDSA_SHA1	number
CMS_SMIMECAP_PREFERSIGNEDDATA	number
CMS_SMIMECAP_CANNOTDECRYPTANY	number
CMS_SMIMECAP_PREFERBINARYINSIDE	number
CMS_RECEIPTREQUEST	number
CMS_RECEIPT_CONTENTIDENTIFIER	number
CMS_RECEIPT_FROM	number
CMS_RECEIPT_TO	number
CMS_SECURITYLABEL	number
CMS_SECLABEL_POLICY	number
CMS_SECLABEL_CLASSIFICATION	number
CMS_SECLABEL_PRIVACYMARK	number
CMS_SECLABEL_CATTYPE	number
CMS_SECLABEL_CATVALUE	number
CMS_MLEXPANSIONHISTORY	number
CMS_MLEXP_ENTITYIDENTIFIER	number
CMS_MLEXP_TIME	number
CMS_MLEXP_NONE	number
CMS_MLEXP_INSTEADOF	number
CMS_MLEXP_INADDITIONTO	number
CMS_CONTENTHINTS	number
CMS_CONTENTHINT_DESCRIPTION	number
CMS_CONTENTHINT_TYPE	number
CMS_EQUIVALENTLABEL	number
CMS_EQVLABEL_POLICY	number
CMS_EQVLABEL_CLASSIFICATION	number
CMS_EQVLABEL_PRIVACYMARK	number
CMS_EQVLABEL_CATTYPE	number
CMS_EQVLABEL_CATVALUE	number
CMS_SIGNINGCERTIFICATE	number
CMS_SIGNINGCERT_ESSCERTID	number
CMS_SIGNINGCERT_POLICIES	number
CMS_SIGNINGCERTIFICATEV2	number
CMS_SIGNINGCERTV2_ESSCERTIDV2	number
CMS_SIGNINGCERTV2_POLICIES	number
CMS_SIGNATUREPOLICYID	number
CMS_SIGPOLICYID	number
CMS_SIGPOLICYHASH	number
CMS_SIGPOLICY_CPSURI	number
CMS_SIGPOLICY_ORGANIZATION	number
CMS_SIGPOLICY_NOTICENUMBERS	number
CMS_SIGPOLICY_EXPLICITTEXT	number
CMS_SIGTYPEIDENTIFIER	number
CMS_SIGTYPEID_ORIGINATORSIG	number
CMS_SIGTYPEID_DOMAINSIG	number
CMS_SIGTYPEID_ADDITIONALATTRIBUTES	number
CMS_SIGTYPEID_REVIEWSIG	number
CMS_NONCE	number
SCEP_MESSAGETYPE	number
SCEP_PKISTATUS	number
SCEP_FAILINFO	number
SCEP_SENDERNONCE	number
SCEP_RECIPIENTNONCE	number
SCEP_TRANSACTIONID	number
CMS_SPCAGENCYINFO	number
CMS_SPCAGENCYURL	number
CMS_SPCSTATEMENTTYPE	number
CMS_SPCSTMT_INDIVIDUALCODESIGNING	number
CMS_SPCSTMT_COMMERCIALCODESIGNING	number
CMS_SPCOPUSINFO	number
CMS_SPCOPUSINFO_NAME	number
CMS_SPCOPUSINFO_URL	number

uifc object
User InterFaCe object - Text User Interface (TUI) menu system for JSexec - introduced in v3.14

**`uifc` methods**
Name	Returns	Usage	Ver	Description
init	boolean	`uifc.init(string title [,string interface_mode])`	3.14	Initialize the UIFC library with the specified application/script title (e.g. name and maybe version). `interface_mode` is a string representing the desired console mode, one of 'STDIO', 'AUTO', 'X', 'CURSES', 'ANSI', 'CONIO', or 'SDL' (see `conio.init()` for details). Return `true` upon successful UIFC library initialization, `false` upon error.
bail	void	`uifc.bail()`	3.14	Uninitialize the UIFC library
msg	void	`uifc.msg(string text)`	3.14	Print a short text message and wait for user acknowledgment
pop	void	`uifc.pop([string text])`	3.14	Pop-up (or down) a short text message. Pop-down by passing no text argument.
input	string	`uifc.input([number mode] [,number left] [,number top] [,string prompt] [,string default] [,number maxlen [,number k_mode]])`	3.14	Prompt for a string input. `mode` is an optional combination of `WIN_` mode flags from `uifcdefs.js`. `left` and `top` are optional window offsets to display the input dialog box. `prompt` is an optional text string to display as part of the string input dialog box. `default` is an optional original text string that the user can edit (requires the `K_EDIT k_mode` flag). `maxlen` is an optional maximum input string length (default is 40 characters). `k_mode` is an optional combination of `K_` mode flags from either `sbbsdefs.js` or `uifcdefs.js`. Return the new/edited string or `undefined` if editing was aborted (e.g. via ESC key press).
list	number	`uifc.list([number mode,] string title, array options [,uifc.list.CTX ctx])`	3.14	Select from a list of displayed options. `title` is the brief description of the list (menu) to be displayed in the list heading. `options` is an array of items (typically strings) that comprise the displayed list. The `CTX` (context) object can be created using `new uifc.list.CTX` and if the same object is passed in successive calls, allows `WIN_SAV` to work correctly. The context object has the following properties (numbers): `cur, bar, left, top, width` Return `-1` if list is aborted (e.g. via ESC key press), `false` upon error (e.g. no option array provided), or the 0-based numeric index of the option selected by the user. Other negative values may be returned in advanced modes/use-cases (e.g. copy/paste), see `MSK_` and related `WIN_` constants/comments in `uifcdefs.js` for details.
showhelp	void	`uifc.showhelp()`	3.17	Show the current help text
scrn	boolean	`uifc.scrn(string text)`	3.18c	Fill the screen with the appropriate background attribute. string is the title for the application banner.
showbuf	void	`uifc.showbuf(number mode, string title, string helpbuf [,uifc.showbuf.CTX ctx])`	3.18c	Show a scrollable text buffer - optionally parsing "help markup codes" The context object can be created using `new uifc.showbuf.CTX` and if the same object is passed, allows `WIN_SAV` to work correctly. The context object has the following properties (numbers): `cur, bar, left, top, width, height`
timedisplay	void	`uifc.timedisplay([bool force = false])`	3.18c	Update time in upper right corner of screen with current time in ASCII/Unix format
bottomline	void	`uifc.bottomline(number mode)`	3.18c	Display the bottom line using the `WIN_*` mode flags
getstrxy	string	`uifc.getstrxy(number left, number top, number width, number max, number mode [,string original][, uifc.getstrxy.CTX ctx])`	3.18c	String input/exit box at a specified positionThe context object can be created using `new uifc.showbuf.CTX` and if the same object is passed, allows `WIN_SAV` to work correctly. The context object has the following properties: number `lastkey`

**`uifc` properties**
Name	Type	Ver	Description
initialized	boolean	3.14	UIFC library has been successfully initialized
mode	number	3.14	Current mode flags (see `uifcdefs.js`)
changes	boolean	3.14	A change has occurred in an input call. You are expected to set this to false before calling the input if you care about it.
save_num	number	3.14	Save buffer depth (advanced)
screen_length	number	3.14	Current screen length
screen_width	number	3.14	Current screen width
list_height	number	3.14	When `WIN_FIXEDHEIGHT` mode flag is set, specifies the height used by a list method
esc_delay	number	3.14	Delay before a single ESC char is parsed and assumed to not be an ANSI sequence (advanced)
help_text	string	3.14	Text that will be displayed when F1 or '?' keys are pressed
background_color	number	3.14	Background colour
frame_color	number	3.14	Frame colour
text_color	number	3.14	Text colour
inverse_color	number	3.14	Inverse colour
lightbar_color	number	3.14	Lightbar colour

Totals: 895 properties, 257 methods

Synchronet JavaScript Object Model Reference

global object Top-level functions and properties (common to all servers, services, and JSexec) - introduced in v3.10

js object JavaScript engine internal control object - introduced in v3.11

system object Global system-related properties and methods - introduced in v3.10

File class Class used for opening, creating, reading, or writing files on the local file systemSpecial features include:

Archive class Class used for creating, reading, or extracting archive files on the local file systemNote: cannot be used to update (e.g. add/remove/replace files in) an existing archive. - introduced in v3.19

Queue class Class for bi-directional message queues. Used for inter-thread/module communications. - introduced in v3.12

Socket class Class used for TCP/IP socket communications - introduced in v3.10

Socket class object

ConnectedSocket class Class used for outgoing TCP/IP socket communications - introduced in v3.17

ListeningSocket class Class used for incoming TCP/IP socket communications - introduced in v3.17

COM class Class used for serial port communications - introduced in v3.15b

conio object Console Input/Output Object (DOS conio library functionality for jsexec) - introduced in v3.15

CryptContext class Class used for encryption/decryption - introduced in v3.16b

CryptContext class object

CryptContext.ALGO object Associative array of crypto algorithm constants - introduced in v3.18

CryptContext.MODE object Associative array of crypto mode constants - introduced in v3.18

CryptKeyset class Class used for storing CryptContext keys - introduced in v3.16b

CryptKeyset class object

CryptKeyset.KEYOPT object Associative array of keyset option constants - introduced in v3.18

CryptCert class Class used for Certificates - introduced in v3.16b

CryptCert class object

CryptCert.CURSOR object Associative array of cursor constants - introduced in v3.18

CryptCert.TYPE object Associative array of certificate type constants - introduced in v3.18

CryptCert.FORMAT object Associative array of certificate format constants - introduced in v3.18

CryptCert.ATTR object Associative array of certificate attribute constants - introduced in v3.18

uifc object User InterFaCe object - Text User Interface (TUI) menu system for JSexec - introduced in v3.14

global object
Top-level functions and properties (common to all servers, services, and JSexec) - introduced in v3.10

js object
JavaScript engine internal control object - introduced in v3.11

system object
Global system-related properties and methods - introduced in v3.10

File class
Class used for opening, creating, reading, or writing files on the local file system
Special features include:

Archive class
Class used for creating, reading, or extracting archive files on the local file system
Note: cannot be used to update (e.g. add/remove/replace files in) an existing archive. - introduced in v3.19

Queue class
Class for bi-directional message queues. Used for inter-thread/module communications. - introduced in v3.12

Socket class
Class used for TCP/IP socket communications - introduced in v3.10

ConnectedSocket class
Class used for outgoing TCP/IP socket communications - introduced in v3.17

ListeningSocket class
Class used for incoming TCP/IP socket communications - introduced in v3.17

COM class
Class used for serial port communications - introduced in v3.15b

conio object
Console Input/Output Object (DOS conio library functionality for jsexec) - introduced in v3.15

CryptContext class
Class used for encryption/decryption - introduced in v3.16b

CryptContext.ALGO object
Associative array of crypto algorithm constants - introduced in v3.18

CryptContext.MODE object
Associative array of crypto mode constants - introduced in v3.18

CryptKeyset class
Class used for storing CryptContext keys - introduced in v3.16b

CryptKeyset.KEYOPT object
Associative array of keyset option constants - introduced in v3.18

CryptCert class
Class used for Certificates - introduced in v3.16b

CryptCert.CURSOR object
Associative array of cursor constants - introduced in v3.18

CryptCert.TYPE object
Associative array of certificate type constants - introduced in v3.18

CryptCert.FORMAT object
Associative array of certificate format constants - introduced in v3.18

CryptCert.ATTR object
Associative array of certificate attribute constants - introduced in v3.18

uifc object
User InterFaCe object - Text User Interface (TUI) menu system for JSexec - introduced in v3.14