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

Jump to bottom

Logging revisited for version 2.1.x and GF7 #44

Merged
merged 2 commits into from
Apr 1, 2024
Merged

Logging revisited for version 2.1.x and GF7 #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
724c513
Improved logging
dmatej Mar 30, 2024
4124829
Exousia now uses System.Logger instead of JUL
dmatej Mar 31, 2024
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
87 changes: 45 additions & 42 deletions impl/src/main/java/org/glassfish/exousia/AuthorizationService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2023 Contributors to the Eclipse Foundation.
* Copyright (c) 2023, 2024 Contributors to the Eclipse Foundation.
* Copyright (c) 2019, 2021 OmniFaces. All rights reserved.
*
* This program and the accompanying materials are made available under the
Expand All @@ -17,11 +17,19 @@

package org.glassfish.exousia;

import static java.util.logging.Level.FINE;
import static java.util.logging.Level.SEVERE;
import static org.glassfish.exousia.constraints.transformer.ConstraintsToPermissionsTransformer.createResourceAndDataPermissions;
import static org.glassfish.exousia.permissions.RolesToPermissionsTransformer.createWebRoleRefPermission;
import jakarta.security.jacc.EJBMethodPermission;
import jakarta.security.jacc.EJBRoleRefPermission;
import jakarta.security.jacc.PolicyConfiguration;
import jakarta.security.jacc.PolicyConfigurationFactory;
import jakarta.security.jacc.PolicyContext;
import jakarta.security.jacc.PolicyContextException;
import jakarta.security.jacc.WebResourcePermission;
import jakarta.security.jacc.WebRoleRefPermission;
import jakarta.security.jacc.WebUserDataPermission;
import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpServletRequest;

import java.lang.System.Logger;
import java.lang.reflect.Method;
import java.security.AccessController;
import java.security.CodeSource;
Expand All @@ -39,7 +47,6 @@
import java.util.Set;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.logging.Logger;

import javax.security.auth.Subject;

Expand All @@ -50,25 +57,18 @@
import org.glassfish.exousia.permissions.JakartaPermissions;
import org.glassfish.exousia.spi.PrincipalMapper;

import jakarta.security.jacc.EJBMethodPermission;
import jakarta.security.jacc.EJBRoleRefPermission;
import jakarta.security.jacc.PolicyConfiguration;
import jakarta.security.jacc.PolicyConfigurationFactory;
import jakarta.security.jacc.PolicyContext;
import jakarta.security.jacc.PolicyContextException;
import jakarta.security.jacc.WebResourcePermission;
import jakarta.security.jacc.WebRoleRefPermission;
import jakarta.security.jacc.WebUserDataPermission;
import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpServletRequest;
import static java.lang.System.Logger.Level.DEBUG;
import static java.lang.System.Logger.Level.ERROR;
import static org.glassfish.exousia.constraints.transformer.ConstraintsToPermissionsTransformer.createResourceAndDataPermissions;
import static org.glassfish.exousia.permissions.RolesToPermissionsTransformer.createWebRoleRefPermission;

