com.amazon.opendistroforelasticsearch.security.user.User Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opendistro_security Show documentation
Show all versions of opendistro_security Show documentation
Open Distro For Elasticsearch Security
/*
* Copyright 2015-2018 _floragunn_ GmbH
* Licensed 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.
*/
/*
* Portions Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* or in the "license" file accompanying this file. This file 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 com.amazon.opendistroforelasticsearch.security.user;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.io.stream.Writeable;
import com.google.common.collect.Lists;
/**
* A authenticated user and attributes associated to them (like roles, tenant, custom attributes)
*
* Do not subclass from this class!
*
*/
public class User implements Serializable, Writeable, CustomAttributesAware {
public static final User ANONYMOUS = new User("opendistro_security_anonymous", Lists.newArrayList("opendistro_security_anonymous_backendrole"), null);
private static final long serialVersionUID = -5500938501822658596L;
private final String name;
private final Set roles = new HashSet();
private String requestedTenant;
private Map attributes = new HashMap<>();
private boolean isInjected = false;
public User(final StreamInput in) throws IOException {
super();
name = in.readString();
roles.addAll(in.readList(StreamInput::readString));
requestedTenant = in.readString();
attributes = in.readMap(StreamInput::readString, StreamInput::readString);
}
/**
* Create a new authenticated user
*
* @param name The username (must not be null or empty)
* @param roles Roles of which the user is a member off (maybe null)
* @param customAttributes Custom attributes associated with this (maybe null)
* @throws IllegalArgumentException if name is null or empty
*/
public User(final String name, final Collection roles, final AuthCredentials customAttributes) {
super();
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("name must not be null or empty");
}
this.name = name;
if (roles != null) {
this.addRoles(roles);
}
if(customAttributes != null) {
this.attributes.putAll(customAttributes.getAttributes());
}
}
/**
* Create a new authenticated user without roles and attributes
*
* @param name The username (must not be null or empty)
* @throws IllegalArgumentException if name is null or empty
*/
public User(final String name) {
this(name, null, null);
}
public final String getName() {
return name;
}
/**
*
* @return A unmodifiable set of the roles this user is a member of
*/
public final Set getRoles() {
return Collections.unmodifiableSet(roles);
}
/**
* Associate this user with a role
*
* @param role The role
*/
public final void addRole(final String role) {
this.roles.add(role);
}
/**
* Associate this user with a set of roles
*
* @param roles The roles
*/
public final void addRoles(final Collection roles) {
if(roles != null) {
this.roles.addAll(roles);
}
}
/**
* Check if this user is a member of a role
*
* @param role The role
* @return true if this user is a member of the role, false otherwise
*/
public final boolean isUserInRole(final String role) {
return this.roles.contains(role);
}
/**
* Associate this user with a set of roles
*
* @param roles The roles
*/
public final void addAttributes(final Map attributes) {
if(attributes != null) {
this.attributes.putAll(attributes);
}
}
public final String getRequestedTenant() {
return requestedTenant;
}
public final void setRequestedTenant(String requestedTenant) {
this.requestedTenant = requestedTenant;
}
public boolean isInjected() {
return isInjected;
}
public void setInjected(boolean isInjected) {
this.isInjected = isInjected;
}
public final String toStringWithAttributes() {
return "User [name=" + name + ", roles=" + roles + ", requestedTenant=" + requestedTenant + ", attributes=" + attributes + "]";
}
@Override
public final String toString() {
return "User [name=" + name + ", roles=" + roles + ", requestedTenant=" + requestedTenant + "]";
}
@Override
public final int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + (name == null ? 0 : name.hashCode());
return result;
}
@Override
public final boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final User other = (User) obj;
if (name == null) {
if (other.name != null) {
return false;
}
} else if (!name.equals(other.name)) {
return false;
}
return true;
}
/**
* Copy all roles from another user
*
* @param user The user from which the roles should be copied over
*/
public final void copyRolesFrom(final User user) {
if(user != null) {
this.addRoles(user.getRoles());
}
}
@Override
public void writeTo(StreamOutput out) throws IOException {
out.writeString(name);
out.writeStringCollection(new ArrayList(roles));
out.writeString(requestedTenant);
out.writeMap(attributes, StreamOutput::writeString, StreamOutput::writeString);
}
/**
* Get the custom attributes associated with this user
*
* @return A modifiable map with all the current custom attributes associated with this user
*/
public synchronized final Map getCustomAttributesMap() {
if(attributes == null) {
attributes = new HashMap<>();
}
return attributes;
}
}