Module: Msf::WebServices::Documentation::Api::V1::LoginApiDoc

Includes:: Swagger::Blocks

Defined in:: lib/msf/core/web_services/documentation/api/v1/login_api_doc.rb

Constant Summary collapse

CORE_ID_DESC =

'The ID of the Metasploit::Credential::Core object this login is associated with.'

CORE_DESC =

'The Metasploit::Credential::Core object that corresponds to the credential pair this login attempt used.'

SERVICE_ID_DESC =

'The ID of the service object that this login was attempted against.'

ACCESS_LEVEL_DESC =

'A free-form text field that can be used to annotate the access level of this login.'

ACCESS_LEVEL_EXAMPLE =

"'admin', 'sudoer', or 'user'"

STATUS_DESC =

'The result of the login attempt.'

LAST_ATTEMPTED_AT_DESC =

'The date and time the login attempt occurred.'

SERVICE_NAME_DESC =

'The name of the service that the login was attempted against.'

SERVICE_NAME_EXAMPLE =

'ssh'

ADDRESS_DESC =

'The IP address of the host/service this login was attempted against.'

ADDRESS_EXAMPLE =

'127.0.0.1'

PORT_DESC =

'The port the service was listening on.'

PORT_EXAMPLE =

'22'

PROTOCOL_DESC =

'The protocol the service was using.'

PROTOCOL_ENUM =

[ 'tcp', 'udp' ]

STATUS_ENUM = Values from lib/metasploit/model/login/status.rb in the metasploit-model repo

[
    'Denied Access',
    'Disabled',
    'Incorrect',
    'Locked Out',
    'No Auth Required',
    'Successful',
    'Unable to Connect',
    'Untried'
]