Add OAuth2AuthenticatedPrincipal.getNameAttributeKey

Author: andreblanke

oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/DefaultOAuth2AuthenticatedPrincipal.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -64,7 +64,7 @@ public DefaultOAuth2AuthenticatedPrincipal(String name, Map<String, Object> attr
 		this.attributes = Collections.unmodifiableMap(attributes);
 		this.authorities = (authorities != null) ? Collections.unmodifiableCollection(authorities)
 				: AuthorityUtils.NO_AUTHORITIES;
-		this.name = (name != null) ? name : (String) this.attributes.get("sub");
+		this.name = (name != null) ? name : (String) this.attributes.get(this.getNameAttributeKey());
 	}
 
 	/**
@@ -81,6 +81,11 @@ public Collection<? extends GrantedAuthority> getAuthorities() {
 		return this.authorities;
 	}
 
+	@Override
+	public String getNameAttributeKey() {
+		return "sub";
+	}
+
 	@Override
 	public String getName() {
 		return this.name;

oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2AuthenticatedPrincipal.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -57,4 +57,11 @@ default <A> A getAttribute(String name) {
 	 */
 	Collection<? extends GrantedAuthority> getAuthorities();
 
+	/**
+	 * Get the key used to access the user's &quot;name&quot; from {@link #getAttributes()}
+	 * @return the key used to access the user's &quot;name&quot;
+	 * @since 6.4
+	 */
+	String getNameAttributeKey();
+
 }

oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/user/DefaultOAuth2User.java

@@ -94,6 +94,11 @@ public Map<String, Object> getAttributes() {
 		return this.attributes;
 	}
 
+	@Override
+	public String getNameAttributeKey() {
+		return this.nameAttributeKey;
+	}
+
 	private Set<GrantedAuthority> sortAuthorities(Collection<? extends GrantedAuthority> authorities) {
 		SortedSet<GrantedAuthority> sortedAuthorities = new TreeSet<>(
 				Comparator.comparing(GrantedAuthority::getAuthority));

oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/introspection/OAuth2IntrospectionAuthenticatedPrincipal.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -80,6 +80,11 @@ public Collection<? extends GrantedAuthority> getAuthorities() {
 		return this.delegate.getAuthorities();
 	}
 
+	@Override
+	public String getNameAttributeKey() {
+		return this.delegate.getNameAttributeKey();
+	}
+
 	@Override
 	public String getName() {
 		return this.delegate.getName();