All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.opensearch.commons.authuser.User Maven / Gradle / Ivy
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/
package org.opensearch.commons.authuser;
import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import org.apache.http.util.EntityUtils;
import org.opensearch.client.Response;
import org.opensearch.common.Nullable;
import org.opensearch.common.inject.internal.ToStringBuilder;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.xcontent.XContentHelper;
import org.opensearch.common.xcontent.json.JsonXContent;
import org.opensearch.commons.ConfigConstants;
import org.opensearch.core.common.Strings;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.core.common.io.stream.Writeable;
import org.opensearch.core.xcontent.ToXContent;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.core.xcontent.XContentParser;
/**
* Gets current Authenticated User - name, odfe roles.
* If security-plugin is not installed or disabled, it returns empty for user name and roles.
*/
final public class User implements Writeable, ToXContent {
// field name in toXContent
public static final String NAME_FIELD = "name";
public static final String BACKEND_ROLES_FIELD = "backend_roles";
public static final String ROLES_FIELD = "roles";
public static final String CUSTOM_ATTRIBUTE_NAMES_FIELD = "custom_attribute_names";
public static final String REQUESTED_TENANT_FIELD = "user_requested_tenant";
private final String name;
private final List backendRoles;
private final List roles;
private final List customAttNames;
@Nullable
private final String requestedTenant;
public User() {
name = "";
backendRoles = new ArrayList<>();
roles = new ArrayList<>();
customAttNames = new ArrayList<>();
requestedTenant = null;
}
public User(final String name, final List backendRoles, List roles, List customAttNames) {
this.name = name;
this.backendRoles = backendRoles;
this.roles = roles;
this.customAttNames = customAttNames;
this.requestedTenant = null;
}
public User(
final String name,
final List backendRoles,
final List roles,
final List customAttNames,
@Nullable final String requestedTenant
) {
this.name = name;
this.backendRoles = backendRoles;
this.roles = roles;
this.customAttNames = customAttNames;
this.requestedTenant = requestedTenant;
}
/**
* Reponse of "GET /_opendistro/_security/authinfo"
* @param response
* @throws IOException
*/
public User(final Response response) throws IOException {
this(EntityUtils.toString(response.getEntity()));
}
@SuppressWarnings("unchecked")
public User(String json) {
if (Strings.isNullOrEmpty(json)) {
throw new IllegalArgumentException("Response json cannot be null");
}
Map mapValue = XContentHelper.convertToMap(JsonXContent.jsonXContent, json, false);
name = (String) mapValue.get("user_name");
backendRoles = (List) mapValue.get("backend_roles");
roles = (List) mapValue.get("roles");
customAttNames = (List) mapValue.get("custom_attribute_names");
requestedTenant = (String) mapValue.getOrDefault("user_requested_tenant", null);
}
public User(StreamInput in) throws IOException {
name = in.readString();
backendRoles = in.readStringList();
roles = in.readStringList();
customAttNames = in.readStringList();
requestedTenant = in.readOptionalString();
}
public static User parse(XContentParser parser) throws IOException {
String name = "";
List backendRoles = new ArrayList<>();
List roles = new ArrayList<>();
List customAttNames = new ArrayList<>();
String requestedTenant = null;
ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
String fieldName = parser.currentName();
parser.nextToken();
switch (fieldName) {
case NAME_FIELD:
name = parser.text();
break;
case BACKEND_ROLES_FIELD:
ensureExpectedToken(XContentParser.Token.START_ARRAY, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
backendRoles.add(parser.text());
}
break;
case ROLES_FIELD:
ensureExpectedToken(XContentParser.Token.START_ARRAY, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
roles.add(parser.text());
}
break;
case CUSTOM_ATTRIBUTE_NAMES_FIELD:
ensureExpectedToken(XContentParser.Token.START_ARRAY, parser.currentToken(), parser);
while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
customAttNames.add(parser.text());
}
break;
case REQUESTED_TENANT_FIELD:
requestedTenant = parser.textOrNull();
break;
default:
break;
}
}
return new User(name, backendRoles, roles, customAttNames, requestedTenant);
}
/**
* User String format must be pipe separated as : user_name|backendrole1,backendrole2|roles1,role2
* @param userString
* @return
*/
public static User parse(final String userString) {
if (Strings.isNullOrEmpty(userString)) {
return null;
}
String[] strs = userString.split("\\|");
if ((strs.length == 0) || (Strings.isNullOrEmpty(strs[0]))) {
return null;
}
String userName = strs[0].trim();
List backendRoles = new ArrayList<>();
List roles = new ArrayList<>();
String requestedTenant = null;
if ((strs.length > 1) && !Strings.isNullOrEmpty(strs[1])) {
backendRoles.addAll(Arrays.asList(strs[1].split(",")));
}
if ((strs.length > 2) && !Strings.isNullOrEmpty(strs[2])) {
roles.addAll(Arrays.asList(strs[2].split(",")));
}
if ((strs.length > 3) && !Strings.isNullOrEmpty(strs[3])) {
requestedTenant = strs[3].trim();
}
return new User(userName, backendRoles, roles, Arrays.asList(), requestedTenant);
}
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder
.startObject()
.field(NAME_FIELD, name)
.field(BACKEND_ROLES_FIELD, backendRoles)
.field(ROLES_FIELD, roles)
.field(CUSTOM_ATTRIBUTE_NAMES_FIELD, customAttNames)
.field(REQUESTED_TENANT_FIELD, requestedTenant);
return builder.endObject();
}
@Override
public void writeTo(StreamOutput out) throws IOException {
out.writeString(name);
out.writeStringCollection(backendRoles);
out.writeStringCollection(roles);
out.writeStringCollection(customAttNames);
out.writeOptionalString(requestedTenant);
}
@Override
public String toString() {
ToStringBuilder builder = new ToStringBuilder(this.getClass());
builder.add(NAME_FIELD, name);
builder.add(BACKEND_ROLES_FIELD, backendRoles);
builder.add(ROLES_FIELD, roles);
builder.add(CUSTOM_ATTRIBUTE_NAMES_FIELD, customAttNames);
builder.add(REQUESTED_TENANT_FIELD, requestedTenant);
return builder.toString();
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof User)) {
return false;
}
User that = (User) obj;
return this.name.equals(that.name)
&& this.getBackendRoles().equals(that.backendRoles)
&& this.getRoles().equals(that.roles)
&& this.getCustomAttNames().equals(that.customAttNames)
&& (Objects.equals(this.requestedTenant, that.requestedTenant));
}
public String getName() {
return name;
}
public List getBackendRoles() {
return backendRoles;
}
public List getRoles() {
return roles;
}
public List getCustomAttNames() {
return customAttNames;
}
@Nullable
public String getRequestedTenant() {
return requestedTenant;
}
public boolean isAdminDn(Settings settings) {
if (settings == null) {
return false;
}
List adminDns = settings.getAsList(ConfigConstants.OPENSEARCH_SECURITY_AUTHCZ_ADMIN_DN, Collections.emptyList());
return adminDns.contains(this.name);
}
}
