diff --git a/README.md b/README.md index b12d8837..d7fab969 100644 --- a/README.md +++ b/README.md @@ -293,6 +293,33 @@ try { ``` +Optional authorize parameters, such as prompt and login hint, can be passed with `OAuthAuthorizeOptions`. `startSignIn` and `startSignUp` take the same arguments: + +```java +OAuthAuthorizeOptions options = OAuthAuthorizeOptions.builder() + .prompt(Arrays.asList(OAuthPrompt.LOGIN, OAuthPrompt.CONSENT)) + .loginHint("user@example.com") + .build(); + +try { + String url = oas.start("google", "https://my-app.com/handle-oauth", loginOptions, null, options); +} catch (DescopeException de) { + // Handle the error +} + +``` + +To add an OAuth provider to a logged-in user, start an update with the user's refresh token. Set `allowAllMerge` to add the provider even when its email isn't one of the user's login IDs: + +```java +try { + String url = oas.updateUser("google", "https://my-app.com/handle-oauth", refreshToken, false, loginOptions); +} catch (DescopeException de) { + // Handle the error +} + +``` + The user will authenticate with the authentication provider, and will be redirected back to the redirect URL, with an appended `code` HTTP URL parameter. Exchange it to validate the user: ```java diff --git a/src/main/java/com/descope/enums/OAuthPrompt.java b/src/main/java/com/descope/enums/OAuthPrompt.java new file mode 100644 index 00000000..0e7a7ab9 --- /dev/null +++ b/src/main/java/com/descope/enums/OAuthPrompt.java @@ -0,0 +1,17 @@ +package com.descope.enums; + +import lombok.Getter; + +public enum OAuthPrompt { + NONE("none"), + LOGIN("login"), + CONSENT("consent"), + SELECT_ACCOUNT("select_account"); + + @Getter + private final String value; + + OAuthPrompt(String value) { + this.value = value; + } +} diff --git a/src/main/java/com/descope/literals/Routes.java b/src/main/java/com/descope/literals/Routes.java index 06466079..c07d5d16 100644 --- a/src/main/java/com/descope/literals/Routes.java +++ b/src/main/java/com/descope/literals/Routes.java @@ -49,6 +49,7 @@ public static class AuthEndPoints { public static final String COMPOSE_OAUTH_LINK = "/v1/auth/oauth/authorize"; public static final String COMPOSE_OAUTH_LINK_SIGN_IN = "/v1/auth/oauth/authorize/signin"; public static final String COMPOSE_OAUTH_LINK_SIGN_UP = "/v1/auth/oauth/authorize/signup"; + public static final String COMPOSE_OAUTH_LINK_UPDATE_USER = "/v1/auth/oauth/authorize/update"; public static final String EXCHANGE_OAUTH_LINK = "/v1/auth/oauth/exchange"; // SAML diff --git a/src/main/java/com/descope/model/auth/AssociatedTenant.java b/src/main/java/com/descope/model/auth/AssociatedTenant.java index 1798deae..05bbc9ff 100644 --- a/src/main/java/com/descope/model/auth/AssociatedTenant.java +++ b/src/main/java/com/descope/model/auth/AssociatedTenant.java @@ -1,5 +1,6 @@ package com.descope.model.auth; +import com.fasterxml.jackson.annotation.JsonProperty; import java.util.List; import lombok.AllArgsConstructor; import lombok.Builder; @@ -14,4 +15,13 @@ public class AssociatedTenant { private String tenantId; private String tenantName; private List roleNames; + // Response only, never sent in requests + @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) + private List permissions; + @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) + private List roleIds; + + public AssociatedTenant(String tenantId, String tenantName, List roleNames) { + this(tenantId, tenantName, roleNames, null, null); + } } diff --git a/src/main/java/com/descope/model/auth/AuthenticationInfo.java b/src/main/java/com/descope/model/auth/AuthenticationInfo.java index b4a5666d..22162d54 100644 --- a/src/main/java/com/descope/model/auth/AuthenticationInfo.java +++ b/src/main/java/com/descope/model/auth/AuthenticationInfo.java @@ -2,6 +2,7 @@ import com.descope.model.jwt.Token; import com.descope.model.user.response.UserResponse; +import java.util.Map; import lombok.AllArgsConstructor; import lombok.Data; @@ -13,8 +14,34 @@ public class AuthenticationInfo { private UserResponse user; private Boolean firstSeen; private IDPResponse idpResponse; + private String cookieDomain; + private String cookiePath; + private Integer cookieMaxAge; + private Integer cookieExpiration; + private Integer sessionExpiration; + private String externalToken; + private Map 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 AuthenticationInfo(Token token, Token refreshToken, UserResponse user, Boolean firstSeen) { this(token, refreshToken, user, firstSeen, null); } + + public AuthenticationInfo(Token token, Token refreshToken, UserResponse user, Boolean firstSeen, + IDPResponse idpResponse) { + this.token = token; + this.refreshToken = refreshToken; + this.user = user; + this.firstSeen = firstSeen; + this.idpResponse = idpResponse; + } } diff --git a/src/main/java/com/descope/model/auth/IDPResponse.java b/src/main/java/com/descope/model/auth/IDPResponse.java index 60bf41e8..0fa9c808 100644 --- a/src/main/java/com/descope/model/auth/IDPResponse.java +++ b/src/main/java/com/descope/model/auth/IDPResponse.java @@ -13,4 +13,15 @@ public class IDPResponse { private List idpGroups; private Map idpSAMLAttributes; private Map idpOIDCClaims; + private String samlResponse; + private String samlGeneratedUser; + private String samlGeneratedRoles; + private String oidcResponse; + private String oidcGeneratedUser; + private String oidcGeneratedRoles; + + public IDPResponse(List idpGroups, Map idpSAMLAttributes, + Map idpOIDCClaims) { + this(idpGroups, idpSAMLAttributes, idpOIDCClaims, null, null, null, null, null, null); + } } diff --git a/src/main/java/com/descope/model/auth/OAuthAuthorizeOptions.java b/src/main/java/com/descope/model/auth/OAuthAuthorizeOptions.java new file mode 100644 index 00000000..312f3d66 --- /dev/null +++ b/src/main/java/com/descope/model/auth/OAuthAuthorizeOptions.java @@ -0,0 +1,22 @@ +package com.descope.model.auth; + +import com.descope.enums.OAuthPrompt; +import java.util.List; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** Optional query parameters for starting an OAuth authorization. */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class OAuthAuthorizeOptions { + /** Prompt values to pass to the OAuth provider. */ + private List prompt; + /** Login hint to pass to the OAuth provider. */ + private String loginHint; + /** Email address the authentication was initiated with. */ + private String initiatedEmail; +} diff --git a/src/main/java/com/descope/model/jwt/response/JWTResponse.java b/src/main/java/com/descope/model/jwt/response/JWTResponse.java index 763fa8c0..7ce438ec 100644 --- a/src/main/java/com/descope/model/jwt/response/JWTResponse.java +++ b/src/main/java/com/descope/model/jwt/response/JWTResponse.java @@ -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; @@ -19,10 +20,29 @@ public class JWTResponse { private UserResponse user; private Boolean firstSeen; private IDPResponse idpResponse; + private Integer sessionExpiration; + private String externalToken; + private Map 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); + } } diff --git a/src/main/java/com/descope/model/magiclink/LoginOptions.java b/src/main/java/com/descope/model/magiclink/LoginOptions.java index de3b9ac2..a48c427a 100644 --- a/src/main/java/com/descope/model/magiclink/LoginOptions.java +++ b/src/main/java/com/descope/model/magiclink/LoginOptions.java @@ -20,6 +20,10 @@ public class LoginOptions { private String jwt; private String locale; private String templateId; + private String ssoAppId; + /** Base64-encoded PKCE challenge (32 bytes), relevant only for enchanted links. */ + private String pkceChallenge; + private String tenantId; public LoginOptions(boolean stepup, boolean mfa, Map customClaims, Map templateOptions) { @@ -41,6 +45,13 @@ public LoginOptions(boolean stepup, boolean mfa, Map customClaim this.jwt = jwt; } + public LoginOptions(boolean stepup, boolean mfa, Map customClaims, + Map templateOptions, boolean revokeOtherSessions, + String[] revokeOtherSessionsTypes, String jwt, String locale, String templateId) { + this(stepup, mfa, customClaims, templateOptions, revokeOtherSessions, revokeOtherSessionsTypes, jwt, locale, + templateId, null, null, null); + } + public boolean isJWTRequired() { return this.isStepup() || this.isMfa(); } diff --git a/src/main/java/com/descope/model/user/response/UserFamily.java b/src/main/java/com/descope/model/user/response/UserFamily.java new file mode 100644 index 00000000..636e9b8f --- /dev/null +++ b/src/main/java/com/descope/model/user/response/UserFamily.java @@ -0,0 +1,17 @@ +package com.descope.model.user.response; + +import java.util.List; +import java.util.Map; +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +@Data +@NoArgsConstructor +@AllArgsConstructor +public class UserFamily { + private String familyId; + private List roleNames; + private List permissions; + private Map familyScopedAttributes; +} diff --git a/src/main/java/com/descope/model/user/response/UserResponse.java b/src/main/java/com/descope/model/user/response/UserResponse.java index 1f933492..e0390deb 100644 --- a/src/main/java/com/descope/model/user/response/UserResponse.java +++ b/src/main/java/com/descope/model/user/response/UserResponse.java @@ -1,6 +1,7 @@ package com.descope.model.user.response; import com.descope.model.auth.AssociatedTenant; +import com.fasterxml.jackson.annotation.JsonAlias; import java.util.List; import java.util.Map; import lombok.AllArgsConstructor; @@ -40,4 +41,66 @@ public class UserResponse { * this is greater than now. */ Long tempLockExpiration; + List externalIds; + Boolean webauthn; + Boolean password; + Boolean editable; + Boolean SCIM; + Boolean push; + List permissions; + Boolean OIDC; + Long consentExpiration; + String recoveryEmail; + Boolean verifiedRecoveryEmail; + String recoveryPhone; + Boolean verifiedRecoveryPhone; + Long modifiedTime; + /** Role IDs; order doesn't match roleNames. */ + List roleIds; + Boolean recoveryCodes; + Boolean dependent; + List userFamilies; + String scimTenantId; + String samlTenantId; + String oidcTenantId; + String consentTenantId; + /** Previous sign-in time in unix seconds, 0 when none. */ + Long lastLoginTime; + + public UserResponse(String userId, List loginIds, String email, Boolean verifiedEmail, String phone, + Boolean verifiedPhone, String name, String givenName, String middleName, String familyName, + List roleNames, List userTenants, String status, String picture, Boolean test, + Long createdTime, Map customAttributes, Boolean totp, Boolean saml, + Map oauth, List ssoAppIds, String lockReason, Long tempLockExpiration) { + this(userId, loginIds, email, verifiedEmail, phone, verifiedPhone, name, givenName, middleName, familyName, + roleNames, userTenants, status, picture, test, createdTime, customAttributes, totp, saml, oauth, ssoAppIds, + lockReason, tempLockExpiration, null, null, null, null, null, null, null, null, null, null, null, null, + null, null, null, null, null, null, null, null, null, null, null); + } + + // The spec's upper-case keys; the getters keep serializing the lower-case names + @JsonAlias("TOTP") + public void setTOTP(Boolean totp) { + this.TOTP = totp; + } + + @JsonAlias("SAML") + public void setSAML(Boolean saml) { + this.SAML = saml; + } + + @JsonAlias("OAuth") + public void setOAuth(Map oauth) { + this.oAuth = oauth; + } + + @JsonAlias("SCIM") + public void setSCIM(Boolean scim) { + this.SCIM = scim; + } + + @JsonAlias("OIDC") + public void setOIDC(Boolean oidc) { + this.OIDC = oidc; + } } diff --git a/src/main/java/com/descope/sdk/auth/OAuthService.java b/src/main/java/com/descope/sdk/auth/OAuthService.java index dc09e2ac..39ae1abe 100644 --- a/src/main/java/com/descope/sdk/auth/OAuthService.java +++ b/src/main/java/com/descope/sdk/auth/OAuthService.java @@ -2,6 +2,7 @@ import com.descope.exception.DescopeException; import com.descope.model.auth.AuthenticationInfo; +import com.descope.model.auth.OAuthAuthorizeOptions; import com.descope.model.magiclink.LoginOptions; import java.util.Map; @@ -30,6 +31,19 @@ String start(String provider, String returnURL, LoginOptions loginOptions) String start(String provider, String returnURL, LoginOptions loginOptions, Map authParams) throws DescopeException; + /** + * Use to start an OAuth authentication using the given OAuthProvider with sign up or in and options. + * + * @param provider - provider + * @param returnURL - return url + * @param loginOptions - {@link LoginOptions loginOptions}; step-up and MFA require its refresh JWT in jwt + * @param authParams - additional query params to append to the authorize URL + * @param options - {@link OAuthAuthorizeOptions options} such as prompt and login hint + * @return a string represent the redirect URL + */ + String start(String provider, String returnURL, LoginOptions loginOptions, Map authParams, + OAuthAuthorizeOptions options) throws DescopeException; + /** * Use to start an OAuth authentication using the given OAuthProvider with sign in and options. * @@ -53,6 +67,19 @@ String startSignIn(String provider, String returnURL, LoginOptions loginOptions) String startSignIn(String provider, String returnURL, LoginOptions loginOptions, Map authParams) throws DescopeException; + /** + * Use to start an OAuth authentication using the given OAuthProvider with sign in and options. + * + * @param provider - provider + * @param returnURL - return url + * @param loginOptions - {@link LoginOptions loginOptions}; step-up and MFA require its refresh JWT in jwt + * @param authParams - additional query params to append to the authorize URL + * @param options - {@link OAuthAuthorizeOptions options} such as prompt and login hint + * @return a string represent the redirect URL + */ + String startSignIn(String provider, String returnURL, LoginOptions loginOptions, Map authParams, + OAuthAuthorizeOptions options) throws DescopeException; + /** * Use to start an OAuth authentication using the given OAuthProvider with sign up and options. * @@ -76,6 +103,19 @@ String startSignUp(String provider, String returnURL, LoginOptions loginOptions) String startSignUp(String provider, String returnURL, LoginOptions loginOptions, Map authParams) throws DescopeException; + /** + * Use to start an OAuth authentication using the given OAuthProvider with sign up and options. + * + * @param provider - provider + * @param returnURL - return url + * @param loginOptions - {@link LoginOptions loginOptions}; step-up and MFA require its refresh JWT in jwt + * @param authParams - additional query params to append to the authorize URL + * @param options - {@link OAuthAuthorizeOptions options} such as prompt and login hint + * @return a string represent the redirect URL + */ + String startSignUp(String provider, String returnURL, LoginOptions loginOptions, Map authParams, + OAuthAuthorizeOptions options) throws DescopeException; + /** * Use to exchange the OAuth code with actual {@link AuthenticationInfo}. * @@ -83,4 +123,31 @@ String startSignUp(String provider, String returnURL, LoginOptions loginOptions, * @return {@link AuthenticationInfo} */ AuthenticationInfo exchangeToken(String code) throws DescopeException; + + /** + * Use to start an OAuth authentication that adds the given OAuthProvider to the logged-in user. + * + * @param provider - provider + * @param returnURL - return url + * @param refreshToken - the logged-in user's refresh token + * @param allowAllMerge - add the provider even when its email isn't one of the user's login IDs + * @param loginOptions - {@link LoginOptions loginOptions} + * @return a string represent the redirect URL + */ + String updateUser(String provider, String returnURL, String refreshToken, boolean allowAllMerge, + LoginOptions loginOptions) throws DescopeException; + + /** + * Use to start an OAuth authentication that adds the given OAuthProvider to the logged-in user. + * + * @param provider - provider + * @param returnURL - return url + * @param refreshToken - the logged-in user's refresh token + * @param allowAllMerge - add the provider even when its email isn't one of the user's login IDs + * @param loginOptions - {@link LoginOptions loginOptions} + * @param options - {@link OAuthAuthorizeOptions options} such as prompt and login hint + * @return a string represent the redirect URL + */ + String updateUser(String provider, String returnURL, String refreshToken, boolean allowAllMerge, + LoginOptions loginOptions, OAuthAuthorizeOptions options) throws DescopeException; } \ No newline at end of file diff --git a/src/main/java/com/descope/sdk/auth/impl/AuthenticationsBase.java b/src/main/java/com/descope/sdk/auth/impl/AuthenticationsBase.java index e01b2b71..ff1e8b5c 100644 --- a/src/main/java/com/descope/sdk/auth/impl/AuthenticationsBase.java +++ b/src/main/java/com/descope/sdk/auth/impl/AuthenticationsBase.java @@ -130,9 +130,27 @@ AuthenticationInfo getAuthenticationInfo(JWTResponse jwtResponse) { if (StringUtils.isNotBlank(jwtResponse.getRefreshJwt())) { refreshToken = validateAndCreateToken(jwtResponse.getRefreshJwt()); } - return new AuthenticationInfo( + AuthenticationInfo info = new AuthenticationInfo( sessionToken, refreshToken, jwtResponse.getUser(), jwtResponse.getFirstSeen(), jwtResponse.getIdpResponse()); + info.setCookieDomain(jwtResponse.getCookieDomain()); + info.setCookiePath(jwtResponse.getCookiePath()); + info.setCookieMaxAge(jwtResponse.getCookieMaxAge()); + info.setCookieExpiration(jwtResponse.getCookieExpiration()); + info.setSessionExpiration(jwtResponse.getSessionExpiration()); + info.setExternalToken(jwtResponse.getExternalToken()); + info.setClaims(jwtResponse.getClaims()); + info.setTenantSSOID(jwtResponse.getTenantSSOID()); + info.setTrustedDeviceJwt(jwtResponse.getTrustedDeviceJwt()); + info.setNextRefreshSeconds(jwtResponse.getNextRefreshSeconds()); + info.setCookieName(jwtResponse.getCookieName()); + info.setSessionCookieName(jwtResponse.getSessionCookieName()); + info.setSessionCookieDomain(jwtResponse.getSessionCookieDomain()); + info.setUnsavedSSO(jwtResponse.getUnsavedSSO()); + info.setKnownDeviceJwt(jwtResponse.getKnownDeviceJwt()); + info.setSsoAuthenticationOnly(jwtResponse.getSsoAuthenticationOnly()); + info.setUserCreationDeferred(jwtResponse.getUserCreationDeferred()); + return info; } @SuppressWarnings("unchecked") diff --git a/src/main/java/com/descope/sdk/auth/impl/OAuthServiceImpl.java b/src/main/java/com/descope/sdk/auth/impl/OAuthServiceImpl.java index ca63881d..9526d831 100644 --- a/src/main/java/com/descope/sdk/auth/impl/OAuthServiceImpl.java +++ b/src/main/java/com/descope/sdk/auth/impl/OAuthServiceImpl.java @@ -3,18 +3,28 @@ import static com.descope.literals.Routes.AuthEndPoints.COMPOSE_OAUTH_LINK; import static com.descope.literals.Routes.AuthEndPoints.COMPOSE_OAUTH_LINK_SIGN_IN; import static com.descope.literals.Routes.AuthEndPoints.COMPOSE_OAUTH_LINK_SIGN_UP; +import static com.descope.literals.Routes.AuthEndPoints.COMPOSE_OAUTH_LINK_UPDATE_USER; import static com.descope.literals.Routes.AuthEndPoints.EXCHANGE_OAUTH_LINK; import static com.descope.utils.CollectionUtils.mapOf; +import com.descope.enums.OAuthPrompt; import com.descope.exception.DescopeException; +import com.descope.exception.ServerCommonException; import com.descope.model.auth.AuthenticationInfo; +import com.descope.model.auth.OAuthAuthorizeOptions; import com.descope.model.auth.OAuthResponse; import com.descope.model.client.Client; import com.descope.model.magiclink.LoginOptions; import com.descope.proxy.ApiProxy; import com.descope.sdk.auth.OAuthService; +import com.descope.utils.JwtUtils; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.ObjectMapper; import java.net.URI; +import java.net.URLEncoder; import java.util.Map; +import lombok.SneakyThrows; import org.apache.commons.lang3.StringUtils; class OAuthServiceImpl extends AuthenticationServiceImpl implements OAuthService { @@ -36,6 +46,65 @@ protected String startWithUrl(String url, String provider, String redirectURL, L return resUrl; } + private String authorize(String route, String provider, String redirectUrl, LoginOptions loginOptions, + Map authParams, OAuthAuthorizeOptions options, String refreshToken, boolean allowAllMerge) { + Map params = mapOf("provider", provider); + if (StringUtils.isNotBlank(redirectUrl)) { + params.put("redirectUrl", redirectUrl); + } + if (allowAllMerge) { + params.put("allowAllMerge", "true"); + } + if (options != null) { + if (StringUtils.isNotBlank(options.getLoginHint())) { + params.put("loginHint", options.getLoginHint()); + } + if (StringUtils.isNotBlank(options.getInitiatedEmail())) { + params.put("initiatedEmail", options.getInitiatedEmail()); + } + } + URI uri = withPrompt(getQueryParamUri(route, params), options); + ApiProxy apiProxy = getApiProxy(refreshToken); + OAuthResponse res = apiProxy.post(uri, loginOptionsBody(loginOptions), OAuthResponse.class); + return appendQueryParams(res.getUrl(), authParams); + } + + // Step-up and MFA send the refresh JWT from the login options + private static String stepUpToken(LoginOptions loginOptions) { + if (!JwtUtils.isJWTRequired(loginOptions)) { + return null; + } + if (StringUtils.isBlank(loginOptions.getJwt())) { + throw ServerCommonException.invalidArgument("JWT"); + } + return loginOptions.getJwt(); + } + + // LoginOptions also serializes jwt and jwtrequired, which the API doesn't accept + private static Map loginOptionsBody(LoginOptions loginOptions) { + Map body = new ObjectMapper().setSerializationInclusion(Include.NON_NULL) + .convertValue(loginOptions != null ? loginOptions : new LoginOptions(), + new TypeReference>() {}); + body.remove("jwt"); + body.remove("jwtrequired"); + return body; + } + + // prompt is an array query param: one entry per value + @SneakyThrows + private static URI withPrompt(URI uri, OAuthAuthorizeOptions options) { + if (options == null || options.getPrompt() == null || options.getPrompt().isEmpty()) { + return uri; + } + StringBuilder sb = new StringBuilder(uri.toString()); + for (OAuthPrompt prompt : options.getPrompt()) { + if (prompt != null) { + sb.append("&prompt=").append(URLEncoder.encode(prompt.getValue(), "UTF-8")); + } + } + return URI.create(sb.toString()); + } + @Override public String start(String provider, String redirectURL, LoginOptions loginOptions) throws DescopeException { return startWithUrl(COMPOSE_OAUTH_LINK, provider, redirectURL, loginOptions, null); @@ -47,6 +116,13 @@ public String start(String provider, String redirectURL, LoginOptions loginOptio return startWithUrl(COMPOSE_OAUTH_LINK, provider, redirectURL, loginOptions, authParams); } + @Override + public String start(String provider, String redirectURL, LoginOptions loginOptions, + Map authParams, OAuthAuthorizeOptions options) throws DescopeException { + return authorize(COMPOSE_OAUTH_LINK, provider, redirectURL, loginOptions, authParams, options, + stepUpToken(loginOptions), false); + } + @Override public String startSignIn(String provider, String redirectURL, LoginOptions loginOptions) throws DescopeException { return startWithUrl(COMPOSE_OAUTH_LINK_SIGN_IN, provider, redirectURL, loginOptions, null); @@ -58,6 +134,13 @@ public String startSignIn(String provider, String redirectURL, LoginOptions logi return startWithUrl(COMPOSE_OAUTH_LINK_SIGN_IN, provider, redirectURL, loginOptions, authParams); } + @Override + public String startSignIn(String provider, String redirectURL, LoginOptions loginOptions, + Map authParams, OAuthAuthorizeOptions options) throws DescopeException { + return authorize(COMPOSE_OAUTH_LINK_SIGN_IN, provider, redirectURL, loginOptions, authParams, options, + stepUpToken(loginOptions), false); + } + @Override public String startSignUp(String provider, String redirectURL, LoginOptions loginOptions) throws DescopeException { return startWithUrl(COMPOSE_OAUTH_LINK_SIGN_UP, provider, redirectURL, loginOptions, null); @@ -69,11 +152,34 @@ public String startSignUp(String provider, String redirectURL, LoginOptions logi return startWithUrl(COMPOSE_OAUTH_LINK_SIGN_UP, provider, redirectURL, loginOptions, authParams); } + @Override + public String startSignUp(String provider, String redirectURL, LoginOptions loginOptions, + Map authParams, OAuthAuthorizeOptions options) throws DescopeException { + return authorize(COMPOSE_OAUTH_LINK_SIGN_UP, provider, redirectURL, loginOptions, authParams, options, + stepUpToken(loginOptions), false); + } + @Override public AuthenticationInfo exchangeToken(String code) throws DescopeException { return exchangeToken(code, composeOAuthExchangeTokenURL()); } + @Override + public String updateUser(String provider, String redirectURL, String refreshToken, boolean allowAllMerge, + LoginOptions loginOptions) throws DescopeException { + return updateUser(provider, redirectURL, refreshToken, allowAllMerge, loginOptions, null); + } + + @Override + public String updateUser(String provider, String redirectURL, String refreshToken, boolean allowAllMerge, + LoginOptions loginOptions, OAuthAuthorizeOptions options) throws DescopeException { + if (StringUtils.isBlank(refreshToken)) { + throw ServerCommonException.invalidArgument("Refresh Token"); + } + return authorize(COMPOSE_OAUTH_LINK_UPDATE_USER, provider, redirectURL, loginOptions, null, options, + refreshToken, allowAllMerge); + } + private URI composeOAuthExchangeTokenURL() { return getUri(EXCHANGE_OAUTH_LINK); } diff --git a/src/test/java/com/descope/sdk/auth/impl/OAuthServiceImplTest.java b/src/test/java/com/descope/sdk/auth/impl/OAuthServiceImplTest.java index fc73c05b..d406a335 100644 --- a/src/test/java/com/descope/sdk/auth/impl/OAuthServiceImplTest.java +++ b/src/test/java/com/descope/sdk/auth/impl/OAuthServiceImplTest.java @@ -7,6 +7,8 @@ import static com.descope.sdk.TestUtils.MOCK_URL; import static com.descope.sdk.TestUtils.PROJECT_ID; import static com.descope.utils.CollectionUtils.mapOf; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; @@ -14,9 +16,15 @@ import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mockStatic; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import com.descope.enums.OAuthPrompt; +import com.descope.exception.ServerCommonException; +import com.descope.model.auth.AssociatedTenant; import com.descope.model.auth.AuthenticationInfo; import com.descope.model.auth.IDPResponse; +import com.descope.model.auth.OAuthAuthorizeOptions; import com.descope.model.auth.OAuthResponse; import com.descope.model.client.Client; import com.descope.model.jwt.Token; @@ -29,12 +37,19 @@ import com.descope.sdk.TestUtils; import com.descope.sdk.auth.OAuthService; import com.descope.utils.JwtUtils; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.net.URI; import java.net.URLDecoder; import java.util.Arrays; import java.util.Map; +import java.util.concurrent.atomic.AtomicReference; +import java.util.function.Supplier; import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; import org.mockito.MockedStatic; public class OAuthServiceImplTest { @@ -172,6 +187,236 @@ void testExchangeTokenWithIDPResponse() { .containsEntry("locale", "en-US"); } + private static final String REFRESH_TOKEN = "some-refresh-token"; + private static final OAuthAuthorizeOptions AUTHORIZE_OPTIONS = OAuthAuthorizeOptions.builder() + .prompt(Arrays.asList(OAuthPrompt.LOGIN, OAuthPrompt.SELECT_ACCOUNT)) + .loginHint("user+1@example.com") + .initiatedEmail("user@example.com") + .build(); + + @Test + void testStartWithAuthorizeOptions() throws Exception { + LoginOptions loginOptions = LoginOptions.builder().ssoAppId("app-id").pkceChallenge("Y2hhbGxlbmdl") + .tenantId("tenant-id").build(); + Captured c = capture(() -> oauthService.start("google", "https://app.example/cb", loginOptions, null, + AUTHORIZE_OPTIONS)); + assertThat(c.uri.getPath()).isEqualTo("/v1/auth/oauth/authorize"); + assertThat(c.uri.getRawQuery().split("&")).containsExactlyInAnyOrder("provider=google", + "redirectUrl=https%3A%2F%2Fapp.example%2Fcb", "loginHint=user%2B1%40example.com", + "initiatedEmail=user%40example.com", "prompt=login", "prompt=select_account"); + assertThat(c.auth).isEqualTo("Bearer " + PROJECT_ID); + assertThat(c.body).isEqualTo("{\"stepup\":false,\"mfa\":false,\"revokeOtherSessions\":false," + + "\"ssoAppId\":\"app-id\",\"pkceChallenge\":\"Y2hhbGxlbmdl\",\"tenantId\":\"tenant-id\"}"); + assertThat(c.result).isEqualTo(MOCK_URL); + } + + @Test + void testStartWithAuthorizeOptionsStepUp() throws Exception { + LoginOptions loginOptions = LoginOptions.builder().stepup(true).jwt(REFRESH_TOKEN).build(); + Captured c = capture(() -> oauthService.start("google", null, loginOptions, null, AUTHORIZE_OPTIONS)); + assertThat(c.auth).isEqualTo("Bearer " + PROJECT_ID + ":" + REFRESH_TOKEN); + assertThat(c.body).isEqualTo("{\"stepup\":true,\"mfa\":false,\"revokeOtherSessions\":false}"); + } + + @Test + void testStartWithAuthorizeOptionsStepUpNoJwt() { + ApiProxy apiProxy = mock(ApiProxy.class); + try (MockedStatic mockedApiProxyBuilder = mockStatic(ApiProxyBuilder.class)) { + mockedApiProxyBuilder.when(() -> ApiProxyBuilder.buildProxy(any(), any())).thenReturn(apiProxy); + LoginOptions loginOptions = LoginOptions.builder().mfa(true).build(); + assertThatThrownBy(() -> oauthService.startSignIn("google", null, loginOptions, null, null)) + .isInstanceOf(ServerCommonException.class).hasMessageContaining("JWT"); + } + verify(apiProxy, never()).post(any(), any(), any()); + } + + @Test + void testStartSignInAndSignUpWithAuthorizeOptions() throws Exception { + Captured c = capture(() -> oauthService.startSignIn("google", null, null, mapOf("aa", "b"), AUTHORIZE_OPTIONS)); + assertThat(c.uri.getPath()).isEqualTo("/v1/auth/oauth/authorize/signin"); + assertThat(c.uri.getRawQuery().split("&")).containsExactlyInAnyOrder("provider=google", + "loginHint=user%2B1%40example.com", "initiatedEmail=user%40example.com", "prompt=login", + "prompt=select_account"); + assertThat(c.body).isEqualTo("{\"stepup\":false,\"mfa\":false,\"revokeOtherSessions\":false}"); + assertThat(c.result).isEqualTo(MOCK_URL + "?aa=b"); + + c = capture(() -> oauthService.startSignUp("google", null, new LoginOptions(), null, + new OAuthAuthorizeOptions())); + assertThat(c.uri.getPath()).isEqualTo("/v1/auth/oauth/authorize/signup"); + assertThat(c.uri.getRawQuery()).isEqualTo("provider=google"); + assertThat(c.auth).isEqualTo("Bearer " + PROJECT_ID); + } + + @Test + void testUpdateUser() throws Exception { + LoginOptions loginOptions = LoginOptions.builder().tenantId("tenant-id").build(); + Captured c = capture(() -> oauthService.updateUser("google", "https://app.example/cb", REFRESH_TOKEN, true, + loginOptions, AUTHORIZE_OPTIONS)); + assertThat(c.uri.getPath()).isEqualTo("/v1/auth/oauth/authorize/update"); + assertThat(c.uri.getRawQuery().split("&")).containsExactlyInAnyOrder("provider=google", + "redirectUrl=https%3A%2F%2Fapp.example%2Fcb", "allowAllMerge=true", "loginHint=user%2B1%40example.com", + "initiatedEmail=user%40example.com", "prompt=login", "prompt=select_account"); + assertThat(c.auth).isEqualTo("Bearer " + PROJECT_ID + ":" + REFRESH_TOKEN); + assertThat(c.body).isEqualTo("{\"stepup\":false,\"mfa\":false,\"revokeOtherSessions\":false," + + "\"tenantId\":\"tenant-id\"}"); + assertThat(c.result).isEqualTo(MOCK_URL); + + c = capture(() -> oauthService.updateUser("google", null, REFRESH_TOKEN, false, null)); + assertThat(c.uri.getRawQuery()).isEqualTo("provider=google"); + assertThat(c.body).isEqualTo("{\"stepup\":false,\"mfa\":false,\"revokeOtherSessions\":false}"); + } + + @Test + void testUpdateUserNoRefreshToken() { + ApiProxy apiProxy = mock(ApiProxy.class); + try (MockedStatic mockedApiProxyBuilder = mockStatic(ApiProxyBuilder.class)) { + mockedApiProxyBuilder.when(() -> ApiProxyBuilder.buildProxy(any(), any())).thenReturn(apiProxy); + assertThatThrownBy(() -> oauthService.updateUser("google", null, " ", false, null)) + .isInstanceOf(ServerCommonException.class).hasMessageContaining("Refresh Token"); + } + verify(apiProxy, never()).post(any(), any(), any()); + } + + @Test + void testExchangeTokenFullResponse() throws Exception { + String json = "{\"sessionJwt\":\"s\",\"refreshJwt\":\"r\",\"cookieDomain\":\"d\",\"cookiePath\":\"/\"," + + "\"cookieMaxAge\":1,\"cookieExpiration\":2,\"firstSeen\":true,\"sessionExpiration\":3," + + "\"externalToken\":\"et\",\"claims\":{\"a\":\"b\"},\"tenantSSOID\":\"tsso\",\"trustedDeviceJwt\":\"tdj\"," + + "\"nextRefreshSeconds\":4,\"cookieName\":\"cn\",\"sessionCookieName\":\"scn\"," + + "\"sessionCookieDomain\":\"scd\",\"unsavedSSO\":true,\"knownDeviceJwt\":\"kdj\"," + + "\"ssoAuthenticationOnly\":true,\"userCreationDeferred\":true,\"unknownField\":1," + + "\"idpResponse\":{\"samlResponse\":\"sr\",\"samlGeneratedUser\":\"sgu\",\"samlGeneratedRoles\":\"sgr\"," + + "\"oidcResponse\":\"or\",\"oidcGeneratedUser\":\"ogu\",\"oidcGeneratedRoles\":\"ogr\"}," + + "\"user\":{\"userId\":\"u1\",\"userTenants\":[{\"tenantId\":\"t1\",\"permissions\":[\"p1\"]," + + "\"roleIds\":[\"ri1\"]}],\"externalIds\":[\"e1\"],\"TOTP\":true,\"SAML\":true," + + "\"OAuth\":{\"google\":true},\"webauthn\":true,\"password\":true,\"editable\":true,\"SCIM\":true," + + "\"push\":true,\"permissions\":[\"p2\"],\"OIDC\":true,\"consentExpiration\":5," + + "\"recoveryEmail\":\"re\",\"verifiedRecoveryEmail\":true,\"recoveryPhone\":\"rp\"," + + "\"verifiedRecoveryPhone\":true,\"modifiedTime\":\"6\",\"roleIds\":[\"ri2\"],\"recoveryCodes\":true," + + "\"dependent\":true,\"userFamilies\":[{\"familyId\":\"f1\",\"roleNames\":[\"fr\"]," + + "\"permissions\":[\"fp\"],\"familyScopedAttributes\":{\"k\":\"v\"}}],\"scimTenantId\":\"st\"," + + "\"samlTenantId\":\"sat\",\"oidcTenantId\":\"ot\",\"consentTenantId\":\"ct\",\"lastLoginTime\":7}}"; + JWTResponse jwtResponse = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) + .readValue(json, JWTResponse.class); + + ApiProxy apiProxy = mock(ApiProxy.class); + doReturn(jwtResponse).when(apiProxy).post(any(), any(), any()); + AtomicReference auth = new AtomicReference<>(); + AuthenticationInfo info; + try (MockedStatic mockedApiProxyBuilder = mockStatic(ApiProxyBuilder.class)) { + mockedApiProxyBuilder.when(() -> ApiProxyBuilder.buildProxy(any(), any())).thenAnswer(inv -> { + auth.set(((Supplier) inv.getArgument(0)).get()); + return apiProxy; + }); + try (MockedStatic mockedJwtUtils = mockStatic(JwtUtils.class)) { + mockedJwtUtils.when(() -> JwtUtils.getToken(anyString(), any())).thenReturn(MOCK_TOKEN); + info = oauthService.exchangeToken("somecode"); + } + } + ArgumentCaptor uri = ArgumentCaptor.forClass(URI.class); + ArgumentCaptor body = ArgumentCaptor.forClass(Object.class); + verify(apiProxy).post(uri.capture(), body.capture(), eq(JWTResponse.class)); + assertThat(uri.getValue().getPath()).isEqualTo("/v1/auth/oauth/exchange"); + assertThat(new ObjectMapper().writeValueAsString(body.getValue())).isEqualTo("{\"code\":\"somecode\"}"); + assertThat(auth.get()).isEqualTo("Bearer " + PROJECT_ID); + + assertThat(info.getCookieDomain()).isEqualTo("d"); + assertThat(info.getCookiePath()).isEqualTo("/"); + assertThat(info.getCookieMaxAge()).isEqualTo(1); + assertThat(info.getCookieExpiration()).isEqualTo(2); + assertThat(info.getSessionExpiration()).isEqualTo(3); + assertThat(info.getExternalToken()).isEqualTo("et"); + assertThat(info.getClaims()).containsEntry("a", "b"); + assertThat(info.getTenantSSOID()).isEqualTo("tsso"); + assertThat(info.getTrustedDeviceJwt()).isEqualTo("tdj"); + assertThat(info.getNextRefreshSeconds()).isEqualTo(4); + assertThat(info.getCookieName()).isEqualTo("cn"); + assertThat(info.getSessionCookieName()).isEqualTo("scn"); + assertThat(info.getSessionCookieDomain()).isEqualTo("scd"); + assertThat(info.getUnsavedSSO()).isTrue(); + assertThat(info.getKnownDeviceJwt()).isEqualTo("kdj"); + assertThat(info.getSsoAuthenticationOnly()).isTrue(); + assertThat(info.getUserCreationDeferred()).isTrue(); + + IDPResponse idp = info.getIdpResponse(); + assertThat(idp.getSamlResponse()).isEqualTo("sr"); + assertThat(idp.getSamlGeneratedUser()).isEqualTo("sgu"); + assertThat(idp.getSamlGeneratedRoles()).isEqualTo("sgr"); + assertThat(idp.getOidcResponse()).isEqualTo("or"); + assertThat(idp.getOidcGeneratedUser()).isEqualTo("ogu"); + assertThat(idp.getOidcGeneratedRoles()).isEqualTo("ogr"); + + UserResponse user = info.getUser(); + AssociatedTenant tenant = user.getUserTenants().get(0); + assertThat(tenant.getPermissions()).containsExactly("p1"); + assertThat(tenant.getRoleIds()).containsExactly("ri1"); + assertThat(user.getExternalIds()).containsExactly("e1"); + assertThat(user.getTOTP()).isTrue(); + assertThat(user.getSAML()).isTrue(); + assertThat(user.getOAuth()).containsEntry("google", true); + assertThat(user.getWebauthn()).isTrue(); + assertThat(user.getPassword()).isTrue(); + assertThat(user.getEditable()).isTrue(); + assertThat(user.getSCIM()).isTrue(); + assertThat(user.getPush()).isTrue(); + assertThat(user.getPermissions()).containsExactly("p2"); + assertThat(user.getOIDC()).isTrue(); + assertThat(user.getConsentExpiration()).isEqualTo(5L); + assertThat(user.getRecoveryEmail()).isEqualTo("re"); + assertThat(user.getVerifiedRecoveryEmail()).isTrue(); + assertThat(user.getRecoveryPhone()).isEqualTo("rp"); + assertThat(user.getVerifiedRecoveryPhone()).isTrue(); + assertThat(user.getModifiedTime()).isEqualTo(6L); + assertThat(user.getRoleIds()).containsExactly("ri2"); + assertThat(user.getRecoveryCodes()).isTrue(); + assertThat(user.getDependent()).isTrue(); + assertThat(user.getUserFamilies().get(0).getFamilyId()).isEqualTo("f1"); + assertThat(user.getUserFamilies().get(0).getRoleNames()).containsExactly("fr"); + assertThat(user.getUserFamilies().get(0).getPermissions()).containsExactly("fp"); + assertThat(user.getUserFamilies().get(0).getFamilyScopedAttributes()).containsEntry("k", "v"); + assertThat(user.getScimTenantId()).isEqualTo("st"); + assertThat(user.getSamlTenantId()).isEqualTo("sat"); + assertThat(user.getOidcTenantId()).isEqualTo("ot"); + assertThat(user.getConsentTenantId()).isEqualTo("ct"); + assertThat(user.getLastLoginTime()).isEqualTo(7L); + } + + @Test + void testResponseOnlyTenantFieldsAreNotSerialized() throws Exception { + AssociatedTenant tenant = new AssociatedTenant("t1", null, Arrays.asList("r1")); + tenant.setPermissions(Arrays.asList("p1")); + tenant.setRoleIds(Arrays.asList("ri1")); + assertThat(new ObjectMapper().setSerializationInclusion(Include.NON_NULL).writeValueAsString(tenant)) + .isEqualTo("{\"tenantId\":\"t1\",\"roleNames\":[\"r1\"]}"); + } + + private static class Captured { + URI uri; + String body; + String auth; + String result; + } + + @SuppressWarnings("unchecked") + private Captured capture(Supplier call) throws Exception { + ApiProxy apiProxy = mock(ApiProxy.class); + doReturn(new OAuthResponse(MOCK_URL)).when(apiProxy).post(any(), any(), any()); + Captured c = new Captured(); + try (MockedStatic mockedApiProxyBuilder = mockStatic(ApiProxyBuilder.class)) { + mockedApiProxyBuilder.when(() -> ApiProxyBuilder.buildProxy(any(), any())).thenAnswer(inv -> { + c.auth = ((Supplier) inv.getArgument(0)).get(); + return apiProxy; + }); + c.result = call.get(); + } + ArgumentCaptor uri = ArgumentCaptor.forClass(URI.class); + ArgumentCaptor body = ArgumentCaptor.forClass(Object.class); + verify(apiProxy).post(uri.capture(), body.capture(), eq(OAuthResponse.class)); + c.uri = uri.getValue(); + c.body = new ObjectMapper().setSerializationInclusion(Include.NON_NULL).writeValueAsString(body.getValue()); + return c; + } + void testExampleRequireBrowser() throws Exception { System.out.println(oauthService.start(OAUTH_PROVIDER_GOOGLE, "https://localhost/kuku", null)); String encodedCode = "";