Module: Metasploit::Model::Login::Status

Defined in:
lib/metasploit/model/login/status.rb

Overview

Canonical Metasploit::Credential::Login#status.

Metasploit::Credential::Login#status is restricted to values in ALL, so new valid values need to be added to this module:

  1. Add a String constant where the constant name is in SCREAMING_SNAKE_CASE and the String in Title Case. The String should work in the sentences 'Login status is ' and 'Login is '.
  2. Add the new constant to ALL.

Examples:

'Succeeded'

# 1. Try 'Succeeded' in 'Login is Succeeded'
# 2. It does not work, so change to 'Successful': 'Login is Successful'
# 3. 'Successful' works in the sentence, so write the code.

# When the `Metasploit::Credential::Login#service` allows access using `Metasploit::Credential::Login#core`.
SUCCESSFUL = 'Successful'

# All values that are valid for `Metasploit::Credential::Login#status`.
ALL = [
  # ...
  SUCCESSFUL,
  # ...
]

Constant Summary collapse

DENIED_ACCESS =

When Metasploit::Credential::Login#service returns that access is denied to Metasploit::Credential::Login#core.

'Denied Access'
DISABLED =

When Metasploit::Credential::Login#service reports that Metasploit::Credential::Login#core are correct, but the account is disabled.

'Disabled'
INCORRECT =

When Metasploit::Credential::Login#service reports that Metasploit::Credential::Login#core are not correct.

'Incorrect'
INVALID_PUBLIC_PART =

When Metasploit::Credential::Login#service reports that Metasploit::Credential::Login#core has a public part that is verified as being invalid.

'Invalid Public Part'
LOCKED_OUT =

When Metasploit::Credential::Login#service reports that account tied to Metasploit::Credential::Login#core has had too many incorrect credentials attempted for authorization, so it is locked out to prevent bruteforce guessing

'Locked Out'
NO_AUTH_REQUIRED =

This status will never be used for a Login, but is required as a result status for certain LoginScanners.

'No Auth Required'
SUCCESSFUL =

When the Metasploit::Credential::Login#service allows access using Metasploit::Credential::Login#core.

'Successful'
UNABLE_TO_CONNECT =

When Metasploit::Credential::Login#service cannot be accessed or a timeout occurs waiting for a response from Metasploit::Credential::Login#service.

'Unable to Connect'
UNTRIED =

When Metasploit::Credential::Login#core has not yet been submitted to Metasploit::Credential::Login#service.

'Untried'
ALL =

All values that are valid for Metasploit::Credential::Login#status.

[
    DENIED_ACCESS,
    DISABLED,
    INCORRECT,
    INVALID_PUBLIC_PART,
    LOCKED_OUT,
    NO_AUTH_REQUIRED,
    SUCCESSFUL,
    UNABLE_TO_CONNECT,
    UNTRIED
]