diff --git a/README.md b/README.md index b12d8837..00a0df51 100644 --- a/README.md +++ b/README.md @@ -236,6 +236,29 @@ try { ``` +Sign-in, sign-up and sign-up-or-in also take optional delivery settings: the messaging +provider and template, and for sign-in the SSO app and whether to send to the recovery +address. Login options can carry a tenant, an SSO app and a PKCE challenge, whose verifier +is then passed when verifying the link. + +```java +try { + LoginOptions loginOptions = LoginOptions.builder().tenantId("tenant").pkceChallenge(challenge).build(); + EnchantedLinkSignInOptions signInOptions = EnchantedLinkSignInOptions.builder() + .providerId("provider").templateId("template").ssoAppId("app").useRecovery(true).build(); + EnchantedLinkResponse signInRes = els.signIn(loginId, uri, null, loginOptions, signInOptions); + EnchantedLinkResponse signUpOrInRes = els.signUpOrIn(loginId, uri, null, loginOptions, signInOptions); + + User user = User.builder().name("name").recoveryEmail("recovery@example.com").build(); + SignUpOptions signUpOptions = SignUpOptions.builder().locale("en").tenantId("tenant").build(); + EnchantedLinkResponse signUpRes = els.signUp(loginId, uri, user, signUpOptions, + new EnchantedLinkSignUpOptions("provider", "template")); +} catch (DescopeException de) { + // Handle the error +} + +``` + After sending the link, you must poll to receive a valid session using the `PendingRef` from the previous step. A valid session will be returned only after the user clicks the right link. @@ -265,12 +288,29 @@ To verify an enchanted link, your redirect page must call the validation functio try { els.verify(token); + // Or, when the link was sent with a PKCE challenge + els.verify(token, verifier); } catch (DescopeException de) { // Token is invalid, handle the error } ``` +To update a signed-in user's email or phone through an enchanted link, pass their refresh +token. `UpdateOptions` can also set the messaging provider, template, locale and `failOnConflict`. + +```java +try { + UpdateOptions options = UpdateOptions.builder() + .providerId("provider").templateId("template").locale("en").failOnConflict(true).build(); + EnchantedLinkResponse emailRes = els.updateUserEmail(loginId, newEmail, uri, refreshToken, options); + PhoneEnchantedLinkResponse phoneRes = els.updateUserPhone(loginId, newPhone, uri, refreshToken, options); +} catch (DescopeException de) { + // Handle the error +} + +``` + The session and refresh JWTs should be returned to the caller, and passed with every request in the session. Read more on [session validation](#session-validation) ### OAuth diff --git a/src/main/java/com/descope/model/auth/AssociatedTenant.java b/src/main/java/com/descope/model/auth/AssociatedTenant.java index 1798deae..678650c4 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..e5218216 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,31 @@ 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, refreshToken, user, firstSeen, idpResponse, null, null, null, null, null, null, null, null, null, + null, null, null, null, null, null, null, null); + } } 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..3a141edc 100644 --- a/src/main/java/com/descope/model/auth/UpdateOptions.java +++ b/src/main/java/com/descope/model/auth/UpdateOptions.java @@ -12,4 +12,16 @@ public class UpdateOptions { private boolean addToLoginIds; private boolean onMergeUseExisting; + /** Sent by enchanted link updates only. */ + private String providerId; + /** Sent by enchanted link updates only. */ + private String templateId; + /** Sent by enchanted link updates only. */ + private String locale; + /** Sent by enchanted link updates only. */ + 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/enchantedlink/EnchantedLinkSignInOptions.java b/src/main/java/com/descope/model/enchantedlink/EnchantedLinkSignInOptions.java new file mode 100644 index 00000000..605fad94 --- /dev/null +++ b/src/main/java/com/descope/model/enchantedlink/EnchantedLinkSignInOptions.java @@ -0,0 +1,17 @@ +package com.descope.model.enchantedlink; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class EnchantedLinkSignInOptions { + private String providerId; + private String templateId; + private String ssoAppId; + private Boolean useRecovery; +} diff --git a/src/main/java/com/descope/model/enchantedlink/EnchantedLinkSignUpOptions.java b/src/main/java/com/descope/model/enchantedlink/EnchantedLinkSignUpOptions.java new file mode 100644 index 00000000..83219f1a --- /dev/null +++ b/src/main/java/com/descope/model/enchantedlink/EnchantedLinkSignUpOptions.java @@ -0,0 +1,15 @@ +package com.descope.model.enchantedlink; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class EnchantedLinkSignUpOptions { + private String providerId; + private String templateId; +} 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..56ece7c2 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,6 +20,25 @@ 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, 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); + } public JWTResponse(String sessionJwt, String refreshJwt, String cookieDomain, String cookiePath, Integer cookieMaxAge, Integer cookieExpiration, UserResponse user, Boolean firstSeen) { diff --git a/src/main/java/com/descope/model/magiclink/LoginOptions.java b/src/main/java/com/descope/model/magiclink/LoginOptions.java index de3b9ac2..5107b492 100644 --- a/src/main/java/com/descope/model/magiclink/LoginOptions.java +++ b/src/main/java/com/descope/model/magiclink/LoginOptions.java @@ -20,6 +20,17 @@ public class LoginOptions { private String jwt; private String locale; private String templateId; + private String ssoAppId; + /** PKCE challenge, used by enchanted link only. */ + private byte[] pkceChallenge; + private String tenantId; + + 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 LoginOptions(boolean stepup, boolean mfa, Map customClaims, Map templateOptions) { diff --git a/src/main/java/com/descope/model/magiclink/SignUpOptions.java b/src/main/java/com/descope/model/magiclink/SignUpOptions.java index 1010d3b3..4018f42a 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; + /** PKCE challenge, used by enchanted link only. */ + private byte[] 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/magiclink/request/VerifyRequest.java b/src/main/java/com/descope/model/magiclink/request/VerifyRequest.java index 190ed4f2..80922d9e 100644 --- a/src/main/java/com/descope/model/magiclink/request/VerifyRequest.java +++ b/src/main/java/com/descope/model/magiclink/request/VerifyRequest.java @@ -9,4 +9,9 @@ @AllArgsConstructor public class VerifyRequest { private String token; + private byte[] pkceVerifier; + + public VerifyRequest(String token) { + this(token, 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..6883dd39 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,8 @@ package com.descope.model.user.response; import com.descope.model.auth.AssociatedTenant; +import com.fasterxml.jackson.annotation.JsonAlias; +import com.fasterxml.jackson.annotation.JsonProperty; import java.util.List; import java.util.Map; import lombok.AllArgsConstructor; @@ -40,4 +42,58 @@ 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; + /** Role IDs; order does not 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); + } + + // Aliases read the spec's casing + @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; + } } diff --git a/src/main/java/com/descope/sdk/auth/EnchantedLinkService.java b/src/main/java/com/descope/sdk/auth/EnchantedLinkService.java index b5d9e092..726a3958 100644 --- a/src/main/java/com/descope/sdk/auth/EnchantedLinkService.java +++ b/src/main/java/com/descope/sdk/auth/EnchantedLinkService.java @@ -4,6 +4,8 @@ import com.descope.model.auth.AuthenticationInfo; import com.descope.model.auth.UpdateOptions; import com.descope.model.enchantedlink.EnchantedLinkResponse; +import com.descope.model.enchantedlink.EnchantedLinkSignInOptions; +import com.descope.model.enchantedlink.EnchantedLinkSignUpOptions; import com.descope.model.enchantedlink.PhoneEnchantedLinkResponse; import com.descope.model.magiclink.LoginOptions; import com.descope.model.magiclink.SignUpOptions; @@ -28,6 +30,20 @@ EnchantedLinkResponse signIn( LoginOptions loginOptions) throws DescopeException; + /** + * Use to login a user based on an enchanted link that will be sent by email. + * + * @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 settings + * @return pendingRef, linkId and masked email + * @throws DescopeException - error upon failure + */ + EnchantedLinkResponse signIn(String loginId, String uri, String token, LoginOptions loginOptions, + EnchantedLinkSignInOptions signInOptions) throws DescopeException; + /** * Use to login a user based on an enchanted link that will be sent by SMS. * @@ -45,6 +61,20 @@ PhoneEnchantedLinkResponse signInWithPhone( LoginOptions loginOptions) throws DescopeException; + /** + * Use to login a user based on an enchanted link that will be sent by SMS. + * + * @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 settings + * @return pendingRef, linkId and masked phone + * @throws DescopeException - error upon failure + */ + PhoneEnchantedLinkResponse signInWithPhone(String loginId, String uri, String token, LoginOptions loginOptions, + EnchantedLinkSignInOptions signInOptions) throws DescopeException; + /** * Use to create a new user based on the given loginID either email or a phone. * @@ -70,6 +100,20 @@ EnchantedLinkResponse signUp(String loginId, String uri, User user) EnchantedLinkResponse signUp(String loginId, String uri, User user, SignUpOptions signupOptions) throws DescopeException; + /** + * Use to create a new user based on the given loginID either email or a phone. + * + * @param loginId - User login ID + * @param uri - Base URI + * @param user - {@link User User} + * @param signupOptions - optional claims and template strings + * @param deliveryOptions - optional provider and template IDs + * @return pendingRef, linkId and masked email + * @throws DescopeException - error upon failure + */ + EnchantedLinkResponse signUp(String loginId, String uri, User user, SignUpOptions signupOptions, + EnchantedLinkSignUpOptions deliveryOptions) throws DescopeException; + /** * Use to create a new user with a phone number as the loginID, verified by an enchanted link * sent by SMS. @@ -97,6 +141,21 @@ PhoneEnchantedLinkResponse signUpWithPhone(String loginId, String uri, User user PhoneEnchantedLinkResponse signUpWithPhone(String loginId, String uri, User user, SignUpOptions signupOptions) throws DescopeException; + /** + * Use to create a new user with a phone number as the loginID, verified by an enchanted link + * sent by SMS. + * + * @param loginId - User login ID, a phone number + * @param uri - Base URI + * @param user - {@link User User} + * @param signupOptions - optional claims and template strings + * @param deliveryOptions - optional provider and template IDs + * @return pendingRef, linkId and masked phone + * @throws DescopeException - error upon failure + */ + PhoneEnchantedLinkResponse signUpWithPhone(String loginId, String uri, User user, + SignUpOptions signupOptions, EnchantedLinkSignUpOptions deliveryOptions) throws DescopeException; + /** * Use to login in using loginID, if user does not exist, a new user will be created. * @@ -108,6 +167,20 @@ PhoneEnchantedLinkResponse signUpWithPhone(String loginId, String uri, User user EnchantedLinkResponse signUpOrIn(String loginId, String uri) throws DescopeException; + /** + * Use to login in using loginID, if user does not exist, a new user will be created. + * + * @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 settings + * @return pendingRef, linkId and masked email + * @throws DescopeException - error upon failure + */ + EnchantedLinkResponse signUpOrIn(String loginId, String uri, String token, LoginOptions loginOptions, + EnchantedLinkSignInOptions signInOptions) throws DescopeException; + /** * Use to login in using a phone number as the loginID, if user does not exist, a new user will * be created. The enchanted link is sent by SMS. @@ -120,6 +193,21 @@ EnchantedLinkResponse signUpOrIn(String loginId, String uri) PhoneEnchantedLinkResponse signUpOrInWithPhone(String loginId, String uri) throws DescopeException; + /** + * Use to login in using a phone number as the loginID, if user does not exist, a new user will + * be created. The enchanted link is sent by SMS. + * + * @param loginId - User login ID, a phone number + * @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 settings + * @return pendingRef, linkId and masked phone + * @throws DescopeException - error upon failure + */ + PhoneEnchantedLinkResponse signUpOrInWithPhone(String loginId, String uri, String token, + LoginOptions loginOptions, EnchantedLinkSignInOptions signInOptions) throws DescopeException; + /** * Use to get a session that was generated by SignIn/SignUp request. * @@ -137,6 +225,15 @@ PhoneEnchantedLinkResponse signUpOrInWithPhone(String loginId, String uri) */ void verify(String token) throws DescopeException; + /** + * Use to verify a SignIn/SignUp request, based on the enchanted link token generated. + * + * @param token - token to be validate + * @param pkceVerifier - PKCE verifier matching the challenge sent with the sign-in or sign-up + * @throws DescopeException - error upon failure + */ + void verify(String token, byte[] pkceVerifier) throws DescopeException; + /** * Use to update email and validate via enchanted link. * 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/EnchantedLinkServiceImpl.java b/src/main/java/com/descope/sdk/auth/impl/EnchantedLinkServiceImpl.java index b649af4f..6e8ffc3f 100644 --- a/src/main/java/com/descope/sdk/auth/impl/EnchantedLinkServiceImpl.java +++ b/src/main/java/com/descope/sdk/auth/impl/EnchantedLinkServiceImpl.java @@ -21,6 +21,8 @@ import com.descope.model.enchantedlink.EmptyResponse; import com.descope.model.enchantedlink.EnchantedLinkResponse; import com.descope.model.enchantedlink.EnchantedLinkSessionBody; +import com.descope.model.enchantedlink.EnchantedLinkSignInOptions; +import com.descope.model.enchantedlink.EnchantedLinkSignUpOptions; import com.descope.model.enchantedlink.PhoneEnchantedLinkResponse; import com.descope.model.jwt.response.JWTResponse; import com.descope.model.magiclink.LoginOptions; @@ -47,22 +49,42 @@ class EnchantedLinkServiceImpl extends AuthenticationServiceImpl implements Ench @Override public EnchantedLinkResponse signIn(String loginId, String uri, String token, LoginOptions loginOptions) throws DescopeException { - return signInByDeliveryMethod(EMAIL, loginId, uri, token, loginOptions, EnchantedLinkResponse.class); + return signIn(loginId, uri, token, loginOptions, null); + } + + @Override + public EnchantedLinkResponse signIn(String loginId, String uri, String token, LoginOptions loginOptions, + EnchantedLinkSignInOptions signInOptions) throws DescopeException { + return sendSignIn(composeEnchantedLinkSignInURL(EMAIL), loginId, uri, token, loginOptions, + signInOptions, EnchantedLinkResponse.class); } @Override public PhoneEnchantedLinkResponse signInWithPhone(String loginId, String uri, String token, LoginOptions loginOptions) throws DescopeException { - return signInByDeliveryMethod(SMS, loginId, uri, token, loginOptions, PhoneEnchantedLinkResponse.class); + return signInWithPhone(loginId, uri, token, loginOptions, null); + } + + @Override + public PhoneEnchantedLinkResponse signInWithPhone(String loginId, String uri, String token, + LoginOptions loginOptions, EnchantedLinkSignInOptions signInOptions) throws DescopeException { + return sendSignIn(composeEnchantedLinkSignInURL(SMS), loginId, uri, token, loginOptions, + signInOptions, PhoneEnchantedLinkResponse.class); } - private R signInByDeliveryMethod(DeliveryMethod deliveryMethod, String loginId, String uri, String token, - LoginOptions loginOptions, Class responseClass) throws DescopeException { + private R sendSignIn(URI enchantedLink, String loginId, String uri, String token, + LoginOptions loginOptions, EnchantedLinkSignInOptions signInOptions, Class responseClass) + throws DescopeException { if (StringUtils.isBlank(loginId)) { throw ServerCommonException.invalidArgument("Login ID"); } - URI enchantedLink = composeEnchantedLinkSignInURL(deliveryMethod); 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()); + } ApiProxy apiProxy; if (JwtUtils.isJWTRequired(loginOptions)) { if (StringUtils.isBlank(token)) { @@ -84,7 +106,14 @@ public EnchantedLinkResponse signUp(String loginId, String uri, User user) @Override public EnchantedLinkResponse signUp(String loginId, String uri, User user, SignUpOptions signupOptions) throws DescopeException { - return signUpByDeliveryMethod(EMAIL, loginId, uri, user, signupOptions, EnchantedLinkResponse.class); + return signUp(loginId, uri, user, signupOptions, null); + } + + @Override + public EnchantedLinkResponse signUp(String loginId, String uri, User user, SignUpOptions signupOptions, + EnchantedLinkSignUpOptions deliveryOptions) throws DescopeException { + return signUpByDeliveryMethod(EMAIL, loginId, uri, user, signupOptions, deliveryOptions, + EnchantedLinkResponse.class); } @Override @@ -96,15 +125,22 @@ public PhoneEnchantedLinkResponse signUpWithPhone(String loginId, String uri, Us @Override public PhoneEnchantedLinkResponse signUpWithPhone(String loginId, String uri, User user, SignUpOptions signupOptions) throws DescopeException { - return signUpByDeliveryMethod(SMS, loginId, uri, user, signupOptions, PhoneEnchantedLinkResponse.class); + return signUpWithPhone(loginId, uri, user, signupOptions, null); + } + + @Override + public PhoneEnchantedLinkResponse signUpWithPhone(String loginId, String uri, User user, + SignUpOptions signupOptions, EnchantedLinkSignUpOptions deliveryOptions) throws DescopeException { + return signUpByDeliveryMethod(SMS, loginId, uri, user, signupOptions, deliveryOptions, + PhoneEnchantedLinkResponse.class); } private R signUpByDeliveryMethod(DeliveryMethod deliveryMethod, String loginId, String uri, User user, - SignUpOptions signupOptions, Class responseClass) throws DescopeException { + SignUpOptions signupOptions, EnchantedLinkSignUpOptions deliveryOptions, Class responseClass) + throws DescopeException { if (user == null) { user = new User(); } - URI enchantedLinkSignUpURL = composeEnchantedLinkSignUpURL(deliveryMethod); SignUpRequest.SignUpRequestBuilder signUpRequestBuilder = SignUpRequest.builder().loginId(loginId).uri(uri); if (deliveryMethod == SMS) { @@ -121,30 +157,37 @@ private R signUpByDeliveryMethod(DeliveryMethod deliveryMethod, String login if (signupOptions != null) { signUpRequestBuilder.loginOptions(signupOptions); } + if (deliveryOptions != null) { + signUpRequestBuilder.providerId(deliveryOptions.getProviderId()).templateId(deliveryOptions.getTemplateId()); + } SignUpRequest signUpRequest = signUpRequestBuilder.user(user).build(); + URI enchantedLinkSignUpURL = composeEnchantedLinkSignUpURL(deliveryMethod); ApiProxy apiProxy = getApiProxy(); return apiProxy.post(enchantedLinkSignUpURL, signUpRequest, responseClass); } @Override public EnchantedLinkResponse signUpOrIn(String loginId, String uri) throws DescopeException { - return signUpOrInByDeliveryMethod(EMAIL, loginId, uri, EnchantedLinkResponse.class); + return signUpOrIn(loginId, uri, null, null, null); + } + + @Override + public EnchantedLinkResponse signUpOrIn(String loginId, String uri, String token, LoginOptions loginOptions, + EnchantedLinkSignInOptions signInOptions) throws DescopeException { + return sendSignIn(composeEnchantedLinkSignUpOrInURL(EMAIL), loginId, uri, token, loginOptions, + signInOptions, EnchantedLinkResponse.class); } @Override public PhoneEnchantedLinkResponse signUpOrInWithPhone(String loginId, String uri) throws DescopeException { - return signUpOrInByDeliveryMethod(SMS, loginId, uri, PhoneEnchantedLinkResponse.class); + return signUpOrInWithPhone(loginId, uri, null, null, null); } - private R signUpOrInByDeliveryMethod(DeliveryMethod deliveryMethod, String loginId, String uri, - Class responseClass) throws DescopeException { - if (StringUtils.isBlank(loginId)) { - throw ServerCommonException.invalidArgument("Login ID"); - } - URI enchantedLinkSignUpOrInURL = composeEnchantedLinkSignUpOrInURL(deliveryMethod); - SignInRequest signInRequest = new SignInRequest(uri, loginId, null); - ApiProxy apiProxy = getApiProxy(); - return apiProxy.post(enchantedLinkSignUpOrInURL, signInRequest, responseClass); + @Override + public PhoneEnchantedLinkResponse signUpOrInWithPhone(String loginId, String uri, String token, + LoginOptions loginOptions, EnchantedLinkSignInOptions signInOptions) throws DescopeException { + return sendSignIn(composeEnchantedLinkSignUpOrInURL(SMS), loginId, uri, token, loginOptions, + signInOptions, PhoneEnchantedLinkResponse.class); } @Override @@ -161,8 +204,13 @@ public AuthenticationInfo getSession(String pendingRef) throws DescopeException @Override public void verify(String token) throws DescopeException { + verify(token, null); + } + + @Override + public void verify(String token, byte[] pkceVerifier) throws DescopeException { URI verifyEnchantedLinkURL = composeVerifyEnchantedLinkURL(); - VerifyRequest verifyRequest = new VerifyRequest(token); + VerifyRequest verifyRequest = new VerifyRequest(token, pkceVerifier); ApiProxy apiProxy = getApiProxy(); apiProxy.post(verifyEnchantedLinkURL, verifyRequest, EmptyResponse.class); } @@ -198,6 +246,10 @@ public EnchantedLinkResponse updateUserEmail(String loginId, String email, Strin .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); @@ -235,6 +287,10 @@ public PhoneEnchantedLinkResponse updateUserPhone(String loginId, String phone, .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); diff --git a/src/test/java/com/descope/sdk/auth/impl/EnchantedLinkServiceImplTest.java b/src/test/java/com/descope/sdk/auth/impl/EnchantedLinkServiceImplTest.java index 9aa879ff..3cd5ae50 100644 --- a/src/test/java/com/descope/sdk/auth/impl/EnchantedLinkServiceImplTest.java +++ b/src/test/java/com/descope/sdk/auth/impl/EnchantedLinkServiceImplTest.java @@ -26,19 +26,28 @@ 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.enchantedlink.EmptyResponse; import com.descope.model.enchantedlink.EnchantedLinkResponse; +import com.descope.model.enchantedlink.EnchantedLinkSignInOptions; +import com.descope.model.enchantedlink.EnchantedLinkSignUpOptions; import com.descope.model.enchantedlink.PhoneEnchantedLinkResponse; 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.SignUpOptions; import com.descope.model.magiclink.request.SignInRequest; import com.descope.model.magiclink.request.SignUpRequest; import com.descope.model.magiclink.request.UpdatePhoneRequest; import com.descope.model.user.User; import com.descope.model.user.request.UserRequest; import com.descope.model.user.response.EnchantedLinkTestUserResponse; +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; @@ -48,10 +57,17 @@ 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.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; import java.net.URI; +import java.nio.charset.StandardCharsets; import java.util.Arrays; import java.util.List; import java.util.Map; +import java.util.function.Function; +import java.util.function.Supplier; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junitpioneer.jupiter.RetryingTest; @@ -348,6 +364,339 @@ void testVerify() { } } + private static final ObjectMapper REQUEST_JSON = new ObjectMapper().setSerializationInclusion(Include.NON_NULL); + private static final byte[] PKCE = "pkce".getBytes(StandardCharsets.UTF_8); + private static final String PKCE_BASE64 = "cGtjZQ=="; + + private static class Sent { + private String authorization; + private String path; + private JsonNode body; + private Object response; + } + + // Runs one call and captures the Authorization header, route and JSON body it sent + @SuppressWarnings("unchecked") + private Sent send(Object response, Function call) { + ApiProxy apiProxy = mock(ApiProxy.class); + doReturn(response).when(apiProxy).post(any(), any(), any()); + Sent sent = new Sent(); + try (MockedStatic mockedApiProxyBuilder = mockStatic(ApiProxyBuilder.class)) { + mockedApiProxyBuilder.when(() -> ApiProxyBuilder.buildProxy(any(), any())).thenAnswer(inv -> { + sent.authorization = ((Supplier) inv.getArgument(0)).get(); + return apiProxy; + }); + sent.response = call.apply(enchantedLinkService); + } + ArgumentCaptor uriCaptor = ArgumentCaptor.forClass(URI.class); + ArgumentCaptor bodyCaptor = ArgumentCaptor.forClass(Object.class); + verify(apiProxy, times(1)).post(uriCaptor.capture(), bodyCaptor.capture(), any()); + sent.path = uriCaptor.getValue().getPath(); + sent.body = wire(bodyCaptor.getValue()); + return sent; + } + + // The JSON the proxy sends for a request body + private static JsonNode wire(Object body) { + try { + return REQUEST_JSON.readTree(REQUEST_JSON.writeValueAsString(body)); + } catch (Exception e) { + throw new IllegalArgumentException(e); + } + } + + private static JsonNode json(String singleQuoted) { + try { + return REQUEST_JSON.readTree(singleQuoted.replace('\'', '"')); + } catch (Exception e) { + throw new IllegalArgumentException(e); + } + } + + private static LoginOptions newLoginOptions(boolean stepup) { + return LoginOptions.builder().stepup(stepup).ssoAppId("app").pkceChallenge(PKCE).tenantId("tenant").build(); + } + + private static void assertSignInBody(JsonNode body, String loginId) { + assertThat(body.get("loginId").asText()).isEqualTo(loginId); + assertThat(body.get("URI").asText()).isEqualTo(MOCK_DOMAIN); + assertThat(body.at("/loginOptions/ssoAppId").asText()).isEqualTo("app"); + assertThat(body.at("/loginOptions/pkceChallenge").asText()).isEqualTo(PKCE_BASE64); + assertThat(body.at("/loginOptions/tenantId").asText()).isEqualTo("tenant"); + assertThat(body.get("providerId").asText()).isEqualTo("provider"); + assertThat(body.get("templateId").asText()).isEqualTo("template"); + assertThat(body.get("ssoAppId").asText()).isEqualTo("app"); + assertThat(body.get("useRecovery").asBoolean()).isTrue(); + } + + private static EnchantedLinkSignInOptions newSignInOptions() { + return new EnchantedLinkSignInOptions("provider", "template", "app", true); + } + + @Test + void signInWithOptionsSendsAllFields() { + EnchantedLinkResponse response = new EnchantedLinkResponse(MOCK_URL, MOCK_URL, MOCK_MASKED_EMAIL); + Sent sent = send(response, s -> s.signIn(MOCK_EMAIL, MOCK_DOMAIN, MOCK_REFRESH_TOKEN, newLoginOptions(true), + newSignInOptions())); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID + ":" + MOCK_REFRESH_TOKEN); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/signin/email"); + assertSignInBody(sent.body, MOCK_EMAIL); + assertThat(sent.response).isEqualTo(response); + } + + @Test + void signInWithPhoneWithOptionsSendsAllFields() { + PhoneEnchantedLinkResponse response = new PhoneEnchantedLinkResponse(MOCK_URL, MOCK_URL, MOCK_MASKED_PHONE); + Sent sent = send(response, s -> s.signInWithPhone(MOCK_PHONE, MOCK_DOMAIN, null, newLoginOptions(false), + newSignInOptions())); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/signin/sms"); + assertSignInBody(sent.body, MOCK_PHONE); + assertThat(sent.response).isEqualTo(response); + } + + @Test + void signUpOrInWithOptionsSendsAllFields() { + EnchantedLinkResponse response = new EnchantedLinkResponse(MOCK_URL, MOCK_URL, MOCK_MASKED_EMAIL); + Sent sent = send(response, s -> s.signUpOrIn(MOCK_EMAIL, MOCK_DOMAIN, null, newLoginOptions(false), + newSignInOptions())); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/signup-in/email"); + assertSignInBody(sent.body, MOCK_EMAIL); + assertThat(sent.response).isEqualTo(response); + } + + @Test + void signUpOrInWithPhoneWithOptionsSendsAllFields() { + PhoneEnchantedLinkResponse response = new PhoneEnchantedLinkResponse(MOCK_URL, MOCK_URL, MOCK_MASKED_PHONE); + Sent sent = send(response, s -> s.signUpOrInWithPhone(MOCK_PHONE, MOCK_DOMAIN, MOCK_REFRESH_TOKEN, + newLoginOptions(true), newSignInOptions())); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID + ":" + MOCK_REFRESH_TOKEN); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/signup-in/sms"); + assertSignInBody(sent.body, MOCK_PHONE); + assertThat(sent.response).isEqualTo(response); + } + + @Test + void signUpOrInWithOptionsRejectsInvalidArguments() { + assertEquals("The Login ID argument is invalid", assertThrows(ServerCommonException.class, + () -> enchantedLinkService.signUpOrIn("", MOCK_DOMAIN, null, null, newSignInOptions())).getMessage()); + assertEquals("The token argument is invalid", assertThrows(ServerCommonException.class, + () -> enchantedLinkService.signUpOrInWithPhone(MOCK_PHONE, MOCK_DOMAIN, "", newLoginOptions(true), null)) + .getMessage()); + } + + @Test + void signUpOrInWithoutOptionsSendsUnchangedBody() { + Sent sent = send(new EnchantedLinkResponse(), s -> s.signUpOrIn(MOCK_EMAIL, MOCK_DOMAIN)); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.body).isEqualTo(json("{'URI':'" + MOCK_DOMAIN + "','loginId':'" + MOCK_EMAIL + "'}")); + } + + private static User newSignUpUser(String loginId) { + return User.builder().loginId(loginId).name("name").recoveryEmail("recovery@domain.com") + .recoveryPhone("+15555555556").build(); + } + + private static SignUpOptions newSignUpOptions() { + return SignUpOptions.builder().locale("en").pkceChallenge(PKCE).templateId("login-template").tenantId("tenant") + .build(); + } + + private static void assertSignUpBody(JsonNode body, String loginId) { + assertThat(body.get("loginId").asText()).isEqualTo(loginId); + assertThat(body.at("/user/loginId").asText()).isEqualTo(loginId); + assertThat(body.at("/user/recoveryEmail").asText()).isEqualTo("recovery@domain.com"); + assertThat(body.at("/user/recoveryPhone").asText()).isEqualTo("+15555555556"); + assertThat(body.get("providerId").asText()).isEqualTo("provider"); + assertThat(body.get("templateId").asText()).isEqualTo("template"); + assertThat(body.at("/loginOptions/locale").asText()).isEqualTo("en"); + assertThat(body.at("/loginOptions/pkceChallenge").asText()).isEqualTo(PKCE_BASE64); + assertThat(body.at("/loginOptions/templateId").asText()).isEqualTo("login-template"); + assertThat(body.at("/loginOptions/tenantId").asText()).isEqualTo("tenant"); + } + + @Test + void signUpWithOptionsSendsAllFields() { + EnchantedLinkResponse response = new EnchantedLinkResponse(MOCK_URL, MOCK_URL, MOCK_MASKED_EMAIL); + Sent sent = send(response, s -> s.signUp(MOCK_EMAIL, MOCK_DOMAIN, newSignUpUser(MOCK_EMAIL), newSignUpOptions(), + new EnchantedLinkSignUpOptions("provider", "template"))); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/signup/email"); + assertSignUpBody(sent.body, MOCK_EMAIL); + assertThat(sent.body.get("email").asText()).isEqualTo(MOCK_EMAIL); + assertThat(sent.response).isEqualTo(response); + } + + @Test + void signUpWithPhoneWithOptionsSendsAllFields() { + PhoneEnchantedLinkResponse response = new PhoneEnchantedLinkResponse(MOCK_URL, MOCK_URL, MOCK_MASKED_PHONE); + Sent sent = send(response, s -> s.signUpWithPhone(MOCK_PHONE, MOCK_DOMAIN, newSignUpUser(MOCK_PHONE), + newSignUpOptions(), new EnchantedLinkSignUpOptions("provider", "template"))); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/signup/sms"); + assertSignUpBody(sent.body, MOCK_PHONE); + assertThat(sent.body.get("phone").asText()).isEqualTo(MOCK_PHONE); + assertThat(sent.response).isEqualTo(response); + } + + private static UpdateOptions newUpdateOptions() { + return UpdateOptions.builder().providerId("provider").templateId("template").locale("en").failOnConflict(true) + .build(); + } + + private static void assertUpdateBody(JsonNode body) { + assertThat(body.get("providerId").asText()).isEqualTo("provider"); + assertThat(body.get("templateId").asText()).isEqualTo("template"); + assertThat(body.get("locale").asText()).isEqualTo("en"); + assertThat(body.get("failOnConflict").asBoolean()).isTrue(); + } + + @Test + void updateUserEmailWithOptionsSendsAllFields() { + EnchantedLinkResponse response = new EnchantedLinkResponse(MOCK_URL, MOCK_URL, MOCK_MASKED_EMAIL); + Sent sent = send(response, s -> s.updateUserEmail(MOCK_EMAIL, MOCK_EMAIL, MOCK_DOMAIN, MOCK_REFRESH_TOKEN, + newUpdateOptions())); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID + ":" + MOCK_REFRESH_TOKEN); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/update/email"); + assertThat(sent.body.get("email").asText()).isEqualTo(MOCK_EMAIL); + assertUpdateBody(sent.body); + assertThat(sent.response).isEqualTo(response); + } + + @Test + void updateUserPhoneWithOptionsSendsAllFields() { + PhoneEnchantedLinkResponse response = new PhoneEnchantedLinkResponse(MOCK_URL, MOCK_URL, MOCK_MASKED_PHONE); + Sent sent = send(response, s -> s.updateUserPhone(MOCK_EMAIL, MOCK_PHONE, MOCK_DOMAIN, MOCK_REFRESH_TOKEN, + newUpdateOptions())); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID + ":" + MOCK_REFRESH_TOKEN); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/update/phone/sms"); + assertThat(sent.body.get("phone").asText()).isEqualTo(MOCK_PHONE); + assertUpdateBody(sent.body); + assertThat(sent.response).isEqualTo(response); + } + + @Test + void updateUserEmailWithoutNewOptionsOmitsThem() { + Sent sent = send(new EnchantedLinkResponse(), s -> s.updateUserEmail(MOCK_EMAIL, MOCK_EMAIL, MOCK_DOMAIN, + MOCK_REFRESH_TOKEN, null)); + assertThat(sent.body.has("providerId")).isFalse(); + assertThat(sent.body.has("templateId")).isFalse(); + assertThat(sent.body.has("locale")).isFalse(); + assertThat(sent.body.has("failOnConflict")).isFalse(); + } + + @Test + void verifyWithPkceVerifierSendsIt() { + Sent sent = send(new EmptyResponse(), s -> { + s.verify("token", PKCE); + return null; + }); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/verify"); + assertThat(sent.body).isEqualTo(json("{'token':'token','pkceVerifier':'" + PKCE_BASE64 + "'}")); + } + + private static final String FULL_JWT_RESPONSE = ("{'sessionJwt':'s','refreshJwt':'r','cookieDomain':'d'," + + "'cookiePath':'/p','cookieMaxAge':1,'cookieExpiration':2,'firstSeen':true,'sessionExpiration':3," + + "'externalToken':'ext','claims':{'c':'v'},'tenantSSOID':'sso','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','idpGroups':['g']}," + + "'user':{'userId':'u1','userTenants':[{'tenantId':'t1','permissions':['p1'],'roleIds':['r1']}]," + + "'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@domain.com','verifiedRecoveryEmail':true,'recoveryPhone':'+15555555556'," + + "'verifiedRecoveryPhone':true,'modifiedTime':6,'roleIds':['r2'],'recoveryCodes':true,'dependent':true," + + "'userFamilies':[{'familyId':'f1','roleNames':['fr'],'permissions':['fp']," + + "'familyScopedAttributes':{'a':'b'}}],'scimTenantId':'st','samlTenantId':'sat','oidcTenantId':'ot'," + + "'consentTenantId':'ct','lastLoginTime':7}}").replace('\'', '"'); + + @Test + void getSessionExposesAllResponseFields() throws Exception { + JWTResponse jwtResponse = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) + .readValue(FULL_JWT_RESPONSE, JWTResponse.class); + AuthenticationInfo info; + try (MockedStatic mockedJwtUtils = mockStatic(JwtUtils.class)) { + mockedJwtUtils.when(() -> JwtUtils.getToken(anyString(), any())).thenReturn(MOCK_TOKEN); + Sent sent = send(jwtResponse, s -> s.getSession("ref")); + assertThat(sent.authorization).isEqualTo("Bearer " + PROJECT_ID); + assertThat(sent.path).isEqualTo("/v1/auth/enchantedlink/pending-session"); + assertThat(sent.body).isEqualTo(json("{'pendingRef':'ref'}")); + info = (AuthenticationInfo) sent.response; + } + assertThat(info.getCookieDomain()).isEqualTo("d"); + assertThat(info.getCookiePath()).isEqualTo("/p"); + assertThat(info.getCookieMaxAge()).isEqualTo(1); + assertThat(info.getCookieExpiration()).isEqualTo(2); + assertThat(info.getFirstSeen()).isTrue(); + assertThat(info.getSessionExpiration()).isEqualTo(3); + assertThat(info.getExternalToken()).isEqualTo("ext"); + assertThat(info.getClaims()).containsEntry("c", "v"); + assertThat(info.getTenantSSOID()).isEqualTo("sso"); + 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.getIdpGroups()).containsExactly("g"); + 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("p1"); + assertThat(user.getUserTenants().get(0).getRoleIds()).containsExactly("r1"); + 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@domain.com"); + assertThat(user.getVerifiedRecoveryEmail()).isTrue(); + assertThat(user.getRecoveryPhone()).isEqualTo("+15555555556"); + assertThat(user.getVerifiedRecoveryPhone()).isTrue(); + assertThat(user.getModifiedTime()).isEqualTo(6L); + assertThat(user.getRoleIds()).containsExactly("r2"); + assertThat(user.getRecoveryCodes()).isTrue(); + assertThat(user.getDependent()).isTrue(); + UserFamily family = user.getUserFamilies().get(0); + assertThat(family.getFamilyId()).isEqualTo("f1"); + 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(7L); + } + + @Test + void responseOnlyTenantFieldsAreNotSent() { + AssociatedTenant tenant = AssociatedTenant.builder().tenantId("t1").roleNames(Arrays.asList("r")) + .permissions(Arrays.asList("p")).roleIds(Arrays.asList("id")).build(); + assertThat(wire(tenant)).isEqualTo(json("{'tenantId':'t1','roleNames':['r']}")); + } + @RetryingTest(value = 3, suspendForMs = 30000, onExceptions = RateLimitExceededException.class) void testFunctionalFullCycle() { String loginId = TestUtils.getRandomName("u-");