diff --git a/CHANGES.ja.md b/CHANGES.ja.md index f6d751003..d159bfa84 100644 --- a/CHANGES.ja.md +++ b/CHANGES.ja.md @@ -1,6 +1,17 @@ 変更点 ====== +- `Service` クラス + * `isCimdAllowlistEnabled()` メソッドを追加。 + * `setCimdAllowlistEnabled(boolean)` メソッドを追加。 + * `getCimdAllowlist()` メソッドを追加。 + * `setCimdAllowlist(String[])` メソッドを追加。 + * `isCimdWhitelistEnabled()` メソッドを削除。 + * `setCimdWhitelistEnabled(boolean)` メソッドを削除。 + * `getCimdWhitelist()` メソッドを削除。 + * `setCimdWhitelist(String[])` メソッドを削除。 + + 4.30 (2025 年 11 月 20 日) -------------------------- diff --git a/CHANGES.md b/CHANGES.md index f00b6c514..0fa868963 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,17 @@ CHANGES ======= +- `Service` class + * Added the `isCimdAllowlistEnabled()` method. + * Added the `setCimdAllowlistEnabled(boolean)` method. + * Added the `getCimdAllowlist()` method. + * Added the `setCimdAllowlist(String[])` method. + * Removed the `isCimdWhitelistEnabled()` method. + * Removed the `setCimdWhitelistEnabled(boolean)` method. + * Removed the `getCimdWhitelist()` method. + * Removed the `setCimdWhitelist(String[])` method. + + 4.30 (2025-11-20) ----------------- diff --git a/src/main/java/com/authlete/common/dto/CimdOptions.java b/src/main/java/com/authlete/common/dto/CimdOptions.java index f7501d02b..a02389ed3 100644 --- a/src/main/java/com/authlete/common/dto/CimdOptions.java +++ b/src/main/java/com/authlete/common/dto/CimdOptions.java @@ -182,8 +182,8 @@ public CimdOptions setAlwaysRetrieved(boolean always) * *

