org.wildfly.security.authz.RoleDecoder Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2015 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.
*/
package org.wildfly.security.authz;
import static org.wildfly.common.Assert.checkNotNullParam;
import java.util.HashSet;
/**
* A decoder to extract role information from an identity's attributes.
*
* @author David M. Lloyd
*/
@FunctionalInterface
public interface RoleDecoder {
/**
* A key whose value is the string "Roles", to provide a standard/default location at which roles may be found.
*/
String KEY_ROLES = "Roles";
/**
* A key whose value is the string "Source-Address". This is where the IP address of a remote
* client may be found.
*/
String KEY_SOURCE_ADDRESS = "Source-Address";
/**
* Decode the role set from the given authorization identity.
*
* @param authorizationIdentity the authorization identity (not {@code null})
* @return the role set (must not be {@code null})
*/
Roles decodeRoles(AuthorizationIdentity authorizationIdentity);
/**
* A role decoder which decodes no roles.
*/
RoleDecoder EMPTY = attributes -> Roles.NONE;
/**
* A role decoder which always decodes roles from the attribute called "Roles".
*/
RoleDecoder DEFAULT = simple(KEY_ROLES);
/**
* Create a simple role decoder which returns the values of the given attribute.
*
* @param attribute the attribute
* @return the roles
*/
static RoleDecoder simple(String attribute) {
return identity -> {
final Attributes.Entry entry = identity.getAttributes().get(attribute);
return entry.isEmpty() ? Roles.NONE : entry instanceof Attributes.SetEntry ? Roles.fromSet((Attributes.SetEntry) entry) : Roles.fromSet(new HashSet<>(entry));
};
}
/**
* Create an aggregate role decoder. Each role decoder is applied in order and the returned value is
* a union of the roles returned by each decoder.
*
* @param decoders the role decoders to apply (must not be {@code null} or contain {@code null} elements)
* @return the aggregate role decoder (not {@code null})
*/
static RoleDecoder aggregate(RoleDecoder... decoders) {
checkNotNullParam("decoders", decoders);
return identity -> {
Roles combinedRoles = Roles.NONE;
for (RoleDecoder decoder : decoders) {
combinedRoles = combinedRoles.or(decoder.decodeRoles(identity));
}
return combinedRoles;
};
}
}