Skip to content
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.

Sign up for GitHub

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

RANGER-5036: checkstyle compliance updates - knox-agent #502

Merged
merged 3 commits into from
Jan 7, 2025
Merged

RANGER-5036: checkstyle compliance updates - knox-agent #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc7cc37
RANGER-5036: checkstyle compliance updates - knox-agent
spolavarpau1 Jan 7, 2025
8bfa61a
Update RangerPDPKnoxFilter.java
kumaab Jan 7, 2025
b686eb6
RANGER-5036: checkstyle compliance updates - knox-agent
mneethiraj Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions knox-agent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
<name>Knox Security Plugin</name>
<description>Knox Security Plugins</description>
<properties>
<checkstyle.failOnViolation>true</checkstyle.failOnViolation>
<checkstyle.skip>false</checkstyle.skip>
<knox.jetty.version>9.4.51.v20230217</knox.jetty.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
Expand Down
2,263 changes: 1,132 additions & 1,131 deletions knox-agent/src/main/java/org/apache/ranger/admin/client/RangerAdminJersey2RESTClient.java
View file
Open in desktop

Large diffs are not rendered by default.

214 changes: 113 additions & 101 deletions knox-agent/src/main/java/org/apache/ranger/authorization/knox/KnoxRangerPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@

package org.apache.ranger.authorization.knox;

import java.util.List;
import java.util.Set;

import org.apache.ranger.authorization.knox.KnoxRangerPlugin.KnoxConstants.AccessType;
import org.apache.ranger.authorization.knox.KnoxRangerPlugin.KnoxConstants.PluginConfiguration;
import org.apache.ranger.authorization.knox.KnoxRangerPlugin.KnoxConstants.ResourceName;
Expand All @@ -31,104 +28,119 @@
import org.apache.ranger.plugin.policyengine.RangerAccessResourceImpl;
import org.apache.ranger.plugin.service.RangerBasePlugin;

import java.util.List;
import java.util.Set;

public class KnoxRangerPlugin extends RangerBasePlugin {
boolean initialized;

public KnoxRangerPlugin() {
super(PluginConfiguration.ServiceType, PluginConfiguration.AuditApplicationType);
}

// must be synchronized so that accidental double init of plugin does not happen .. in case servlet instantiates multiple filters.
@Override
public synchronized void init() {
if (!initialized) {
// mandatory call to base plugin
super.init();
// One time call to register the audit hander with the policy engine.
super.setResultProcessor(new RangerDefaultAuditHandler(getConfig()));
initialized = true;
}
}

public static class RequestBuilder {
String service;
String topology;
String user;
Set<String> groups;
String clientIp;
String remoteIp;
List<String> forwardedAddresses;

RequestBuilder service(String service) {
this.service = service;
return this;
}

RequestBuilder topology(String topology) {
this.topology = topology;
return this;
}

RequestBuilder user(String user) {
this.user = user;
return this;
}

RequestBuilder groups(Set<String> groups) {
this.groups = groups;
return this;
}

RequestBuilder clientIp(String clientIp) {
this.clientIp = clientIp;
return this;
}

RequestBuilder remoteIp(String remoteIp) {
this.remoteIp = remoteIp;
return this;
}

RequestBuilder forwardedAddresses(List<String> forwardedAddresses) {
this.forwardedAddresses = forwardedAddresses;
return this;
}

void verifyBuildable() {
if (topology == null) {
throw new IllegalStateException("_topology can't be null!");
}
if (service == null) {
throw new IllegalStateException("_service can't be null!");
}
if (user == null) {
throw new IllegalStateException("_user can't be null!");
}
}

RangerAccessRequest build() {
// build resource
RangerAccessResourceImpl resource = new RangerAccessResourceImpl();
resource.setValue(ResourceName.Service, service);
resource.setValue(ResourceName.Topology, topology);
// build request
RangerAccessRequestImpl request = new RangerAccessRequestImpl();
request.setAction(AccessType.Allow);
request.setAccessType(AccessType.Allow);
request.setClientIPAddress(clientIp);
request.setUser(user);
request.setUserGroups(groups);
request.setResource(resource);
request.setRemoteIPAddress(remoteIp);
request.setForwardedAddresses(forwardedAddresses);
return request;
}
}

public static class KnoxConstants {
// Plugin parameters
static class PluginConfiguration {
static final String ServiceType = "knox";
static final String AuditApplicationType = "knox";
}

// must match the corresponding string used in service definition file
static class ResourceName {
static final String Topology = "topology";
static final String Service = "service";
}

boolean initialized = false;
public KnoxRangerPlugin() {
super(PluginConfiguration.ServiceType, PluginConfiguration.AuditApplicationType);
}

// must be synchronized so that accidental double init of plugin does not happen .. in case servlet instantiates multiple filters.
@Override
synchronized public void init() {
if (!initialized) {
// mandatory call to base plugin
super.init();
// One time call to register the audit hander with the policy engine.
super.setResultProcessor(new RangerDefaultAuditHandler(getConfig()));
initialized = true;
}
}

public static class RequestBuilder {
String _service;
String _topology;
String _user;
Set<String> _groups;
String _clientIp;
String _remoteIp;
List<String> _forwardedAddresses;

RequestBuilder service(String service) {
_service = service;
return this;
}
RequestBuilder topology(String topology) {
_topology = topology;
return this;
}
RequestBuilder user(String user) {
_user = user;
return this;
}
RequestBuilder groups(Set<String> groups) {
_groups = groups;
return this;
}
RequestBuilder clientIp(String clientIp) {
_clientIp = clientIp;
return this;
}
RequestBuilder remoteIp(String remoteIp) {
_remoteIp = remoteIp;
return this;
}
RequestBuilder forwardedAddresses(List<String> forwardedAddresses) {
_forwardedAddresses = forwardedAddresses;
return this;
}
void verifyBuildable() {
if (_topology == null) throw new IllegalStateException("_topology can't be null!");
if (_service == null) throw new IllegalStateException("_service can't be null!");
if (_user == null) throw new IllegalStateException("_user can't be null!");
}

RangerAccessRequest build() {
// build resource
RangerAccessResourceImpl resource = new RangerAccessResourceImpl();
resource.setValue(ResourceName.Service, _service);
resource.setValue(ResourceName.Topology, _topology);
// build request
RangerAccessRequestImpl request = new RangerAccessRequestImpl();
request.setAction(AccessType.Allow);
request.setAccessType(AccessType.Allow);
request.setClientIPAddress(_clientIp);
request.setUser(_user);
request.setUserGroups(_groups);
request.setResource(resource);
request.setRemoteIPAddress(_remoteIp);
request.setForwardedAddresses(_forwardedAddresses);
return request;
}
}

public static class KnoxConstants {

// Plugin parameters
static class PluginConfiguration {
static final String ServiceType = "knox";
static final String AuditApplicationType = "knox";
}

// must match the corresponding string used in service definition file
static class ResourceName {
static final String Topology = "topology";
static final String Service = "service";
}

// must match the corresponding string used in service definition file
static class AccessType {
static final String Allow = "allow";
}
}
// must match the corresponding string used in service definition file
static class AccessType {
static final String Allow = "allow";
}
}
}
Loading
Loading