Skip to content

Backport to branch(3) : Fix certificate and secret key version check and messages #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2025
Merged

Backport to branch(3) : Fix certificate and secret key version check and messages #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions client/src/main/java/com/scalar/dl/client/config/ClientConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,10 +405,8 @@ private void load() {
ENTITY_ID, CERT_HOLDER_ID));

// identity based on digital signature
certVersion = ConfigUtils.getInt(props, DS_CERT_VERSION, 0);
if (certVersion <= 0) {
certVersion = ConfigUtils.getInt(props, CERT_VERSION, DEFAULT_CERT_VERSION);
}
certVersion = ConfigUtils.getInt(props, CERT_VERSION, DEFAULT_CERT_VERSION);
certVersion = ConfigUtils.getInt(props, DS_CERT_VERSION, certVersion);
cert = ConfigUtils.getString(props, DS_CERT_PEM, null);
if (cert == null) {
cert = ConfigUtils.getStringFromFilePath(props, DS_CERT_PATH, null);
Expand Down
3 changes: 1 addition & 2 deletions client/src/main/java/com/scalar/dl/client/config/DigitalSignatureIdentityConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,7 @@ public DigitalSignatureIdentityConfig.Builder entityId(String entityId) {

public DigitalSignatureIdentityConfig.Builder certVersion(int certVersion) {
checkArgument(
certVersion >= 0,
CommonError.CERT_VERSION_MUST_BE_GREATER_THAN_OR_EQUAL_TO_ZERO.buildMessage());
certVersion > 0, CommonError.CERT_VERSION_MUST_BE_GREATER_THAN_ZERO.buildMessage());
this.certVersion = certVersion;
return this;
}
Expand Down
4 changes: 2 additions & 2 deletions client/src/main/java/com/scalar/dl/client/config/HmacIdentityConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ public HmacIdentityConfig.Builder entityId(String entityId) {

public HmacIdentityConfig.Builder secretKeyVersion(int secretKeyVersion) {
checkArgument(
secretKeyVersion >= 0,
CommonError.SECRET_VERSION_MUST_BE_GREATER_THAN_OR_EQUAL_TO_ZERO.buildMessage());
secretKeyVersion > 0,
CommonError.SECRET_VERSION_MUST_BE_GREATER_THAN_ZERO.buildMessage());
this.secretKeyVersion = secretKeyVersion;
return this;
}
Expand Down
61 changes: 60 additions & 1 deletion client/src/test/java/com/scalar/dl/client/config/ClientConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,10 +589,12 @@ public void constructor_HmacAuthEnabledButNoSecretKeyGiven_ShouldCreateConfigPro
throws IOException {
// Arrange
Properties props = new Properties();
props.put(ClientConfig.ENTITY_ID, SOME_ENTITY_ID);
props.put(ClientConfig.CERT_VERSION, "0");
props.put(ClientConfig.CERT_HOLDER_ID, SOME_CERT_HOLDER_ID);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The property ClientConfig.CERT_HOLDER_ID is redundant here because ClientConfig.ENTITY_ID is set on line 596. The configuration loading logic gives precedence to ENTITY_ID, so CERT_HOLDER_ID will be ignored for determining the entity ID. Removing this line will make the test cleaner.

props.put(ClientConfig.CERT_PEM, SOME_CERT_PEM);
props.put(ClientConfig.PRIVATE_KEY_PEM, SOME_PRIVATE_KEY_PEM);
props.put(ClientConfig.ENTITY_ID, SOME_ENTITY_ID);
props.put(ClientConfig.DS_CERT_VERSION, SOME_CERT_VERSION);
props.put(ClientConfig.DS_CERT_PEM, SOME_CERT_PEM + "New");
props.put(ClientConfig.DS_PRIVATE_KEY_PEM, SOME_PRIVATE_KEY_PEM + "New");

Expand All @@ -601,6 +603,8 @@ public void constructor_HmacAuthEnabledButNoSecretKeyGiven_ShouldCreateConfigPro

// Assert
assertThat(config.getDigitalSignatureIdentityConfig().getEntityId()).isEqualTo(SOME_ENTITY_ID);
assertThat(config.getDigitalSignatureIdentityConfig().getCertVersion())
.isEqualTo(Integer.parseInt(SOME_CERT_VERSION));
assertThat(config.getDigitalSignatureIdentityConfig().getCert())
.isEqualTo(SOME_CERT_PEM + "New");
assertThat(config.getDigitalSignatureIdentityConfig().getPrivateKey())
Expand Down Expand Up @@ -740,4 +744,59 @@ public void constructor_DifferentClientConfigGiven_ShouldReturnNonEqualConfigs()
assertThat(config1.getLedgerTargetConfig()).isNotEqualTo(config2.getLedgerTargetConfig());
assertThat(config1.getAuditorTargetConfig()).isNotEqualTo(config2.getAuditorTargetConfig());
}

@Test
public void constructor_CertVersionZeroGiven_ShouldThrowIllegalArgumentException() {
// Arrange
Properties props = new Properties();
props.put(ClientConfig.ENTITY_ID, SOME_CERT_HOLDER_ID);
props.put(ClientConfig.DS_CERT_VERSION, "0");
props.put(ClientConfig.DS_CERT_PEM, SOME_CERT_PEM);
props.put(ClientConfig.DS_PRIVATE_KEY_PEM, SOME_PRIVATE_KEY_PEM);

// Act Assert
assertThatThrownBy(() -> new ClientConfig(props)).isInstanceOf(IllegalArgumentException.class);
}

@Test
public void constructor_DeprecatedCertVersionZeroGiven_ShouldThrowIllegalArgumentException() {
// Arrange
Properties props = new Properties();
props.put(ClientConfig.CERT_HOLDER_ID, SOME_CERT_HOLDER_ID);
props.put(ClientConfig.CERT_VERSION, "0");
props.put(ClientConfig.CERT_PEM, SOME_CERT_PEM);
props.put(ClientConfig.PRIVATE_KEY_PEM, SOME_PRIVATE_KEY_PEM);

// Act Assert
assertThatThrownBy(() -> new ClientConfig(props)).isInstanceOf(IllegalArgumentException.class);
}

@Test
public void
constructor_NewWrongCertVersionAndDeprecatedCorrectCertVersionGiven_ShouldThrowIllegalArgumentException() {
// Arrange
Properties props = new Properties();
props.put(ClientConfig.ENTITY_ID, SOME_CERT_HOLDER_ID);
props.put(ClientConfig.DS_CERT_VERSION, "0");
props.put(ClientConfig.DS_CERT_PEM, SOME_CERT_PEM);
props.put(ClientConfig.DS_PRIVATE_KEY_PEM, SOME_PRIVATE_KEY_PEM);
props.put(ClientConfig.CERT_HOLDER_ID, SOME_CERT_HOLDER_ID);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This line is redundant. ClientConfig.ENTITY_ID is set on line 779, and it has precedence over the deprecated ClientConfig.CERT_HOLDER_ID. The configuration loading logic will use the value from ENTITY_ID and ignore CERT_HOLDER_ID for determining the entity ID. Removing this line will make the test cleaner and avoid confusion.

props.put(ClientConfig.CERT_VERSION, SOME_CERT_VERSION);

// Act Assert
assertThatThrownBy(() -> new ClientConfig(props)).isInstanceOf(IllegalArgumentException.class);
}

@Test
public void constructor_SecretVersionZeroGiven_ShouldThrowIllegalArgumentException() {
// Arrange
Properties props = new Properties();
props.put(ClientConfig.ENTITY_ID, SOME_ENTITY_ID);
props.put(ClientConfig.AUTHENTICATION_METHOD, AuthenticationMethod.HMAC.getMethod());
props.put(ClientConfig.HMAC_SECRET_KEY, SOME_SECRET_KEY);
props.put(ClientConfig.HMAC_SECRET_KEY_VERSION, "0");

// Act Assert
assertThatThrownBy(() -> new ClientConfig(props)).isInstanceOf(IllegalArgumentException.class);
}
}
8 changes: 4 additions & 4 deletions common/src/main/java/com/scalar/dl/ledger/error/CommonError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,10 @@ public enum CommonError implements ScalarDlError {
""),
PRIVATE_KEY_AND_CERT_REQUIRED(
StatusCode.INVALID_ARGUMENT, "009", "The private key and certificate are required.", "", ""),
CERT_VERSION_MUST_BE_GREATER_THAN_OR_EQUAL_TO_ZERO(
CERT_VERSION_MUST_BE_GREATER_THAN_ZERO(
StatusCode.INVALID_ARGUMENT,
"010",
"The certificate version must be greater than or equal to zero.",
"The certificate version must be greater than zero.",
"",
""),
SECRET_KEY_REQUIRED(
Expand All @@ -175,10 +175,10 @@ public enum CommonError implements ScalarDlError {
"A secret key is required for HMAC authentication.",
"",
""),
SECRET_VERSION_MUST_BE_GREATER_THAN_OR_EQUAL_TO_ZERO(
SECRET_VERSION_MUST_BE_GREATER_THAN_ZERO(
StatusCode.INVALID_ARGUMENT,
"012",
"The secret version for HMAC authentication must be greater than or equal to zero.",
"The secret version for HMAC authentication must be greater than zero.",
"",
""),
GRPC_DEADLINE_DURATION_MUST_BE_GREATER_THAN_OR_EQUAL_TO_ZERO(
Expand Down