Interface MpicClientInterface

All Known Implementing Classes:
NoopMpicClientImpl

public interface MpicClientInterface
Interface for MPIC (Multi-Perspective Corroboration) client operations. This interface defines methods to retrieve MPIC DNS responses and file responses.

This interface also provides a default method to determine if corroboration enforcement is required, which must be true after the 09/15/2025 deadline for MPIC implemenation.

  • Method Details

    • getMpicDnsResponse

      MpicDnsResponse getMpicDnsResponse(String domain, DnsType dnsType, String challengeValue)
      Retrieves the MPIC DNS response for a given domain, DNS type, and challenge value.
      Parameters:
      domain - The domain to query.
      dnsType - The type of DNS record to query (e.g., TXT, CNAME).
      challengeValue - The challenge value to look for in the DNS records. This can be null if not applicable.
      Returns:
    • getPrimaryOnlyDnsResponse

      PrimaryDnsResponse getPrimaryOnlyDnsResponse(String domain, DnsType dnsType)
      Retrieves the primary-only DNS response for a given domain and DNS type. NO CORROBORATION Check is done.
      Parameters:
      domain - The domain to query.
      dnsType - The type of DNS record to query (e.g., TXT, CNAME).
      Returns:
      The primary DNS response.
    • getMpicFileResponse

      MpicFileResponse getMpicFileResponse(String fileUrl, String challengeValue)
      Retrieves the MPIC file response for a given file URL and challenge value.
      Parameters:
      fileUrl - The URL of the file to query.
      challengeValue - The challenge value to look for in the file content. This can be null if not applicable.
      Returns:
      MpicFileResponse The MPIC file response.
    • getPrimaryOnlyFileResponse

      PrimaryFileResponse getPrimaryOnlyFileResponse(String fileUrl)
      Retrieves a primary-only file response for a given file URL. NO CORROBORATION Check is done.
      Parameters:
      fileUrl - The URL of the file to query.
      Returns:
      MpicFileResponse The MPIC file response.
    • shouldEnforceCorroboration

      default Boolean shouldEnforceCorroboration()