Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -634,6 +634,20 @@ try {

```

You can also pass the logout types to sign out of. This returns the server's response, which includes the
cookie domain and path to clear.

```java
try {
JWTResponse res = as.logoutAll(refreshToken, Arrays.asList("web", "mobile"));
String cookieDomain = res.getCookieDomain();
String cookiePath = res.getCookiePath();
} catch (DescopeException de) {
// Handle the error
}

```

## Management Functions

It is very common for some form of management or automation to be required. These can be performed
Expand Down
15 changes: 15 additions & 0 deletions src/main/java/com/descope/model/auth/LogoutRequest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package com.descope.model.auth;

import java.util.List;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class LogoutRequest {
private List<String> logoutType;
}
21 changes: 21 additions & 0 deletions src/main/java/com/descope/model/jwt/response/JWTResponse.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.descope.model.auth.IDPResponse;
import com.descope.model.user.response.UserResponse;
import java.util.Map;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
Expand All @@ -19,10 +20,30 @@ public class JWTResponse {
private UserResponse user;
private Boolean firstSeen;
private IDPResponse idpResponse;
private Integer sessionExpiration;
private String externalToken;
private Map<String, Object> claims;
private String tenantSSOID;
private String trustedDeviceJwt;
private Integer nextRefreshSeconds;
private String cookieName;
private String sessionCookieName;
private String sessionCookieDomain;
private Boolean unsavedSSO;
private String knownDeviceJwt;
private Boolean ssoAuthenticationOnly;
private Boolean userCreationDeferred;

public JWTResponse(String sessionJwt, String refreshJwt, String cookieDomain, String cookiePath,
Integer cookieMaxAge, Integer cookieExpiration, UserResponse user, Boolean firstSeen) {
this(sessionJwt, refreshJwt, cookieDomain, cookiePath, cookieMaxAge, cookieExpiration, user,
firstSeen, null);
}

public JWTResponse(String sessionJwt, String refreshJwt, String cookieDomain, String cookiePath,
Integer cookieMaxAge, Integer cookieExpiration, UserResponse user, Boolean firstSeen,
IDPResponse idpResponse) {
this(sessionJwt, refreshJwt, cookieDomain, cookiePath, cookieMaxAge, cookieExpiration, user,
firstSeen, idpResponse, null, null, null, null, null, null, null, null, null, null, null, null, null);
}
}
12 changes: 12 additions & 0 deletions src/main/java/com/descope/sdk/auth/AuthenticationService.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import com.descope.model.auth.AccessKeyLoginOptions;
import com.descope.model.auth.AuthenticationInfo;
import com.descope.model.jwt.Token;
import com.descope.model.jwt.response.JWTResponse;
import com.descope.model.user.response.UserHistoryResponse;
import com.descope.model.user.response.UserResponse;
import java.util.List;
Expand Down Expand Up @@ -258,6 +259,17 @@ boolean validatePermissions(Token token, String tenant, List<String> permissions
*/
void logoutAll(String refreshToken) throws DescopeException;

/**
* Used to log out of all device sessions, optionally limited to the given logout types.
*
* @param refreshToken - token
* @param logoutType - optional logout types; each must be non-empty
* @return {@link JWTResponse JWTResponse} the server's response, which carries the cookie
* settings to clear
* @throws DescopeException if there is an error
*/
JWTResponse logoutAll(String refreshToken, List<String> logoutType) throws DescopeException;

/**
* Use to retrieve current session user details. The request requires a valid refresh token.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import com.descope.model.auth.AccessKeyLoginOptions;
import com.descope.model.auth.AuthenticationInfo;
import com.descope.model.auth.ExchangeTokenRequest;
import com.descope.model.auth.LogoutRequest;
import com.descope.model.client.Client;
import com.descope.model.jwt.Token;
import com.descope.model.jwt.response.JWTResponse;
Expand Down Expand Up @@ -227,6 +228,16 @@ public void logoutAll(String refreshToken) throws DescopeException {
apiProxy.post(logOutAllURL, null, JWTResponse.class);
}

@Override
public JWTResponse logoutAll(String refreshToken, List<String> logoutType) throws DescopeException {
if (StringUtils.isBlank(refreshToken)) {
throw ServerCommonException.missingArguments("refresh token");
}
ApiProxy apiProxy = getApiProxy(refreshToken);
LogoutRequest request = new LogoutRequest(logoutType);
return apiProxy.post(composeLogOutAllLinkURL(), request, JWTResponse.class);
}

@Override
public UserResponse me(String refreshToken) throws DescopeException {
if (StringUtils.isBlank(refreshToken)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,24 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.mockStatic;
import static org.mockito.Mockito.when;

import com.descope.enums.DeliveryMethod;
import com.descope.exception.RateLimitExceededException;
import com.descope.exception.ServerCommonException;
import com.descope.model.auth.AccessKeyLoginOptions;
import com.descope.model.auth.AuthenticationInfo;
import com.descope.model.auth.AuthenticationServices;
import com.descope.model.client.Client;
import com.descope.model.jwt.Token;
import com.descope.model.jwt.response.JWTResponse;
import com.descope.model.mgmt.AccessKeyResponse;
import com.descope.model.mgmt.ManagementServices;
import com.descope.model.user.request.UserRequest;
Expand All @@ -28,11 +37,24 @@
import com.descope.sdk.mgmt.TenantService;
import com.descope.sdk.mgmt.UserService;
import com.descope.sdk.mgmt.impl.ManagementServiceBuilder;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Map;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.core5.http.ClassicHttpRequest;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junitpioneer.jupiter.RetryingTest;
import org.mockito.ArgumentCaptor;
import org.mockito.MockedStatic;

public class AuthenticationServiceImplTest {

Expand Down Expand Up @@ -205,4 +227,94 @@ void testFunctionalSelectTenant() {
roleService.delete(roleBName);
}


@Test
void testLogoutAllWithLogoutTypeForEmptyRefreshToken() {
ServerCommonException thrown = assertThrows(ServerCommonException.class,
() -> authenticationService.logoutAll("", Arrays.asList("web")));
assertNotNull(thrown);
assertEquals("refresh token", thrown.getMessage());
}

@Test
void testLogoutAllWithLogoutTypeForSuccess() throws Exception {
ArgumentCaptor<ClassicHttpRequest> captor = ArgumentCaptor.forClass(ClassicHttpRequest.class);
CloseableHttpClient httpClient = mockHttpClient(captor, 200,
"{\"sessionJwt\":\"s\",\"refreshJwt\":\"r\",\"cookieDomain\":\"example.com\",\"cookiePath\":\"/\","
+ "\"cookieMaxAge\":1,\"cookieExpiration\":2,\"user\":{\"userId\":\"u1\"},\"firstSeen\":true,"
+ "\"idpResponse\":{\"idpGroups\":[\"g\"]},\"sessionExpiration\":3,\"externalToken\":\"e\","
+ "\"claims\":{\"c\":\"v\"},\"tenantSSOID\":\"t1\",\"trustedDeviceJwt\":\"td\","
+ "\"nextRefreshSeconds\":4,\"cookieName\":\"DSR\",\"sessionCookieName\":\"DS\","
+ "\"sessionCookieDomain\":\"s.example.com\",\"unsavedSSO\":true,\"knownDeviceJwt\":\"kd\","
+ "\"ssoAuthenticationOnly\":true,\"userCreationDeferred\":true,\"unknownField\":1}");
try (MockedStatic<HttpClients> mockedHttpClients = mockStatic(HttpClients.class)) {
mockedHttpClients.when(HttpClients::createDefault).thenReturn(httpClient);
final JWTResponse response =
authenticationService.logoutAll("someRefreshToken", Arrays.asList("web", "mobile"));
ClassicHttpRequest request = captor.getValue();
assertEquals("POST", request.getMethod());
assertTrue(request.getRequestUri().endsWith("/v1/auth/logoutall"));
assertEquals("Bearer " + TestUtils.PROJECT_ID + ":someRefreshToken",
request.getHeader("Authorization").getValue());
Map<?, ?> body = requestBody(request);
assertEquals(1, body.size());
assertEquals(Arrays.asList("web", "mobile"), body.get("logoutType"));
assertEquals("s", response.getSessionJwt());
assertEquals("r", response.getRefreshJwt());
assertEquals("example.com", response.getCookieDomain());
assertEquals("/", response.getCookiePath());
assertEquals(1, response.getCookieMaxAge());
assertEquals(2, response.getCookieExpiration());
assertEquals("u1", response.getUser().getUserId());
assertTrue(response.getFirstSeen());
assertEquals(Arrays.asList("g"), response.getIdpResponse().getIdpGroups());
assertEquals(3, response.getSessionExpiration());
assertEquals("e", response.getExternalToken());
assertEquals("v", response.getClaims().get("c"));
assertEquals("t1", response.getTenantSSOID());
assertEquals("td", response.getTrustedDeviceJwt());
assertEquals(4, response.getNextRefreshSeconds());
assertEquals("DSR", response.getCookieName());
assertEquals("DS", response.getSessionCookieName());
assertEquals("s.example.com", response.getSessionCookieDomain());
assertTrue(response.getUnsavedSSO());
assertEquals("kd", response.getKnownDeviceJwt());
assertTrue(response.getSsoAuthenticationOnly());
assertTrue(response.getUserCreationDeferred());
}
}

@Test
void testLogoutAllWithoutLogoutType() throws Exception {
ArgumentCaptor<ClassicHttpRequest> captor = ArgumentCaptor.forClass(ClassicHttpRequest.class);
CloseableHttpClient httpClient = mockHttpClient(captor, 200, "{\"cookieName\":null,\"user\":null}");
try (MockedStatic<HttpClients> mockedHttpClients = mockStatic(HttpClients.class)) {
mockedHttpClients.when(HttpClients::createDefault).thenReturn(httpClient);
JWTResponse response = authenticationService.logoutAll("someRefreshToken", null);
assertTrue(requestBody(captor.getValue()).isEmpty());
assertNotNull(response);
assertNull(response.getUser());
}
}

private CloseableHttpClient mockHttpClient(ArgumentCaptor<ClassicHttpRequest> captor, int statusCode,
String responseBody) throws IOException {
CloseableHttpClient httpClient = mock(CloseableHttpClient.class);
doAnswer(inv -> {
ClassicHttpResponse response = mock(ClassicHttpResponse.class);
when(response.getCode()).thenReturn(statusCode);
HttpEntity entity = mock(HttpEntity.class);
when(entity.getContent())
.thenReturn(new ByteArrayInputStream(responseBody.getBytes(StandardCharsets.UTF_8)));
when(response.getEntity()).thenReturn(entity);
return ((HttpClientResponseHandler) inv.getArgument(1)).handleResponse(response);
}).when(httpClient).execute(captor.capture(), any(HttpClientResponseHandler.class));
return httpClient;
}

private Map<?, ?> requestBody(ClassicHttpRequest request) throws IOException {
ByteArrayOutputStream bs = new ByteArrayOutputStream();
request.getEntity().writeTo(bs);
return new ObjectMapper().readValue(bs.toByteArray(), Map.class);
}
}