Jira (FACT-3198) Fact keys and values should not contain embedded null bytes

[Josh Cooper (Jira)]

Josh Cooper created an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes Issue Type: Bug Assignee: Unassigned Created: 2023/04/18 12:18 PM Priority: Normal Reporter: Josh Cooper Facter 4 should scrub embedded null unicode code points from fact keys and values, because they cannot be stored in puppetdb, resuling in errors like the following when facts are stored in puppetdb: org.postgresql.util.PSQLException: ERROR: invalid byte sequence for encoding "UTF8": 0x00 To reproduce:   PS C:\Users\Administrator> cat .\external\msi_info.yaml --- msi_info: "Alteryx 2020.2 x64 Server (Remove only)\0e\0\0\0\x11": version: 2020.2.3.27789 vendor: Alteryx installdate: '' PS C:\Users\Administrator> facter --external-dir external msi_info { Alteryx 2020.2 x64 Server (Remove only)\u0000e\u0000\u0000\u0000\u0011 => { installdate => "", vendor => "Alteryx", version => "2020.2.3.27789" } } PS C:\Users\Administrator> facter --version 4.3.1 Add Comment

This message was sent by Atlassian Jira (v8.20.11#820011-sha1:0629dd8)

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Josh Cooper Team: Phoenix

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Josh Cooper Component/s: Facter 4 Component/s: Facter 3

Add Comment

[Tony Vu (Jira)]

Tony Vu updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Tony Vu Facter 4 should scrub embedded null unicode code points from fact keys and values, because they cannot be stored in puppetdb, resuling resulting in errors like the following when facts are stored in puppetdb:

{{org.postgresql.util.PSQLException: ERROR: invalid byte sequence for encoding "UTF8": 0x00}} To reproduce:

{noformat}

PS C:\Users\Administrator> cat .\external\msi_info.yaml --- msi_info:   "Alteryx 2020.2 x64 Server (Remove only)\0e\0\0\0\x11":     version: 2020.2.3.27789     vendor: Alteryx     installdate: '' PS C:\Users\Administrator> facter --external-dir external msi_info {   Alteryx 2020.2 x64 Server (Remove only)\u0000e\u0000\u0000\u0000\u0011 => {     installdate => "",     vendor => "Alteryx",     version => "2020.2.3.27789"   } } PS C:\Users\Administrator> facter --version 4.3.1

{noformat} Acceptance criteria: * spec tests with null unicode code points; make sure it covers all fact types * Should this be restricted to the puppetdb terminus? * shouldn't require any acceptance tests

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Josh Cooper Labels: needs-validation

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Josh Cooper Priority: Normal High

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Josh Cooper Epic Link: PUP-11659

Add Comment

[Aria Li (Jira)]

Aria Li updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Aria Li Facter 4 should scrub embedded null unicode code points from fact keys and values, because they cannot be stored in puppetdb, resulting in errors like the following when facts are stored in puppetdb:

{{org.postgresql.util.PSQLException: ERROR: invalid byte sequence for encoding "UTF8": 0x00}} To reproduce:

{noformat} PS C:\Users\Administrator> cat .\external\msi_info.yaml --- msi_info:   "Alteryx 2020.2 x64 Server (Remove only)\0e\0\0\0\x11":     version: 2020.2.3.27789     vendor: Alteryx     installdate: '' PS C:\Users\Administrator> facter --external-dir external msi_info {   Alteryx 2020.2 x64 Server (Remove only)\u0000e\u0000\u0000\u0000\u0011 => {     installdate => "",     vendor => "Alteryx",     version => "2020.2.3.27789"   } } PS C:\Users\Administrator> facter --version 4.3.1 {noformat} Acceptance criteria: * spec tests with null unicode code points; make sure it covers all fact types * Should this be restricted to the puppetdb terminus? * shouldn't require any acceptance tests

* If a custom, extdrnal data or executable fact emits a valid UTF-8 string containing an embedded null byte,then facter should reject the string in the same way it does if the string is not valid UTF-8

Add Comment

This message was sent by Atlassian Jira (v8.20.21#820021-sha1:38274c8)

[Aria Li (Jira)]

* shouldn't require any acceptance tests * If a custom, extdrnal data or executable fact emits a valid UTF-8 string containing an embedded null byte,then facter should reject the string in the same way it does if the string is not valid UTF-8

** Within [normalize_string in normalization.rb|[https://github.com/puppetlabs/facter/blob/04d3d0e34bfa2503eb83442279d8e04e15a788f1/lib/facter/custom_facts/util/normalization.rb#L50-L60],] somewhere between line 55-57, the function should scan the string value to look for null character(s) and raise a normalization error just like how we do when the string can't be encoded into UTF-8

Add Comment

[Aria Li (Jira)]

* If a custom, extdrnal data or executable fact emits a valid UTF-8 string containing an embedded null byte,then facter should reject the string in the same way it does if the string is not valid UTF-8 (see FACT-1902) ** Within [normalize_string in normalization.rb| [https://github.com/puppetlabs/facter/blob/04d3d0e34bfa2503eb83442279d8e04e15a788f1/lib/facter/custom_facts/util/normalization.rb #L50-L60],] somewhere between line 55-57, the function should scan the string value to look for null character(s) and raise a normalization error just like how we do when the string can't be encoded into UTF-8

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Josh Cooper Sprint: Phoenix 2023-06-21

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Josh Cooper Fix Version/s: FACT 4.4.1

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Josh Cooper Story Points: 3

Add Comment

[Tony Vu (Jira)]

Tony Vu assigned an issue to Tony Vu

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Tony Vu Assignee: Tony Vu

Add Comment

[Christopher Thorn (Jira)]

Christopher Thorn updated an issue

Facter / FACT-3198 Fact keys and values should not contain embedded null bytes

Change By: Christopher Thorn Fix Version/s: FACT 4.4.1 Fix Version/s: FACT 4.4.2

Add Comment