/**
*
* @author Arjan Tijms
*/
public class AuthorizationService {

static final Logger logger = Logger.getLogger(AuthorizationService.class.getName());
private static final Logger LOG = System.getLogger(AuthorizationService.class.getName());

private static final boolean isSecMgrOff = System.getSecurityManager() == null;

Expand Down Expand Up @@ -367,7 +367,7 @@ public void commitPolicy() {
// If this is not true, the call to commit will not result in the correct
// policy statements being made available to the policy module.
policyConfiguration.commit();
logger.log(FINE, () -> "Jakarta Authorization: committed policy for context: " + contextId);
LOG.log(DEBUG, "Committed policy for context: {0}", contextId);
}

policy.refresh();
Expand All @@ -378,15 +378,16 @@ public void commitPolicy() {

public static void commitPolicy(String contextId) {
try {
if (!PolicyConfigurationFactory.getPolicyConfigurationFactory().inService(contextId)) {
PolicyConfigurationFactory configurationFactory = PolicyConfigurationFactory.getPolicyConfigurationFactory();
if (!configurationFactory.inService(contextId)) {

// Note that it is presumed that the policyConfiguration exists, and that
// it is populated with the desired policy statements.
//
// If this is not true, the call to commit will not result in the correct
// policy statements being made available to the policy module.
PolicyConfigurationFactory.getPolicyConfigurationFactory().getPolicyConfiguration(contextId, false).commit();
logger.log(FINE, () -> "Jakarta Authorization: committed policy for context: " + contextId);
configurationFactory.getPolicyConfiguration(contextId, false).commit();
LOG.log(DEBUG, "Committed policy for context: {0}", contextId);
}

Policy.getPolicy().refresh();
Expand Down Expand Up @@ -479,11 +480,12 @@ public boolean checkBeanRoleRefPermission(String beanName, String role, Set<Prin

boolean isCallerInRole = checkPermissionScoped(ejbRoleRefPermission, principals);

logger.fine(() ->
"Authorization: checkBeanRoleRefPermission Result: " + isCallerInRole +
" EJBRoleRefPermission (Name) = " + ejbRoleRefPermission.getName() +
" (Action) = " + ejbRoleRefPermission.getActions() +
" (Codesource) = " + protectionDomainCreator.apply(principals).getCodeSource());
if (LOG.isLoggable(DEBUG)) {
LOG.log(DEBUG, "checkBeanRoleRefPermission result: {0} for"
+ " EJBRoleRefPermission[Name = {1}, Actions = {2}], Codesource = {3}",
isCallerInRole, ejbRoleRefPermission.getName(), ejbRoleRefPermission.getActions(),
protectionDomainCreator.apply(principals).getCodeSource());
}

return isCallerInRole;
}
Expand All @@ -493,10 +495,9 @@ public boolean checkBeanMethodPermission(String beanName, String methodInterface

boolean authorized = checkPermissionScoped(methodPermission, principals);

logger.fine(() ->
"Authorization: Access Control Decision Result: " + authorized +
" EJBMethodPermission (Name) = " + methodPermission.getName() +
" (Action) = " + methodPermission.getActions());
LOG.log(DEBUG,
"Authorization: Access Control Decision result: {0} for EJBMethodPermission[Name = {1}, Actions = {2}]",
authorized, methodPermission.getName(), methodPermission.getActions());

return authorized;
}
Expand Down Expand Up @@ -524,7 +525,7 @@ public void deletePolicy() {
}

} catch (PolicyContextException pce) {
throw new IllegalStateException(pce.toString());
throw new IllegalStateException(pce);
}
}

Expand All @@ -543,32 +544,36 @@ public static void deletePolicy(String contextId) {
}

} catch (PolicyContextException | ClassNotFoundException pce) {
throw new IllegalStateException(pce.toString());
throw new IllegalStateException(pce);
}
}


boolean checkPermission(Permission permissionToBeChecked) {
LOG.log(DEBUG, "checkPermission(permissionToBeChecked={0})", permissionToBeChecked);
return policy.implies(emptyProtectionDomain, permissionToBeChecked);
}

boolean checkPermission(Permission permissionToBeChecked, Set<Principal> principals) {
LOG.log(DEBUG, "checkPermission(permissionToBeChecked={0}, principals={1})",
new Object[] {permissionToBeChecked, principals});
return policy.implies(newProtectionDomain(principals), permissionToBeChecked);
}

boolean checkPermissionScoped(Permission permissionToBeChecked, Set<Principal> principals) {
LOG.log(DEBUG, "checkPermission(permissionToBeChecked={0}, principals={1})",
new Object[] {permissionToBeChecked, principals});
String oldContextId = null;
try {
oldContextId = setThreadContextId(contextId);

return policy.implies(protectionDomainCreator.apply(principals), permissionToBeChecked);
} catch (Throwable t) {
logger.log(SEVERE, "jacc_is_caller_in_role_exception", t);
LOG.log(ERROR, "Unexpected security exception", t);
} finally {
try {
setPolicyContextChecked(oldContextId, contextId);
} catch (Throwable ex) {
logger.log(SEVERE, "jacc_policy_context_exception", ex);
LOG.log(ERROR, "Unexpected exception manipulating policy context", ex);
}
}

Expand Down Expand Up @@ -617,7 +622,7 @@ private ProtectionDomain newProtectionDomain(Set<Principal> principalSet) {
emptyCodeSource,
null,
null,
principalSet == null ? null : (Principal[]) principalSet.toArray(new Principal[0]));
principalSet == null ? null : principalSet.toArray(Principal[]::new));
}

