Skip to content
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

Jump to bottom

Make PublicKeyCredentialRequestOptions Serializable #16438

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make PublicKeyCredentialRequestOptions Serializable #16438

wants to merge 1 commit into from

Conversation

franticticktick
Copy link
Contributor

Closes gh-16432

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 17, 2025
rwinch
rwinch requested changes Jan 18, 2025
View reviewed changes
Copy link
Member

@rwinch rwinch left a comment

Choose a reason for hiding this comment

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

Thanks for the Pull Request. Historically the serialVersionUID no longer used for new classes implementing Serializable. Going forward we should generate a serialVersionUID.

@franticticktick
Copy link
Contributor Author

Hi @rwinch, thanks for feedback. If we use the generated serialVersionUID SpringSecurityCoreVersionSerializableTests will not work. It only works with SpringSecurityCoreVersion. Maybe we should add such support to SpringSecurityCoreVersionSerializableTests?

@rwinch
Copy link
Member

rwinch commented Jan 18, 2025 •
edited
Loading

Please take a look at 6f379aa which was progress towards gh-16276 for an example for how to implement it. It uses generated serialVersionUID and adds tests. The ticket gh-16276 also has instructions on how to address it.

NOTE: This PR has some overlap with gh-16285 (which I provided the same advice for)

@rwinch rwinch mentioned this pull request Jan 18, 2025
Open
@franticticktick
Copy link
Contributor Author

Thanks for help @rwinch. Could you review changes please?

@ngocnhan-tran1996 ngocnhan-tran1996 mentioned this pull request Jan 20, 2025
Open
@rwinch rwinch self-assigned this Jan 21, 2025
rwinch
rwinch requested changes Jan 21, 2025
View reviewed changes
Copy link
Member

@rwinch rwinch left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! I've provided feedback inline

...gframework.security.web.webauthn.api.ImmutableAuthenticationExtensionsClientInput.serialized
Copy link
Member

Choose a reason for hiding this comment

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

It looks like this failed to write

...g/src/test/java/org/springframework/security/SpringSecurityCoreVersionSerializableTests.java
CredProtectAuthenticationExtensionsClientInput.CredProtect credProtect = new CredProtectAuthenticationExtensionsClientInput.CredProtect(
CredProtectAuthenticationExtensionsClientInput.CredProtect.ProtectionPolicy.USER_VERIFICATION_OPTIONAL,
true);
Bytes id = new Bytes(("test").getBytes());
Copy link
Member

Choose a reason for hiding this comment

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

I like that you used a constant value here vs generating a new value. Please use a more realistic value. To make this easy I recently added TestBytes.get() gh-16461

...g/src/test/java/org/springframework/security/SpringSecurityCoreVersionSerializableTests.java
generatorByClassName.put(Bytes.class, (b) -> id);
generatorByClassName.put(PublicKeyCredentialDescriptor.class, (d) -> descriptor);
// @formatter:off
generatorByClassName.put(PublicKeyCredentialRequestOptions.class, (o) -> PublicKeyCredentialRequestOptions.builder()
Copy link
Member

Choose a reason for hiding this comment

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

Please use (or at least start with) TestPublicKeyCredentialRequestOptions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rwinch rwinch rwinch requested changes

Assignees

@rwinch rwinch

Labels
status: waiting-for-triage An issue we've not yet triaged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make PublicKeyCredentialRequestOptions Serializable
3 participants
@franticticktick @rwinch @spring-projects-issues