Module: Msf::WebServices::Documentation::Api::V1::CredentialApiDoc

Includes:: Swagger::Blocks

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

Overview

TODO: Complete this documentation when the credential model is fully implemented in the API.

Constant Summary collapse

ORIGIN_ID_DESC =

'The ID of the origin record associated with this credential.'

ORIGIN_TYPE_DESC =

'The class name within Metasploit::Credential that indicates where this credential came from.'

PRIVATE_ID_DESC =

'The ID of the Metasploit::Credential::Private record associated with this credential.'

PUBLIC_ID_DESC =

'The ID of the Metasploit::Credential::Public record associated with this credential.'

REALM_ID_DESC =

'The ID of the Metasploit::Credential::Realm from where the credential was gathered.'

LOGINS_COUNT_DESC =

'The number of successful login attempts that were completed using this credential.'

ADDRESS_DESC =

'The IP address of the host this credential was collected from.'

ADDRESS_EXAMPLE =

'127.0.0.1'

SERVICE_NAME_DESC =

'The name of the service from which this credential was collected from.'

SERVICE_NAME_EXAMPLE =

'ssh'

PORT_DESC =

'The port on which the service was listening where this credential was collected from.'

PORT_EXAMPLE =

'22'

PROTOCOL_DESC =

'The protocol the service was using.'

PROTOCOL_ENUM =

[ 'tcp', 'udp' ]

MODULE_FULLNAME_DESC =

'The full name of the Metasploit module that was used to collect this credential.'

MODULE_FULLNAME_EXAMPLE =

'auxiliary/scanner/smb/smb_login'

FILENAME_DESC =

'The filename of the file that was imported. This is necessary when the origin_type is import.'

FILENAME_EXAMPLE =

'/etc/shadow'

POST_REFERENCE_NAME_DESC =

'The reference name of the Metasploit Post module used to collect this credential.'

POST_REFERENCE_NAME_EXAMPLE =

'post/linux/gather/hashdump'

SESSION_ID_DESC =

'The ID of the session where this credential was collected from.'

USERNAME_DESC =

'The username for this credential.'

USERNAME_EXAMPLE =

'administrator'

PUBLIC_TYPE_DESC =

'The type of username that this falls into. This is used for searching for similar credentials.'

PRIVATE_TYPE_DESC =

'The type of password data for this credential.'

DATA_DESC =

'The private data for this credential.  The semantic meaning of this data varies based on the type.'

DATA_EXAMPLE =

"'password123', '$1$5nfRD/bA$y7ZZD0NimJTbX9FtvhHJX1', or '$NT$7f8fe03093cc84b267b109625f6bbf4b'"

JTR_FORMAT_DESC =

'Comma-separated list of the formats for John the ripper to use to try and crack this.'

JTR_FORMAT_EXAMPLE =

'md5,des,bsdi,crypt'

KEY_DESC =

'The name of the key for the realm.'

KEY_EXAMPLE =

'Active Directory Domain'

VALUE_DESC =

'The value of the key for the realm.'

VALUE_EXAMPLE =

'contoso.com'

PUBLIC_TYPE_ENUM =

[ 'Metasploit::Credential::BlankUsername', 'Metasploit::Credential::Username' ]

PRIVATE_TYPE_CLASS_ENUM =

[
    'Metasploit::Credential::ReplayableHash',
    'Metasploit::Credential::NonreplayableHash',
    'Metasploit::Credential::NTLMHash',
    'Metasploit::Credential::Password',
    'Metasploit::Credential::PasswordHash',
    'Metasploit::Credential::SSHKey',
    'Metasploit::Credential::PostgresMD5',
    'Metasploit::Credential::BlankPassword'
]

PRIVATE_TYPE_ENUM =

[
    'password',
    'ssh_key',
    'ntlm_hash',
    'postgres_md5',
    'nonreplayable_hash',
    '<blank>'
]

ORIGIN_TYPE_CLASS_ENUM =

[
    'Metasploit::Credential::Origin::Import',
    'Metasploit::Credential::Origin::Manual',
    'Metasploit::Credential::Origin::Service',
    'Metasploit::Credential::Origin::Session'
]

ORIGIN_TYPE_ENUM =

[
    'import',
    'manual',
    'service',
    'session'
]