Module: Msf::WebServices::Documentation::Api::V1::LootApiDoc

Includes:
Swagger::Blocks
Defined in:
lib/msf/core/web_services/documentation/api/v1/loot_api_doc.rb

Constant Summary collapse

HOST_ID_DESC =
'The ID of the host record this loot is associated with.'
HOST_DESC =
'The IP address of the host from where the loot was obtained.'
SERVICE_ID_DESC =
'The ID of the service record this loot is associated with.'
LTYPE_DESC =
'The type of loot.'
LTYPE_EXAMPLE =
"'file', 'image', 'config_file', etc."
PATH_DESC =
'The on-disk path to the loot file.'
PATH_EXAMPLE =
'/path/to/file.txt'
DATA_DESC =
"Base64 encoded copy of the file's contents."
DATA_EXAMPLE =
'dGhpcyBpcyB0aGUgZmlsZSdzIGNvbnRlbnRz'
CONTENT_TYPE_DESC =
'The mime/content type of the file at {#path}.  Used to server the file correctly so browsers understand whether to render or download the file.'
CONTENT_TYPE_EXAMPLE =
'text/plain'
NAME_DESC =
'The name of the loot.'
NAME_EXAMPLE =
'password_file.txt'
INFO_DESC =
'Information about the loot.'
MODULE_RUN_ID_DESC =
'The ID of the module run record this loot is associated with.'
CREATE_PATH_DESC =

Some of the attributes expect different data when doing a create.

'The name to give the file on the server. All files are stored in a server configured path, so a full path is not needed. If there is a corresponding file on disk, the given value will be prepended with a unique string to prevent accidental overwrites of other files.'
CREATE_PATH_EXAMPLE =
'password_file.txt'