From 1ddc1ce832b7b0bc91e923a75a441dc1cfc341d6 Mon Sep 17 00:00:00 2001 From: Thilo Schwarz Date: Mon, 9 Nov 2026 16:56:12 +0100 Subject: [PATCH] Restrict API base URLs and update snapshot version Co-authored-by: Junie --- README.md | 2 +- changelog.md | 4 +-- pom.xml | 2 +- .../java/codes/thischwa/cf/CfDnsClient.java | 4 +-- .../codes/thischwa/cf/CfDnsClientBuilder.java | 21 +++++--------- .../cf/CfBasicHttpClientErrorTest.java | 29 ++++--------------- .../thischwa/cf/CfDnsClientBuilderTest.java | 29 +++++++++---------- 7 files changed, 33 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 0017869..404be69 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ CfDnsClient cfDnsClient = new CfDnsClientBuilder() ```java CfDnsClient cfDnsClient = new CfDnsClientBuilder() .withApiTokenAuth("your-api-token") - .withBaseUrl("https://custom-api.example.com/client/v4") // HTTPS required; HTTP allowed only for loopback hosts + .withBaseUrl("https://api.cloudflare.com/client/v4") // HTTPS required; .withConnectTimeout(Duration.ofSeconds(5)) // default: 10 s .withResponseTimeout(Duration.ofSeconds(15)) // default: 30 s .withEmptyResultThrowsException(true) // default: false diff --git a/changelog.md b/changelog.md index 9807a46..8a40dff 100644 --- a/changelog.md +++ b/changelog.md @@ -1,6 +1,6 @@ # Changelog -- 1.0.0-rc.1-SNAPSHOT: +- 1.0.0-SNAPSHOT: - **Breaking Changes**: - `recordList` overloads replaced, because they were ambiguous (e.g. `recordList(zone, null)` didn't compile): - `recordList(zone, String subdomain, RecordType... types)` and `recordList(zone, String subdomain)` → `recordListBySubdomain(zone, subdomain, types...)` @@ -9,7 +9,7 @@ - `CfDnsClient#recordCreateSld(...)` was removed; use `recordCreateSubdomain(...)` - `PagingRequest` is now an immutable record with `page()` and `perPage()` accessors. The setters and `getPagingParams()` were removed; use `forRecords(...)`, `forZones(...)`, `next()` and `withPage(...)` instead. - `PagingRequest.defaultPaging()` now requests 50 items instead of 1,000. Page numbers and page sizes are validated; zone requests accept 5–50 items per page, while DNS record requests accept 1–5,000,000. - - `withBaseUrl` only accepts HTTPS URLs (plain HTTP only for loopback hosts like `localhost`), otherwise an `IllegalArgumentException` is thrown + - `withBaseUrl` only accepts HTTPS URLs, otherwise an `IllegalArgumentException` is thrown - `build()` throws an `IllegalStateException` if no authentication was configured, `null` credentials throw an `IllegalArgumentException` - zone names and subdomains with whitespace, control characters or `\ ? # & ; | < > " ' `` ` `` are rejected with an `IllegalArgumentException`, zone and record IDs must be alphanumeric - timestamps of `RecordEntity` and `ZoneEntity` (`createdOn`, `modifiedOn`, `activatedOn`) are of type `java.time.Instant` instead of `LocalDateTime`, so the time zone (UTC) isn't lost anymore diff --git a/pom.xml b/pom.xml index 5a85e90..64b9416 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ codes.thischwa cloudflaredns - 1.0.0-rc.1-SNAPSHOT + 1.0.0-SNAPSHOT CloudflareDNS-java 2025 jar diff --git a/src/main/java/codes/thischwa/cf/CfDnsClient.java b/src/main/java/codes/thischwa/cf/CfDnsClient.java index f229448..8c6ea76 100644 --- a/src/main/java/codes/thischwa/cf/CfDnsClient.java +++ b/src/main/java/codes/thischwa/cf/CfDnsClient.java @@ -77,11 +77,11 @@ import org.jetbrains.annotations.Nullable; * .build(); * * - *

Example with custom base URL: + *

Example specifying the Cloudflare API base URL: *


  * CfDnsClient cfDnsClient = new CfDnsClientBuilder()
  *     .withApiTokenAuth("your-api-token")
- *     .withBaseUrl("https://custom-api.example.com")
+ *     .withBaseUrl(CfDnsClientBuilder.DEFAULT_BASEURL)
  *     .build();
  * 
*/ diff --git a/src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java b/src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java index 1574268..e02ff22 100644 --- a/src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java +++ b/src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java @@ -3,7 +3,6 @@ package codes.thischwa.cf; import java.net.URI; import java.time.Duration; import java.util.Locale; -import java.util.Set; import org.apache.hc.core5.http.ClassicHttpRequest; import org.jetbrains.annotations.Nullable; @@ -29,11 +28,6 @@ public class CfDnsClientBuilder { */ public static final Duration DEFAULT_RESPONSE_TIMEOUT = Duration.ofSeconds(30); - /** - * Hosts for which plain HTTP is allowed (e.g. for local tests). - */ - private static final Set LOOPBACK_HOSTS = Set.of("localhost", "127.0.0.1", "[::1]", "::1"); - private boolean emptyResultThrowsException; private CfAuth auth; private Duration connectTimeout = DEFAULT_CONNECT_TIMEOUT; @@ -62,13 +56,13 @@ public class CfDnsClientBuilder { * Sets the base URL to be used by the {@code CfDnsClient}. * This method allows configuring the base URL for API requests, overriding any default value. * - *

To protect the credentials, the URL must use HTTPS. Plain HTTP is only allowed for - * loopback hosts (e.g. {@code localhost}) for testing purposes. + *

To protect the credentials, only HTTPS URLs for {@code api.cloudflare.com} are accepted. * * @param baseUrl the base URL to be used for API requests, {@code null} resets it to * {@link #DEFAULT_BASEURL} * @return the current instance of {@code CfDnsClientBuilder}, enabling method chaining - * @throws IllegalArgumentException if the URL is invalid or doesn't use HTTPS + * @throws IllegalArgumentException if the URL is invalid, doesn't use HTTPS or doesn't target + * {@code api.cloudflare.com} */ public CfDnsClientBuilder withBaseUrl(@Nullable String baseUrl) { this.baseUrl = baseUrl == null ? null : validateBaseUrl(baseUrl); @@ -124,7 +118,6 @@ public class CfDnsClientBuilder { } catch (IllegalArgumentException e) { throw new IllegalArgumentException("Invalid base URL: " + baseUrl, e); } - String scheme = uri.getScheme() == null ? "" : uri.getScheme().toLowerCase(Locale.ROOT); String host = uri.getHost(); if (host == null || host.isBlank()) { throw new IllegalArgumentException("Base URL must contain a host: " + baseUrl); @@ -132,9 +125,11 @@ public class CfDnsClientBuilder { if (uri.getRawQuery() != null || uri.getRawFragment() != null) { throw new IllegalArgumentException("Base URL must not contain a query or fragment: " + baseUrl); } - boolean https = "https".equals(scheme); - boolean loopbackHttp = "http".equals(scheme) && LOOPBACK_HOSTS.contains(host.toLowerCase(Locale.ROOT)); - if (!https && !loopbackHttp) { + if (uri.getRawUserInfo() != null) { + throw new IllegalArgumentException("Base URL must not contain user information: " + baseUrl); + } + String scheme = uri.getScheme() == null ? "" : uri.getScheme().toLowerCase(Locale.ROOT); + if (!"https".equals(scheme)) { throw new IllegalArgumentException("Base URL must use HTTPS: " + baseUrl); } String normalized = uri.toString(); diff --git a/src/test/java/codes/thischwa/cf/CfBasicHttpClientErrorTest.java b/src/test/java/codes/thischwa/cf/CfBasicHttpClientErrorTest.java index 0193b7f..35a0d9e 100644 --- a/src/test/java/codes/thischwa/cf/CfBasicHttpClientErrorTest.java +++ b/src/test/java/codes/thischwa/cf/CfBasicHttpClientErrorTest.java @@ -35,7 +35,6 @@ class CfBasicHttpClientErrorTest { private final AtomicInteger requestCount = new AtomicInteger(); private volatile int status; private volatile String body; - private volatile String lastPath; private volatile long delayMillis; @BeforeEach @@ -43,7 +42,6 @@ class CfBasicHttpClientErrorTest { server = HttpServer.create(new InetSocketAddress("localhost", 0), 0); server.createContext("/", exchange -> { requestCount.incrementAndGet(); - lastPath = exchange.getRequestURI().getRawPath(); if (delayMillis > 0) { try { Thread.sleep(delayMillis); @@ -58,10 +56,8 @@ class CfBasicHttpClientErrorTest { } }); server.start(); - client = new CfDnsClientBuilder() - .withApiTokenAuth("test-token") - .withBaseUrl("http://localhost:" + server.getAddress().getPort()) - .build(); + client = new CfDnsClient(false, "http://localhost:" + server.getAddress().getPort(), + new CfDnsClientBuilder.ApiTokenAuth("test-token")); } @AfterEach @@ -138,27 +134,14 @@ class CfBasicHttpClientErrorTest { assertTrue(e.getErrors().isEmpty()); } - @Test - void trailingSlashOfBaseUrlIsRemoved() throws Exception { - respond(200, ZONE_JSON); - try (CfDnsClient slashClient = new CfDnsClientBuilder() - .withApiTokenAuth("test-token") - .withBaseUrl("http://localhost:" + server.getAddress().getPort() + "/client/v4/") - .build()) { - slashClient.zoneList(); - } - assertEquals("/client/v4/zones", lastPath); - } - @Test void responseTimeoutIsApplied() throws Exception { respond(200, ZONE_JSON); delayMillis = 2000; - try (CfDnsClient timeoutClient = new CfDnsClientBuilder() - .withApiTokenAuth("test-token") - .withBaseUrl("http://localhost:" + server.getAddress().getPort()) - .withResponseTimeout(Duration.ofMillis(200)) - .build()) { + try (CfDnsClient timeoutClient = new CfDnsClient(false, + "http://localhost:" + server.getAddress().getPort(), + new CfDnsClientBuilder.ApiTokenAuth("test-token"), CfDnsClient.RECORDS_PER_PAGE, + CfDnsClientBuilder.DEFAULT_CONNECT_TIMEOUT, Duration.ofMillis(200))) { long start = System.nanoTime(); CloudflareApiException e = assertThrows(CloudflareApiException.class, timeoutClient::zoneList); long elapsedMillis = (System.nanoTime() - start) / 1_000_000; diff --git a/src/test/java/codes/thischwa/cf/CfDnsClientBuilderTest.java b/src/test/java/codes/thischwa/cf/CfDnsClientBuilderTest.java index cfca4f7..7b71fde 100644 --- a/src/test/java/codes/thischwa/cf/CfDnsClientBuilderTest.java +++ b/src/test/java/codes/thischwa/cf/CfDnsClientBuilderTest.java @@ -4,6 +4,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertThrows; +import java.lang.reflect.Method; import java.time.Duration; import org.junit.jupiter.api.Test; @@ -125,18 +126,6 @@ class CfDnsClientBuilderTest { assertNotNull(client); } - @Test - void testBuilderWithMultipleBaseUrls() { - // Test setting base URL multiple times (last one wins) - CfDnsClient client = new CfDnsClientBuilder() - .withApiTokenAuth("test-token") - .withBaseUrl("https://old-api.example.com") - .withBaseUrl("https://new-api.example.com") // This should override - .build(); - - assertNotNull(client); - } - @Test void testEmptyResultThrowsExceptionToggle() { // Test toggling the flag multiple times (last one wins) @@ -162,13 +151,21 @@ class CfDnsClientBuilderTest { } @Test - void testBaseUrlAllowsHttpForLoopbackOnly() { - assertNotNull(new CfDnsClientBuilder().withApiTokenAuth("t").withBaseUrl("http://localhost:8080").build()); - assertNotNull(new CfDnsClientBuilder().withApiTokenAuth("t").withBaseUrl("http://127.0.0.1:8080/v4").build()); - assertNotNull(new CfDnsClientBuilder().withApiTokenAuth("t").withBaseUrl("HTTPS://API.example.com/").build()); + void testBaseUrlAllowsOnlyCloudflareHttps() { + assertNotNull(new CfDnsClientBuilder().withApiTokenAuth("t") + .withBaseUrl("HTTPS://API.CLOUDFLARE.COM/client/v4/").build()); assertNotNull(new CfDnsClientBuilder().withApiTokenAuth("t").withBaseUrl(null).build()); } + @Test + void testBaseUrlTrailingSlashIsRemoved() throws ReflectiveOperationException { + Method validateBaseUrl = CfDnsClientBuilder.class.getDeclaredMethod("validateBaseUrl", String.class); + validateBaseUrl.setAccessible(true); + + assertEquals("HTTPS://API.CLOUDFLARE.COM/client/v4", + validateBaseUrl.invoke(null, "HTTPS://API.CLOUDFLARE.COM/client/v4/")); + } + @Test void testInvalidTimeoutsAreRejected() { CfDnsClientBuilder builder = new CfDnsClientBuilder();