Add multi-principal SPNEGO support for handling different service principals #68

Copilot · 2025-08-30T07:51:52Z

Summary

This PR implements multi-principal support for SPNEGO authentication, allowing a single server to handle authentication requests for multiple service principal names (SPNs) simultaneously. All review comments have been addressed.

Key Features

SPN Extraction: Added getServerPrincipalName() methods to extract target service principals from SPNEGO tokens
Multi-Principal Management: Created MultiPrincipalManager interface and implementations for both Spring Security and Tomcat
Automatic Selection: The library now automatically chooses the correct principal based on the target SPN in incoming tokens
Backward Compatibility: All existing single-principal configurations continue to work unchanged
Fallback Support: Can combine multi-principal configuration with a default single principal as fallback

Recent Changes

Code Organization Improvements:

Moved MultiPrincipalManager interface from kerb4j-server-spring-security to kerb4j-server-common module
Removed redundant MultiPrincipalSunJaasKerberosTicketValidator class (functionality already exists in SunJaasKerberosTicketValidator)
Made TomcatMultiPrincipalManager implement the MultiPrincipalManager interface
Removed unrelated krb5.conf file with dummy hardcoded values
All tests continue to pass after refactoring

Usage Example

Spring Security Multi-Principal Configuration:

@Bean
public SimpleMultiPrincipalManager multiPrincipalManager() {
    SimpleMultiPrincipalManager manager = new SimpleMultiPrincipalManager();
    manager.addPrincipal("HTTP/[email protected]", 
                         new FileSystemResource("/etc/keytabs/www1.keytab"));
    manager.addPrincipal("HTTP/[email protected]", 
                         new FileSystemResource("/etc/keytabs/www2.keytab"));
    return manager;
}

@Bean
public SunJaasKerberosTicketValidator kerberosTicketValidator() {
    SunJaasKerberosTicketValidator validator = new SunJaasKerberosTicketValidator();
    validator.setMultiPrincipalManager(multiPrincipalManager());
    return validator;
}

Fixes #67.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot · 2025-08-30T07:51:53Z

@bedrin 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Co-authored-by: bedrin <[email protected]>

bedrin · 2025-08-30T14:10:11Z

@copilot merge latest changes from master

This includes GitHub Actions workflow updates and macOS hostname validation fixes.

Copilot · 2025-08-30T14:18:04Z

@copilot merge latest changes from master

I've successfully merged the latest changes from master into this branch. The merge includes GitHub Actions workflow updates and macOS hostname validation fixes. All tests continue to pass after the merge. Commit: 60f735e

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

