-
Notifications
You must be signed in to change notification settings - Fork 1.2k
import network acl rules using csv #12013
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sudo87
wants to merge
3
commits into
apache:4.22
Choose a base branch
from
shapeblue:importACL
base: 4.22
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+695
−9
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
133 changes: 133 additions & 0 deletions
133
api/src/main/java/org/apache/cloudstack/api/command/user/network/ImportNetworkACLCmd.java
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,133 @@ | ||
| // 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.user.network; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import org.apache.cloudstack.api.APICommand; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.ApiErrorCode; | ||
| import org.apache.cloudstack.api.BaseAsyncCmd; | ||
| import org.apache.cloudstack.api.Parameter; | ||
| import org.apache.cloudstack.api.ServerApiException; | ||
| import org.apache.cloudstack.api.response.ListResponse; | ||
| import org.apache.cloudstack.api.response.NetworkACLItemResponse; | ||
| import org.apache.cloudstack.api.response.NetworkACLResponse; | ||
| import org.apache.cloudstack.context.CallContext; | ||
| import org.apache.commons.collections.MapUtils; | ||
|
|
||
| import com.cloud.event.EventTypes; | ||
| import com.cloud.exception.ResourceUnavailableException; | ||
| import com.cloud.network.vpc.NetworkACLItem; | ||
| import com.cloud.user.Account; | ||
|
|
||
| @APICommand(name = "importNetworkACL", description = "Imports network ACL rules.", | ||
| responseObject = NetworkACLItemResponse.class, | ||
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) | ||
| public class ImportNetworkACLCmd extends BaseAsyncCmd { | ||
|
|
||
| // /////////////////////////////////////////////////// | ||
| // ////////////// API parameters ///////////////////// | ||
| // /////////////////////////////////////////////////// | ||
|
|
||
| @Parameter( | ||
| name = ApiConstants.ACL_ID, | ||
| type = CommandType.UUID, | ||
| entityType = NetworkACLResponse.class, | ||
| required = true, | ||
| description = "The ID of the network ACL to which the rules will be imported", | ||
| since = "4.22.0" | ||
| ) | ||
| private Long aclId; | ||
|
|
||
| @Parameter(name = ApiConstants.RULES, type = CommandType.MAP, required = true, | ||
| description = "Rules param list, id and protocol are must. Example: " + | ||
| "rules[0].id=101&rules[0].protocol=tcp&rules[0].traffictype=ingress&rules[0].state=active&rules[0].cidrlist=192.168.1.0/24" + | ||
| "&rules[0].tags=web&rules[0].aclid=acl-001&rules[0].aclname=web-acl&rules[0].number=1&rules[0].action=allow&rules[0].fordisplay=true" + | ||
| "&rules[0].description=allow%20web%20traffic&rules[1].id=102&rules[1].protocol=udp&rules[1].traffictype=egress&rules[1].state=enabled" + | ||
| "&rules[1].cidrlist=10.0.0.0/8&rules[1].tags=db&rules[1].aclid=acl-002&rules[1].aclname=db-acl&rules[1].number=2&rules[1].action=deny" + | ||
| "&rules[1].fordisplay=false&rules[1].description=deny%20database%20traffic", | ||
| since = "4.22.0") | ||
| private Map rules; | ||
|
|
||
|
|
||
| // /////////////////////////////////////////////////// | ||
| // ///////////////// Accessors /////////////////////// | ||
| // /////////////////////////////////////////////////// | ||
|
|
||
| // Returns map, corresponds to a rule with the details in the keys: | ||
| // id, protocol, startport, endport, traffictype, state, cidrlist, tags, aclid, aclname, number, action, fordisplay, description | ||
| public Map getRules() { | ||
| return rules; | ||
| } | ||
|
|
||
| public Long getAclId() { | ||
| return aclId; | ||
| } | ||
|
|
||
| // /////////////////////////////////////////////////// | ||
| // ///////////// API Implementation/////////////////// | ||
| // /////////////////////////////////////////////////// | ||
|
|
||
|
|
||
| @Override | ||
| public void execute() throws ResourceUnavailableException { | ||
| validateParams(); | ||
| List<NetworkACLItem> importedRules = _networkACLService.importNetworkACLRules(this); | ||
| ListResponse<NetworkACLItemResponse> response = new ListResponse<>(); | ||
| List<NetworkACLItemResponse> aclResponse = new ArrayList<>(); | ||
| for (NetworkACLItem acl : importedRules) { | ||
| NetworkACLItemResponse ruleData = _responseGenerator.createNetworkACLItemResponse(acl); | ||
| aclResponse.add(ruleData); | ||
| } | ||
| response.setResponses(aclResponse, importedRules.size()); | ||
| response.setResponseName(getCommandName()); | ||
| setResponseObject(response); | ||
| } | ||
|
|
||
| @Override | ||
| public long getEntityOwnerId() { | ||
| Account account = CallContext.current().getCallingAccount(); | ||
| if (account != null) { | ||
| return account.getId(); | ||
| } | ||
| return Account.ACCOUNT_ID_SYSTEM; | ||
| } | ||
|
|
||
| @Override | ||
| public String getEventType() { | ||
| return EventTypes.EVENT_NETWORK_ACL_CREATE; | ||
| } | ||
|
|
||
| @Override | ||
| public String getEventDescription() { | ||
| return "Importing ACL rules for ACL ID: " + getAclId(); | ||
| } | ||
|
|
||
|
|
||
| private void validateParams() { | ||
| if(MapUtils.isEmpty(rules)) { | ||
| throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Rules parameter is empty or null"); | ||
| } | ||
|
|
||
| if (getAclId() == null || _networkACLService.getNetworkACL(getAclId()) == null) { | ||
| throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Unable to find network ACL with provided aclid"); | ||
| } | ||
| } | ||
| } |
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.
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.
this is very confusing to a user. the reason is probably because a rule already existed and it is counterintuitive to not allow it. We might add a flag allowing overwriting it.