Skip to content

Commit

Permalink
refactor: move escape method to util class
Browse files Browse the repository at this point in the history
  • Loading branch information
@joe-chacko
joe-chacko committed Oct 29, 2024
1 parent 0d5b86b commit 4b85680
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 112 deletions.
98 changes: 0 additions & 98 deletions dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/CorbanameUrlContextFactory.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,116 +14,18 @@

import static org.osgi.service.component.annotations.ConfigurationPolicy.REQUIRE;

import java.nio.charset.StandardCharsets;
import java.util.BitSet;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.naming.spi.ObjectFactory;

import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

import com.ibm.websphere.ras.Tr;
import com.ibm.websphere.ras.TraceComponent;
import com.ibm.ws.transport.iiop.spi.ClientORBRef;
import com.ibm.wsspi.application.lifecycle.ApplicationPrereq;
import com.ibm.wsspi.application.lifecycle.ApplicationRecycleComponent;

@Component(configurationPolicy=REQUIRE,property={"service.vendor=ibm","osgi.jndi.url.scheme=corbaname"})
public class CorbanameUrlContextFactory extends UrlContextFactory implements ObjectFactory, ApplicationRecycleComponent, ApplicationPrereq {
static class Escaper{
static final TraceComponent tc = Tr.register(CorbanameUrlContextFactory.Escaper.class);
private static final Pattern PERCENT_TRIPLET = Pattern.compile("%(?:[0-9a-f]{2}|[0-9A-F]{2})");
private static final Pattern ALL_LEGAL_CHARS = Pattern.compile("[;/:?@&=+\\$,\\-_.!~*’()0-9A-Za-z]*");
private static final Pattern ILLEGAL_NAME = Pattern.compile("(?:[^/]\\./|\\.[^/]*\\.|[^/]\\.$)");
private static final BitSet ESCAPE_NOT_NEEDED = new BitSet(256);
static {
for (char c : ";/:?@&=+$,-_.!~*’()".toCharArray()) {
ESCAPE_NOT_NEEDED.set(c);
}
for (char c = '0'; c <= 0xFF; c++) {
if (Character.isAlphabetic(c) || Character.isDigit(c)) {
ESCAPE_NOT_NEEDED.set(c);
}
}
}
public static String escapeCorbanameUrlIfNecessary(String url) {
final String methodName = "escapeCorbanameUrlIfNecessary(): ";
if (url == null || !!!url.startsWith("corbaname:") || url.contains("\\"))
return url;

// split on the first hash, which MUST delimit the start of the stringified name
String[] twoParts = url.split("#", 2);
// early return if there is no stringified name
if (twoParts.length < 2)
return url;

String stringifiedName = twoParts[1];
if (stringifiedName.isEmpty())
return url;

// check if it contains any percent escapes
if (PERCENT_TRIPLET.matcher(stringifiedName).find()) {
// found some - not touching this string
// if it is badly escaped then errors will arise later
return url;
}

// check for no need of escaping
if (ALL_LEGAL_CHARS.matcher(stringifiedName).matches()) {
// no characters need to be URI-escaped
// so just check for illegal dot patterns
Matcher matcher = ILLEGAL_NAME.matcher(stringifiedName);
if (!!!matcher.find()) {
// really, nothing needed replacing!
return url;
}
}

StringBuilder sn = new StringBuilder();

for (String n : stringifiedName.split("/", -1)) {
// escape backslashes
n = n.replaceAll("\\\\", "\\\\" + "\\\\");

// escape dots
n = n.replaceAll("\\.", "\\\\.");

//
sn.append(n).append("/");
}

sn.setLength(sn.length() - 1);

// now for the URI escaping...
// The CosNaming specification v1.4 2.5.3.3 specifies that:
// corbaname URLs use the escape mechanism described in the Internet Engineering
// Task Force (IETF) RFC 2396. These escape rules insure that URLs can be transferred
// via a variety of transports without undergoing changes. The character escape rules for
// the stringified name portion of a corbaname are:
//
// The CosNaming spec goes on to say that only the following characters go unescaped:
// * US-ASCII alphanumeric characters
// * any of these: ; / : ? @ & = + $ , - _ . ! ~ * ’ ( )
StringBuilder escaped = new StringBuilder(twoParts[0]).append("#");
// since we must use an octet-based representation to URI-encode, convert the string into its UTF-8 bytes
for (byte b : sn.toString().getBytes(StandardCharsets.UTF_8)) {
if (ESCAPE_NOT_NEEDED.get(b)) {
escaped.append((char) b);
} else {
escaped.append(String.format("%%%02x", 0xFF & b));
}
}

if (tc.isDebugEnabled()) Tr.debug(tc, methodName + "escaped original url " + url + " to " + escaped);
return escaped.toString();
}


}

@Activate
public CorbanameUrlContextFactory(@Reference ClientORBRef orbRef) {
super(orbRef);
Expand Down
98 changes: 96 additions & 2 deletions dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/CosNameUtil.java
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,122 @@
/*******************************************************************************
* Copyright (c) 2017 IBM Corporation and others.
* Copyright (c) 2017,2024 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-2.0/
*
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package com.ibm.ws.jndi.iiop;

import java.nio.charset.StandardCharsets;
import java.util.BitSet;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.naming.CompositeName;
import javax.naming.InvalidNameException;
import javax.naming.NamingException;

import org.omg.CosNaming.NameComponent;

import com.ibm.websphere.ras.Tr;
import com.ibm.websphere.ras.TraceComponent;
import com.ibm.ws.ffdc.annotation.FFDCIgnore;
import com.ibm.ws.jndi.WSName;

public enum CosNameUtil {
;
private static final TraceComponent tc = Tr.register(CosNameUtil.class);
private static final Pattern PERCENT_TRIPLET = Pattern.compile("%(?:[0-9a-f]{2}|[0-9A-F]{2})");
private static final Pattern ALL_LEGAL_CHARS = Pattern.compile("[;/:?@&=+\\$,\\-_.!~*’()0-9A-Za-z]*");
private static final Pattern ILLEGAL_NAME = Pattern.compile("(?:[^/]\\./|\\.[^/]*\\.|[^/]\\.$)");
private static final BitSet ESCAPE_NOT_NEEDED = new BitSet(256);
static {
for (char c : ";/:?@&=+$,-_.!~*’()".toCharArray()) {
ESCAPE_NOT_NEEDED.set(c);
}
for (char c = '0'; c <= 0xFF; c++) {
if (Character.isAlphabetic(c) || Character.isDigit(c)) {
ESCAPE_NOT_NEEDED.set(c);
}
}
}
public static String escapeCorbanameUrlIfNecessary(String url) {
final String methodName = "escapeCorbanameUrlIfNecessary(): ";
if (url == null || !!!url.startsWith("corbaname:") || url.contains("\\"))
return url;

// split on the first hash, which MUST delimit the start of the stringified name
String[] twoParts = url.split("#", 2);
// early return if there is no stringified name
if (twoParts.length < 2)
return url;

String stringifiedName = twoParts[1];
if (stringifiedName.isEmpty())
return url;

// check if it contains any percent escapes
if (PERCENT_TRIPLET.matcher(stringifiedName).find()) {
// found some - not touching this string
// if it is badly escaped then errors will arise later
return url;
}

// check for no need of escaping
if (ALL_LEGAL_CHARS.matcher(stringifiedName).matches()) {
// no characters need to be URI-escaped
// so just check for illegal dot patterns
Matcher matcher = ILLEGAL_NAME.matcher(stringifiedName);
if (!!!matcher.find()) {
// really, nothing needed replacing!
return url;
}
}

StringBuilder sn = new StringBuilder();

for (String n : stringifiedName.split("/", -1)) {
// escape backslashes
n = n.replaceAll("\\\\", "\\\\" + "\\\\");

// escape dots
n = n.replaceAll("\\.", "\\\\.");

//
sn.append(n).append("/");
}

sn.setLength(sn.length() - 1);

// now for the URI escaping...
// The CosNaming specification v1.4 2.5.3.3 specifies that:
// corbaname URLs use the escape mechanism described in the Internet Engineering
// Task Force (IETF) RFC 2396. These escape rules insure that URLs can be transferred
// via a variety of transports without undergoing changes. The character escape rules for
// the stringified name portion of a corbaname are:
//
// The CosNaming spec goes on to say that only the following characters go unescaped:
// * US-ASCII alphanumeric characters
// * any of these: ; / : ? @ & = + $ , - _ . ! ~ * ’ ( )
StringBuilder escaped = new StringBuilder(twoParts[0]).append("#");
// since we must use an octet-based representation to URI-encode, convert the string into its UTF-8 bytes
for (byte b : sn.toString().getBytes(StandardCharsets.UTF_8)) {
if (ESCAPE_NOT_NEEDED.get(b)) {
escaped.append((char) b);
} else {
escaped.append(String.format("%%%02x", 0xFF & b));
}
}

if (tc.isDebugEnabled()) Tr.debug(tc, methodName + "escaped original url " + url + " to " + escaped);
return escaped.toString();
}

static NameComponent[] cosify(WSName name) {
NameComponent[] cosName = new NameComponent[name.size()];
for (int i = 0; i < cosName.length; i++)
Expand Down
8 changes: 5 additions & 3 deletions dev/com.ibm.ws.jndi.iiop/src/com/ibm/ws/jndi/iiop/OrbContext.java
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
/*******************************************************************************
* Copyright (c) 2017 IBM Corporation and others.
* Copyright (c) 2017,2024 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-2.0/
*
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package com.ibm.ws.jndi.iiop;

import static com.ibm.ws.jndi.iiop.CosNameUtil.escapeCorbanameUrlIfNecessary;

import java.util.Hashtable;

import javax.naming.Binding;
Expand Down Expand Up @@ -50,7 +52,7 @@ public Object lookup(Name name) throws NamingException {
@FFDCIgnore(NO_IMPLEMENT.class)
public Object lookup(String name) throws NamingException {
final String methodName = "lookup(): ";
name = CorbanameUrlContextFactory.Escaper.escapeCorbanameUrlIfNecessary(name);
name = escapeCorbanameUrlIfNecessary(name);
if (tc.isDebugEnabled()) Tr.debug(tc, methodName + "");
org.omg.CORBA.Object result = orb.string_to_object(name);
if (tc.isDebugEnabled()) Tr.debug(tc, methodName + ": orb.string_to_object() returned "+result);
Expand Down
8 changes: 5 additions & 3 deletions dev/com.ibm.ws.jndi.iiop/test/com/ibm/ws/jndi/iiop/CorbanameEscapeTestSuite.java
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
/* ***************************************************************************
* Copyright (c) 2015 IBM Corporation and others.
* Copyright (c) 2015,2024 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-2.0/
*
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* ***************************************************************************/
package com.ibm.ws.jndi.iiop;

import static com.ibm.ws.jndi.iiop.CosNameUtil.escapeCorbanameUrlIfNecessary;

import java.util.Arrays;
import java.util.List;

Expand Down Expand Up @@ -213,7 +215,7 @@ private static void assertNoChange(String expected) {
}

private static void assertEscaped(String from, String to) {
String actual = TestFacade.escapeCorbanameUrlIfNecessary(from);
String actual = escapeCorbanameUrlIfNecessary(from);
Assert.assertEquals(to, actual);
}
}
8 changes: 2 additions & 6 deletions dev/com.ibm.ws.jndi.iiop/test/com/ibm/ws/jndi/iiop/TestFacade.java
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/* ***************************************************************************
* Copyright (c) 2015 IBM Corporation and others.
* Copyright (c) 2015,2024 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-2.0/
*
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
Expand Down Expand Up @@ -91,10 +91,6 @@ private static NameComponent[] cosName(String s) throws Exception {
return result;
}

public static String escapeCorbanameUrlIfNecessary(String url) {
return CorbanameUrlContextFactory.Escaper.escapeCorbanameUrlIfNecessary(url);
}

private static class TestFacadeDelegate {

final short port;
Expand Down

0 comments on commit 4b85680

Please sign in to comment.