Skip to content

fix: not correctly process exclude_upper param #1031

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
peterhaochen47 merged 1 commit into from
Dec 15, 2025
Merged

fix: not correctly process exclude_upper param #1031

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
8 changes: 4 additions & 4 deletions .../credhub/src/main/kotlin/org/cloudfoundry/credhub/credentials/RemoteCredentialsHandler.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,8 +515,8 @@ class RemoteCredentialsHandler(
if (jsonNode.hasNonNull("exclude_lower")) {
generationParameters.excludeLower = jsonNode["exclude_lower"].booleanValue()
}
if (jsonNode.hasNonNull("exlude_upper")) {
generationParameters.excludeUpper = jsonNode["exlude_upper"].booleanValue()
if (jsonNode.hasNonNull("exclude_upper")) {
generationParameters.excludeUpper = jsonNode["exclude_upper"].booleanValue()
}
if (jsonNode.hasNonNull("exclude_number")) {
generationParameters.excludeNumber = jsonNode["exclude_number"].booleanValue()
Expand All @@ -543,8 +543,8 @@ class RemoteCredentialsHandler(
if (jsonNode.hasNonNull("exclude_lower")) {
generationParameters.excludeLower = jsonNode["exclude_lower"].booleanValue()
}
if (jsonNode.hasNonNull("exlude_upper")) {
generationParameters.excludeUpper = jsonNode["exlude_upper"].booleanValue()
if (jsonNode.hasNonNull("exclude_upper")) {
generationParameters.excludeUpper = jsonNode["exclude_upper"].booleanValue()
}
if (jsonNode.hasNonNull("exclude_number")) {
generationParameters.excludeNumber = jsonNode["exclude_number"].booleanValue()
Expand Down
92 changes: 92 additions & 0 deletions ...credhub/src/test/kotlin/org/cloudfoundry/credhub/handlers/RemoteCredentialsHandlerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1355,6 +1355,52 @@ class RemoteCredentialsHandlerTest {
assertThat(actualValue).isEqualTo(shouldBeReturned.username)
}

@Test
fun generateUser_whenParsingGenerationParameters_preservesAllFields() {
val type = "user"
val uuid = UUID.randomUUID().toString()
val userCredential = UserCredentialValue("test-user", "test-password", "salt")

// Create generation parameters with ALL fields set
val originalGenerationParameters = StringGenerationParameters()
originalGenerationParameters.length = 15
originalGenerationParameters.username = "test-username"
originalGenerationParameters.excludeLower = false
originalGenerationParameters.excludeUpper = true
originalGenerationParameters.excludeNumber = true
originalGenerationParameters.includeSpecial = false

// Serialize to ByteString (as remote backend would)
val generationParamsByteString = subject.createByteStringFromGenerationParameters(type, originalGenerationParameters)

// Create a GetResponse with these generation parameters (simulating remote backend response)
val getResponse =
GetResponse
.newBuilder()
.setName(CREDENTIAL_NAME)
.setType(type)
.setData(subject.createByteStringFromData(type, userCredential))
.setId(uuid)
.setVersionCreatedAt(versionCreatedAt)
.setGenerationParameters(generationParamsByteString)
.build()

`when`(client.getByNameRequest(CREDENTIAL_NAME, USER)).thenReturn(getResponse)

// Create a new request with matching parameters
val userGenerateRequest = UserGenerateRequest()
userGenerateRequest.setGenerationParameters(originalGenerationParameters)
userGenerateRequest.name = CREDENTIAL_NAME
userGenerateRequest.type = type

// This should NOT regenerate because parameters match
val generateResponse = subject.generateCredential(userGenerateRequest)

// Verify the credential was not regenerated (existing one returned)
assertThat(generateResponse.getUuid()).isEqualTo(uuid)
assertThat((generateResponse.value as UserCredentialValue).username).isEqualTo("test-user")
}

@Test
fun generatePassword_whenExistingPasswordGenerationParametersDontMatch_generateNewCredential() {
val type = "password"
Expand Down Expand Up @@ -1530,6 +1576,52 @@ class RemoteCredentialsHandlerTest {
assertThat(actualValue).isEqualTo(originalPassword.stringCredential.toString())
}

@Test
fun generatePassword_whenParsingGenerationParameters_preservesAllFields() {
val type = "password"
val uuid = UUID.randomUUID().toString()
val password = StringCredentialValue("test-password")

// Create generation parameters with ALL fields set
val originalGenerationParameters = StringGenerationParameters()
originalGenerationParameters.length = 20
originalGenerationParameters.username = "test-user"
originalGenerationParameters.excludeLower = false
originalGenerationParameters.excludeUpper = true
originalGenerationParameters.excludeNumber = true
originalGenerationParameters.includeSpecial = true

// Serialize to ByteString (as remote backend would)
val generationParamsByteString = subject.createByteStringFromGenerationParameters(type, originalGenerationParameters)

// Create a GetResponse with these generation parameters (simulating remote backend response)
val getResponse =
GetResponse
.newBuilder()
.setName(CREDENTIAL_NAME)
.setType(type)
.setData(subject.createByteStringFromData(type, password))
.setId(uuid)
.setVersionCreatedAt(versionCreatedAt)
.setGenerationParameters(generationParamsByteString)
.build()

`when`(client.getByNameRequest(CREDENTIAL_NAME, USER)).thenReturn(getResponse)

// Create a new request with matching parameters
val passwordGenerateRequest = PasswordGenerateRequest()
passwordGenerateRequest.generationParameters = originalGenerationParameters
passwordGenerateRequest.name = CREDENTIAL_NAME
passwordGenerateRequest.type = type

// This should NOT regenerate because parameters match
val generateResponse = subject.generateCredential(passwordGenerateRequest)

// Verify the credential was not regenerated (existing one returned)
assertThat(generateResponse.getUuid()).isEqualTo(uuid)
assertThat((generateResponse.value as StringCredentialValue).stringCredential).isEqualTo("test-password")
}

@Test
fun getCredentialByName_whenCredentialDoesNotExist_throwsCorrectError() {
val exception = StatusRuntimeException(Status.NOT_FOUND)
Expand Down