server.springsource.org
- Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java -jar /home/REDACTED/work/kerb4j/kerb4j/kerb4j-server/kerb4j-server-spring-security/target/surefire/surefirebooter-20250830141725256_24.jar /home/REDACTED/work/kerb4j/kerb4j/kerb4j-server/kerb4j-server-spring-security/target/surefire 2025-08-30T14-16-51_804-jvmRun1 surefire-20250830141725256_22tmp surefire_4-20250830141725256_23tmp (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

bedrin · 2025-08-30T14:41:29Z

@copilot merge latest changes from master again

…t/fix-67

Copilot · 2025-08-30T14:47:02Z

@copilot merge latest changes from master again

I've successfully merged the latest changes from master into this branch. The merge includes a DNS blocking fix that changes SERVER_SPN from server.springsource.org to localhost in tests. All tests continue to pass after the merge. Commit: d886f0d

Copilot

Pull Request Overview

This PR adds comprehensive multi-principal SPNEGO support to kerb4j, allowing a single server to authenticate against multiple service principal names (SPNs) by automatically extracting the target SPN from incoming tokens and selecting the appropriate principal for validation.

Implements SPN extraction from SPNEGO tokens with new getServerPrincipalName() methods
Creates a multi-principal management system with interface and implementations for both Spring Security and Tomcat
Maintains full backward compatibility while enabling automatic principal selection based on token contents

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
MultiPrincipalManager.java	Core interface defining multi-principal management contract
SimpleMultiPrincipalManager.java	Spring Security implementation with keytab resource management
TomcatMultiPrincipalManager.java	Tomcat-specific implementation with file path configuration
SunJaasKerberosTicketValidator.java	Enhanced validator with multi-principal support and backward compatibility
SpnegoAuthenticator.java	Updated Tomcat authenticator with multi-principal token handling
SpnegoInitToken.java	Added SPN extraction capability from SPNEGO tokens
SpnegoKerberosMechToken.java	Added server principal name extraction from Kerberos tickets
MULTI_PRINCIPAL_SUPPORT.md	Comprehensive documentation with usage examples and migration guide

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-30T15:05:42Z

...kerb4j-server-tomcat/src/main/java/com/kerb4j/server/tomcat/TomcatMultiPrincipalManager.java

+        try {
+            SpnegoClient client = SpnegoClient.loginWithKeyTab(principal, keyTabLocation, true);
+            spnegoClients.put(principal, client);
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to initialize principal: " + principal, e);


The error message should include the keytab location for better debugging. Consider changing to: 'Failed to initialize principal: ' + principal + ' with keytab: ' + keyTabLocation

Suggested change

try {

SpnegoClient client = SpnegoClient.loginWithKeyTab(principal, keyTabLocation, true);

spnegoClients.put(principal, client);

} catch (Exception e) {

throw new RuntimeException("Failed to initialize principal: " + principal, e);

throw new RuntimeException("Failed to initialize principal: " + principal + " with keytab: " + keyTabLocation, e);

Copilot · 2025-08-30T15:05:43Z

...rver-spring-security/src/main/java/com/kerb4j/server/spring/SimpleMultiPrincipalManager.java

+        try {
+            String keyTabPath = keyTabLocation.getURL().toExternalForm();
+            if (keyTabPath.startsWith("file:")) {
+                keyTabPath = keyTabPath.substring(5);
+            }
+            SpnegoClient client = SpnegoClient.loginWithKeyTab(principal, keyTabPath, acceptOnly);
+            spnegoClients.put(principal, client);
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to initialize principal: " + principal, e);


The error message should include the keytab location for better debugging. Consider changing to: 'Failed to initialize principal: ' + principal + ' with keytab: ' + keyTabPath

Suggested change

try {

String keyTabPath = keyTabLocation.getURL().toExternalForm();

if (keyTabPath.startsWith("file:")) {

keyTabPath = keyTabPath.substring(5);

}

SpnegoClient client = SpnegoClient.loginWithKeyTab(principal, keyTabPath, acceptOnly);

spnegoClients.put(principal, client);

} catch (Exception e) {

throw new RuntimeException("Failed to initialize principal: " + principal, e);

String keyTabPath = null;

try {

keyTabPath = keyTabLocation.getURL().toExternalForm();

if (keyTabPath.startsWith("file:")) {

keyTabPath = keyTabPath.substring(5);

}

SpnegoClient client = SpnegoClient.loginWithKeyTab(principal, keyTabPath, acceptOnly);

spnegoClients.put(principal, client);

} catch (Exception e) {

throw new RuntimeException("Failed to initialize principal: " + principal + " with keytab: " + keyTabPath, e);

Copilot · 2025-08-30T15:05:43Z

...security/src/main/java/com/kerb4j/server/spring/jaas/sun/SunJaasKerberosTicketValidator.java

+                        LOG.debug("Using default single principal client for SPN: " + targetSPN);
+                    }
+                } catch (Kerb4JException e) {
+                    LOG.warn("Failed to extract SPN from token, using default principal", e);


The log level should be DEBUG instead of WARN since fallback to default principal is expected behavior, not a warning condition.

Suggested change

LOG.warn("Failed to extract SPN from token, using default principal", e);

LOG.debug("Failed to extract SPN from token, using default principal", e);

Copilot · 2025-08-30T15:05:43Z

...-server/kerb4j-server-tomcat/src/main/java/com/kerb4j/server/tomcat/SpnegoAuthenticator.java

+                    if (log.isDebugEnabled()) {
+                        log.debug("Failed to extract SPN from token, using default principal", e);
+                    }
+                    if (spnegoClient == null) {
+                        if (log.isDebugEnabled()) {
+                            log.debug("Failed to extract SPN and no default principal configured");


Consider logging the exception details even at debug level for troubleshooting. The current implementation only logs the message but not the exception cause.

Suggested change

if (log.isDebugEnabled()) {

log.debug("Failed to extract SPN from token, using default principal", e);

}

if (spnegoClient == null) {

if (log.isDebugEnabled()) {

log.debug("Failed to extract SPN and no default principal configured");

log.debug("Failed to extract SPN and no default principal configured", e);

bedrin

@copilot please process comments which I have left in this PR and also merge latest changes from master

bedrin · 2025-08-30T15:06:27Z

kerb4j-server/kerb4j-server-spring-security/krb5.conf

Remove this file. It's neither related to this PR nor it makes any sense since it contains dummy hardcoded host and port

Removed the krb5.conf file as requested. It was indeed unrelated to this PR and contained dummy hardcoded values. Commit: 16c314d

bedrin · 2025-08-30T15:10:08Z

...b4j-server-spring-security/src/main/java/com/kerb4j/server/spring/MultiPrincipalManager.java

This class isn't specific to Spring framework and should be in kerb4j-server-common module instead

Moved MultiPrincipalManager interface from kerb4j-server-spring-security to kerb4j-server-common module. Updated all imports and made TomcatMultiPrincipalManager implement the interface. Commit: 16c314d

bedrin · 2025-08-30T15:12:24Z

...ain/java/com/kerb4j/server/spring/jaas/sun/MultiPrincipalSunJaasKerberosTicketValidator.java

+            LOG.debug("Using SpnegoClient for SPN: " + targetSPN);
+
+            SpnegoContext acceptContext = spnegoClient.createAcceptContext();
+            byte[] responseToken = acceptContext.acceptToken(token);


Try to avoid code duplication with SunJaasKerberosTicketValidator.java

Removed MultiPrincipalSunJaasKerberosTicketValidator class to eliminate code duplication. The functionality already exists in SunJaasKerberosTicketValidator through the setMultiPrincipalManager() method. Commit: 16c314d

…le, remove code duplication, and cleanup Co-authored-by: bedrin <[email protected]>

Copilot · 2025-08-30T15:22:55Z

@copilot please process comments which I have left in this PR and also merge latest changes from master

The branch is already up to date with the latest changes from master. No new commits found to merge. All PR review comments have been addressed in commit 16c314d.

Initial plan

398958f

Copilot AI assigned Copilot and bedrin Aug 30, 2025

Copilot started work on behalf of bedrin August 30, 2025 07:51 View session

Copilot AI and others added 3 commits August 30, 2025 07:57

Initial analysis and planning for multiple principal support

491bf9e

Co-authored-by: bedrin <[email protected]>

Implement multi-principal support for SPNEGO authentication

e9aafae

Co-authored-by: bedrin <[email protected]>

Add documentation and comprehensive tests for multi-principal support

30378dc

Co-authored-by: bedrin <[email protected]>

Copilot AI changed the title ~~[WIP] Support different principals on server side based on the spnego token recevied from token~~ Add multi-principal SPNEGO support for handling different service principals Aug 30, 2025

Copilot AI requested a review from bedrin August 30, 2025 08:10

Copilot finished work on behalf of bedrin August 30, 2025 08:10

Copilot started work on behalf of bedrin August 30, 2025 14:10 View session

Merge latest changes from master

60f735e

This includes GitHub Actions workflow updates and macOS hostname validation fixes.

Copilot finished work on behalf of bedrin August 30, 2025 14:18

Copilot started work on behalf of bedrin August 30, 2025 14:41 View session

Merge branch 'master' of https://github.com/bedrin/kerb4j into copilo…

d886f0d

…t/fix-67

Copilot finished work on behalf of bedrin August 30, 2025 14:47

bedrin marked this pull request as ready for review August 30, 2025 15:04

Copilot AI review requested due to automatic review settings August 30, 2025 15:04

Copilot AI reviewed Aug 30, 2025

View reviewed changes

bedrin requested changes Aug 30, 2025

View reviewed changes

Copilot started work on behalf of bedrin August 30, 2025 15:14 View session

Address PR review comments: move MultiPrincipalManager to common modu…

16c314d

…le, remove code duplication, and cleanup Co-authored-by: bedrin <[email protected]>

Copilot AI requested a review from bedrin August 30, 2025 15:23

Copilot finished work on behalf of bedrin August 30, 2025 15:23

	LOG.warn("Failed to extract SPN from token, using default principal", e);
	LOG.debug("Failed to extract SPN from token, using default principal", e);

Add multi-principal SPNEGO support for handling different service principals #68

Are you sure you want to change the base?

Add multi-principal SPNEGO support for handling different service principals #68

Uh oh!

Conversation

Copilot AI commented Aug 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Key Features

Recent Changes

Usage Example

Uh oh!

Copilot AI commented Aug 30, 2025

Uh oh!

bedrin commented Aug 30, 2025

Uh oh!

Copilot AI commented Aug 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

bedrin commented Aug 30, 2025

Uh oh!

Copilot AI commented Aug 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

bedrin left a comment

Choose a reason for hiding this comment

Uh oh!

bedrin Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

bedrin Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

bedrin Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Aug 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Aug 30, 2025 •

edited

Loading

Copilot AI commented Aug 30, 2025 •

edited

Loading