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.

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

Allow rejection of NaN and Inf float values on encode and decode. #513

Merged
merged 1 commit into from
Apr 20, 2024

Conversation

benluddy
Copy link
Contributor

@benluddy benluddy commented Apr 2, 2024

Description

Implements #512 to allow users to error rather than encode or decode NaN and Inf floating-point values.

PR Was Proposed and Welcomed in Currently Open Issue

Checklist (for code PR only, ignore for docs PR)

  • Include unit tests that cover the new code
  • Pass all unit tests
  • Pass all lint checks in CI (goimports, gosec, staticcheck, etc.)
  • Sign each commit with your real name and email.
    Last line of each commit message should be in this format:
    Signed-off-by: Firstname Lastname firstname.lastname@example.com
  • Certify the Developer's Certificate of Origin 1.1
    (see next section).

Certify the Developer's Certificate of Origin 1.1

  • By marking this item as completed, I certify
    the Developer Certificate of Origin 1.1.
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

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

@benluddy Thanks for opening this PR! It makes sense to add options to reject NaN and infinity for some use cases.

Encoding looks great!

For decoding, we can probably handle decoding options similar to way it is done for TagsMode and IndefLengthMode:

  • Handle new decoding options in wellformedl() instead of decoding functions, so codec can reject CBOR data early without allocating decoded objects. It would also simplify decoding function because wellformed() is called before parseToValue().

  • Use the same naming convention (e.g. TagsMode has options TagsAllowed and TagsForbidden).

Thoughts?

@benluddy
Copy link
Contributor Author

benluddy commented Apr 8, 2024

Thoughts?

Sounds great. I had been thinking to myself, "what if a user needs to distinguish between ill-formed input and well-formed input that is rejected by the application's protocol." Now I realize that that case can be served just fine by a second call to Wellformed using a permissive decode mode on error cases.

I'll implement your recommendations today.

@benluddy benluddy force-pushed the float-nan-inf branch 2 times, most recently from c6c93a1 to 7c776ec Compare April 8, 2024 15:03
@benluddy
Copy link
Contributor Author

benluddy commented Apr 8, 2024

I'll implement your recommendations today.

Done. Please take another look when you have a chance.

@benluddy benluddy requested a review from fxamacker April 8, 2024 15:03
Copy link
Owner

@fxamacker fxamacker 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 updating this PR! I left some comments about checking CBOR type before converting to float.

valid.go Outdated Show resolved Hide resolved
valid.go Outdated Show resolved Hide resolved
valid.go Outdated Show resolved Hide resolved
@benluddy
Copy link
Contributor Author

D'oh! Thank you. Added test cases to catch that and fixed.

Signed-off-by: Ben Luddy <bluddy@redhat.com>
Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

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

Nice! 👍 Thanks for updating this PR!

@fxamacker fxamacker merged commit 69a85b8 into fxamacker:master Apr 20, 2024
17 checks passed
@fxamacker fxamacker added the enhancement New feature or request label Apr 22, 2024
@fxamacker fxamacker added this to the v2.7.0 milestone Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants