diff --git a/README.md b/README.md index b12d8837..84b61413 100644 --- a/README.md +++ b/README.md @@ -174,6 +174,56 @@ try { ``` +Sign in, sign up or sign up or in accept optional request options, such as the messaging provider and template: + +```java +try { + String uri = "http://myapp.com/verify-magic-link"; + MagicLinkSignInOptions signInOptions = MagicLinkSignInOptions.builder() + .providerId("my-provider") + .templateId("my-template") + .build(); + LoginOptions loginOptions = LoginOptions.builder().tenantId("my-tenant").build(); + String maskedAddress = mls.signIn(DeliveryMethod.EMAIL, loginId, uri, null, loginOptions, signInOptions); + maskedAddress = mls.signUpOrIn(DeliveryMethod.EMAIL, loginId, uri, loginOptions, signInOptions); + + // The phone option applies to SMS and WhatsApp sign-up only + String phone = "+12125551234"; + MagicLinkSignUpOptions signUpRequestOptions = MagicLinkSignUpOptions.builder() + .phone(phone) + .providerId("my-provider") + .templateId("my-template") + .build(); + SignUpOptions signUpOptions = SignUpOptions.builder().locale("en").tenantId("my-tenant").build(); + maskedAddress = mls.signUp(DeliveryMethod.SMS, phone, uri, User.builder().phone(phone).build(), signUpOptions, + signUpRequestOptions); +} catch (DescopeException de) { + // Handle the error +} + +``` + +To update a user's email or phone through a magic link, pass the refresh token of the user's session. Update options +can also set the messaging provider, template, locale, and whether to fail instead of merging on a conflict: + +```java +try { + UpdateOptions updateOptions = UpdateOptions.builder() + .addToLoginIds(true) + .providerId("my-provider") + .templateId("my-template") + .locale("en") + .failOnConflict(true) + .build(); + String maskedEmail = mls.updateUserEmail(loginId, "new@descope.com", uri, refreshToken, updateOptions); + String maskedPhone = mls.updateUserPhone(DeliveryMethod.SMS, loginId, "+12125551234", uri, refreshToken, + updateOptions); +} catch (DescopeException de) { + // Handle the error +} + +``` + To verify a magic link, your redirect page must call the validation function on the token (`t`) parameter (`https://your-redirect-address.com/verify?t=`): ```java diff --git a/src/main/java/com/descope/model/auth/AssociatedTenant.java b/src/main/java/com/descope/model/auth/AssociatedTenant.java index 1798deae..772cbd1e 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,14 @@ public class AssociatedTenant { private String tenantId; private String tenantName; private List roleNames; + // Response only: user create and update requests don't accept them + @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) + private List permissions; + /** Not in the same order as roleNames; don't pair them by index. */ + @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..116bfbaf 100644 --- a/src/main/java/com/descope/model/auth/AuthenticationInfo.java +++ b/src/main/java/com/descope/model/auth/AuthenticationInfo.java @@ -2,19 +2,44 @@ import com.descope.model.jwt.Token; import com.descope.model.user.response.UserResponse; -import lombok.AllArgsConstructor; +import java.util.Map; import lombok.Data; @Data -@AllArgsConstructor public class AuthenticationInfo { private Token token; // session token private Token refreshToken; 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/UpdateOptions.java b/src/main/java/com/descope/model/auth/UpdateOptions.java index 31b5846b..1146a2d7 100644 --- a/src/main/java/com/descope/model/auth/UpdateOptions.java +++ b/src/main/java/com/descope/model/auth/UpdateOptions.java @@ -12,4 +12,13 @@ public class UpdateOptions { private boolean addToLoginIds; private boolean onMergeUseExisting; + // Sent by the magic link update methods only + private String providerId; + private String templateId; + private String locale; + private Boolean failOnConflict; + + public UpdateOptions(boolean addToLoginIds, boolean onMergeUseExisting) { + this(addToLoginIds, onMergeUseExisting, null, null, null, null); + } } \ No newline at end of file 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..25bc3dfb 100644 --- a/src/main/java/com/descope/model/jwt/response/JWTResponse.java +++ b/src/main/java/com/descope/model/jwt/response/JWTResponse.java @@ -2,13 +2,12 @@ import com.descope.model.auth.IDPResponse; import com.descope.model.user.response.UserResponse; -import lombok.AllArgsConstructor; +import java.util.Map; import lombok.Data; import lombok.NoArgsConstructor; @Data @NoArgsConstructor -@AllArgsConstructor public class JWTResponse { private String sessionJwt; private String refreshJwt; @@ -19,10 +18,37 @@ 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 = sessionJwt; + this.refreshJwt = refreshJwt; + this.cookieDomain = cookieDomain; + this.cookiePath = cookiePath; + this.cookieMaxAge = cookieMaxAge; + this.cookieExpiration = cookieExpiration; + this.user = user; + this.firstSeen = firstSeen; + this.idpResponse = idpResponse; + } } diff --git a/src/main/java/com/descope/model/magiclink/LoginOptions.java b/src/main/java/com/descope/model/magiclink/LoginOptions.java index de3b9ac2..ca740116 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 PKCE challenge; only enchanted links use it, other methods ignore it. */ + 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/magiclink/MagicLinkSignInOptions.java b/src/main/java/com/descope/model/magiclink/MagicLinkSignInOptions.java new file mode 100644 index 00000000..2d4c8868 --- /dev/null +++ b/src/main/java/com/descope/model/magiclink/MagicLinkSignInOptions.java @@ -0,0 +1,18 @@ +package com.descope.model.magiclink; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** Request options sent alongside {@link LoginOptions} by magic link sign-in and sign-up-or-in. */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class MagicLinkSignInOptions { + private String providerId; + private String templateId; + private String ssoAppId; + private Boolean useRecovery; +} diff --git a/src/main/java/com/descope/model/magiclink/MagicLinkSignUpOptions.java b/src/main/java/com/descope/model/magiclink/MagicLinkSignUpOptions.java new file mode 100644 index 00000000..17ef92f5 --- /dev/null +++ b/src/main/java/com/descope/model/magiclink/MagicLinkSignUpOptions.java @@ -0,0 +1,18 @@ +package com.descope.model.magiclink; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** Request options sent alongside {@link SignUpOptions} by magic link sign-up. */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class MagicLinkSignUpOptions { + /** The user's phone, for SMS and WhatsApp delivery only. */ + private String phone; + private String providerId; + private String templateId; +} diff --git a/src/main/java/com/descope/model/magiclink/SignUpOptions.java b/src/main/java/com/descope/model/magiclink/SignUpOptions.java index 1010d3b3..9e447ea7 100644 --- a/src/main/java/com/descope/model/magiclink/SignUpOptions.java +++ b/src/main/java/com/descope/model/magiclink/SignUpOptions.java @@ -13,4 +13,13 @@ public class SignUpOptions { private Map customClaims; private Map templateOptions; + private String locale; + /** Base64 PKCE challenge; only enchanted links use it, other methods ignore it. */ + private String pkceChallenge; + private String templateId; + private String tenantId; + + public SignUpOptions(Map customClaims, Map templateOptions) { + this(customClaims, templateOptions, null, null, null, null); + } } diff --git a/src/main/java/com/descope/model/magiclink/request/SignInRequest.java b/src/main/java/com/descope/model/magiclink/request/SignInRequest.java index 0d2caf8d..7a39b013 100644 --- a/src/main/java/com/descope/model/magiclink/request/SignInRequest.java +++ b/src/main/java/com/descope/model/magiclink/request/SignInRequest.java @@ -18,4 +18,12 @@ public class SignInRequest { private String loginId; private LoginOptions loginOptions; + private String providerId; + private String templateId; + private String ssoAppId; + private Boolean useRecovery; + + public SignInRequest(String uri, String loginId, LoginOptions loginOptions) { + this(uri, loginId, loginOptions, null, null, null, null); + } } diff --git a/src/main/java/com/descope/model/magiclink/request/SignUpRequest.java b/src/main/java/com/descope/model/magiclink/request/SignUpRequest.java index 7f72a6d1..f07bf2f4 100644 --- a/src/main/java/com/descope/model/magiclink/request/SignUpRequest.java +++ b/src/main/java/com/descope/model/magiclink/request/SignUpRequest.java @@ -21,9 +21,16 @@ public class SignUpRequest { private String uri; private SignUpOptions loginOptions; private String phone; + private String providerId; + private String templateId; public SignUpRequest(String email, String loginId, User user, String uri, SignUpOptions loginOptions) { this(email, loginId, user, uri, loginOptions, null); } + + public SignUpRequest(String email, String loginId, User user, String uri, + SignUpOptions loginOptions, String phone) { + this(email, loginId, user, uri, loginOptions, phone, null, null); + } } diff --git a/src/main/java/com/descope/model/magiclink/request/UpdateEmailRequest.java b/src/main/java/com/descope/model/magiclink/request/UpdateEmailRequest.java index 2f85217c..3140afe9 100644 --- a/src/main/java/com/descope/model/magiclink/request/UpdateEmailRequest.java +++ b/src/main/java/com/descope/model/magiclink/request/UpdateEmailRequest.java @@ -21,4 +21,13 @@ public class UpdateEmailRequest { private boolean addToLoginIds; private boolean onMergeUseExisting; private Map templateOptions; + private String providerId; + private String templateId; + private String locale; + private Boolean failOnConflict; + + public UpdateEmailRequest(String email, String loginId, String uri, boolean crossDevice, boolean addToLoginIds, + boolean onMergeUseExisting, Map templateOptions) { + this(email, loginId, uri, crossDevice, addToLoginIds, onMergeUseExisting, templateOptions, null, null, null, null); + } } diff --git a/src/main/java/com/descope/model/magiclink/request/UpdatePhoneRequest.java b/src/main/java/com/descope/model/magiclink/request/UpdatePhoneRequest.java index 1e838b1f..bc317339 100644 --- a/src/main/java/com/descope/model/magiclink/request/UpdatePhoneRequest.java +++ b/src/main/java/com/descope/model/magiclink/request/UpdatePhoneRequest.java @@ -21,4 +21,13 @@ public class UpdatePhoneRequest { private boolean addToLoginIds; private boolean onMergeUseExisting; private Map templateOptions; + private String providerId; + private String templateId; + private String locale; + private Boolean failOnConflict; + + public UpdatePhoneRequest(String phone, String loginId, String uri, boolean crossDevice, boolean addToLoginIds, + boolean onMergeUseExisting, Map templateOptions) { + this(phone, loginId, uri, crossDevice, addToLoginIds, onMergeUseExisting, templateOptions, null, null, null, null); + } } diff --git a/src/main/java/com/descope/model/user/User.java b/src/main/java/com/descope/model/user/User.java index 05cae442..3fd6e39e 100644 --- a/src/main/java/com/descope/model/user/User.java +++ b/src/main/java/com/descope/model/user/User.java @@ -16,8 +16,15 @@ public class User { private String givenName; private String middleName; private String familyName; + private String loginId; + private String recoveryEmail; + private String recoveryPhone; public User(String name, String email, String phone) { this(name, email, phone, null, null, null); } + + public User(String name, String email, String phone, String givenName, String middleName, String familyName) { + this(name, email, phone, givenName, middleName, familyName, null, null, null); + } } 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..c8b78574 100644 --- a/src/main/java/com/descope/model/user/response/UserResponse.java +++ b/src/main/java/com/descope/model/user/response/UserResponse.java @@ -1,15 +1,14 @@ package com.descope.model.user.response; import com.descope.model.auth.AssociatedTenant; +import com.fasterxml.jackson.annotation.JsonProperty; import java.util.List; import java.util.Map; -import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @Data @NoArgsConstructor -@AllArgsConstructor @SuppressWarnings("checkstyle:MemberName") public class UserResponse { String userId; @@ -29,8 +28,11 @@ public class UserResponse { Boolean test; Long createdTime; Map customAttributes; + @JsonProperty("TOTP") Boolean TOTP; + @JsonProperty("SAML") Boolean SAML; + @JsonProperty("OAuth") Map oAuth; List ssoAppIds; /** Auth method that triggered brute-force protection, empty when none. */ @@ -40,4 +42,68 @@ public class UserResponse { * this is greater than now. */ Long tempLockExpiration; + List externalIds; + Boolean webauthn; + Boolean password; + Boolean editable; + @JsonProperty("SCIM") + Boolean SCIM; + Boolean push; + List permissions; + @JsonProperty("OIDC") + Boolean OIDC; + Long consentExpiration; + String recoveryEmail; + Boolean verifiedRecoveryEmail; + String recoveryPhone; + Boolean verifiedRecoveryPhone; + Long modifiedTime; + /** Not in the same order as roleNames; don't pair them by index. */ + List roleIds; + /** Whether the user has set up recovery codes. */ + Boolean recoveryCodes; + Boolean dependent; + List userFamilies; + /** Tenant whose SCIM connection provisioned the user, empty when none or ambiguous. */ + String scimTenantId; + /** Tenant whose SAML SSO created the user or merged its login, empty when none or ambiguous. */ + String samlTenantId; + /** Tenant whose OIDC SSO created the user or merged its login, empty when none or ambiguous. */ + String oidcTenantId; + String consentTenantId; + /** + * Last sign-in, in unix seconds (0 when never). On a sign-in response this is the sign-in before the + * current one. + */ + 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 = userId; + this.loginIds = loginIds; + this.email = email; + this.verifiedEmail = verifiedEmail; + this.phone = phone; + this.verifiedPhone = verifiedPhone; + this.name = name; + this.givenName = givenName; + this.middleName = middleName; + this.familyName = familyName; + this.roleNames = roleNames; + this.userTenants = userTenants; + this.status = status; + this.picture = picture; + this.test = test; + this.createdTime = createdTime; + this.customAttributes = customAttributes; + this.TOTP = totp; + this.SAML = saml; + this.oAuth = oauth; + this.ssoAppIds = ssoAppIds; + this.lockReason = lockReason; + this.tempLockExpiration = tempLockExpiration; + } } diff --git a/src/main/java/com/descope/sdk/auth/MagicLinkService.java b/src/main/java/com/descope/sdk/auth/MagicLinkService.java index 405e81c4..5f7c84b3 100644 --- a/src/main/java/com/descope/sdk/auth/MagicLinkService.java +++ b/src/main/java/com/descope/sdk/auth/MagicLinkService.java @@ -5,6 +5,8 @@ import com.descope.model.auth.AuthenticationInfo; import com.descope.model.auth.UpdateOptions; import com.descope.model.magiclink.LoginOptions; +import com.descope.model.magiclink.MagicLinkSignInOptions; +import com.descope.model.magiclink.MagicLinkSignUpOptions; import com.descope.model.magiclink.SignUpOptions; import com.descope.model.user.User; import java.util.Map; @@ -33,6 +35,30 @@ String signIn( LoginOptions loginOptions) throws DescopeException; + /** + * SignIn - Use to login a user based on a magic link that will be sent either email, sms or + * whatsapp and choose the selected delivery method for verification (see auth/DeliveryMethod). + * returns the masked address where the link was sent (email, sms or whatsapp) or an error upon + * failure. + * + * @param deliveryMethod - {@link DeliveryMethod DeliveryMethod} + * @param loginId - User login ID + * @param uri - Base URI + * @param token - when doing step-up or mfa then we need current session token + * @param loginOptions - {@link LoginOptions LoginOptions} + * @param signInOptions - optional provider, template, SSO app and recovery options + * @return masked address where the link was sent (email, whatsapp or phone) + * @throws DescopeException - error upon failure + */ + String signIn( + DeliveryMethod deliveryMethod, + String loginId, + String uri, + String token, + LoginOptions loginOptions, + MagicLinkSignInOptions signInOptions) + throws DescopeException; + /** * Use to create a new user based on the given loginID either email, sms or whatsapp. Choose the * selected delivery method for verification. @@ -62,6 +88,22 @@ String signUp(DeliveryMethod deliveryMethod, String loginId, String uri, User us String signUp(DeliveryMethod deliveryMethod, String loginId, String uri, User user, SignUpOptions signupOptions) throws DescopeException; + /** + * Use to create a new user based on the given loginID either email, sms or whatsapp. Choose the + * selected delivery method for verification. + * + * @param deliveryMethod - {@link com.descope.enums.DeliveryMethod DeliveryMethod} + * @param loginId - User login ID + * @param uri - Base URI + * @param user - {@link User User} + * @param signupOptions - optional claims, template, locale and tenant options + * @param signUpRequestOptions - optional phone (SMS and WhatsApp only), provider and template + * @return masked address where the link was sent (email, whatsapp or phone) + * @throws DescopeException - error upon failure + */ + String signUp(DeliveryMethod deliveryMethod, String loginId, String uri, User user, SignUpOptions signupOptions, + MagicLinkSignUpOptions signUpRequestOptions) throws DescopeException; + /** * Verify - Use to verify a SignIn/SignUp request, based on the magic link token generated. if the * link was generated with crossDevice, the authentication info will be nil, and should returned @@ -86,6 +128,21 @@ String signUp(DeliveryMethod deliveryMethod, String loginId, String uri, User us String signUpOrIn(DeliveryMethod deliveryMethod, String loginId, String uri) throws DescopeException; + /** + * Use to login in using loginID, if user does not exist, a new user will be created with the + * given loginID. Choose the selected delivery method for verification + * + * @param deliveryMethod - {@link com.descope.enums.DeliveryMethod DeliveryMethod} + * @param loginId - User login ID + * @param uri - Base URI + * @param loginOptions - {@link LoginOptions LoginOptions}, without step-up or mfa + * @param signInOptions - optional provider, template, SSO app and recovery options + * @return masked address where the link was sent (email, whatsapp or phone) + * @throws DescopeException - error upon failure + */ + String signUpOrIn(DeliveryMethod deliveryMethod, String loginId, String uri, LoginOptions loginOptions, + MagicLinkSignInOptions signInOptions) throws DescopeException; + /** * Use to update email and validate via magiclink. * 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..439e422e 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 authenticationInfo = new AuthenticationInfo( sessionToken, refreshToken, jwtResponse.getUser(), jwtResponse.getFirstSeen(), jwtResponse.getIdpResponse()); + authenticationInfo.setCookieDomain(jwtResponse.getCookieDomain()); + authenticationInfo.setCookiePath(jwtResponse.getCookiePath()); + authenticationInfo.setCookieMaxAge(jwtResponse.getCookieMaxAge()); + authenticationInfo.setCookieExpiration(jwtResponse.getCookieExpiration()); + authenticationInfo.setSessionExpiration(jwtResponse.getSessionExpiration()); + authenticationInfo.setExternalToken(jwtResponse.getExternalToken()); + authenticationInfo.setClaims(jwtResponse.getClaims()); + authenticationInfo.setTenantSSOID(jwtResponse.getTenantSSOID()); + authenticationInfo.setTrustedDeviceJwt(jwtResponse.getTrustedDeviceJwt()); + authenticationInfo.setNextRefreshSeconds(jwtResponse.getNextRefreshSeconds()); + authenticationInfo.setCookieName(jwtResponse.getCookieName()); + authenticationInfo.setSessionCookieName(jwtResponse.getSessionCookieName()); + authenticationInfo.setSessionCookieDomain(jwtResponse.getSessionCookieDomain()); + authenticationInfo.setUnsavedSSO(jwtResponse.getUnsavedSSO()); + authenticationInfo.setKnownDeviceJwt(jwtResponse.getKnownDeviceJwt()); + authenticationInfo.setSsoAuthenticationOnly(jwtResponse.getSsoAuthenticationOnly()); + authenticationInfo.setUserCreationDeferred(jwtResponse.getUserCreationDeferred()); + return authenticationInfo; } @SuppressWarnings("unchecked") diff --git a/src/main/java/com/descope/sdk/auth/impl/MagicLinkServiceImpl.java b/src/main/java/com/descope/sdk/auth/impl/MagicLinkServiceImpl.java index a1464c9b..08539167 100644 --- a/src/main/java/com/descope/sdk/auth/impl/MagicLinkServiceImpl.java +++ b/src/main/java/com/descope/sdk/auth/impl/MagicLinkServiceImpl.java @@ -19,6 +19,8 @@ import com.descope.model.client.Client; import com.descope.model.jwt.response.JWTResponse; import com.descope.model.magiclink.LoginOptions; +import com.descope.model.magiclink.MagicLinkSignInOptions; +import com.descope.model.magiclink.MagicLinkSignUpOptions; import com.descope.model.magiclink.SignUpOptions; import com.descope.model.magiclink.request.SignInRequest; import com.descope.model.magiclink.request.SignUpRequest; @@ -48,6 +50,18 @@ public String signIn( String token, LoginOptions loginOptions) throws DescopeException { + return signIn(deliveryMethod, loginId, uri, token, loginOptions, null); + } + + @Override + public String signIn( + DeliveryMethod deliveryMethod, + String loginId, + String uri, + String token, + LoginOptions loginOptions, + MagicLinkSignInOptions signInOptions) + throws DescopeException { if (StringUtils.isBlank(loginId)) { throw ServerCommonException.invalidArgument("Login ID"); } @@ -55,7 +69,7 @@ public String signIn( ApiProxy apiProxy; Class maskedClass = getMaskedValue(deliveryMethod); URI magicLinkSignInURL = composeMagicLinkSignInURI(deliveryMethod); - SignInRequest signInRequest = new SignInRequest(uri, loginId, loginOptions); + SignInRequest signInRequest = composeSignInRequest(uri, loginId, loginOptions, signInOptions); if (JwtUtils.isJWTRequired(loginOptions)) { if (StringUtils.isBlank(token)) { throw ServerCommonException.invalidArgument("token"); @@ -76,13 +90,22 @@ public String signUp(DeliveryMethod deliveryMethod, String loginId, String uri, @Override public String signUp(DeliveryMethod deliveryMethod, String loginId, String uri, User user, SignUpOptions signupOptions) throws DescopeException { + return signUp(deliveryMethod, loginId, uri, user, signupOptions, null); + } + + @Override + public String signUp(DeliveryMethod deliveryMethod, String loginId, String uri, User user, + SignUpOptions signupOptions, MagicLinkSignUpOptions signUpRequestOptions) throws DescopeException { if (user == null) { user = new User(); } verifyDeliveryMethod(deliveryMethod, loginId, user); - Class maskedClass = getMaskedValue(deliveryMethod); - URI magicLinkSignUpURL = composeMagicLinkSignUpURI(deliveryMethod); + // The email sign-up request has no top-level phone + if (EMAIL.equals(deliveryMethod) && signUpRequestOptions != null + && StringUtils.isNotBlank(signUpRequestOptions.getPhone())) { + throw ServerCommonException.invalidArgument("Phone"); + } SignUpRequest.SignUpRequestBuilder signUpRequestBuilder = SignUpRequest.builder().loginId(loginId).uri(uri); if (EMAIL.equals(deliveryMethod)) { @@ -91,7 +114,14 @@ public String signUp(DeliveryMethod deliveryMethod, String loginId, String uri, if (signupOptions != null) { signUpRequestBuilder.loginOptions(signupOptions); } + if (signUpRequestOptions != null) { + signUpRequestBuilder.phone(signUpRequestOptions.getPhone()) + .providerId(signUpRequestOptions.getProviderId()) + .templateId(signUpRequestOptions.getTemplateId()); + } SignUpRequest signUpRequest = signUpRequestBuilder.user(user).build(); + Class maskedClass = getMaskedValue(deliveryMethod); + URI magicLinkSignUpURL = composeMagicLinkSignUpURI(deliveryMethod); ApiProxy apiProxy = getApiProxy(); Masked masked = apiProxy.post(magicLinkSignUpURL, signUpRequest, maskedClass); return masked.getMasked(); @@ -110,6 +140,12 @@ public AuthenticationInfo verify(String token) { @Override public String signUpOrIn(DeliveryMethod deliveryMethod, String loginId, String uri) throws DescopeException { + return signUpOrIn(deliveryMethod, loginId, uri, null, null); + } + + @Override + public String signUpOrIn(DeliveryMethod deliveryMethod, String loginId, String uri, LoginOptions loginOptions, + MagicLinkSignInOptions signInOptions) throws DescopeException { if (StringUtils.isBlank(loginId)) { throw ServerCommonException.invalidArgument("Login ID"); @@ -117,7 +153,11 @@ public String signUpOrIn(DeliveryMethod deliveryMethod, String loginId, String u Class maskedClass = getMaskedValue(deliveryMethod); URI magicLinkSignUpOrInURL = composeMagicLinkSignUpOrInURI(deliveryMethod); - SignInRequest signInRequest = new SignInRequest(uri, loginId, null); + // Sign-up-or-in takes no session token + if (JwtUtils.isJWTRequired(loginOptions)) { + throw ServerCommonException.invalidArgument("loginOptions.stepup/mfa"); + } + SignInRequest signInRequest = composeSignInRequest(uri, loginId, loginOptions, signInOptions); ApiProxy apiProxy = getApiProxy(); Masked masked = apiProxy.post(magicLinkSignUpOrInURL, signInRequest, maskedClass); @@ -156,6 +196,10 @@ public String updateUserEmail(String loginId, String email, String uri, String r .addToLoginIds(updateOptions.isAddToLoginIds()) .onMergeUseExisting(updateOptions.isOnMergeUseExisting()) .templateOptions(templateOptions) + .providerId(updateOptions.getProviderId()) + .templateId(updateOptions.getTemplateId()) + .locale(updateOptions.getLocale()) + .failOnConflict(updateOptions.getFailOnConflict()) .build(); ApiProxy apiProxy = getApiProxy(refreshToken); @@ -201,6 +245,10 @@ public String updateUserPhone( .addToLoginIds(updateOptions.isAddToLoginIds()) .onMergeUseExisting(updateOptions.isOnMergeUseExisting()) .templateOptions(templateOptions) + .providerId(updateOptions.getProviderId()) + .templateId(updateOptions.getTemplateId()) + .locale(updateOptions.getLocale()) + .failOnConflict(updateOptions.getFailOnConflict()) .build(); ApiProxy apiProxy = getApiProxy(refreshToken); @@ -208,6 +256,18 @@ public String updateUserPhone( return masked.getMasked(); } + private static SignInRequest composeSignInRequest(String uri, String loginId, LoginOptions loginOptions, + MagicLinkSignInOptions signInOptions) { + SignInRequest signInRequest = new SignInRequest(uri, loginId, loginOptions); + if (signInOptions != null) { + signInRequest.setProviderId(signInOptions.getProviderId()); + signInRequest.setTemplateId(signInOptions.getTemplateId()); + signInRequest.setSsoAppId(signInOptions.getSsoAppId()); + signInRequest.setUseRecovery(signInOptions.getUseRecovery()); + } + return signInRequest; + } + private URI composeMagicLinkSignInURI(DeliveryMethod deliveryMethod) { return composeURI(SIGN_IN_MAGIC_LINK, deliveryMethod.getValue()); } diff --git a/src/test/java/com/descope/sdk/auth/impl/MagicLinkServiceImplTest.java b/src/test/java/com/descope/sdk/auth/impl/MagicLinkServiceImplTest.java index e28739ce..2fb487c1 100644 --- a/src/test/java/com/descope/sdk/auth/impl/MagicLinkServiceImplTest.java +++ b/src/test/java/com/descope/sdk/auth/impl/MagicLinkServiceImplTest.java @@ -5,6 +5,7 @@ import static com.descope.sdk.TestUtils.MOCK_JWT_RESPONSE; import static com.descope.sdk.TestUtils.MOCK_MASKED_EMAIL; import static com.descope.sdk.TestUtils.MOCK_MASKED_PHONE; +import static com.descope.sdk.TestUtils.MOCK_NAME; import static com.descope.sdk.TestUtils.MOCK_PHONE; import static com.descope.sdk.TestUtils.MOCK_REFRESH_TOKEN; import static com.descope.sdk.TestUtils.MOCK_SIGNING_KEY; @@ -22,19 +23,31 @@ import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mockStatic; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; import com.descope.enums.DeliveryMethod; import com.descope.exception.RateLimitExceededException; 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.UpdateOptions; import com.descope.model.client.Client; +import com.descope.model.client.SdkInfo; import com.descope.model.jwt.Token; +import com.descope.model.jwt.response.JWTResponse; import com.descope.model.jwt.response.SigningKeysResponse; +import com.descope.model.magiclink.LoginOptions; +import com.descope.model.magiclink.MagicLinkSignInOptions; +import com.descope.model.magiclink.MagicLinkSignUpOptions; +import com.descope.model.magiclink.SignUpOptions; import com.descope.model.magiclink.response.MaskedEmailRes; import com.descope.model.magiclink.response.MaskedPhoneRes; import com.descope.model.user.User; import com.descope.model.user.request.UserRequest; import com.descope.model.user.response.MagicLinkTestUserResponse; +import com.descope.model.user.response.UserFamily; import com.descope.model.user.response.UserResponse; import com.descope.proxy.ApiProxy; import com.descope.proxy.impl.ApiProxyBuilder; @@ -44,13 +57,20 @@ import com.descope.sdk.mgmt.impl.ManagementServiceBuilder; import com.descope.utils.JwtUtils; import com.descope.utils.UriUtils; +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.util.Arrays; import java.util.List; import java.util.Map; +import java.util.function.Function; +import java.util.function.Supplier; import lombok.SneakyThrows; 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; class MagicLinkServiceImplTest { @@ -284,6 +304,310 @@ void testUpdateUserPhoneForSuccess() { } } + @Test + void testSignInWithAllOptions() { + LoginOptions loginOptions = LoginOptions.builder().stepup(true).templateId("tmpl").locale("en") + .ssoAppId("loginApp").pkceChallenge("Y2hhbGxlbmdl").tenantId("T1").build(); + MagicLinkSignInOptions signInOptions = MagicLinkSignInOptions.builder().providerId("prov") + .templateId("topTmpl").ssoAppId("app").useRecovery(true).build(); + SentRequest sent = send(new MaskedPhoneRes(MOCK_MASKED_PHONE), s -> s.signIn( + DeliveryMethod.WHATSAPP, MOCK_PHONE, MOCK_DOMAIN, MOCK_REFRESH_TOKEN, loginOptions, signInOptions)); + + assertThat(sent.result).isEqualTo(MOCK_MASKED_PHONE); + assertThat(sent.path).isEqualTo("/v1/auth/magiclink/signin/whatsapp"); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID + ":" + MOCK_REFRESH_TOKEN); + assertThat(sent.body).containsEntry("loginId", MOCK_PHONE).containsEntry("URI", MOCK_DOMAIN) + .containsEntry("providerId", "prov").containsEntry("templateId", "topTmpl") + .containsEntry("ssoAppId", "app").containsEntry("useRecovery", true); + assertThat(asMap(sent.body.get("loginOptions"))).containsEntry("stepup", true) + .containsEntry("templateId", "tmpl").containsEntry("locale", "en").containsEntry("ssoAppId", "loginApp") + .containsEntry("pkceChallenge", "Y2hhbGxlbmdl").containsEntry("tenantId", "T1"); + } + + @Test + void testSignInWithoutOptionsSendsSameBody() { + SentRequest sent = send(new MaskedEmailRes(MOCK_MASKED_EMAIL), + s -> s.signIn(DeliveryMethod.EMAIL, MOCK_EMAIL, MOCK_DOMAIN, null, null)); + + assertThat(sent.path).isEqualTo("/v1/auth/magiclink/signin/email"); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.body).containsOnlyKeys("loginId", "URI"); + } + + @Test + void testSignUpOrInWithAllOptions() { + LoginOptions loginOptions = LoginOptions.builder().templateId("tmpl").tenantId("T1").ssoAppId("loginApp") + .pkceChallenge("Y2hhbGxlbmdl").build(); + MagicLinkSignInOptions signInOptions = MagicLinkSignInOptions.builder().providerId("prov") + .templateId("topTmpl").ssoAppId("app").useRecovery(false).build(); + SentRequest sent = send(new MaskedPhoneRes(MOCK_MASKED_PHONE), s -> s.signUpOrIn( + DeliveryMethod.SMS, MOCK_PHONE, MOCK_DOMAIN, loginOptions, signInOptions)); + + assertThat(sent.result).isEqualTo(MOCK_MASKED_PHONE); + assertThat(sent.path).isEqualTo("/v1/auth/magiclink/signup-in/sms"); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.body).containsEntry("loginId", MOCK_PHONE).containsEntry("providerId", "prov") + .containsEntry("templateId", "topTmpl").containsEntry("ssoAppId", "app") + .containsEntry("useRecovery", false); + assertThat(asMap(sent.body.get("loginOptions"))).containsEntry("templateId", "tmpl") + .containsEntry("tenantId", "T1").containsEntry("ssoAppId", "loginApp") + .containsEntry("pkceChallenge", "Y2hhbGxlbmdl"); + } + + @Test + void testSignUpOrInWithStepUp() { + LoginOptions loginOptions = LoginOptions.builder().stepup(true).build(); + ServerCommonException thrown = assertThrows(ServerCommonException.class, () -> magicLinkService.signUpOrIn( + DeliveryMethod.EMAIL, MOCK_EMAIL, MOCK_DOMAIN, loginOptions, null)); + assertEquals("The loginOptions.stepup/mfa argument is invalid", thrown.getMessage()); + } + + @Test + void testSignUpOrInWithoutOptionsSendsSameBody() { + SentRequest sent = send(new MaskedEmailRes(MOCK_MASKED_EMAIL), + s -> s.signUpOrIn(DeliveryMethod.EMAIL, MOCK_EMAIL, MOCK_DOMAIN)); + + assertThat(sent.path).isEqualTo("/v1/auth/magiclink/signup-in/email"); + assertThat(sent.body).containsOnlyKeys("loginId", "URI"); + } + + @Test + void testSignUpWithAllOptions() { + User user = User.builder().name(MOCK_NAME).phone(MOCK_PHONE).loginId(MOCK_PHONE) + .recoveryEmail(MOCK_EMAIL).recoveryPhone("+15555555556").build(); + SignUpOptions signUpOptions = SignUpOptions.builder().locale("en").pkceChallenge("Y2hhbGxlbmdl") + .templateId("tmpl").tenantId("T1").build(); + MagicLinkSignUpOptions requestOptions = MagicLinkSignUpOptions.builder().phone(MOCK_PHONE) + .providerId("prov").templateId("topTmpl").build(); + SentRequest sent = send(new MaskedPhoneRes(MOCK_MASKED_PHONE), s -> s.signUp( + DeliveryMethod.SMS, MOCK_PHONE, MOCK_DOMAIN, user, signUpOptions, requestOptions)); + + assertThat(sent.result).isEqualTo(MOCK_MASKED_PHONE); + assertThat(sent.path).isEqualTo("/v1/auth/magiclink/signup/sms"); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.body).containsEntry("loginId", MOCK_PHONE).containsEntry("phone", MOCK_PHONE) + .containsEntry("providerId", "prov").containsEntry("templateId", "topTmpl"); + assertThat(asMap(sent.body.get("user"))).containsEntry("loginId", MOCK_PHONE) + .containsEntry("recoveryEmail", MOCK_EMAIL).containsEntry("recoveryPhone", "+15555555556"); + assertThat(asMap(sent.body.get("loginOptions"))).containsEntry("locale", "en") + .containsEntry("pkceChallenge", "Y2hhbGxlbmdl").containsEntry("templateId", "tmpl") + .containsEntry("tenantId", "T1"); + } + + @Test + void testSignUpWithoutOptionsSendsSameBody() { + User user = new User(MOCK_NAME, MOCK_EMAIL, MOCK_PHONE); + SentRequest sent = send(new MaskedEmailRes(MOCK_MASKED_EMAIL), + s -> s.signUp(DeliveryMethod.EMAIL, MOCK_EMAIL, MOCK_DOMAIN, user)); + + assertThat(sent.path).isEqualTo("/v1/auth/magiclink/signup/email"); + assertThat(sent.body).containsOnlyKeys("email", "loginId", "user", "URI"); + assertThat(asMap(sent.body.get("user"))).containsOnlyKeys("name", "email", "phone"); + } + + @Test + void testSignUpEmailWithPhone() { + MagicLinkSignUpOptions requestOptions = MagicLinkSignUpOptions.builder().phone(MOCK_PHONE).build(); + ServerCommonException thrown = assertThrows(ServerCommonException.class, () -> magicLinkService.signUp( + DeliveryMethod.EMAIL, MOCK_EMAIL, MOCK_DOMAIN, null, null, requestOptions)); + assertEquals("The Phone argument is invalid", thrown.getMessage()); + } + + @Test + void testUpdateUserEmailWithAllOptions() { + UpdateOptions updateOptions = UpdateOptions.builder().addToLoginIds(true).providerId("prov") + .templateId("tmpl").locale("en").failOnConflict(true).build(); + SentRequest sent = send(new MaskedEmailRes(MOCK_MASKED_EMAIL), s -> s.updateUserEmail( + MOCK_EMAIL, UPDATE_MOCK_EMAIL, MOCK_DOMAIN, MOCK_REFRESH_TOKEN, updateOptions)); + + assertThat(sent.result).isEqualTo(MOCK_MASKED_EMAIL); + assertThat(sent.path).isEqualTo("/v1/auth/magiclink/update/email"); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID + ":" + MOCK_REFRESH_TOKEN); + assertThat(sent.body).containsEntry("email", UPDATE_MOCK_EMAIL).containsEntry("addToLoginIDs", true) + .containsEntry("providerId", "prov").containsEntry("templateId", "tmpl").containsEntry("locale", "en") + .containsEntry("failOnConflict", true); + } + + @Test + void testUpdateUserEmailWithoutOptionsSendsSameBody() { + SentRequest sent = send(new MaskedEmailRes(MOCK_MASKED_EMAIL), s -> s.updateUserEmail( + MOCK_EMAIL, UPDATE_MOCK_EMAIL, MOCK_DOMAIN, MOCK_REFRESH_TOKEN, null)); + + assertThat(sent.body).containsOnlyKeys( + "email", "loginId", "URI", "crossDevice", "addToLoginIDs", "onMergeUseExisting"); + } + + @Test + void testUpdateUserPhoneWithAllOptions() { + UpdateOptions updateOptions = UpdateOptions.builder().providerId("prov").templateId("tmpl").locale("en") + .failOnConflict(false).build(); + SentRequest sent = send(new MaskedPhoneRes(MOCK_MASKED_PHONE), s -> s.updateUserPhone( + DeliveryMethod.WHATSAPP, MOCK_EMAIL, MOCK_PHONE, MOCK_DOMAIN, MOCK_REFRESH_TOKEN, updateOptions)); + + assertThat(sent.result).isEqualTo(MOCK_MASKED_PHONE); + assertThat(sent.path).isEqualTo("/v1/auth/magiclink/update/phone/whatsapp"); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID + ":" + MOCK_REFRESH_TOKEN); + assertThat(sent.body).containsEntry("phone", MOCK_PHONE).containsEntry("providerId", "prov") + .containsEntry("templateId", "tmpl").containsEntry("locale", "en").containsEntry("failOnConflict", false); + } + + @SneakyThrows + @Test + void testVerifyFullResponse() { + String json = "{\"sessionJwt\":\"s\",\"refreshJwt\":\"r\",\"cookieDomain\":\"d\",\"cookiePath\":\"/\"," + + "\"cookieMaxAge\":10,\"cookieExpiration\":11,\"firstSeen\":true,\"sessionExpiration\":12," + + "\"externalToken\":\"ext\",\"claims\":{\"c\":\"v\"},\"tenantSSOID\":\"sso\",\"trustedDeviceJwt\":\"td\"," + + "\"nextRefreshSeconds\":13,\"cookieName\":\"cn\",\"sessionCookieName\":\"scn\"," + + "\"sessionCookieDomain\":\"scd\",\"unsavedSSO\":true,\"knownDeviceJwt\":\"kd\"," + + "\"ssoAuthenticationOnly\":true,\"userCreationDeferred\":true," + + "\"idpResponse\":{\"samlResponse\":\"sr\",\"samlGeneratedUser\":\"sgu\",\"samlGeneratedRoles\":\"sgr\"," + + "\"oidcResponse\":\"or\",\"oidcGeneratedUser\":\"ogu\",\"oidcGeneratedRoles\":\"ogr\"}," + + "\"user\":{\"userId\":\"u1\",\"userTenants\":[{\"tenantId\":\"T1\",\"permissions\":[\"p\"]," + + "\"roleIds\":[\"r\"]}],\"externalIds\":[\"e\"],\"TOTP\":true,\"SAML\":true,\"OAuth\":{\"google\":true}," + + "\"webauthn\":true,\"password\":true,\"editable\":true,\"SCIM\":true,\"push\":true," + + "\"permissions\":[\"up\"],\"OIDC\":true,\"consentExpiration\":14,\"recoveryEmail\":\"re\"," + + "\"verifiedRecoveryEmail\":true,\"recoveryPhone\":\"rp\",\"verifiedRecoveryPhone\":true," + + "\"modifiedTime\":15,\"roleIds\":[\"ur\"],\"recoveryCodes\":true,\"dependent\":true," + + "\"userFamilies\":[{\"familyId\":\"f\",\"roleNames\":[\"fr\"],\"permissions\":[\"fp\"]," + + "\"familyScopedAttributes\":{\"a\":\"b\"}}],\"scimTenantId\":\"st\",\"samlTenantId\":\"sat\"," + + "\"oidcTenantId\":\"ot\",\"consentTenantId\":\"ct\",\"lastLoginTime\":16,\"unknown\":1}}"; + 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()); + + AuthenticationInfo info; + try (MockedStatic mockedApiProxyBuilder = mockStatic(ApiProxyBuilder.class)) { + mockedApiProxyBuilder.when(() -> ApiProxyBuilder.buildProxy(any(), any())).thenReturn(apiProxy); + try (MockedStatic mockedJwtUtils = mockStatic(JwtUtils.class)) { + mockedJwtUtils.when(() -> JwtUtils.getToken(anyString(), any())).thenReturn(MOCK_TOKEN); + info = magicLinkService.verify("SomeToken"); + } + } + + assertThat(info.getCookieDomain()).isEqualTo("d"); + assertThat(info.getCookiePath()).isEqualTo("/"); + assertThat(info.getCookieMaxAge()).isEqualTo(10); + assertThat(info.getCookieExpiration()).isEqualTo(11); + assertThat(info.getSessionExpiration()).isEqualTo(12); + assertThat(info.getExternalToken()).isEqualTo("ext"); + assertThat(info.getClaims()).containsEntry("c", "v"); + assertThat(info.getTenantSSOID()).isEqualTo("sso"); + assertThat(info.getTrustedDeviceJwt()).isEqualTo("td"); + assertThat(info.getNextRefreshSeconds()).isEqualTo(13); + assertThat(info.getCookieName()).isEqualTo("cn"); + assertThat(info.getSessionCookieName()).isEqualTo("scn"); + assertThat(info.getSessionCookieDomain()).isEqualTo("scd"); + assertThat(info.getUnsavedSSO()).isTrue(); + assertThat(info.getKnownDeviceJwt()).isEqualTo("kd"); + assertThat(info.getSsoAuthenticationOnly()).isTrue(); + assertThat(info.getUserCreationDeferred()).isTrue(); + assertThat(info.getFirstSeen()).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(); + assertThat(user.getUserTenants().get(0).getPermissions()).containsExactly("p"); + assertThat(user.getUserTenants().get(0).getRoleIds()).containsExactly("r"); + assertThat(user.getExternalIds()).containsExactly("e"); + 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("up"); + assertThat(user.getOIDC()).isTrue(); + assertThat(user.getConsentExpiration()).isEqualTo(14L); + assertThat(user.getRecoveryEmail()).isEqualTo("re"); + assertThat(user.getVerifiedRecoveryEmail()).isTrue(); + assertThat(user.getRecoveryPhone()).isEqualTo("rp"); + assertThat(user.getVerifiedRecoveryPhone()).isTrue(); + assertThat(user.getModifiedTime()).isEqualTo(15L); + assertThat(user.getRoleIds()).containsExactly("ur"); + assertThat(user.getRecoveryCodes()).isTrue(); + assertThat(user.getDependent()).isTrue(); + UserFamily family = user.getUserFamilies().get(0); + assertThat(family.getFamilyId()).isEqualTo("f"); + assertThat(family.getRoleNames()).containsExactly("fr"); + assertThat(family.getPermissions()).containsExactly("fp"); + assertThat(family.getFamilyScopedAttributes()).containsEntry("a", "b"); + assertThat(user.getScimTenantId()).isEqualTo("st"); + assertThat(user.getSamlTenantId()).isEqualTo("sat"); + assertThat(user.getOidcTenantId()).isEqualTo("ot"); + assertThat(user.getConsentTenantId()).isEqualTo("ct"); + assertThat(user.getLastLoginTime()).isEqualTo(16L); + } + + @SneakyThrows + @Test + void testVerifyNullObjects() { + JWTResponse jwtResponse = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) + .readValue("{\"sessionJwt\":\"s\",\"user\":null,\"idpResponse\":null,\"claims\":null}", JWTResponse.class); + assertThat(jwtResponse.getUser()).isNull(); + assertThat(jwtResponse.getIdpResponse()).isNull(); + assertThat(jwtResponse.getClaims()).isNull(); + } + + @SneakyThrows + @Test + void testAssociatedTenantResponseFieldsNotSent() { + AssociatedTenant tenant = AssociatedTenant.builder().tenantId("T1").permissions(Arrays.asList("p")) + .roleIds(Arrays.asList("r")).build(); + Map sent = asMap(tenant); + assertThat(sent).containsOnlyKeys("tenantId"); + } + + private static final Client CLIENT = Client.builder() + .uri("https://api.descope.com") + .projectId(PROJECT_ID) + .sdkInfo(SdkInfo.builder().name("java").build()) + .build(); + + private static class SentRequest { + private String path; + private String authorization; + private Map body; + private Object result; + } + + /** Runs the call against a mocked proxy and returns what it sent. */ + @SuppressWarnings("unchecked") + private static SentRequest send(Object response, Function call) { + ApiProxy apiProxy = mock(ApiProxy.class); + doReturn(response).when(apiProxy).post(any(), any(), any()); + SentRequest sent = new SentRequest(); + try (MockedStatic mockedApiProxyBuilder = mockStatic(ApiProxyBuilder.class)) { + mockedApiProxyBuilder.when(() -> ApiProxyBuilder.buildProxy(any(), any())).thenAnswer(inv -> { + sent.authorization = ((Supplier) inv.getArgument(0)).get(); + return apiProxy; + }); + sent.result = call.apply(AuthenticationServiceBuilder.buildServices(CLIENT).getMagicLinkService()); + } + ArgumentCaptor uriCaptor = ArgumentCaptor.forClass(URI.class); + ArgumentCaptor bodyCaptor = ArgumentCaptor.forClass(Object.class); + verify(apiProxy, times(1)).post(uriCaptor.capture(), bodyCaptor.capture(), any(Class.class)); + sent.path = uriCaptor.getValue().getPath(); + sent.body = asMap(bodyCaptor.getValue()); + return sent; + } + + // Serializes the way the proxy does + @SneakyThrows + @SuppressWarnings("unchecked") + private static Map asMap(Object value) { + ObjectMapper objectMapper = new ObjectMapper().setSerializationInclusion(Include.NON_NULL); + return objectMapper.readValue(objectMapper.writeValueAsBytes(value), Map.class); + } + @RetryingTest(value = 3, suspendForMs = 30000, onExceptions = RateLimitExceededException.class) void testFunctionalFullCycle() { String loginId = TestUtils.getRandomName("u-");