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

Add decoding option to allow decoding CBOR byte string into Go time.Time #517

Closed
wants to merge 1 commit into from

Conversation

ssuriyan7
Copy link
Contributor

@ssuriyan7 ssuriyan7 commented Apr 5, 2024

Currently, when cbor.Unmarshal is called with a byte string data item and time.Time as destination type, it causes UnmarshalTypeError. This change adds a decoding option to specify if this operation can be allowed.

  • Default value for this option (ByteStringToTimeForbidden) blocks decoding a byte string data item into a Go time.Time value.
  • ByteStringToTimeAllowed allows decoding a byte string data item into a Go time.Time value.

Description

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 [email protected]
  • 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.

…yte string into Go time.Time

Signed-off-by: Suriyan Subbarayan [email protected]
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.

@ssuriyan7 Thanks for opening this PR! I left a couple of suggestions.

b, _ := d.parseByteString()
t, err := time.Parse(time.RFC3339, string(b))
if err != nil {
return time.Time{}, false, errors.New("cbor: cannot set " + string(b) + " for time.Time: " + err.Error())
Copy link
Owner

Choose a reason for hiding this comment

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

We should escape control characters and non-printable characters in the error message.

Suggested change
return time.Time{}, false, errors.New("cbor: cannot set " + string(b) + " for time.Time: " + err.Error())
return time.Time{}, false, errors.New("cbor: cannot set " + strconv.Quote(string(b)) + " for time.Time: " + err.Error())

Comment on lines +8808 to +8812
name: "Unmarshal an invalid byte string to time.Time when ByteStringToTime is set to ByteStringToTimeAllowed",
opts: DecOptions{ByteStringToTime: ByteStringToTimeAllowed},
in: hexDecode("4B696E76616C696454657874"), // 'invalidText'
wantErrorMsg: "cbor: cannot set invalidText for time.Time: parsing time \"invalidText\" as \"2006-01-02T15:04:05Z07:00\": cannot parse \"invalidText\" as \"2006\"",
},
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe add a test with byte string containing some invalid UTF-8 characters.

@fxamacker fxamacker changed the title Adds a decoding option to specify the behavior when decoding a cbor byte string into Go time.Time Add decoding option to allow decoding CBOR byte string into Go time.Time Apr 8, 2024
@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
@benluddy
Copy link
Contributor

I opened #524 to nudge this over the finish line. This is necessary for cases that were dependent on the behavior of the bug #501, which has since been fixed. Thank you @ssuriyan7 for your work on this! I took care to retain you as the commit author on my updated branch.

@fxamacker
Copy link
Owner

This PR is completed by @benluddy's PR #524.

Thanks @ssuriyan7 for opening this PR and your other contributions too! 👍

@fxamacker fxamacker closed this Apr 28, 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.

3 participants