* Given this purpose, it is not recommended to enable this option in - * production environments unless a whitelist is used (see {@link - * Service#isCimdWhitelistEnabled()}). + * production environments unless an allowlist is used (see {@link + * Service#isCimdAllowlistEnabled()}). *

* *

@@ -216,8 +216,8 @@ public boolean isHttpPermitted() * *

* Given this purpose, it is not recommended to enable this option in - * production environments unless a whitelist is used (see {@link - * Service#isCimdWhitelistEnabled()}). + * production environments unless an allowlist is used (see {@link + * Service#isCimdAllowlistEnabled()}). *

* *

diff --git a/src/main/java/com/authlete/common/dto/Service.java b/src/main/java/com/authlete/common/dto/Service.java index f460d11fc..8eaf45a32 100644 --- a/src/main/java/com/authlete/common/dto/Service.java +++ b/src/main/java/com/authlete/common/dto/Service.java @@ -330,7 +330,7 @@ */ public class Service implements Serializable { - private static final long serialVersionUID = 86L; + private static final long serialVersionUID = 87L; /* @@ -1905,21 +1905,21 @@ public class Service implements Serializable /** - * Whether to enable the whitelist for client IDs in the CIMD context. + * Whether to enable the allowlist for client IDs in the CIMD context. * - * @since 4.30 + * @since 4.31 * @since Authlete 3.0.22 */ - private boolean cimdWhitelistEnabled; + private boolean cimdAllowlistEnabled; /** - * The whitelist for client IDs in the CIMD context. + * The allowlist for client IDs in the CIMD context. * - * @since 4.30 + * @since 4.31 * @since Authlete 3.0.22 */ - private String[] cimdWhitelist; + private String[] cimdAllowlist; /** @@ -12251,162 +12251,162 @@ public Service setClientIdMetadataDocumentSupported(boolean supported) /** - * Get the flag that indicates whether the whitelist for client IDs + * Get the flag that indicates whether the allowlist for client IDs * in the CIMD context is enabled or not. * *

- * If the whitelist is enabled, the client ID in a request must match at - * least one entry in the whitelist to be considered a valid client ID + * If the allowlist is enabled, the client ID in a request must match at + * least one entry in the allowlist to be considered a valid client ID * in the CIMD context. *

* * @return - * {@code true} if the whitelist for client IDs in the CIMD + * {@code true} if the allowlist for client IDs in the CIMD * context is enabled. * - * @since 4.30 + * @since 4.31 * @since Authlete 3.0.22 * * @see * OAuth Client ID Metadata Document */ - public boolean isCimdWhitelistEnabled() + public boolean isCimdAllowlistEnabled() { - return cimdWhitelistEnabled; + return cimdAllowlistEnabled; } /** - * Set the flag that indicates whether the whitelist for client IDs + * Set the flag that indicates whether the allowlist for client IDs * in the CIMD context is enabled or not. * *

- * If the whitelist is enabled, the client ID in a request must match at - * least one entry in the whitelist to be considered a valid client ID + * If the allowlist is enabled, the client ID in a request must match at + * least one entry in the allowlist to be considered a valid client ID * in the CIMD context. *

* * @param enabled - * {@code true} to enable the whitelist for client IDs in the + * {@code true} to enable the allowlist for client IDs in the * CIMD context. * * @return * {@code this} object. * - * @since 4.30 + * @since 4.31 * @since Authlete 3.0.22 * * @see * OAuth Client ID Metadata Document */ - public Service setCimdWhitelistEnabled(boolean enabled) + public Service setCimdAllowlistEnabled(boolean enabled) { - this.cimdWhitelistEnabled = enabled; + this.cimdAllowlistEnabled = enabled; return this; } /** - * Get the whitelist for client IDs in the CIMD context. * *

- * When the whitelist feature is enabled (see {@link #isCimdWhitelistEnabled()}), - * the whitelist specified by this property is consulted to determine + * When the allowlist feature is enabled (see {@link #isCimdAllowlistEnabled()}), + * the allowlist specified by this property is consulted to determine * whether the client ID in a request is valid in the CIMD context. * In this case, the client ID must match at least one entry in the - * whitelist. + * allowlist. *

* *

- * Each entry in the whitelist must be a valid URI. The comparison between - * a whitelist entry and a client ID is performed as follows: + * Each entry in the allowlist must be a valid URI. The comparison between + * an allowlist entry and a client ID is performed as follows: *

* *
    *
  1. [scheme] Simple string comparison. *
  2. [authority] Simple string comparison. *
  3. [path] The client ID's path must contain all path segments of - * the whitelist entry in the same order. - *
  4. [query] Simple string comparison, but only if the whitelist + * the allowlist entry in the same order. + *
  5. [query] Simple string comparison, but only if the allowlist * entry has a query component. *
* *

- * For example, if the whitelist contains "{@code https://example.com/a/b}", + * For example, if the allowlist contains "{@code https://example.com/a/b}", * then "{@code https://example.com/a/b/c}" is considered valid, but * "{@code https://example.com/a}" is not. *

* * @return - * The whitelist for client IDs in the CIMD context. + * The allowlist for client IDs in the CIMD context. * - * @since 4.30 + * @since 4.31 * @since Authlete 3.0.22 * * @see * OAuth Client ID Metadata Document */ - public String[] getCimdWhitelist() + public String[] getCimdAllowlist() { - return cimdWhitelist; + return cimdAllowlist; } /** - * Set the whitelist for client IDs in the CIMD context. * *

- * When the whitelist feature is enabled (see {@link #isCimdWhitelistEnabled()}), - * the whitelist specified by this property is consulted to determine + * When the allowlist feature is enabled (see {@link #isCimdAllowlistEnabled()}), + * the allowlist specified by this property is consulted to determine * whether the client ID in a request is valid in the CIMD context. * In this case, the client ID must match at least one entry in the - * whitelist. + * allowlist. *

* *

- * Each entry in the whitelist must be a valid URI. The comparison between - * a whitelist entry and a client ID is performed as follows: + * Each entry in the allowlist must be a valid URI. The comparison between + * an allowlist entry and a client ID is performed as follows: *

* *
    *
  1. [scheme] Simple string comparison. *
  2. [authority] Simple string comparison. *
  3. [path] The client ID's path must contain all path segments of - * the whitelist entry in the same order. - *
  4. [query] Simple string comparison, but only if the whitelist + * the allowlist entry in the same order. + *
  5. [query] Simple string comparison, but only if the allowlist * entry has a query component. *
* *

- * For example, if the whitelist contains "{@code https://example.com/a/b}", + * For example, if the allowlist contains "{@code https://example.com/a/b}", * then "{@code https://example.com/a/b/c}" is considered valid, but * "{@code https://example.com/a}" is not. *

* - * @param whitelist - * The whitelist for client IDs in the CIMD context. + * @param allowlist + * The allowlist for client IDs in the CIMD context. * * @return * {@code this} object. * - * @since 4.30 + * @since 4.31 * @since Authlete 3.0.22 * * @see * OAuth Client ID Metadata Document */ - public Service setCimdWhitelist(String[] whitelist) + public Service setCimdAllowlist(String[] allowlist) { - this.cimdWhitelist = whitelist; + this.cimdAllowlist = allowlist; return this; } @@ -12559,8 +12559,8 @@ public Service setCimdAlwaysRetrieved(boolean always) * *

* Given this purpose, it is not recommended to enable this option in - * production environments unless a whitelist is used (see {@link - * Service#isCimdWhitelistEnabled()}). + * production environments unless an allowlist is used (see {@link + * Service#isCimdAllowlistEnabled()}). *

* *

@@ -12602,8 +12602,8 @@ public boolean isCimdHttpPermitted() * *

* Given this purpose, it is not recommended to enable this option in - * production environments unless a whitelist is used (see {@link - * Service#isCimdWhitelistEnabled()}). + * production environments unless an allowlist is used (see {@link + * Service#isCimdAllowlistEnabled()}). *

* *