Skip to content

Commit

Permalink
HDDS-4917.[FSO]Implement ACL requests for new layout (#2024)
Browse files Browse the repository at this point in the history
  • Loading branch information
sadanand48 committed Mar 15, 2021
1 parent 752fe7c commit dc843b9
Show file tree
Hide file tree
Showing 10 changed files with 845 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1698,12 +1698,16 @@ public List<OzoneAcl> getAcl(OzoneObj obj) throws IOException {
String volume = obj.getVolumeName();
String bucket = obj.getBucketName();
String keyName = obj.getKeyName();

OmKeyInfo keyInfo;
metadataManager.getLock().acquireReadLock(BUCKET_LOCK, volume, bucket);
try {
validateBucket(volume, bucket);
String objectKey = metadataManager.getOzoneKey(volume, bucket, keyName);
OmKeyInfo keyInfo = metadataManager.getKeyTable().get(objectKey);
if (OzoneManagerRatisUtils.isBucketFSOptimized()) {
keyInfo = getOmKeyInfoV1(volume, bucket, keyName);
} else {
keyInfo = getOmKeyInfo(volume, bucket, keyName);
}
if (keyInfo == null) {
throw new OMException("Key not found. Key:" + objectKey, KEY_NOT_FOUND);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,11 @@
import org.apache.hadoop.ozone.om.request.key.OMKeysRenameRequest;
import org.apache.hadoop.ozone.om.request.key.OMTrashRecoverRequest;
import org.apache.hadoop.ozone.om.request.key.acl.OMKeyAddAclRequest;
import org.apache.hadoop.ozone.om.request.key.acl.OMKeyAddAclRequestV1;
import org.apache.hadoop.ozone.om.request.key.acl.OMKeyRemoveAclRequest;
import org.apache.hadoop.ozone.om.request.key.acl.OMKeyRemoveAclRequestV1;
import org.apache.hadoop.ozone.om.request.key.acl.OMKeySetAclRequest;
import org.apache.hadoop.ozone.om.request.key.acl.OMKeySetAclRequestV1;
import org.apache.hadoop.ozone.om.request.key.acl.prefix.OMPrefixAddAclRequest;
import org.apache.hadoop.ozone.om.request.key.acl.prefix.OMPrefixRemoveAclRequest;
import org.apache.hadoop.ozone.om.request.key.acl.prefix.OMPrefixSetAclRequest;
Expand Down Expand Up @@ -234,6 +237,9 @@ private static OMClientRequest getOMAclRequest(OMRequest omRequest) {
} else if (ObjectType.BUCKET == type) {
return new OMBucketAddAclRequest(omRequest);
} else if (ObjectType.KEY == type) {
if (isBucketFSOptimized()){
return new OMKeyAddAclRequestV1(omRequest);
}
return new OMKeyAddAclRequest(omRequest);
} else {
return new OMPrefixAddAclRequest(omRequest);
Expand All @@ -245,6 +251,9 @@ private static OMClientRequest getOMAclRequest(OMRequest omRequest) {
} else if (ObjectType.BUCKET == type) {
return new OMBucketRemoveAclRequest(omRequest);
} else if (ObjectType.KEY == type) {
if (isBucketFSOptimized()){
return new OMKeyRemoveAclRequestV1(omRequest);
}
return new OMKeyRemoveAclRequest(omRequest);
} else {
return new OMPrefixRemoveAclRequest(omRequest);
Expand All @@ -256,6 +265,9 @@ private static OMClientRequest getOMAclRequest(OMRequest omRequest) {
} else if (ObjectType.BUCKET == type) {
return new OMBucketSetAclRequest(omRequest);
} else if (ObjectType.KEY == type) {
if (isBucketFSOptimized()){
return new OMKeySetAclRequestV1(omRequest);
}
return new OMKeySetAclRequest(omRequest);
} else {
return new OMPrefixSetAclRequest(omRequest);
Expand Down
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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.hadoop.ozone.om.request.key.acl;

import com.google.common.base.Optional;
import org.apache.hadoop.hdds.utils.db.Table;
import org.apache.hadoop.hdds.utils.db.cache.CacheKey;
import org.apache.hadoop.hdds.utils.db.cache.CacheValue;
import org.apache.hadoop.ozone.om.OMMetadataManager;
import org.apache.hadoop.ozone.om.OzoneManager;
import org.apache.hadoop.ozone.om.exceptions.OMException;
import org.apache.hadoop.ozone.om.helpers.OmDirectoryInfo;
import org.apache.hadoop.ozone.om.helpers.OmKeyInfo;
import org.apache.hadoop.ozone.om.helpers.OzoneFileStatus;
import org.apache.hadoop.ozone.om.ratis.utils.OzoneManagerDoubleBufferHelper;
import org.apache.hadoop.ozone.om.request.file.OMFileRequest;
import org.apache.hadoop.ozone.om.request.util.ObjectParser;
import org.apache.hadoop.ozone.om.response.OMClientResponse;
import org.apache.hadoop.ozone.om.response.key.acl.OMKeyAclResponseV1;
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos;
import org.apache.hadoop.ozone.security.acl.IAccessAuthorizer;
import org.apache.hadoop.ozone.security.acl.OzoneObj;

import java.io.IOException;
import java.util.Map;

import static org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes.KEY_NOT_FOUND;
import static org.apache.hadoop.ozone.om.lock.OzoneManagerLock.Resource.BUCKET_LOCK;


/**
* Handles key ACL requests layout version V1.
*/
public abstract class OMKeyAclRequestV1 extends OMKeyAclRequest {

public OMKeyAclRequestV1(OzoneManagerProtocolProtos.OMRequest omRequest) {
super(omRequest);
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
long trxnLogIndex, OzoneManagerDoubleBufferHelper omDoubleBufferHelper) {
OmKeyInfo omKeyInfo = null;

OzoneManagerProtocolProtos.OMResponse.Builder omResponse = onInit();
OMClientResponse omClientResponse = null;
IOException exception = null;

OMMetadataManager omMetadataManager = ozoneManager.getMetadataManager();
boolean lockAcquired = false;
String volume = null;
String bucket = null;
String key = null;
boolean operationResult = false;
Result result = null;
try {
ObjectParser objectParser = new ObjectParser(getPath(),
OzoneManagerProtocolProtos.OzoneObj.ObjectType.KEY);

volume = objectParser.getVolume();
bucket = objectParser.getBucket();
key = objectParser.getKey();

// check Acl
if (ozoneManager.getAclsEnabled()) {
checkAcls(ozoneManager, OzoneObj.ResourceType.VOLUME,
OzoneObj.StoreType.OZONE, IAccessAuthorizer.ACLType.WRITE_ACL,
volume, bucket, key);
}
lockAcquired = omMetadataManager.getLock()
.acquireWriteLock(BUCKET_LOCK, volume, bucket);
OzoneFileStatus keyStatus = OMFileRequest
.getOMKeyInfoIfExists(omMetadataManager, volume, bucket, key, 0);
if (keyStatus == null) {
throw new OMException("Key not found. Key:" + key, KEY_NOT_FOUND);
}
omKeyInfo = keyStatus.getKeyInfo();
String dbKey = omKeyInfo.getPath();
boolean isDirectory = keyStatus.isDirectory();
operationResult = apply(omKeyInfo, trxnLogIndex);
omKeyInfo.setUpdateID(trxnLogIndex, ozoneManager.isRatisEnabled());

// Update the modification time when updating ACLs of Key.
long modificationTime = omKeyInfo.getModificationTime();
if (getOmRequest().getAddAclRequest().hasObj() && operationResult) {
modificationTime =
getOmRequest().getAddAclRequest().getModificationTime();
} else if (getOmRequest().getSetAclRequest().hasObj()) {
modificationTime =
getOmRequest().getSetAclRequest().getModificationTime();
} else if (getOmRequest().getRemoveAclRequest().hasObj()
&& operationResult) {
modificationTime =
getOmRequest().getRemoveAclRequest().getModificationTime();
}
omKeyInfo.setModificationTime(modificationTime);

// update cache.
if (isDirectory) {
Table<String, OmDirectoryInfo> dirTable =
omMetadataManager.getDirectoryTable();
dirTable.addCacheEntry(new CacheKey<>(dbKey),
new CacheValue<>(Optional.of(OMFileRequest.
getDirectoryInfo(omKeyInfo)), trxnLogIndex));
} else {
omMetadataManager.getKeyTable().addCacheEntry(new CacheKey<>(dbKey),
new CacheValue<>(Optional.of(omKeyInfo), trxnLogIndex));
}
omClientResponse =
onSuccess(omResponse, omKeyInfo, operationResult, isDirectory);
result = Result.SUCCESS;
} catch (IOException ex) {
result = Result.FAILURE;
exception = ex;
omClientResponse = onFailure(omResponse, ex);
} finally {
addResponseToDoubleBuffer(trxnLogIndex, omClientResponse,
omDoubleBufferHelper);
if (lockAcquired) {
omMetadataManager.getLock()
.releaseWriteLock(BUCKET_LOCK, volume, bucket);
}
}

OzoneObj obj = getObject();
Map<String, String> auditMap = obj.toAuditMap();
onComplete(result, operationResult, exception, trxnLogIndex,
ozoneManager.getAuditLogger(), auditMap);

return omClientResponse;
}

/**
* Get the om client response on failure case with lock.
*
* @param omResponse
* @param exception
* @return OMClientResponse
*/
@Override OMClientResponse onFailure(
OzoneManagerProtocolProtos.OMResponse.Builder omResponse,
IOException exception) {
return new OMKeyAclResponseV1(createErrorOMResponse(omResponse, exception));
}

abstract OMClientResponse onSuccess(
OzoneManagerProtocolProtos.OMResponse.Builder omResponse,
OmKeyInfo omKeyInfo, boolean operationResult, boolean isDirectory);

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
/**
* 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.hadoop.ozone.om.request.key.acl;

import com.google.common.collect.Lists;
import org.apache.hadoop.ozone.OzoneAcl;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.hadoop.ozone.audit.AuditLogger;
import org.apache.hadoop.ozone.audit.OMAction;
import org.apache.hadoop.ozone.om.OzoneManager;
import org.apache.hadoop.ozone.om.helpers.OmKeyInfo;
import org.apache.hadoop.ozone.om.ratis.utils.OzoneManagerDoubleBufferHelper;
import org.apache.hadoop.ozone.om.request.util.OmResponseUtil;
import org.apache.hadoop.ozone.om.response.OMClientResponse;
import org.apache.hadoop.ozone.om.response.key.acl.OMKeyAclResponse;
import org.apache.hadoop.ozone.om.response.key.acl.OMKeyAclResponseV1;
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos;
import org.apache.hadoop.ozone.security.acl.OzoneObj;
import org.apache.hadoop.ozone.security.acl.OzoneObjInfo;
import org.apache.hadoop.util.Time;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.List;
import java.util.Map;

/**
* Handle add Acl request for bucket for layout version V1.
*/
public class OMKeyAddAclRequestV1 extends OMKeyAclRequestV1 {

private static final Logger LOG =
LoggerFactory.getLogger(OMKeyAddAclRequestV1.class);

@Override public OzoneManagerProtocolProtos.OMRequest preExecute(
OzoneManager ozoneManager) throws IOException {
long modificationTime = Time.now();
OzoneManagerProtocolProtos.AddAclRequest.Builder addAclRequestBuilder =
getOmRequest().getAddAclRequest().toBuilder()
.setModificationTime(modificationTime);

return getOmRequest().toBuilder().setAddAclRequest(addAclRequestBuilder)
.setUserInfo(getUserInfo()).build();
}

private String path;
private List<OzoneAcl> ozoneAcls;
private OzoneObj obj;

public OMKeyAddAclRequestV1(OzoneManagerProtocolProtos.OMRequest omRequest) {
super(omRequest);
OzoneManagerProtocolProtos.AddAclRequest addAclRequest =
getOmRequest().getAddAclRequest();
obj = OzoneObjInfo.fromProtobuf(addAclRequest.getObj());
path = obj.getPath();
ozoneAcls =
Lists.newArrayList(OzoneAcl.fromProtobuf(addAclRequest.getAcl()));
}

@Override String getPath() {
return path;
}

@Override OzoneObj getObject() {
return obj;
}

@Override OzoneManagerProtocolProtos.OMResponse.Builder onInit() {
return OmResponseUtil.getOMResponseBuilder(getOmRequest());
}

@Override OMClientResponse onSuccess(
OzoneManagerProtocolProtos.OMResponse.Builder omResponse,
OmKeyInfo omKeyInfo, boolean operationResult) {
omResponse.setSuccess(operationResult);
omResponse.setAddAclResponse(
OzoneManagerProtocolProtos.AddAclResponse.newBuilder()
.setResponse(operationResult));
return new OMKeyAclResponse(omResponse.build(), omKeyInfo);
}

@Override void onComplete(Result result, boolean operationResult,
IOException exception, long trxnLogIndex, AuditLogger auditLogger,
Map<String, String> auditMap) {
switch (result) {
case SUCCESS:
if (LOG.isDebugEnabled()) {
if (operationResult) {
LOG.debug("Add acl: {} to path: {} success!", ozoneAcls, path);
} else {
LOG.debug("Acl {} already exists in path {}", ozoneAcls, path);
}
}
break;
case FAILURE:
LOG.error("Add acl {} to path {} failed!", ozoneAcls, path, exception);
break;
default:
LOG.error("Unrecognized Result for OMKeyAddAclRequest: {}",
getOmRequest());
}

if (ozoneAcls != null) {
auditMap.put(OzoneConsts.ACL, ozoneAcls.toString());
}
auditLog(auditLogger,
buildAuditMessage(OMAction.ADD_ACL, auditMap, exception,
getOmRequest().getUserInfo()));
}

@Override boolean apply(OmKeyInfo omKeyInfo, long trxnLogIndex) {
// No need to check not null here, this will be never called with null.
return omKeyInfo.addAcl(ozoneAcls.get(0));
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
long trxnLogIndex, OzoneManagerDoubleBufferHelper omDoubleBufferHelper) {
ozoneManager.getMetrics().incNumAddAcl();
return super.validateAndUpdateCache(ozoneManager, trxnLogIndex,
omDoubleBufferHelper);
}

@Override OMClientResponse onSuccess(
OzoneManagerProtocolProtos.OMResponse.Builder omResponse,
OmKeyInfo omKeyInfo, boolean operationResult, boolean isDirectory) {
omResponse.setSuccess(operationResult);
omResponse.setAddAclResponse(
OzoneManagerProtocolProtos.AddAclResponse.newBuilder()
.setResponse(operationResult));
return new OMKeyAclResponseV1(omResponse.build(), omKeyInfo, isDirectory);
}
}
Loading

0 comments on commit dc843b9

Please sign in to comment.