You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@groovy.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2026/08/18 09:13:00 UTC

[jira] [Commented] (GROOVY-12273) ConfigObject.writeTo breaks its round-trip contract

    [ https://issues.apache.org/jira/browse/GROOVY-12273?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18105535#comment-18105535 ] 

ASF GitHub Bot commented on GROOVY-12273:
-----------------------------------------

paulk-asert opened a new pull request, #2810:
URL: https://github.com/apache/groovy/pull/2810

   ConfigObject.writeTo documents a round trip with ConfigSlurper.parse, which compiles its output as a Groovy script. Keys were written bare unless they were Groovy keywords, and values were rendered by FormatHelper.inspect, which quotes a String but not other types. What that produced was source rather than data, and it was read back as whatever it happened to parse as.
   
   Measured before the change, writing a ConfigObject and parsing it back:
   
     key 'a b'                        did not parse
     key "a'b"                        did not parse
     key "x = <statement>; y"         *** executed on re-parse ***
     nested block under key 'a b'     did not parse
     GString value holding a dollar   did not parse
     StringBuilder value              did not parse
     GString inside a list            came back altered
     a value of any other type        did not parse
   
   The executing case is the one that matters: a key is data, and an application which stores an attacker-influenced entry name and later persists the configuration would run it.
   
   Render every key as an identifier when it is one and as a quoted literal otherwise, rather than only quoting keywords, and give a quoted leading key the receiver it needs to open a statement, which is what keyword keys have always been given. Nested blocks accept a quoted key unchanged, so only the rendering moved. writeValue now receives a key path whose components have already been rendered, because it is also called with a composed path and must not quote the path as a whole.
   
   Carry a value which has no literal form over to its text so that it is rendered as a quoted String: a CharSequence which is not a String would otherwise be written double quoted, where a dollar is live, and a value of any other type would be written as a bare toString(). Collections and maps are converted through, which covers the same value nested inside them. Numbers and booleans already write as themselves and are untouched.




> ConfigObject.writeTo breaks its round-trip contract
> ---------------------------------------------------
>
>                 Key: GROOVY-12273
>                 URL: https://issues.apache.org/jira/browse/GROOVY-12273
>             Project: Groovy
>          Issue Type: Improvement
>            Reporter: Paul King
>            Assignee: Paul King
>            Priority: Major
>




--
This message was sent by Atlassian Jira
(v8.20.10#820010)