[java-oidc-common] branch dev/JCOMOIDC-66 updated: Remove unnecessary interface. Cleanup definitions and annotations
Phil Smart
philip.smart at jisc.ac.uk
Wed Mar 29 16:39:11 UTC 2023
This is an automated email from the git hooks/post-receive script.
philsmart pushed a commit to branch dev/JCOMOIDC-66
in repository java-oidc-common.
View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=bb4b43fa9b759d4b71d8f24f6b6501af2a5e6c41
The following commit(s) were added to refs/heads/dev/JCOMOIDC-66 by this push:
new bb4b43f Remove unnecessary interface. Cleanup definitions and annotations
bb4b43f is described below
commit bb4b43fa9b759d4b71d8f24f6b6501af2a5e6c41
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Wed Mar 29 17:39:08 2023 +0100
Remove unnecessary interface. Cleanup definitions and annotations
---
.../OIDCAuthenticationProfileConfiguration.java | 6 +--
.../config/OIDCAuthorizationConfiguration.java | 21 +++++---
.../OIDCIDTokenProducingProfileConfiguration.java | 3 +-
.../config/OIDCSSOProfileConfiguration.java | 4 +-
.../profile/config/OIDCUserInfoConfiguration.java | 2 +-
.../navigate/EncodedAttributesLookupFunction.java | 8 +--
.../OAuth2AuthorizationProfileConfiguration.java | 4 +-
...th2ClientAuthenticableProfileConfiguration.java | 2 +-
.../oauth2/config/OAuth2TokenConfiguration.java | 10 ++--
.../OAuth2TokenEndpointProfileConfiguration.java | 59 ----------------------
.../config/OAuth2TokenRevocationConfiguration.java | 4 +-
11 files changed, 35 insertions(+), 88 deletions(-)
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthenticationProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthenticationProfileConfiguration.java
index c0187de..787241f 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthenticationProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthenticationProfileConfiguration.java
@@ -55,7 +55,7 @@ public interface OIDCAuthenticationProfileConfiguration extends OAuth2Authorizat
*
* @since 2.2.0
*/
- @Nullable public Function<Collection<String>,Collection<Principal>>
+ @Nullable Function<Collection<String>,Collection<Principal>>
getAuthenticationMethodsReferencesTranslationStrategy(@Nullable final ProfileRequestContext prc);
/**
@@ -68,7 +68,7 @@ public interface OIDCAuthenticationProfileConfiguration extends OAuth2Authorizat
*
* @since 2.2.0
*/
- @Nullable public Function<Collection<String>,Collection<Principal>>
+ @Nullable Function<Collection<String>,Collection<Principal>>
getAuthenticationContextClassReferenceTranslationStrategy(@Nullable final ProfileRequestContext prc);
/**
@@ -80,7 +80,7 @@ public interface OIDCAuthenticationProfileConfiguration extends OAuth2Authorizat
*
* @since 2.2.0
*/
- @Nullable public String getLoginHint(@Nullable final ProfileRequestContext profileRequestContext);
+ @Nullable @NotEmpty String getLoginHint(@Nullable final ProfileRequestContext profileRequestContext);
/**
* Get the max authentication age.
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthorizationConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthorizationConfiguration.java
index 865a4dd..31b40f1 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthorizationConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthorizationConfiguration.java
@@ -27,7 +27,6 @@ import org.opensaml.profile.context.ProfileRequestContext;
import net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration;
import net.shibboleth.idp.profile.config.OverriddenIssuerProfileConfiguration;
import net.shibboleth.oidc.profile.oauth2.config.OAuth2AuthorizationCodeProducingProfileConfiguration;
-import net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenEndpointProfileConfiguration;
import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
@@ -41,8 +40,7 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
*/
public interface OIDCAuthorizationConfiguration extends OIDCAuthenticationProfileConfiguration,
OAuth2AuthorizationCodeProducingProfileConfiguration, AuthenticationProfileConfiguration,
- OverriddenIssuerProfileConfiguration, OAuth2TokenEndpointProfileConfiguration,
- OIDCSSOProviderConfiguration {
+ OverriddenIssuerProfileConfiguration, OIDCSSOProviderConfiguration {
/** ID for this profile configuration. */
@Nonnull @NotEmpty public static final String PROFILE_ID = "http://shibboleth.net/ns/profiles/oidc/sso/browser";
@@ -63,7 +61,7 @@ public interface OIDCAuthorizationConfiguration extends OIDCAuthenticationProfil
*
* @return whether to encode consent in authorization code and access/refresh tokens
*/
- public boolean isEncodeConsentInTokens(@Nullable final ProfileRequestContext profileRequestContext);
+ boolean isEncodeConsentInTokens(@Nullable final ProfileRequestContext profileRequestContext);
/**
* Get the set of attribute IDs which should be omitted from the UserInfo token.
@@ -75,7 +73,7 @@ public interface OIDCAuthorizationConfiguration extends OIDCAuthenticationProfil
*
* @return the attribute IDs to omit from UserInfo token
*/
- @Nonnull @NonnullElements @NotLive public Set<String> getDeniedUserInfoAttributes(
+ @Nonnull @NonnullElements @NotLive Set<String> getDeniedUserInfoAttributes(
@Nullable final ProfileRequestContext profileRequestContext);
/**
@@ -88,7 +86,18 @@ public interface OIDCAuthorizationConfiguration extends OIDCAuthenticationProfil
* @since 2.1.0
*
*/
- public boolean isIncludeIssuerInResponse(@Nullable final ProfileRequestContext profileRequestContext);
+ boolean isIncludeIssuerInResponse(@Nullable final ProfileRequestContext profileRequestContext);
+
+ /**
+ * Get the set of attribute IDs which should be encoded in encrypted form into the authorization code
+ * and/or access/refresh tokens to enable recovery on the back-channel.
+ *
+ * @param profileRequestContext profile request context
+ *
+ * @return the attribute IDs to encode
+ */
+ @Nonnull @NonnullElements @NotLive Set<String> getEncodedAttributes(
+ @Nullable final ProfileRequestContext profileRequestContext);
}
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCIDTokenProducingProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCIDTokenProducingProfileConfiguration.java
index d2ca4ac..e7b410f 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCIDTokenProducingProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCIDTokenProducingProfileConfiguration.java
@@ -56,8 +56,7 @@ public interface OIDCIDTokenProducingProfileConfiguration extends OIDCProfileCon
*
* @since 2.1.0
*/
- @Nonnull
- public BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>> getIDTokenManipulationStrategy(
+ @Nonnull BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>> getIDTokenManipulationStrategy(
@Nullable final ProfileRequestContext profileRequestContext);
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCSSOProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCSSOProfileConfiguration.java
index 834cdc6..f736abc 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCSSOProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCSSOProfileConfiguration.java
@@ -37,7 +37,7 @@ public interface OIDCSSOProfileConfiguration extends OIDCProfileConfiguration {
*
* @return whether client is required to use PKCE
*/
- public boolean isForcePKCE(@Nullable final ProfileRequestContext profileRequestContext);
+ boolean isForcePKCE(@Nullable final ProfileRequestContext profileRequestContext);
/**
* Get whether client is allowed to use PKCE code challenge method plain.
@@ -46,7 +46,7 @@ public interface OIDCSSOProfileConfiguration extends OIDCProfileConfiguration {
*
* @return whether client is allowed to use PKCE code challenge method plain
*/
- public boolean isAllowPKCEPlain(@Nullable final ProfileRequestContext profileRequestContext);
+ boolean isAllowPKCEPlain(@Nullable final ProfileRequestContext profileRequestContext);
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCUserInfoConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCUserInfoConfiguration.java
index 49013e5..457228d 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCUserInfoConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCUserInfoConfiguration.java
@@ -52,7 +52,7 @@ public interface OIDCUserInfoConfiguration extends AttributeResolvingProfileConf
*
* @return the attribute IDs to omit from UserInfo token
*/
- @Nonnull @NonnullElements @NotLive public Set<String> getDeniedUserInfoAttributes(
+ @Nonnull @NonnullElements @NotLive Set<String> getDeniedUserInfoAttributes(
@Nullable final ProfileRequestContext profileRequestContext);
}
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/EncodedAttributesLookupFunction.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/EncodedAttributesLookupFunction.java
index 71bf251..b6bd03d 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/EncodedAttributesLookupFunction.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/EncodedAttributesLookupFunction.java
@@ -26,11 +26,11 @@ import org.opensaml.profile.context.ProfileRequestContext;
import net.shibboleth.idp.profile.config.ProfileConfiguration;
import net.shibboleth.idp.profile.context.RelyingPartyContext;
import net.shibboleth.idp.profile.context.navigate.AbstractRelyingPartyLookupFunction;
-import net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenEndpointProfileConfiguration;
+import net.shibboleth.oidc.profile.config.OIDCAuthorizationConfiguration;
/**
* A function that obtains
- * {@link OAuth2TokenEndpointProfileConfiguration#getEncodedAttributes(ProfileRequestContext)}
+ * {@link OIDCAuthorizationConfiguration#getEncodedAttributes(ProfileRequestContext)}
* if such a profile is available from a {@link RelyingPartyContext} obtained via a lookup function,
* by default a child of the {@link ProfileRequestContext}.
*
@@ -45,8 +45,8 @@ public class EncodedAttributesLookupFunction
final RelyingPartyContext rpc = getRelyingPartyContextLookupStrategy().apply(input);
if (rpc != null) {
final ProfileConfiguration pc = rpc.getProfileConfig();
- if (pc instanceof OAuth2TokenEndpointProfileConfiguration) {
- return ((OAuth2TokenEndpointProfileConfiguration)pc).getEncodedAttributes(input);
+ if (pc instanceof OIDCAuthorizationConfiguration) {
+ return ((OIDCAuthorizationConfiguration)pc).getEncodedAttributes(input);
}
}
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AuthorizationProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AuthorizationProfileConfiguration.java
index 1c29508..ba997eb 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AuthorizationProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AuthorizationProfileConfiguration.java
@@ -67,7 +67,7 @@ public interface OAuth2AuthorizationProfileConfiguration {
*
* @return the HTTP request method
*/
- public HttpRequestMethod getHttpRequestMethod(@Nullable final ProfileRequestContext profileRequestContext);
+ @Nullable HttpRequestMethod getHttpRequestMethod(@Nullable final ProfileRequestContext profileRequestContext);
/**
@@ -79,7 +79,7 @@ public interface OAuth2AuthorizationProfileConfiguration {
*
* @since 2.2.0
*/
- public String getResponseMode(@Nullable final ProfileRequestContext profileRequestContext);
+ @Nullable @NotEmpty String getResponseMode(@Nullable final ProfileRequestContext profileRequestContext);
/**
* Get the response_type to use for authorization requests.
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2ClientAuthenticableProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2ClientAuthenticableProfileConfiguration.java
index ef07d19..62e7c63 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2ClientAuthenticableProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2ClientAuthenticableProfileConfiguration.java
@@ -45,7 +45,7 @@ public interface OAuth2ClientAuthenticableProfileConfiguration
*
* @since 3.1.0
*/
- @Nullable public ClaimsValidator getClaimsValidator(@Nullable final ProfileRequestContext profileRequestContext);
+ @Nullable ClaimsValidator getClaimsValidator(@Nullable final ProfileRequestContext profileRequestContext);
/**
* Get the enabled token endpoint authentication methods.
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenConfiguration.java
index 53c6010..728ad1f 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenConfiguration.java
@@ -61,8 +61,7 @@ public interface OAuth2TokenConfiguration extends OIDCSSOProviderConfiguration {
*
* @since 2.1.0
*/
- @Nonnull
- public boolean isEnforceRefreshTokenRotation(
+ boolean isEnforceRefreshTokenRotation(
@Nullable final ProfileRequestContext profileRequestContext);
/**
@@ -74,9 +73,8 @@ public interface OAuth2TokenConfiguration extends OIDCSSOProviderConfiguration {
*
* @since 2.1.0
*/
- @Nonnull
- BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>>
- getRefreshTokenClaimsSetManipulationStrategy(
- @Nullable final ProfileRequestContext profileRequestContext);
+ // TODO: move to OAuth2RefreshTokenProducingProfileConfiguration in 3.0.0
+ @Nonnull BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>>
+ getRefreshTokenClaimsSetManipulationStrategy(@Nullable final ProfileRequestContext profileRequestContext);
}
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenEndpointProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenEndpointProfileConfiguration.java
deleted file mode 100644
index 0f82586..0000000
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenEndpointProfileConfiguration.java
+++ /dev/null
@@ -1,59 +0,0 @@
-/*
- * Licensed to the University Corporation for Advanced Internet Development,
- * Inc. (UCAID) under one or more contributor license agreements. See the
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You 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 net.shibboleth.oidc.profile.oauth2.config;
-
-import java.util.Set;
-
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
-import org.opensaml.profile.context.ProfileRequestContext;
-
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
-import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
-import net.shibboleth.utilities.java.support.annotation.constraint.Unmodifiable;
-
-/** Profile configuration common to generic token endpoints.*/
-public interface OAuth2TokenEndpointProfileConfiguration extends OAuth2ProfileConfiguration {
-
-
- /**
- * Get the set of attribute IDs which should be encoded in encrypted form into the authorization code
- * and/or access/refresh tokens to enable recovery on the back-channel.
- *
- * @param profileRequestContext profile request context
- *
- * @return the attribute IDs to encode
- */
- @Nonnull @NonnullElements @NotLive Set<String> getEncodedAttributes(
- @Nullable final ProfileRequestContext profileRequestContext);
-
-
- /**
- * Get the enabled token endpoint authentication methods.
- *
- * @param profileRequestContext profile request context
- *
- * @return enabled token endpoint authentication methods
- */
- @Nonnull @NonnullElements @NotLive @Unmodifiable Set<String> getTokenEndpointAuthMethods(
- @Nullable final ProfileRequestContext profileRequestContext);
-
-
-
-}
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenRevocationConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenRevocationConfiguration.java
index 0e566fe..cd6c412 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenRevocationConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenRevocationConfiguration.java
@@ -59,7 +59,7 @@ public interface OAuth2TokenRevocationConfiguration extends OAuth2TokenValidatin
*
* @since 2.1.0
*/
- public OAuth2TokenRevocationMethod getRevocationMethod(
+ OAuth2TokenRevocationMethod getRevocationMethod(
@Nullable final ProfileRequestContext profileRequestContext);
/**
@@ -74,6 +74,6 @@ public interface OAuth2TokenRevocationConfiguration extends OAuth2TokenValidatin
* @since 2.1.0
*/
@Positive @Nonnull
- public Duration getRevocationLifetime(@Nullable final ProfileRequestContext profileRequestContext);
+ Duration getRevocationLifetime(@Nullable final ProfileRequestContext profileRequestContext);
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list