Cloudstack:8647 LDAP Trust AD and Autoimport #755
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,115 @@ | ||
| /* | ||
| * 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 org.apache.cloudstack.api.command; | ||
|
|
||
| import javax.inject.Inject; | ||
|
|
||
| import com.cloud.exception.InvalidParameterValueException; | ||
| import com.cloud.user.User; | ||
| import com.cloud.user.UserAccount; | ||
| import org.apache.cloudstack.api.APICommand; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.ApiErrorCode; | ||
| import org.apache.cloudstack.api.BaseCmd; | ||
| import org.apache.cloudstack.api.Parameter; | ||
| import org.apache.cloudstack.api.ServerApiException; | ||
| import org.apache.cloudstack.api.response.DomainResponse; | ||
| import org.apache.cloudstack.api.response.LinkDomainToLdapResponse; | ||
| import org.apache.cloudstack.ldap.LdapManager; | ||
| import org.apache.cloudstack.ldap.LdapUser; | ||
| import org.apache.cloudstack.ldap.NoLdapUserMatchingQueryException; | ||
| import org.apache.log4j.Logger; | ||
|
|
||
| import com.cloud.user.Account; | ||
|
|
||
| import java.util.UUID; | ||
|
|
||
| @APICommand(name = "linkDomainToLdap", description = "link an existing cloudstack domain to group or OU in ldap", responseObject = LinkDomainToLdapResponse.class, since = "4.6.0", | ||
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) | ||
| public class LinkDomainToLdapCmd extends BaseCmd { | ||
| public static final Logger s_logger = Logger.getLogger(LinkDomainToLdapCmd.class.getName()); | ||
| private static final String s_name = "linkdomaintoldapresponse"; | ||
|
|
||
| @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, required = true, entityType = DomainResponse.class, description = "The id of the domain which has to be " | ||
| + "linked to LDAP.") | ||
| private Long domainId; | ||
|
|
||
| @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, required = true, description = "type of the ldap name. GROUP or OU") | ||
| private String type; | ||
|
|
||
| @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the group or OU in LDAP") | ||
| private String name; | ||
|
|
||
| @Parameter(name = ApiConstants.ADMIN, type = CommandType.STRING, required = false, description = "domain admin username in LDAP ") | ||
| private String admin; | ||
|
|
||
| @Parameter(name = ApiConstants.ACCOUNT_TYPE, type = CommandType.SHORT, required = true, description = "Type of the account to auto import. Specify 0 for user and 2 for " + | ||
| "domain admin") | ||
| private short accountType; | ||
|
|
||
| @Inject | ||
| private LdapManager _ldapManager; | ||
|
|
||
| @Override | ||
| public void execute() throws ServerApiException { | ||
| try { | ||
| LinkDomainToLdapResponse response = _ldapManager.linkDomainToLdap(domainId, type, name, accountType); | ||
| if(admin!=null) { | ||
| LdapUser ldapUser = null; | ||
| try { | ||
| ldapUser = _ldapManager.getUser(admin, type, name); | ||
| } catch (NoLdapUserMatchingQueryException e) { | ||
| s_logger.debug("no ldap user matching username " + admin + " in the given group/ou", e); | ||
| } | ||
| if (ldapUser != null && !ldapUser.isDisabled()) { | ||
| Account account = _accountService.getActiveAccountByName(admin, domainId); | ||
| if (account == null) { | ||
| try { | ||
| UserAccount userAccount = _accountService.createUserAccount(admin, "", ldapUser.getFirstname(), ldapUser.getLastname(), ldapUser.getEmail(), null, | ||
| admin, Account.ACCOUNT_TYPE_DOMAIN_ADMIN, domainId, admin, null, UUID.randomUUID().toString(), UUID.randomUUID().toString(), User.Source.LDAP); | ||
| response.setAdminId(String.valueOf(userAccount.getAccountId())); | ||
| s_logger.info("created an account with name " + admin + " in the given domain " + domainId); | ||
| } catch (Exception e) { | ||
| s_logger.info("an exception occurred while creating account with name " + admin +" in domain " + domainId, e); | ||
| } | ||
| } else { | ||
| s_logger.debug("an account with name " + admin + " already exists in the domain " + domainId); | ||
| } | ||
| } else { | ||
| s_logger.debug("ldap user with username "+admin+" is disabled in the given group/ou"); | ||
| } | ||
| } | ||
| response.setObjectName("LinkDomainToLdap"); | ||
| response.setResponseName(getCommandName()); | ||
| setResponseObject(response); | ||
| } catch (final InvalidParameterValueException e) { | ||
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.toString()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String getCommandName() { | ||
| return s_name; | ||
| } | ||
|
|
||
| @Override | ||
| public long getEntityOwnerId() { | ||
| return Account.ACCOUNT_ID_SYSTEM; | ||
| } | ||
| } | ||
This file contains hidden or 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,78 @@ | ||
| /* | ||
| * 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 org.apache.cloudstack.api.response; | ||
|
|
||
| import com.cloud.serializer.Param; | ||
| import com.google.gson.annotations.SerializedName; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.BaseResponse; | ||
|
|
||
| public class LinkDomainToLdapResponse extends BaseResponse { | ||
|
|
||
| @SerializedName(ApiConstants.DOMAIN_ID) | ||
| @Param(description = "id of the Domain which is linked to LDAP") | ||
| private long domainId; | ||
|
|
||
| @SerializedName(ApiConstants.NAME) | ||
| @Param(description = "name of the group or OU in LDAP which is linked to the domain") | ||
| private String name; | ||
|
|
||
| @SerializedName(ApiConstants.TYPE) | ||
| @Param(description = "type of the name in LDAP which is linke to the domain") | ||
| private String type; | ||
|
|
||
| @SerializedName(ApiConstants.ACCOUNT_TYPE) | ||
| @Param(description = "Type of the account to auto import") | ||
| private short accountType; | ||
|
|
||
| @SerializedName(ApiConstants.ACCOUNT_ID) | ||
| @Param(description = "Domain Admin accountId that is created") | ||
| private String adminId; | ||
|
|
||
| public LinkDomainToLdapResponse(long domainId, String type, String name, short accountType) { | ||
| this.domainId = domainId; | ||
| this.name = name; | ||
| this.type = type; | ||
| this.accountType = accountType; | ||
| } | ||
|
|
||
| public long getDomainId() { | ||
| return domainId; | ||
| } | ||
|
|
||
| public String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| public String getType() { | ||
| return type; | ||
| } | ||
|
|
||
| public short getAccountType() { | ||
| return accountType; | ||
| } | ||
|
|
||
| public String getAdminId() { | ||
| return adminId; | ||
| } | ||
|
|
||
| public void setAdminId(String adminId) { | ||
| this.adminId = adminId; | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
linkDomainToAdmin() and createUserAccount() involves DB updates. Shouldn't it be in a tx? What if the first call succeeds and the second call fails?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it is ok for the first call to succeed and the second to fail. for example if the username already exists, it will fail. I will check if tx is required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if user doesn't exist but still createUserAccount() fails?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
createUserAccount can fail and that doesnt mean api failure. When it is successful, the new id is returned in response. check fs for sample request response in different scenarios.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The api semantics doesn't seem right here. It is ok for createUserAccount to fail if the user exists but in that case the response should have the UUID of the existing account. Also if the user doesn't exist but still the call fails then the entire API should fail, a tx would help in this case. The semantics should be if optional admin user parameter is specified then the admin UUID should always be present in the response in case of success otherwise the API call should return failure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will see if I can change that later. For now, it will as documented in FS which is, it returns created account id when the account can be created. Otherwise, the information on why it failed to create the account will be in logs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the semantic aspect of the API will be revisited as part of CLOUDSTACK-8796, for now the changes are ok.