private String getConstrainedURI(HttpServletRequest request) {
Expand Down Expand Up @@ -658,9 +663,7 @@ public static String setThreadContextId(String contextId) {

private static void setPolicyContextChecked(String newContextId, String oldContextId) {
if (newContextId != null && (oldContextId == null || !oldContextId.equals(newContextId))) {

logger.fine(() -> "Authorization: Changing Policy Context ID: oldContextId = " + oldContextId + " newContextId = " + newContextId);

LOG.log(DEBUG, "Changing Policy Context ID: oldContextId = {0}, newContextId = {1}", oldContextId, newContextId);
try {
doPrivileged(() -> PolicyContext.setContextID(newContextId));
} catch (Exception e) {
Expand All @@ -684,12 +687,12 @@ public static void doPrivileged(PrivilegedExceptionRunnable runnable) throws Exc
}

@FunctionalInterface
private static interface PrivilegedExceptionRunnable {
private interface PrivilegedExceptionRunnable {
void run() throws PrivilegedActionException;
}

@FunctionalInterface
public static interface ThrowableSupplier<T> {
public interface ThrowableSupplier<T> {
T get() throws Throwable;
}

Expand Down
21 changes: 14 additions & 7 deletions impl/src/main/java/org/glassfish/exousia/constraints/SecurityConstraint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/*
* Copyright (c) 2024 Contributors to the Eclipse Foundation.
* Copyright (c) 2019, 2020 OmniFaces. All rights reserved.
*
* This program and the accompanying materials are made available under the
Expand All @@ -13,20 +14,21 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/

package org.glassfish.exousia.constraints;

import static java.util.Arrays.asList;
import static java.util.Collections.unmodifiableList;
import static java.util.Collections.unmodifiableSet;
import static java.util.stream.Collectors.toList;
import static java.util.stream.Stream.concat;
import static jakarta.servlet.annotation.ServletSecurity.TransportGuarantee.NONE;
import jakarta.servlet.annotation.ServletSecurity.TransportGuarantee;

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

import jakarta.servlet.annotation.ServletSecurity.TransportGuarantee;
import static jakarta.servlet.annotation.ServletSecurity.TransportGuarantee.NONE;
import static java.util.Arrays.asList;
import static java.util.Collections.unmodifiableList;
import static java.util.Collections.unmodifiableSet;
import static java.util.stream.Collectors.toList;
import static java.util.stream.Stream.concat;

public class SecurityConstraint {

Expand Down Expand Up @@ -72,6 +74,11 @@ public Set<String> getRolesAllowed() {
return rolesAllowed;
}

@Override
public String toString() {
return getClass().getSimpleName() + "[webResourceCollections: " + getWebResourceCollections()
+ ", rolesAllowed: " + getRolesAllowed() + ", transportGuarantee: " + getTransportGuarantee() + "]";
}


// ### Static utility methods that work on constraints
Expand Down
8 changes: 7 additions & 1 deletion impl/src/main/java/org/glassfish/exousia/constraints/WebResourceCollection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/*
* Copyright (c) 2024 Contributors to the Eclipse Foundation.
* Copyright (c) 2019 OmniFaces. All rights reserved.
*
* This program and the accompanying materials are made available under the
Expand All @@ -13,6 +14,7 @@
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/

package org.glassfish.exousia.constraints;

import static java.util.Arrays.asList;
Expand Down Expand Up @@ -67,5 +69,9 @@ public Set<String> getHttpMethodOmissions() {
return httpMethodOmissions;
}


@Override
public String toString() {
return getClass().getSimpleName() + "[urlPatterns: " + getUrlPatterns() + ", httpMethods: " + getHttpMethods()
+ ", httpMethodOmmissions: " + getHttpMethodOmissions() + "]";
}
}
Loading