-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Feature: Forgot password * Address comments * fixups * Make forgot password disabled by default * Apply suggestions from code review * Address comments
- Loading branch information
Showing
29 changed files
with
1,726 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
165 changes: 165 additions & 0 deletions
165
server/src/main/java/com/cloud/api/auth/DefaultForgotPasswordAPIAuthenticatorCmd.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
| package com.cloud.api.auth; | ||
|
|
||
| import com.cloud.api.ApiServlet; | ||
| import com.cloud.api.response.ApiResponseSerializer; | ||
| import com.cloud.domain.Domain; | ||
| import com.cloud.user.Account; | ||
| import com.cloud.user.User; | ||
| import com.cloud.user.UserAccount; | ||
| import com.cloud.utils.exception.CloudRuntimeException; | ||
| import org.apache.cloudstack.api.APICommand; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.ApiErrorCode; | ||
| import org.apache.cloudstack.api.ApiServerService; | ||
| import org.apache.cloudstack.api.BaseCmd; | ||
| import org.apache.cloudstack.api.Parameter; | ||
| import org.apache.cloudstack.api.ServerApiException; | ||
| import org.apache.cloudstack.api.auth.APIAuthenticationType; | ||
| import org.apache.cloudstack.api.auth.APIAuthenticator; | ||
| import org.apache.cloudstack.api.auth.PluggableAPIAuthenticator; | ||
| import org.apache.cloudstack.api.response.SuccessResponse; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| import javax.inject.Inject; | ||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.servlet.http.HttpServletResponse; | ||
| import javax.servlet.http.HttpSession; | ||
| import java.net.InetAddress; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| @APICommand(name = "forgotPassword", | ||
| description = "Sends an email to the user with a token to reset the password using resetPassword command.", | ||
| since = "4.20.0.0", | ||
| requestHasSensitiveInfo = true, | ||
| responseObject = SuccessResponse.class) | ||
| public class DefaultForgotPasswordAPIAuthenticatorCmd extends BaseCmd implements APIAuthenticator { | ||
|
|
||
|
|
||
| ///////////////////////////////////////////////////// | ||
| //////////////// API parameters ///////////////////// | ||
| ///////////////////////////////////////////////////// | ||
| @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, description = "Username", required = true) | ||
| private String username; | ||
|
|
||
| @Parameter(name = ApiConstants.DOMAIN, type = CommandType.STRING, description = "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.") | ||
| private String domain; | ||
|
|
||
| @Inject | ||
| ApiServerService _apiServer; | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| /////////////////// Accessors /////////////////////// | ||
| ///////////////////////////////////////////////////// | ||
|
|
||
| public String getUsername() { | ||
| return username; | ||
| } | ||
|
|
||
| public String getDomainName() { | ||
| return domain; | ||
| } | ||
|
|
||
|
|
||
| ///////////////////////////////////////////////////// | ||
| /////////////// API Implementation/////////////////// | ||
| ///////////////////////////////////////////////////// | ||
|
|
||
| @Override | ||
| public long getEntityOwnerId() { | ||
| return Account.Type.NORMAL.ordinal(); | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() throws ServerApiException { | ||
| // We should never reach here | ||
| throw new ServerApiException(ApiErrorCode.METHOD_NOT_ALLOWED, "This is an authentication api, cannot be used directly"); | ||
| } | ||
|
|
||
| @Override | ||
| public String authenticate(String command, Map<String, Object[]> params, HttpSession session, InetAddress remoteAddress, String responseType, StringBuilder auditTrailSb, final HttpServletRequest req, final HttpServletResponse resp) throws ServerApiException { | ||
| final String[] username = (String[])params.get(ApiConstants.USERNAME); | ||
| final String[] domainName = (String[])params.get(ApiConstants.DOMAIN); | ||
|
|
||
| Long domainId = null; | ||
| String domain = null; | ||
| domain = getDomainName(auditTrailSb, domainName, domain); | ||
|
|
||
| String serializedResponse = null; | ||
| if (username != null) { | ||
| try { | ||
| final Domain userDomain = _domainService.findDomainByPath(domain); | ||
| if (userDomain != null) { | ||
| domainId = userDomain.getId(); | ||
| } else { | ||
| throw new ServerApiException(ApiErrorCode.PARAM_ERROR, String.format("Unable to find the domain from the path %s", domain)); | ||
| } | ||
| final UserAccount userAccount = _accountService.getActiveUserAccount(username[0], domainId); | ||
| if (userAccount != null && List.of(User.Source.SAML2, User.Source.OAUTH2, User.Source.LDAP).contains(userAccount.getSource())) { | ||
| throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Forgot Password is not allowed for this user"); | ||
| } | ||
| boolean success = _apiServer.forgotPassword(userAccount, userDomain); | ||
| logger.debug("Forgot password request for user " + username[0] + " in domain " + domain + " is successful: " + success); | ||
| } catch (final CloudRuntimeException ex) { | ||
| ApiServlet.invalidateHttpSession(session, "fall through to API key,"); | ||
| String msg = String.format("%s", ex.getMessage() != null ? | ||
| ex.getMessage() : | ||
| "forgot password request failed for user, check if username/domain are correct"); | ||
| auditTrailSb.append(" " + ApiErrorCode.ACCOUNT_ERROR + " " + msg); | ||
| serializedResponse = _apiServer.getSerializedApiError(ApiErrorCode.ACCOUNT_ERROR.getHttpCode(), msg, params, responseType); | ||
| if (logger.isTraceEnabled()) { | ||
| logger.trace(msg); | ||
| } | ||
| } | ||
| SuccessResponse successResponse = new SuccessResponse(); | ||
| successResponse.setSuccess(true); | ||
| successResponse.setResponseName(getCommandName()); | ||
| return ApiResponseSerializer.toSerializedString(successResponse, responseType); | ||
| } | ||
| // We should not reach here and if we do we throw an exception | ||
| throw new ServerApiException(ApiErrorCode.ACCOUNT_ERROR, serializedResponse); | ||
| } | ||
|
|
||
| @Nullable | ||
| private String getDomainName(StringBuilder auditTrailSb, String[] domainName, String domain) { | ||
| if (domainName != null) { | ||
| domain = domainName[0]; | ||
| auditTrailSb.append(" domain=" + domain); | ||
| if (domain != null) { | ||
| // ensure domain starts with '/' and ends with '/' | ||
| if (!domain.endsWith("/")) { | ||
| domain += '/'; | ||
| } | ||
| if (!domain.startsWith("/")) { | ||
| domain = "/" + domain; | ||
| } | ||
| } | ||
| } | ||
| return domain; | ||
| } | ||
|
|
||
| @Override | ||
| public APIAuthenticationType getAPIType() { | ||
| return APIAuthenticationType.PASSWORD_RESET; | ||
| } | ||
|
|
||
| @Override | ||
| public void setAuthenticators(List<PluggableAPIAuthenticator> authenticators) { | ||
| } | ||
| } |
Oops, something went wrong.