OpenDaylight JIRA

OpenDaylight JIRA https://jira.opendaylight.org This file is an XML representation of an issue en-us

8.20.10

820010

22-06-2022

[CONTROLLER-130] cannot interpret '/' in urls https://jira.opendaylight.org/browse/CONTROLLER-130 controller <p>If an element id contains '/' (encoded to %2F), restconf is unable to generate xml output and fails to do so without any warning (site, stdout, log).</p> <p>Operating System: Linux<br/> Platform: PC</p> CONTROLLER-130

cannot interpret '/' in urls

Improvement Resolved Done Unassigned Dana Kutenicsova Wed, 22 Jan 2014 10:54:14 +0000 Tue, 25 Jul 2023 08:23:01 +0000 Fri, 21 Feb 2014 10:39:38 +0000 restconf 0 5 <p>I am able to replicate this bug and working to debug the same</p> <p>Hi,</p> <p>I am able to replicate the bug by following the below mentioned steps:</p> <p>PUT : <a href="http://192.168.56.1:8080/restconf/config/opendaylight-inventory:nodes/node/openflow:1/table/0/flow/22/" class="external-link" target="_blank" rel="nofollow noopener">http://192.168.56.1:8080/restconf/config/opendaylight-inventory:nodes/node/openflow:1/table/0/flow/22/</a></p> <p><?xml version="1.0" encoding="UTF-8" standalone="no"?><br/> <flow xmlns="urn:opendaylight:flow:inventory"><br/> <priority>2</priority><br/> <flow-name>Foo</flow-name><br/> <match><br/> <ethernet-match><br/> <ethernet-type><br/> <type>2048</type><br/> </ethernet-type><br/> </ethernet-match><br/> <ipv4-destination>10.0.10.2/24</ipv4-destination><br/> </match><br/> <id>22/</id><br/> <table_id>1</table_id><br/> <instructions><br/> <instruction><br/> <order>0</order><br/> <apply-actions><br/> <action><br/> <order>0</order><br/> <dec-nw-ttl/><br/> </action><br/> </apply-actions><br/> </instruction><br/> </instructions><br/> </flow></p> <p>The flow gets created and RESPONSE is 200 ok.</p> <p>When I hit the below URI it fails to generate the xml.</p> <p>GET : <a href="http://192.168.56.1:8080/restconf/config/opendaylight-inventory:nodes/node/openflow:1/table/0/flow/22/" class="external-link" target="_blank" rel="nofollow noopener">http://192.168.56.1:8080/restconf/config/opendaylight-inventory:nodes/node/openflow:1/table/0/flow/22/</a></p> <p>Following are my observations:</p> <p>1.) pathArgs array is created by slicing the above URI based on "/" delimiter. </p> <p>ControllerContext.java</p> <p> public InstanceIdWithSchemaNode toInstanceIdentifier(final String restconfInstance) {<br/> this.checkPreconditions();<br/> final String[] pathArgs = restconfInstance.split("/");<br/> boolean _isEmpty = ((List<String>)Conversions.doWrapArray(pathArgs)).isEmpty();<br/> if (_isEmpty) </p> { return null; } <p>So the logic understands flow ID - "22/" as "22" while fetching value from the URI. <br/> But the PUT body still contains flow ID as "22/" which creates a conflict and a proper flow entry is not created.</p> <p>2.) The logic can be augmented to allow users to create and retrieve flow with flow ID "22/" in URI, while the created flow in DB will still be of ID 22, thus enabling the user to get proper xml.</p> <p>Request you to please confirm if this is the expected implementation.</p> <p><a href="https://git.opendaylight.org/gerrit/#/c/5014/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/5014/</a></p> <p>logic has been augmented to allow users to create and retrieve flows having "/" in flow ID. The user gets a proper xml while retrieving the flow.</p> <p>Thanks<br/> Priyanka</p> <p>Priyanka Chopra:<br/> Restconf specification states that if the "/" slash is part of key, to distinguish it from separator must be URL-encoded to %2f.</p> <p>This bug also deeps down more, because tomcat does not allow %2f in URL or deecodes them to "/" so restconf does not get original view of URI supplied by the user.</p> <p>This requires further investigation in Jersey and Tomcat configuration in container, to find right combination when escaping will get passed to the restconf.</p> <p>Hi Tony,</p> <p>We can configure the server to allow encoded characters in origin. Although only doing this will not fix <a href="https://jira.opendaylight.org/browse/CONTROLLER-130" title="cannot interpret '/' in urls" class="issue-link" data-issue-key="CONTROLLER-130"><del>CONTROLLER-130</del></a> as the pathArgs array is created by slicing the URI based on "/" delimiter and hence the "/" will again be ignored by the code.</p> <p>Have attached the snippet below:<br/> ControllerContext.java</p> <p> public InstanceIdWithSchemaNode toInstanceIdentifier(final String restconfInstance) {<br/> this.checkPreconditions();<br/> final String[] pathArgs = restconfInstance.split("/");<br/> boolean _isEmpty = ((List<String>)Conversions.doWrapArray(pathArgs)).isEmpty();<br/> if (_isEmpty) </p> { return null; } <p>Moreover this bug is closely related with <a href="https://jira.opendaylight.org/browse/CONTROLLER-148" title="Controller should not allow to create flow with different flowID in URI and xml body" class="issue-link" data-issue-key="CONTROLLER-148"><del>CONTROLLER-148</del></a>.</p> <p>Thanks<br/> Priyanka</p> <p>The patch which should solve this issue was commited<br/> <a href="https://git.opendaylight.org/gerrit/#/c/5368/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/5368/</a></p> <p>It also is necessary to insert line<br/> org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true<br/> to config.ini file which is part of distribution package. This setting allows inserting of %2F char sequences to URI.</p> <p>It was also necessary to use @Encoded anotation before method parameters which should hold identifier in RestconfService.java interface. The annotation disables automatic decoding of specific characters from URI. So it is possible to resolve %2F in methods of RestconfService interface.</p> <p>Example<br/> Assume path which consist of list >lst< with key >ke/y<.<br/> The URI which makes it possible to access data behind this key is<br/> <a href="http://server/lst/ke%2Fy" class="external-link" target="_blank" rel="nofollow noopener">http://server/lst/ke%2Fy</a></p> <p>commit was merged</p> Development External issue ID 344 External issue URL Priority Rank 0|i02ihz: