Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cidr white list unit test #7213

Merged
merged 2 commits into from
Feb 13, 2025
Merged

Add cidr white list unit test #7213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
060d5ec
Added unit test for cidr papi whitelist change
Camelia-Orcid Feb 10, 2025
8deaf00
Fixed typo
Camelia-Orcid Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion orcid-pub-web/src/main/java/org/orcid/api/filters/ApiRateLimitFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public class ApiRateLimitFilter extends OncePerRequestFilter {
@Value("${org.orcid.papi.rate.limit.referrer.whiteSpaceSeparatedWhiteList}")
private String papiReferrerWhiteSpaceSeparatedWhiteList;

@Value("${org.orcid.papi.rate.limit.cidrRange.whiteSpaceSeparatedWhiteList}")
@Value("${org.orcid.papi.rate.limit.cidrRange.whiteSpaceSeparatedWhiteList:10.0.0.0/8}")
private String papiCidrRangeWhiteSpaceSeparatedWhiteList;

private List<String> papiIpWhiteList;
Expand Down
40 changes: 37 additions & 3 deletions orcid-pub-web/src/test/java/org/orcid/api/filters/ApiRateLimitFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
import org.mockito.MockitoAnnotations;
import org.orcid.core.api.rate_limit.PapiRateLimitRedisClient;
import org.orcid.core.oauth.service.OrcidTokenStore;
import org.orcid.persistence.dao.PublicApiDailyRateLimitDao;
import org.orcid.persistence.jpa.entities.PublicApiDailyRateLimitEntity;
import org.orcid.test.OrcidJUnit4ClassRunner;
import org.orcid.test.TargetProxyHelper;
import org.springframework.mock.web.MockHttpServletRequest;
Expand Down Expand Up @@ -219,4 +217,40 @@ public void doFilterInternal_checkLimitReachedTest() throws ServletException, IO
"Too Many Requests. You have exceeded the daily quota for anonymous usage of this API. \nYou can increase your daily quota by registering for and using Public API client credentials (https://info.orcid.org/documentation/integration-guide/registering-a-public-api-client/)",
content);
}
}

@Test
public void doFilterInternal_annonymousRequest_whitelisted_cidr_IP_Test() throws ServletException, IOException {
MockitoAnnotations.initMocks(this);
String ip_in_cidr = "10.0.0.0";

TargetProxyHelper.injectIntoProxy(apiRateLimitFilter, "enableRateLimiting", true);
TargetProxyHelper.injectIntoProxy(apiRateLimitFilter, "orcidTokenStore", orcidTokenStoreMock);
TargetProxyHelper.injectIntoProxy(apiRateLimitFilter, "papiRedisClient", papiRateLimitRedisMock);

when(papiRateLimitRedisMock.getTodayDailyLimitsForClient(eq(ip_in_cidr))).thenReturn(null);
httpServletRequestMock.addHeader("X-REAL-IP", ip_in_cidr);

apiRateLimitFilter.doFilterInternal(httpServletRequestMock, httpServletResponseMock, filterChainMock);

verify(orcidTokenStoreMock, never()).readClientId(anyString());
verify(papiRateLimitRedisMock, never()).setTodayLimitsForClient(eq(ip_in_cidr), any());
}

@Test
public void doFilterInternal_annonymousRequest_not_whitelisted_cidr_IP_Test() throws ServletException, IOException {
MockitoAnnotations.initMocks(this);
String ip_not_cidr = "20.0.0.0";

TargetProxyHelper.injectIntoProxy(apiRateLimitFilter, "enableRateLimiting", true);
TargetProxyHelper.injectIntoProxy(apiRateLimitFilter, "orcidTokenStore", orcidTokenStoreMock);
TargetProxyHelper.injectIntoProxy(apiRateLimitFilter, "papiRedisClient", papiRateLimitRedisMock);

when(papiRateLimitRedisMock.getTodayDailyLimitsForClient(eq(ip_not_cidr))).thenReturn(null);
httpServletRequestMock.addHeader("X-REAL-IP", ip_not_cidr);

apiRateLimitFilter.doFilterInternal(httpServletRequestMock, httpServletResponseMock, filterChainMock);

verify(orcidTokenStoreMock, never()).readClientId(anyString());
verify(papiRateLimitRedisMock, times(1)).setTodayLimitsForClient(eq(ip_not_cidr), any(JSONObject.class));
}
}