[java-oidc-common] branch main updated: Fix Javadoc, add missing annotations
Phil Smart
philip.smart at jisc.ac.uk
Fri Feb 10 16:09:47 UTC 2023
This is an automated email from the git hooks/post-receive script.
philsmart pushed a commit to branch main
in repository java-oidc-common.
View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=a79c37a8fb295797df359a097e4d2faa5b6a71ad
The following commit(s) were added to refs/heads/main by this push:
new a79c37a Fix Javadoc, add missing annotations
a79c37a is described below
commit a79c37a8fb295797df359a097e4d2faa5b6a71ad
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Fri Feb 10 16:09:42 2023 +0000
Fix Javadoc, add missing annotations
---
.../jwa/algorithm/descriptors/SignaturePS256.java | 2 +
.../jwa/algorithm/descriptors/SignaturePS384.java | 2 +
.../jwa/algorithm/descriptors/SignaturePS512.java | 2 +
.../credential/BasicNimbusSecretCredential.java | 2 +
.../credential/ClientSecretCredential.java | 2 +
.../credential/DefaultClientSecretCredential.java | 2 +
.../security/jose/DecryptionConfiguration.java | 2 +-
.../oidc/security/jose/DecryptionParameters.java | 2 +-
.../security/jose/EncryptionConfiguration.java | 2 +-
.../security/jose/SignatureSigningParameters.java | 2 +-
.../jose/SignatureValidationConfiguration.java | 2 +-
.../jose/SignatureValidationParameters.java | 2 +-
.../jose/context/SecurityParametersContext.java | 2 +-
.../criterion/ClientSecretCredentialCriterion.java | 2 +-
.../DecryptionConfigurationCriterion.java | 2 +-
.../jose/criterion/JOSEObjectCriterion.java | 2 +-
.../security/jose/criterion/KeyIdCriterion.java | 6 +--
.../jose/criterion/ProviderMetadataCriterion.java | 2 +-
.../BasicClientSecretCredentialFactoryBean.java | 2 +
...piringJWTSharedSecretCredentialFactoryBean.java | 6 ++-
.../impl/BasicJWKCredentialFactoryBean.java | 6 ++-
.../ClientSecretCriterionCredentialResolver.java | 2 +-
.../impl/DataEncryptionAlgorithmCriterion.java | 4 +-
.../impl/EvaluableKeyIDCredentialCriterion.java | 2 +
...AbstractEncryptionAlgorithmsLookupStrategy.java | 2 +
.../impl/BaseJWTSignatureSecurityHandler.java | 4 +-
.../security/impl/BaseSignedJWTTrustEngine.java | 2 +
.../impl/ClientInformationJWTTrustEngine.java | 2 +
.../oidc/security/impl/EncryptJWTHandler.java | 2 +-
.../impl/ExplicitKeySignedJWTTrustEngine.java | 2 +
.../security/impl/ExplicitKeyTrustEvaluator.java | 2 +
.../oidc/security/impl/JWETokenDecrypter.java | 2 +-
.../jose/impl/BasicDecryptionConfiguration.java | 2 +
.../jose/impl/BasicEncryptionConfiguration.java | 2 +
.../impl/BasicSignatureSigningConfiguration.java | 2 +
.../BasicSignatureSigningParametersResolver.java | 2 +
.../BasicSignatureValidationConfiguration.java | 2 +
...BasicSignatureValidationParametersResolver.java | 2 +
...aultDataEncryptionAlgorithmsLookupStrategy.java | 2 +
.../impl/DefaultEncryptionParametersResolver.java | 2 +
...ransportEncryptionAlgorithmsLookupStrategy.java | 2 +
.../shibboleth/oidc/profile/audit/AuditFields.java | 6 ++-
.../profile/config/CredentialsListFactory.java | 2 +
.../profile/config/JSONSecurityConfiguration.java | 2 +
.../config/OIDCAuthorizationConfiguration.java | 48 ++++++++++++++++++++++
...ClientInformationStringValueLookupFunction.java | 2 +-
.../profile/core/OAuthAuthorizationRequest.java | 4 ++
.../profile/core/OIDCAuthenticationRequest.java | 12 ++++++
...AuthenticationContextClassReferenceSupport.java | 2 +
.../oidc/profile/encoding/OIDCMessageEncoder.java | 2 +
.../oidc/profile/messaging/JSONErrorResponse.java | 6 ++-
.../profile/messaging/JSONSuccessResponse.java | 7 +++-
...bstractAuthenticationRequestAuditExtractor.java | 2 +
...stractAuthenticationResponseAuditExtractor.java | 2 +
.../encoding/impl/AbstractOIDCMessageEncoder.java | 2 +
.../impl/AbstractBuildErrorResponseFromEvent.java | 2 +
...AuthenticationRequestMessageEncoderFactory.java | 2 +
57 files changed, 176 insertions(+), 25 deletions(-)
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS256.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS256.java
index 753d3da..98f6fd8 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS256.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS256.java
@@ -27,6 +27,8 @@ import net.shibboleth.oidc.jwa.support.SignatureConstants;
/**
* Algorithm descriptor for signature algorithm: PS256.
+ *
+ * @since 2.2.0
*/
public final class SignaturePS256 implements SignatureAlgorithm {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS384.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS384.java
index 64f8703..810ddbb 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS384.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS384.java
@@ -27,6 +27,8 @@ import net.shibboleth.oidc.jwa.support.SignatureConstants;
/**
* Algorithm descriptor for signature algorithm: PS384.
+ *
+ * @since 2.2.0
*/
public final class SignaturePS384 implements SignatureAlgorithm {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS512.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS512.java
index 9fe2306..853435f 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS512.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/jwa/algorithm/descriptors/SignaturePS512.java
@@ -27,6 +27,8 @@ import net.shibboleth.oidc.jwa.support.SignatureConstants;
/**
* Algorithm descriptor for signature algorithm: PS512.
+ *
+ * @since 2.2.0
*/
public final class SignaturePS512 implements SignatureAlgorithm {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicNimbusSecretCredential.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicNimbusSecretCredential.java
index b3e5b07..30ec724 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicNimbusSecretCredential.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/BasicNimbusSecretCredential.java
@@ -24,6 +24,8 @@ import com.nimbusds.oauth2.sdk.auth.Secret;
/**
* A basic implementation of {@link NimbusSecretCredential}.
+ *
+ * @deprecated use {@link ClientSecretCredential}
*/
@Deprecated(since = "2.2.0", forRemoval=true)
public class BasicNimbusSecretCredential extends AbstractCredential implements NimbusSecretCredential {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ClientSecretCredential.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ClientSecretCredential.java
index 15d8b2a..1548bc0 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ClientSecretCredential.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ClientSecretCredential.java
@@ -32,6 +32,8 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
* signing and encryption.
*
* <p>Note, despite its name, this is not an opensaml {@link Credential} type.</p>
+ *
+ * @since 2.2.0
*/
public interface ClientSecretCredential {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/DefaultClientSecretCredential.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/DefaultClientSecretCredential.java
index 1af0841..7b424f6 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/DefaultClientSecretCredential.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/DefaultClientSecretCredential.java
@@ -37,6 +37,8 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
/**
* A basic implementation of {@link ClientSecretCredential}.
+ *
+ * @since 2.2.0
*/
@ThreadSafe
public class DefaultClientSecretCredential implements ClientSecretCredential {
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/DecryptionConfiguration.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/DecryptionConfiguration.java
index 31f9736..eddc165 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/DecryptionConfiguration.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/DecryptionConfiguration.java
@@ -24,7 +24,7 @@ import org.opensaml.xmlsec.AlgorithmPolicyConfiguration;
import net.shibboleth.oidc.security.credential.JOSEObjectCredentialResolver;
/**
- * The configuration information to use when decrypting encrypted JWEs.
+ * The configuration information to use when decrypting JWEs.
*
* @since 2.2.0
*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/DecryptionParameters.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/DecryptionParameters.java
index ace736d..883c47d 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/DecryptionParameters.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/DecryptionParameters.java
@@ -27,7 +27,7 @@ import net.shibboleth.oidc.security.credential.JOSEObjectCredentialResolver;
import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
/**
- * Describes the decryption parameters the system is required to used to decrypt a JWE.
+ * Describes the decryption parameters the system is required to use to decrypt a JWE.
*
* @since 2.2.0
*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/EncryptionConfiguration.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/EncryptionConfiguration.java
index d5be267..083d86e 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/EncryptionConfiguration.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/EncryptionConfiguration.java
@@ -30,7 +30,7 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
import net.shibboleth.utilities.java.support.annotation.constraint.Unmodifiable;
/**
- * The configuration information to use when generating an encrypted JWT.
+ * The configuration information to use when generating a JWE.
*
* @since 2.2.0
*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureSigningParameters.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureSigningParameters.java
index 5573221..c165437 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureSigningParameters.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureSigningParameters.java
@@ -22,7 +22,7 @@ import javax.annotation.Nullable;
import org.opensaml.security.credential.Credential;
/**
- * The effective parameters to use when generating a signed JWT.
+ * The effective parameters to use when generating a JWS.
*
* @since 2.2.0
*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureValidationConfiguration.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureValidationConfiguration.java
index 625b08a..c17a671 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureValidationConfiguration.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureValidationConfiguration.java
@@ -25,7 +25,7 @@ import org.opensaml.xmlsec.AlgorithmPolicyConfiguration;
import com.nimbusds.jwt.SignedJWT;
/**
- * The configuration information to use when validating a signed JWT.
+ * The configuration information to use when validating a JWS.
*
* @since 2.2.0
*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureValidationParameters.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureValidationParameters.java
index b589e0f..14f4d84 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureValidationParameters.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/SignatureValidationParameters.java
@@ -25,7 +25,7 @@ import org.opensaml.xmlsec.AlgorithmPolicyParameters;
import com.nimbusds.jwt.SignedJWT;
/**
- * The effective parameters to use when validating a signed JWT.
+ * The effective parameters to use when validating a JWS.
*
* @since 2.2.0
*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/context/SecurityParametersContext.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/context/SecurityParametersContext.java
index fe19f4d..ea526a9 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/context/SecurityParametersContext.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/context/SecurityParametersContext.java
@@ -28,7 +28,7 @@ import net.shibboleth.oidc.security.jose.SignatureSigningParameters;
import net.shibboleth.oidc.security.jose.SignatureValidationParameters;
/**
- * A context implementation for storing parameter instances for JWT signature signing and validation, and JWT
+ * A context implementation for storing parameter instances for JWS signature signing and validation, and JWE
* encryption and decryption.
*
* @since 2.2.0
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/ClientSecretCredentialCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/ClientSecretCredentialCriterion.java
index e537c5a..865b1a3 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/ClientSecretCredentialCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/ClientSecretCredentialCriterion.java
@@ -24,7 +24,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
- * A {@link Criterion} that holds a single, fixed, credential.
+ * A {@link Criterion} that holds a single, fixed, client_secret credential.
*
* @since 2.2.0
*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/DecryptionConfigurationCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/DecryptionConfigurationCriterion.java
index 9429309..d63b10d 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/DecryptionConfigurationCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/DecryptionConfigurationCriterion.java
@@ -30,7 +30,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
- * Criterion which holds one or more instances of {@link DecryptionConfiguration}.
+ * Criterion which holds one or more instances of a {@link DecryptionConfiguration}.
*
* @since 2.2.0
*/
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/JOSEObjectCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/JOSEObjectCriterion.java
index 9f64f08..f096cd2 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/JOSEObjectCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/JOSEObjectCriterion.java
@@ -32,7 +32,7 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
public final class JOSEObjectCriterion implements Criterion {
/** The JOSEObject which serves as the source for credential criteria. */
- private JOSEObject joseObject;
+ @Nullable private JOSEObject joseObject;
/**
* Constructor.
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/KeyIdCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/KeyIdCriterion.java
index 0cc177c..7f8208f 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/KeyIdCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/KeyIdCriterion.java
@@ -31,7 +31,7 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
*/
public class KeyIdCriterion implements Criterion {
- /** Key ID of resolved credentials. */
+ /** Expected key ID of resolved credentials. */
private String keyId;
/**
@@ -53,13 +53,13 @@ public class KeyIdCriterion implements Criterion {
}
/**
- * Set the key name criteria.
+ * Set the key ID criteria.
*
* @param id The keyId to set.
*/
public void setKeyId(@Nonnull final String id) {
final String trimmed = StringSupport.trimOrNull(id);
- Constraint.isNotNull(trimmed, "Key id criteria value cannot be null or empty");
+ Constraint.isNotNull(trimmed, "Key ID criteria value cannot be null or empty");
keyId = trimmed;
}
diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/ProviderMetadataCriterion.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/ProviderMetadataCriterion.java
index 78ccbee..22651cb 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/ProviderMetadataCriterion.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/jose/criterion/ProviderMetadataCriterion.java
@@ -31,7 +31,7 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
*/
public class ProviderMetadataCriterion implements Criterion {
- /** The OIDC provider metadata. */
+ /** The OpenID Provider metadata. */
@Nonnull private final OIDCProviderMetadata metadata;
/**
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicClientSecretCredentialFactoryBean.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicClientSecretCredentialFactoryBean.java
index 46bd2d6..3bc2d28 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicClientSecretCredentialFactoryBean.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicClientSecretCredentialFactoryBean.java
@@ -28,6 +28,8 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
/**
* Factory to generate a {@link ClientSecretCredential} from a client_secret string.
+ *
+ * @since 2.2.0
*/
public class BasicClientSecretCredentialFactoryBean
extends AbstractComponentAwareFactoryBean<DefaultClientSecretCredential> {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicExpiringJWTSharedSecretCredentialFactoryBean.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicExpiringJWTSharedSecretCredentialFactoryBean.java
index b7b6e05..fa8715f 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicExpiringJWTSharedSecretCredentialFactoryBean.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicExpiringJWTSharedSecretCredentialFactoryBean.java
@@ -39,7 +39,11 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.StringSupport;
-/** A factory bean for creating a {@link BasicExpiringJWKCredential} from the static secret injected.*/
+/**
+ * A factory bean for creating a {@link BasicExpiringJWKCredential} from an injected secret.
+ *
+ * @since 2.2.0
+ */
public class BasicExpiringJWTSharedSecretCredentialFactoryBean
extends AbstractCredentialFactoryBean<ExpiringJWKCredential> {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicJWKCredentialFactoryBean.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicJWKCredentialFactoryBean.java
index d59a0ac..19b60c3 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicJWKCredentialFactoryBean.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicJWKCredentialFactoryBean.java
@@ -43,7 +43,11 @@ import net.shibboleth.oidc.security.credential.BasicJWKCredential;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.logic.Constraint;
-/** factory bean for Basic JSON Web Keys (JWK). */
+/**
+ * Factory bean for Basic JSON Web Keys (JWK).
+ *
+ * @since 2.2.0
+ */
public class BasicJWKCredentialFactoryBean extends AbstractCredentialFactoryBean<BasicJWKCredential> {
/** Class logger. */
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientSecretCriterionCredentialResolver.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientSecretCriterionCredentialResolver.java
index 46da092..7088525 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientSecretCriterionCredentialResolver.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientSecretCriterionCredentialResolver.java
@@ -54,7 +54,7 @@ public class ClientSecretCriterionCredentialResolver extends BasicJOSEObjectCred
if (criteriaSet.contains(ClientSecretCredentialCriterion.class)) {
final ClientSecretCredentialCriterion credentialCriterion = criteriaSet.get(ClientSecretCredentialCriterion.class);
final ClientSecretCredential secretCred = credentialCriterion.getCredential();
- log.debug("Found client secret credential");
+ log.trace("Found client secret credential");
final Credential derivedCredential = deriveClientSecretCredential(secretCred, criteriaSet);
return derivedCredential != null ? List.of(derivedCredential) : Collections.emptyList();
} else {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/DataEncryptionAlgorithmCriterion.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/DataEncryptionAlgorithmCriterion.java
index c925fc9..afca686 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/DataEncryptionAlgorithmCriterion.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/DataEncryptionAlgorithmCriterion.java
@@ -8,7 +8,9 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
import net.shibboleth.utilities.java.support.resolver.Criterion;
/**
- * An implementation of {@link Criterion} which specifies content encryption algorithm criteria.
+ * An implementation of an {@link Criterion} which specifies content encryption algorithm criteria.
+ *
+ * @since 2.2.0
*/
public final class DataEncryptionAlgorithmCriterion implements Criterion {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/EvaluableKeyIDCredentialCriterion.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/EvaluableKeyIDCredentialCriterion.java
index 4bc4b8c..2cb697c 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/EvaluableKeyIDCredentialCriterion.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/EvaluableKeyIDCredentialCriterion.java
@@ -33,6 +33,8 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
/**
* Instance of evaluable credential criteria for evaluating credential key IDs.
+ *
+ * @since 2.2.0
*/
public class EvaluableKeyIDCredentialCriterion extends AbstractTriStatePredicate<Credential>
implements EvaluableCredentialCriterion {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/AbstractEncryptionAlgorithmsLookupStrategy.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/AbstractEncryptionAlgorithmsLookupStrategy.java
index 05c0667..2de75bc 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/AbstractEncryptionAlgorithmsLookupStrategy.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/AbstractEncryptionAlgorithmsLookupStrategy.java
@@ -34,6 +34,8 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
/**
* A base class for lookup strategies that return encryption algorithms and make use
* of the {@link AlgorithmRegistry}.
+ *
+ * @since 2.2.0
*/
public abstract class AbstractEncryptionAlgorithmsLookupStrategy
implements BiFunction<CriteriaSet, Predicate<String>, List<String>> {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/BaseJWTSignatureSecurityHandler.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/BaseJWTSignatureSecurityHandler.java
index 1c68ff7..bba35f0 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/BaseJWTSignatureSecurityHandler.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/BaseJWTSignatureSecurityHandler.java
@@ -61,6 +61,8 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* <li>(Optional) Client secret credentials.</li>
* <li>(Required) The SecurityParametersContext.</li>
* </ol>
+ *
+ * @since 2.2.0
*/
public abstract class BaseJWTSignatureSecurityHandler extends BaseTrustEngineSecurityHandler<SignedJWT> {
@@ -208,7 +210,7 @@ public abstract class BaseJWTSignatureSecurityHandler extends BaseTrustEngineSec
if (credential != null) {
criteriaSet.add(new ClientSecretCredentialCriterion(credential));
} else {
- log.trace("{} No credential found from the profile configuration", getLogPrefix());
+ log.trace("{} No client_secret credential found from the profile configuration", getLogPrefix());
}
}
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/BaseSignedJWTTrustEngine.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/BaseSignedJWTTrustEngine.java
index db17de8..7846ef1 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/BaseSignedJWTTrustEngine.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/BaseSignedJWTTrustEngine.java
@@ -54,6 +54,8 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
* A {@link TrustEngine} implementation for Signed JSON Web Tokens.
*
* @param <TrustBasisType> the trust basis type
+ *
+ * @since 2.2.0
*/
public abstract class BaseSignedJWTTrustEngine<TrustBasisType> implements TrustEngine<SignedJWT> {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ClientInformationJWTTrustEngine.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ClientInformationJWTTrustEngine.java
index 49037e9..7df30aa 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ClientInformationJWTTrustEngine.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ClientInformationJWTTrustEngine.java
@@ -49,6 +49,8 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* value. If neither function is returning value nor the default value is set, then any signature accepted by the
* parent class is accepted.
* </p>
+ *
+ * @since 2.2.0
*/
public class ClientInformationJWTTrustEngine extends ExplicitKeySignedJWTTrustEngine
implements TrustedCredentialTrustEngine<SignedJWT> {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/EncryptJWTHandler.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/EncryptJWTHandler.java
index 7a2afb4..d4de730 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/EncryptJWTHandler.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/EncryptJWTHandler.java
@@ -60,7 +60,7 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
/**
* A {@link MessageHandler} that encrypts a JWT using the {@link EncryptionParameters} found in the
* {@link SecurityParametersContext}. The {@link Payload} to encrypt is determined by lookup strategy.
- * A consumer takes the {@link EncryptedJWT} and updates the correct object in the {@link MessageContext}.
+ * A supplied consumer takes the {@link EncryptedJWT} and updates the correct object in the {@link MessageContext}.
*/
//TODO encrypt action is unpleasent to look at
public class EncryptJWTHandler extends AbstractMessageHandler {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ExplicitKeySignedJWTTrustEngine.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ExplicitKeySignedJWTTrustEngine.java
index 407e198..ac7595d 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ExplicitKeySignedJWTTrustEngine.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ExplicitKeySignedJWTTrustEngine.java
@@ -53,6 +53,8 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
* key, then all trusted credentials obtained by the trusted credential resolver will be used to attempt to validate the
* signature.
* </p>
+ *
+ * @since 2.2.0
*/
public class ExplicitKeySignedJWTTrustEngine extends BaseSignedJWTTrustEngine<Iterable<Credential>>
implements TrustedCredentialTrustEngine<SignedJWT> {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ExplicitKeyTrustEvaluator.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ExplicitKeyTrustEvaluator.java
index b3074b6..afd429f 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ExplicitKeyTrustEvaluator.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/ExplicitKeyTrustEvaluator.java
@@ -29,6 +29,8 @@ import org.slf4j.LoggerFactory;
* Auxillary trust evaluator for evaluating an untrusted key or credential against a trusted key or credential. Trust is
* established if the untrusted key (a public key or symmetric key from the untrusted credential) matches one of the
* trusted keys supplied.
+ *
+ * @since 2.2.0
*/
public class ExplicitKeyTrustEvaluator {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWETokenDecrypter.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWETokenDecrypter.java
index 9eb48bc..4f406b6 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWETokenDecrypter.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWETokenDecrypter.java
@@ -80,7 +80,7 @@ import net.shibboleth.utilities.java.support.resolver.Criterion;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
/**
- * Supports decryption of OpendID connect encrypted JSON Web Tokens using the JSON Web Encryption standard.
+ * Supports decryption of encrypted JSON Web Tokens using the JSON Web Encryption standard.
* The {@link EncryptedJWT} will be decrypted in-place, with its {@link State} changing to {@link State#DECRYPTED}
* on successful decryption. Any error that occurs decrypting the JWT will throw an {@link DecryptionException}.
*
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicDecryptionConfiguration.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicDecryptionConfiguration.java
index c851c73..2dbbc1d 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicDecryptionConfiguration.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicDecryptionConfiguration.java
@@ -26,6 +26,8 @@ import net.shibboleth.oidc.security.jose.DecryptionConfiguration;
/**
* Basic implementation of {@link DecryptionConfiguration} for handling JWEs.
+ *
+ * @since 2.2.0
*/
public class BasicDecryptionConfiguration
extends BasicAlgorithmPolicyConfiguration implements DecryptionConfiguration {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicEncryptionConfiguration.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicEncryptionConfiguration.java
index 6dbcc47..39ba1db 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicEncryptionConfiguration.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicEncryptionConfiguration.java
@@ -34,6 +34,8 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
/**
* Basic implementation of {@link EncryptionConfiguration} for handling JWE encryption.
+ *
+ * @since 2.2.0
*/
public class BasicEncryptionConfiguration extends BasicAlgorithmPolicyConfiguration
implements EncryptionConfiguration {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureSigningConfiguration.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureSigningConfiguration.java
index dd3858e..52a041f 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureSigningConfiguration.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureSigningConfiguration.java
@@ -36,6 +36,8 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
/**
* The configuration information to use when generating an signed JWT.
+ *
+ * @since 2.2.0
*/
public class BasicSignatureSigningConfiguration extends BasicAlgorithmPolicyConfiguration
implements SignatureSigningConfiguration {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureSigningParametersResolver.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureSigningParametersResolver.java
index ce2cc50..877cd47 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureSigningParametersResolver.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureSigningParametersResolver.java
@@ -58,6 +58,8 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
*
* <p>The set of effective signature algorithms is filtered against those supported by the runtime and those configured
* by include/exclude policy.</p>
+ *
+ * @since 2.2.0
*/
public class BasicSignatureSigningParametersResolver
extends AbstractSecurityParametersResolver<SignatureSigningParameters>
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureValidationConfiguration.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureValidationConfiguration.java
index e26e30e..d922400 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureValidationConfiguration.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureValidationConfiguration.java
@@ -29,6 +29,8 @@ import net.shibboleth.oidc.security.jose.SignatureValidationConfiguration;
/**
* Basic implementation of {@link SignatureValidationConfiguration} for signed JWTs.
+ *
+ * @since 2.2.0
*/
public class BasicSignatureValidationConfiguration extends BasicAlgorithmPolicyConfiguration
implements SignatureValidationConfiguration {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureValidationParametersResolver.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureValidationParametersResolver.java
index b610a90..0203e3f 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureValidationParametersResolver.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/BasicSignatureValidationParametersResolver.java
@@ -48,6 +48,8 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
* <ul>
* <li>{@link SignatureValidationConfigurationCriterion} - required</li>
* </ul>
+ *
+ * @since 2.2.0
*/
public class BasicSignatureValidationParametersResolver
extends AbstractSecurityParametersResolver<SignatureValidationParameters>
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultDataEncryptionAlgorithmsLookupStrategy.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultDataEncryptionAlgorithmsLookupStrategy.java
index 3656e96..47edf5b 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultDataEncryptionAlgorithmsLookupStrategy.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultDataEncryptionAlgorithmsLookupStrategy.java
@@ -36,6 +36,8 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* A BiFunction which pulls data encryption (content encryption) algorithms to use from the
* encryption configuration and filters them. Algorithms are removed (filtered) if not supported
* by the runtime or are explicitly excluded or not included.
+ *
+ * @since 2.2.0
*/
public class DefaultDataEncryptionAlgorithmsLookupStrategy extends AbstractEncryptionAlgorithmsLookupStrategy {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultEncryptionParametersResolver.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultEncryptionParametersResolver.java
index 08c4608..883b3b1 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultEncryptionParametersResolver.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultEncryptionParametersResolver.java
@@ -90,6 +90,8 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
* <li>{@link EncryptionConfigurationCriterion} - required</li>
* <li>{@link ProviderMetadataCriterion} - likely required for some downstream resolvers</li>
* </ul>
+ *
+ * @since 2.2.0
*/
public class DefaultEncryptionParametersResolver extends AbstractSecurityParametersResolver<EncryptionParameters>
implements EncryptionParametersResolver {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultKeyTransportEncryptionAlgorithmsLookupStrategy.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultKeyTransportEncryptionAlgorithmsLookupStrategy.java
index 940088a..d279e40 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultKeyTransportEncryptionAlgorithmsLookupStrategy.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/jose/impl/DefaultKeyTransportEncryptionAlgorithmsLookupStrategy.java
@@ -37,6 +37,8 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* A BiFunction that retrieves and filters the key transport encryption algorithms from the
* {@link EncryptionConfiguration} inside the criteria set. Algorithms are removed (filtered) if not supported
* by the runtime or are explicitly excluded or not included.
+ *
+ * @since 2.2.0
*/
public class DefaultKeyTransportEncryptionAlgorithmsLookupStrategy extends AbstractEncryptionAlgorithmsLookupStrategy {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/audit/AuditFields.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/audit/AuditFields.java
index dc838ff..2ceec92 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/audit/AuditFields.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/audit/AuditFields.java
@@ -24,7 +24,11 @@ import net.shibboleth.idp.profile.context.AuditContext;
import net.shibboleth.idp.saml.profile.SAMLAuditFields;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-/** Constants to use for audit logging fields stored in an {@link AuditContext}. */
+/**
+ * Constants to use for audit logging fields stored in an {@link AuditContext}.
+ *
+ * @since 2.2.0
+ */
public final class AuditFields {
/** OIDC client ID. */
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/CredentialsListFactory.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/CredentialsListFactory.java
index be0579d..2e08735 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/CredentialsListFactory.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/CredentialsListFactory.java
@@ -35,6 +35,8 @@ import org.springframework.beans.factory.config.AbstractFactoryBean;
*
* <p>Primarily created to support signature credential injection into the {@link SignatureSigningConfiguration}
* when the credential list may contain, in its raw state, {@literal null} elements.</p>
+ *
+ * @since 2.2.0
*/
public class CredentialsListFactory extends AbstractFactoryBean<List<Credential>> {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/JSONSecurityConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/JSONSecurityConfiguration.java
index fec5095..80f6f84 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/JSONSecurityConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/JSONSecurityConfiguration.java
@@ -28,6 +28,8 @@ import net.shibboleth.oidc.security.jose.SignatureValidationConfiguration;
/**
* Class extends SecurityConfiguration to support separate configuration for various encryption and signature
* validation operations.
+ *
+ * @since 2.2.0
*/
public class JSONSecurityConfiguration extends SecurityConfiguration {
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 6ab3c85..5f406d3 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
@@ -268,6 +268,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param profileRequestContext profile request context
*
* @return whether to make a request to the UserInfo Endpoint
+ *
+ * @since 2.2.0
*/
public boolean isRetrieveUserInfoEndpointClaims(@Nonnull final ProfileRequestContext profileRequestContext) {
return retrieveUserInfoEndpointClaims.test(profileRequestContext);
@@ -277,6 +279,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set whether to make a request to the UserInfo Endpoint to obtain authenticated End-User claims.
*
* @param flag flag to set
+ *
+ * @since 2.2.0
*/
public void setRetrieveUserInfoEndpointClaims(final boolean flag) {
retrieveUserInfoEndpointClaims = flag ? Predicates.alwaysTrue() : Predicates.alwaysFalse();
@@ -286,6 +290,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set condition for whether to make a request to the UserInfo Endpoint to obtain authenticated End-User claims.
*
* @param condition condition to set
+ *
+ * @since 2.2.0
*/
public void setRetrieveUserInfoEndpointClaims(@Nonnull final Predicate<ProfileRequestContext> condition){
retrieveUserInfoEndpointClaims = Constraint.isNotNull(condition, "Condition cannot be null");
@@ -297,6 +303,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param profileRequestContext the profile request context
*
* @return true iff the RequestObject should be signed, false otherwise.
+ *
+ * @since 2.2.0
*/
public boolean isSignRequestObject(@Nullable final ProfileRequestContext profileRequestContext) {
return signRequestObjectPredicate.test(profileRequestContext);
@@ -306,6 +314,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set whether the RequestObject should be signed.
*
* @param flag flag to set
+ *
+ * @since 2.2.0
*/
public void setSignRequestObject(final boolean flag) {
signRequestObjectPredicate = flag ? Predicates.alwaysTrue() : Predicates.alwaysFalse();
@@ -315,6 +325,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set the predicate to determine if the RequestObject should be signed.
*
* @param condition the condition
+ *
+ * @since 2.2.0
*/
public void setSignRequestObjectPredicate(final Predicate<ProfileRequestContext> condition) {
signRequestObjectPredicate = Constraint.isNotNull(condition, "Condition cannot be null");
@@ -326,6 +338,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param profileRequestContext the profile request context
*
* @return true iff the RequestObject should be encrypted, false otherwise.
+ *
+ * @since 2.2.0
*/
public boolean isEncryptRequestObject(@Nullable final ProfileRequestContext profileRequestContext) {
return encryptRequestObjectPredicate.test(profileRequestContext);
@@ -335,6 +349,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set whether the RequestObject should be encrypted.
*
* @param flag flag to set
+ *
+ * @since 2.2.0
*/
public void setEncryptRequestObject(final boolean flag) {
encryptRequestObjectPredicate = flag ? Predicates.alwaysTrue() : Predicates.alwaysFalse();
@@ -344,6 +360,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set the predicate to determine if the RequestObject should be encrypted.
*
* @param condition the condition
+ *
+ * @since 2.2.0
*/
public void setEncryptRequestObjectPredicate(final Predicate<ProfileRequestContext> condition) {
encryptRequestObjectPredicate = Constraint.isNotNull(condition, "Condition cannot be null");
@@ -353,6 +371,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set the redirect_uri lookup strategy used to locate an overridden redirect.
*
* @param strategy the strategy to use.
+ *
+ * @since 2.2.0
*/
public void setRedirectUriOverrideLookupStrategy(@Nonnull final
Function<ProfileRequestContext, String> strategy) {
@@ -363,6 +383,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set the override redirect_uri.
*
* @param uri the redirect_uri
+ *
+ * @since 2.2.0
*/
public void setRedirectUriOverride(@Nullable final String uri) {
if (uri != null) {
@@ -378,6 +400,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param profileRequestContext profile request context
*
* @return the redirect_uri override
+ *
+ * @since 2.2.0
*/
public String getRedirectUriOverride(@Nullable final ProfileRequestContext profileRequestContext) {
return redirectUriOverrideLookupStrategy.apply(profileRequestContext);
@@ -595,6 +619,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set the lookup strategy to determine the response_type for authentication requests.
*
* @param strategy the strategy to use
+ *
+ * @since 2.2.0
*/
public void setResponseTypeLookupStrategy(@Nonnull final Function<ProfileRequestContext, String> strategy) {
responseTypeLookupStrategy = Constraint.isNotNull(strategy, "ResponseType lookup strategy can not be null");
@@ -604,6 +630,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set the response_type to use for authentication requests.
*
* @param responseType the response_type to use
+ *
+ * @since 2.2.0
*/
public void setResponseType(@Nullable final String responseType) {
responseTypeLookupStrategy = FunctionSupport.constant(responseType);
@@ -615,6 +643,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param profileRequestContext the profile request context
*
* @return the response_type
+ *
+ * @since 2.2.0
*/
public String getResponseType(@Nullable final ProfileRequestContext profileRequestContext) {
return responseTypeLookupStrategy.apply(profileRequestContext);
@@ -666,6 +696,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set the lookup strategy to determine the scopes to use for authentication requests.
*
* @param strategy the strategy to use
+ *
+ * @since 2.2.0
*/
public void setScopesLookupStrategy(@Nonnull final Function<ProfileRequestContext, Set<String>> strategy) {
scopesLookupStrategy = Constraint.isNotNull(strategy, "Scopes lookup strategy can not be null");
@@ -675,6 +707,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* Set the scopes to use for authentication requests.
*
* @param scopes the scopes
+ *
+ * @since 2.2.0
*/
public void setScopes(@Nullable @NonnullElements final Set<String> scopes) {
if (scopes == null || scopes.isEmpty()) {
@@ -691,6 +725,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param profileRequestContext the profile request context
*
* @return the scopes
+ *
+ * @since 2.2.0
*/
@Nullable public Set<String> getScopes(@Nullable final ProfileRequestContext profileRequestContext) {
return scopesLookupStrategy.apply(profileRequestContext);
@@ -702,6 +738,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* to populate the subject.
*
* @param strategy translation function
+ *
+ * @since 2.2.0
*/
public void setAuthenticationMethodsReferencesTranslationStrategyLookupStrategy(@Nonnull
final Function<ProfileRequestContext,Function<Collection<String>, Collection<Principal>>> strategy){
@@ -715,6 +753,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param prc current profile request context
*
* @return translation function
+ *
+ * @since 2.2.0
*/
@Nullable public Function<Collection<String>,Collection<Principal>>
getAuthenticationMethodsReferencesTranslationStrategy(@Nullable final ProfileRequestContext prc){
@@ -727,6 +767,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* populate the subject.
*
* @param strategy translation function
+ *
+ * @since 2.2.0
*/
public void setAuthenticationContextClassReferenceTranslationStrategyLookupStrategy(@Nullable
final Function<ProfileRequestContext,Function<Collection<String>, Collection<Principal>>> strategy){
@@ -740,6 +782,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param prc current profile request context
*
* @return translation function
+ *
+ * @since 2.2.0
*/
@Nullable public Function<Collection<String>,Collection<Principal>>
getAuthenticationContextClassReferenceTranslationStrategy(@Nullable final ProfileRequestContext prc){
@@ -755,6 +799,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* @param profileRequestContext current profile request context
*
* @return whether to proxy across the inbound auth_time
+ *
+ * @since 2.2.0
*/
public boolean isProxiedAuthnInstant(@Nullable final ProfileRequestContext profileRequestContext) {
return proxiedAuthnInstantPredicate.test(profileRequestContext);
@@ -765,6 +811,8 @@ public class OIDCAuthorizationConfiguration extends AbstractOIDCSSOConfiguration
* assertion's auth_time from the id_token, rather than the current time.
*
* @param flag flag to set
+ *
+ * @since 2.2.0
*
*/
public void setProxiedAuthnInstant(final boolean flag) {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/ClientInformationStringValueLookupFunction.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/ClientInformationStringValueLookupFunction.java
index c666413..334f0e6 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/ClientInformationStringValueLookupFunction.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/ClientInformationStringValueLookupFunction.java
@@ -31,7 +31,7 @@ import net.shibboleth.utilities.java.support.annotation.ParameterName;
import net.shibboleth.utilities.java.support.logic.Constraint;
/**
- * Fetches the value for the configured key as {@link String}. May be null if the value is not found or the given
+ * Fetches the value for the configured key as {@link String}. May be {@code null} if the value is not found or the given
* {@link OIDCClientInformation} or its metadata is null.
*/
public class ClientInformationStringValueLookupFunction implements Function<OIDCClientInformation, String> {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OAuthAuthorizationRequest.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OAuthAuthorizationRequest.java
index 02b79bc..8389835 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OAuthAuthorizationRequest.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OAuthAuthorizationRequest.java
@@ -120,6 +120,8 @@ public class OAuthAuthorizationRequest {
* Set the default response_mode for the given response_type.
*
* @param mode the default response_mode for the given response_type
+ *
+ * @since 2.2.0
*/
public void setDefaultResponseMode(@Nullable final ResponseMode mode) {
defaultResponseMode = mode;
@@ -129,6 +131,8 @@ public class OAuthAuthorizationRequest {
* Get the response_mode to use with this authentication request.
*
* @return the default response_mode
+ *
+ * @since 2.2.0
*/
@Nullable public ResponseMode getDefaultResponseMode() {
return defaultResponseMode;
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OIDCAuthenticationRequest.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OIDCAuthenticationRequest.java
index 0e42041..141aecd 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OIDCAuthenticationRequest.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/core/OIDCAuthenticationRequest.java
@@ -72,6 +72,8 @@ public class OIDCAuthenticationRequest extends OAuthAuthorizationRequest {
* Set the request object claims set.
*
* @param claims the claims
+ *
+ * @since 2.2.0
*/
public void setRequestObjectClaimsSet(@Nullable final ClaimsSet claims) {
requestObjectClaimsSet = claims;
@@ -83,6 +85,8 @@ public class OIDCAuthenticationRequest extends OAuthAuthorizationRequest {
* no longer 'live' and will not be reused.
*
* @return the request object claims
+ *
+ * @since 2.2.0
*/
@Nullable public ClaimsSet getRequestObjectClaimsSet() {
if (requestObject == null) {
@@ -131,6 +135,8 @@ public class OIDCAuthenticationRequest extends OAuthAuthorizationRequest {
* Set any individual requested claims.
*
* @param claims the requested claims.
+ *
+ * @since 2.2.0
*/
public void setRequestedClaims(@Nullable final OIDCClaimsRequest claims) {
requestedClaims = claims;
@@ -140,6 +146,8 @@ public class OIDCAuthenticationRequest extends OAuthAuthorizationRequest {
* Get the requested claims.
*
* @return the requested claims.
+ *
+ * @since 2.2.0
*/
@Nullable public OIDCClaimsRequest getRequestedClaims() {
return requestedClaims;
@@ -149,6 +157,8 @@ public class OIDCAuthenticationRequest extends OAuthAuthorizationRequest {
* Does the OpenID Provider support the claims parameter?
*
* @return true if it does, false otherwise.
+ *
+ * @since 2.2.0
*/
public boolean providerSupportsClaimsParameter() {
return providerSupportsClaimsParameter;
@@ -159,6 +169,8 @@ public class OIDCAuthenticationRequest extends OAuthAuthorizationRequest {
* parameter.
*
* @param flag true if supported, false otherwise.
+ *
+ * @since 2.2.0
*/
public void setProviderSupportsClaimsParameter(final boolean flag) {
providerSupportsClaimsParameter = flag;
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/encoding/AuthenticationContextClassReferenceSupport.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/encoding/AuthenticationContextClassReferenceSupport.java
index f21a864..47a39c4 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/encoding/AuthenticationContextClassReferenceSupport.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/encoding/AuthenticationContextClassReferenceSupport.java
@@ -31,6 +31,8 @@ import net.shibboleth.oidc.profile.core.OIDCAuthenticationRequest;
/**
* Support class for ACR operations.
+ *
+ * @since 2.2.0
*/
public final class AuthenticationContextClassReferenceSupport {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/encoding/OIDCMessageEncoder.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/encoding/OIDCMessageEncoder.java
index 72f4a45..298b7e0 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/encoding/OIDCMessageEncoder.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/encoding/OIDCMessageEncoder.java
@@ -26,6 +26,8 @@ import net.shibboleth.oidc.profile.config.OIDCAuthorizationConfiguration.OIDCHtt
/**
* An OIDC message encoder interface which requires implementations to test if the request
* method is supported by the encoder.
+ *
+ * @since 2.2.0
*/
public interface OIDCMessageEncoder extends Predicate<OIDCHttpRequestMethod>, MessageEncoder {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/messaging/JSONErrorResponse.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/messaging/JSONErrorResponse.java
index 553a8ee..7c3808e 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/messaging/JSONErrorResponse.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/messaging/JSONErrorResponse.java
@@ -28,7 +28,11 @@ import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import net.minidev.json.JSONObject;
import net.shibboleth.utilities.java.support.logic.Constraint;
-/** Class for creating JSON Error response for requests expecting JSON response. */
+/**
+ * Class for creating JSON Error response for requests expecting JSON response.
+ *
+ * @since 2.2.0
+ */
public class JSONErrorResponse implements ErrorResponse {
/** Error object. */
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/messaging/JSONSuccessResponse.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/messaging/JSONSuccessResponse.java
index 184a1fc..2f7fb7f 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/messaging/JSONSuccessResponse.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/messaging/JSONSuccessResponse.java
@@ -28,7 +28,12 @@ import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import net.minidev.json.JSONObject;
import net.shibboleth.utilities.java.support.logic.Constraint;
-/** Class for creating JSON Success response. */
+/**
+ * Class for creating JSON Success response.
+ *
+ * @since 2.2.0
+ *
+ */
public class JSONSuccessResponse implements SuccessResponse {
/** JSON content. */
diff --git a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/audit/impl/AbstractAuthenticationRequestAuditExtractor.java b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/audit/impl/AbstractAuthenticationRequestAuditExtractor.java
index b6aa400..f002e54 100644
--- a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/audit/impl/AbstractAuthenticationRequestAuditExtractor.java
+++ b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/audit/impl/AbstractAuthenticationRequestAuditExtractor.java
@@ -30,6 +30,8 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
* A base class for audit extractors that lookup the {@link OIDCAuthenticationRequest}.
*
* @param <T> the extracted type
+ *
+ * @since 2.2.0
*/
public abstract class AbstractAuthenticationRequestAuditExtractor<T> implements Function<ProfileRequestContext, T>{
diff --git a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/audit/impl/AbstractAuthenticationResponseAuditExtractor.java b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/audit/impl/AbstractAuthenticationResponseAuditExtractor.java
index 87c41a6..d5b29b1 100644
--- a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/audit/impl/AbstractAuthenticationResponseAuditExtractor.java
+++ b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/audit/impl/AbstractAuthenticationResponseAuditExtractor.java
@@ -31,6 +31,8 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
* A base class for audit extractors that lookup the {@link AuthenticationResponse}.
*
* @param <T> the extracted type
+ *
+ * @since 2.2.0
*/
public abstract class AbstractAuthenticationResponseAuditExtractor<T> implements Function<ProfileRequestContext, T>{
diff --git a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/encoding/impl/AbstractOIDCMessageEncoder.java b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/encoding/impl/AbstractOIDCMessageEncoder.java
index 3fac2d4..3bb68f8 100644
--- a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/encoding/impl/AbstractOIDCMessageEncoder.java
+++ b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/encoding/impl/AbstractOIDCMessageEncoder.java
@@ -43,6 +43,8 @@ import net.shibboleth.utilities.java.support.net.URLBuilder;
/**
* Base class for OIDC message encoders.
+ *
+ * @since 2.2.0
*/
public abstract class AbstractOIDCMessageEncoder extends AbstractHttpServletResponseMessageEncoder
implements OIDCMessageEncoder {
diff --git a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/AbstractBuildErrorResponseFromEvent.java b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/AbstractBuildErrorResponseFromEvent.java
index ea0f7d3..7d80763 100644
--- a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/AbstractBuildErrorResponseFromEvent.java
+++ b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/AbstractBuildErrorResponseFromEvent.java
@@ -43,6 +43,8 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
* message context was found.
*
* @param <T> ErrorResponse implementation.
+ *
+ * @since 2.2.0
*/
public abstract class AbstractBuildErrorResponseFromEvent<T extends ErrorResponse> extends AbstractProfileAction {
diff --git a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/AuthenticationRequestMessageEncoderFactory.java b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/AuthenticationRequestMessageEncoderFactory.java
index c8b55a0..c72a710 100644
--- a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/AuthenticationRequestMessageEncoderFactory.java
+++ b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/AuthenticationRequestMessageEncoderFactory.java
@@ -43,6 +43,8 @@ import net.shibboleth.utilities.java.support.component.AbstractInitializableComp
/**
* Message encoder factory function that returns the first encoder suitable for the given request method found in the
* profile configuration.
+ *
+ * @since 2.2.0
*/
@ThreadSafe
public class AuthenticationRequestMessageEncoderFactory extends AbstractInitializableComponent
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list