Package com.digicert.validation.enums

Enum Class DcvError

java.lang.Object
java.lang.Enum<DcvError>
com.digicert.validation.enums.DcvError
All Implemented Interfaces:
Serializable, Comparable<DcvError>, Constable
public enum DcvError extends Enum<DcvError>
Enumeration representing various errors that can occur during Domain Control Validation (DCV). Each error type corresponds to a specific validation failure scenario, providing detailed information about the nature of the error to facilitate debugging and resolution.

  • Enum Constant Details

    • DNS_TYPE_REQUIRED

      public static final DcvError DNS_TYPE_REQUIRED
      Error indicating that the DNS type is required. This error occurs when the DNS type is not provided in the request, which is essential for determining the type of DNS record to validate.

    • CHALLENGE_TYPE_REQUIRED

      public static final DcvError CHALLENGE_TYPE_REQUIRED
      Error indicating that the user requested DNS or FILE validation without providing a challenge type.

      DNS and FILE validation methods can be performed using either a random value or a request token, so the user must specify which type of challenge they are using.

    • REQUEST_TOKEN_DATA_REQUIRED

      public static final DcvError REQUEST_TOKEN_DATA_REQUIRED
      Error indicating that the user requested the use of either the DNS_TXT or FILE_VALIDATION dcv method with a request token without providing the request token data necessary to identify valid request tokens.

    • INVALID_REQUEST_TOKEN_DATA

      public static final DcvError INVALID_REQUEST_TOKEN_DATA
      Error indicating that the user requested the use of either the DNS_TXT or FILE_VALIDATION dcv method with a request token without providing usable request token data necessary to identify valid request tokens.

      This error can occur because request token data is of the wrong subtype of RequestTokenData for the RequestTokenValidator being used, or because some of its data is missing or malformed.

    • RANDOM_VALUE_REQUIRED

      public static final DcvError RANDOM_VALUE_REQUIRED
      Error indicating that the user requested the use of a dcv method with a random value without providing a random value.

    • RANDOM_VALUE_INSUFFICIENT_ENTROPY

      public static final DcvError RANDOM_VALUE_INSUFFICIENT_ENTROPY
      Error indicating that the random value has insufficient entropy.

      The baseline requirements require that random values must have at least 112 bits of entropy. This error occurs when the library can determine that the provided random value does not meet that requirement. High entropy is necessary to ensure the unpredictability of the value, which is crucial for security purposes.

    • INVALID_DNS_TYPE

      public static final DcvError INVALID_DNS_TYPE
      Error indicating that the DNS type is not support by DCV method requested.

    • INVALID_DCV_METHOD

      public static final DcvError INVALID_DCV_METHOD
      Error indicating that the DCV method is invalid. This error occurs when the DCV method provided in the validationState object does not match the allowed DCV method.

    • DOMAIN_REQUIRED

      public static final DcvError DOMAIN_REQUIRED
      Error indicating that the domain is required. This error occurs when the domain name is not provided in the request. The domain name is a fundamental part of the validation process, as it specifies the domain to be validated. Without it, the validation cannot proceed.

    • DOMAIN_INVALID_INCORRECT_NAME_PATTERN

      public static final DcvError DOMAIN_INVALID_INCORRECT_NAME_PATTERN
      Error indicating that the domain name pattern is incorrect. This error occurs when the domain name does not match the expected pattern found in DomainNameUtils The domain name must adhere to specific formatting rules to be considered valid. An incorrect pattern indicates a malformed domain name.

    • DOMAIN_INVALID_BAD_LDH_LABEL

      public static final DcvError DOMAIN_INVALID_BAD_LDH_LABEL
      Error indicating that the domain has a bad LDH label. This error occurs when the domain name contains an invalid LDH (Letter-Digit-Hyphen) label. The LDH label must follow specific rules to be valid. A bad LDH label means that the domain name does not conform to these rules.

    • DOMAIN_INVALID_NAME_IS_TOP_LEVEL

      public static final DcvError DOMAIN_INVALID_NAME_IS_TOP_LEVEL
      Error indicating that the domain name is a top-level domain. This error occurs when the domain name is a top-level domain (TLD), which is not allowed in this context. TLDs are not specific enough for validation purposes, and a more specific domain name is required.

    • DOMAIN_INVALID_TOO_LONG

      public static final DcvError DOMAIN_INVALID_TOO_LONG
      Error indicating that the domain name is too long. This error occurs when the domain name exceeds the maximum allowed length. Domain names must be within a certain length to be valid. (Maximum length: 255 characters)

    • DOMAIN_INVALID_WILDCARD_NOT_ALLOWED

      public static final DcvError DOMAIN_INVALID_WILDCARD_NOT_ALLOWED
      Error indicating that wildcard domains are not allowed. This error occurs when a wildcard domain is provided on a file validation request, which is not permitted in this context. Wildcard domains are used to represent multiple subdomains, but they are not allowed for file validation purposes.

    • DOMAIN_INVALID_NOT_UNDER_PUBLIC_SUFFIX

      public static final DcvError DOMAIN_INVALID_NOT_UNDER_PUBLIC_SUFFIX
      Error indicating that the domain is not under a public suffix. This error occurs when the domain is not part of a recognized public suffix. Public suffixes are top-level domains under which domain names can be registered. A domain not under a public suffix is considered invalid.

    • FILE_VALIDATION_EMPTY_RESPONSE

      public static final DcvError FILE_VALIDATION_EMPTY_RESPONSE
      Error indicating that the file validation response is empty. This error occurs when the response from the file validation process is empty. An empty response means that the system did not receive the expected data, leading to a validation failure.

    • FILE_VALIDATION_CLIENT_ERROR

      public static final DcvError FILE_VALIDATION_CLIENT_ERROR
      Error indicating a client error during file validation. This error occurs when there is a client-side error during the file validation process. Client errors can include issues such as network problems or incorrect request formatting, which prevent the authentication from succeeding.

    • FILE_VALIDATION_INVALID_CONTENT

      public static final DcvError FILE_VALIDATION_INVALID_CONTENT
      Error indicating that the file validation content is invalid. This error occurs when the content of the file validation response is invalid. Invalid content means that the data received does not match the expected format or values, leading to a validation failure.

    • FILE_VALIDATION_INVALID_STATUS_CODE

      public static final DcvError FILE_VALIDATION_INVALID_STATUS_CODE
      Error indicating that the file validation status code is not as expected. The status code indicates the result of the authentication request, and an unexpected code suggests a problem with the response.

    • REQUEST_TOKEN_ERROR_NOT_FOUND

      public static final DcvError REQUEST_TOKEN_ERROR_NOT_FOUND
      Error indicating that no potential request token was found.

    • REQUEST_TOKEN_ERROR_INVALID_TOKEN

      public static final DcvError REQUEST_TOKEN_ERROR_INVALID_TOKEN
      Error indicating that a potential request token was found but is not valid.

      This error occurs when the potential token does not follow the specification expected by the RequestTokenValidator being used.

    • REQUEST_TOKEN_ERROR_DATE_EXPIRED

      public static final DcvError REQUEST_TOKEN_ERROR_DATE_EXPIRED
      Error indicating that the request token has expired.

      The baseline requirements specify that "A Request Token that includes a timestamp SHALL remain valid for no more than 30 days from the time of creation." If the timestamp is more than 30 days old (or a shorter age specified by the CA), the request token has expired.

    • REQUEST_TOKEN_ERROR_FUTURE_DATE

      public static final DcvError REQUEST_TOKEN_ERROR_FUTURE_DATE
      Error indicating that the request token's date is in the future.

      The baseline requirements specify that "A Request Token that includes a timestamp SHALL be treated as invalid if its timestamp is in the future."

    • REQUEST_TOKEN_EMPTY_TEXT_BODY

      public static final DcvError REQUEST_TOKEN_EMPTY_TEXT_BODY
      Error indicating that the text body that should contain a request token is instead empty.

      The text body should contain the actual data to be validated. An empty text body can indicate a problem on the customer's side that they need to address.

    • REQUEST_TOKEN_CANNOT_GENERATE_HASH

      public static final DcvError REQUEST_TOKEN_CANNOT_GENERATE_HASH
      Error indicating that the hash for a request token cannot be generated.

      The baseline requirements specify that request tokens "SHALL use a digital signature algorithm or a cryptographic hash algorithm." A failure in hash generation means that the request token cannot be verified.

    • RANDOM_VALUE_NOT_FOUND

      public static final DcvError RANDOM_VALUE_NOT_FOUND
      Error indicating that the random value was not found.

      Random values are used by the client to prove control of the domain they are submitting for validation. A missing random value means that the validation has failed.

    • RANDOM_VALUE_EMPTY_TEXT_BODY

      public static final DcvError RANDOM_VALUE_EMPTY_TEXT_BODY
      Error indicating that the text body that should contain a random value is instead empty.

      The text body should contain the expected random value. An empty text body can indicate a problem on the customer's side that they need to address.

    • RANDOM_VALUE_EXPIRED

      public static final DcvError RANDOM_VALUE_EXPIRED
      Error indicating that the random value has expired. This error occurs when the random value has passed its expiration date. Expired random values are no longer valid and cannot be used for validation, leading to a validation failure. Because the DCV library is stateless, this date is calculated based the validationState prepareTime field provided as part of the validation request.

    • VALIDATION_STATE_REQUIRED

      public static final DcvError VALIDATION_STATE_REQUIRED
      Error indicating that the validation state is required. The validation state contains information about the current status of the validation process.

    • VALIDATION_STATE_DOMAIN_REQUIRED

      public static final DcvError VALIDATION_STATE_DOMAIN_REQUIRED
      Error indicating that the validation state domain is required. The domain is a crucial part of the validation state, as it specifies the domain being validated.

    • VALIDATION_STATE_DCV_METHOD_REQUIRED

      public static final DcvError VALIDATION_STATE_DCV_METHOD_REQUIRED
      Error indicating that the validation state DCV method is required. The DCV method defines the approach used for domain control validation. Without it, the validation state is incomplete.

    • VALIDATION_STATE_PREPARE_TIME_REQUIRED

      public static final DcvError VALIDATION_STATE_PREPARE_TIME_REQUIRED
      Error indicating that the validation state prepare time is required. The prepare time indicates when the validation process was initiated. Without it, the system cannot accurately track the validation timeline.

    • DNS_LOOKUP_RECORD_NOT_FOUND

      public static final DcvError DNS_LOOKUP_RECORD_NOT_FOUND
      Error indicating that the DNS lookup record was not found. DNS lookup records are used to verify the domain's DNS configuration. A missing record means that the system cannot perform the DNS validation.

    • DNS_LOOKUP_UNKNOWN_HOST_EXCEPTION

      public static final DcvError DNS_LOOKUP_UNKNOWN_HOST_EXCEPTION
      Error indicating an unknown host exception during DNS lookup. Unknown host exceptions indicate that the domain name could not be resolved to an IP address, preventing the DNS validation from succeeding.

    • DNS_LOOKUP_TEXT_PARSE_EXCEPTION

      public static final DcvError DNS_LOOKUP_TEXT_PARSE_EXCEPTION
      Error indicating a text parse exception during DNS lookup. Text parse exceptions indicate that the DNS response could not be parsed correctly, leading to a validation failure.

    • WHOIS_EMPTY_RESPONSE

      public static final DcvError WHOIS_EMPTY_RESPONSE
      Error indicating that the whois response is empty. An empty response means that the system did not receive the expected data, leading to a validation failure.

    • WHOIS_NO_EMAILS_FOUND

      public static final DcvError WHOIS_NO_EMAILS_FOUND
      Error indicating that no emails were found in the whois response. Email addresses are used to contact the domain owner for validation purposes. A lack of email addresses means that the system cannot proceed with the validation.

    • WHOIS_QUERY_ERROR

      public static final DcvError WHOIS_QUERY_ERROR
      Error indicating a query error during whois lookup. Query errors can include issues such as network problems or incorrect query formatting, which prevent the whois lookup from succeeding.

    • INVALID_EMAIL_ADDRESS

      public static final DcvError INVALID_EMAIL_ADDRESS
      Error indicating that the email address is invalid.

  • Constructor Details

    • DcvError

      private DcvError()

  • Method Details

    • values

      public static DcvError[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DcvError valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Returns the string representation of the error in lowercase.
      Overrides:
      toString in class Enum<DcvError>
      Returns:
      the lowercase name of the error