Skip to content

API Reference: Validators

certmonitor.validators

VALIDATORS module-attribute

VALIDATORS = {'expiration': ExpirationValidator(), 'hostname': HostnameValidator(), 'key_info': KeyInfoValidator(), 'subject_alt_names': SubjectAltNamesValidator(), 'root_certificate': RootCertificateValidator(), 'sensitive_date': SensitiveDateValidator(), 'tls_version': TLSVersionValidator(), 'weak_cipher': WeakCipherValidator(), 'chain': ChainValidator()}

get_enabled_validators

get_enabled_validators() -> list

Get enabled validators from configuration.

Returns:

Name Type Description
list list

A list of enabled validator names.

Source code in certmonitor/validators/__init__.py
56
57
58
59
60
61
62
63
64
65
def get_enabled_validators() -> list:
    """
    Get enabled validators from configuration.

    Returns:
        list: A list of enabled validator names.
    """
    from ..config import ENABLED_VALIDATORS

    return ENABLED_VALIDATORS

list_validators

list_validators() -> list

Lists all currently registered validators.

Returns:

Name Type Description
list list

A list of validator names.

Source code in certmonitor/validators/__init__.py
46
47
48
49
50
51
52
53
def list_validators() -> list:
    """
    Lists all currently registered validators.

    Returns:
        list: A list of validator names.
    """
    return list(VALIDATORS.keys())

register_validator

register_validator(validator_instance: Any) -> None

Register a custom validator instance with the system.

Parameters:

Name Type Description Default
validator_instance BaseValidator

An instance of a validator class that inherits from BaseValidator.

required
Source code in certmonitor/validators/__init__.py
34
35
36
37
38
39
40
41
42
43
def register_validator(validator_instance: Any) -> None:
    """
    Register a custom validator instance with the system.

    Args:
        validator_instance (BaseValidator): An instance of a validator class
                                            that inherits from BaseValidator.
    """
    name = validator_instance.name
    VALIDATORS[name] = validator_instance