Fixes #21356: Validate resource adapter name (#22137)

* Add validation logic for connector resources defined through app-scoped resources

Author: mskdeepak-oracle

appserver/deployment/dol/src/main/java/com/sun/enterprise/deployment/util/LocalStrings.properties

@@ -48,4 +48,5 @@ enterprise.deployment.util.application.fail=Application validation fails for giv
 enterprise.deployment.util.descriptor.duplicate=Duplicate descriptor found for given jndi-name: [{0}]
 enterprise.deployment.util.application.lookup=Lookup failed for given jndi-name: [{0}]
 enterprise.deployment.util.unsupportedruntimealtdd=Unsupported external runtime alternate deployment descriptor [{0}]. The currently supported external runtime alternate deployment descriptors are GlassFish runtime deployment descriptors (the file name needs to contain "glassfish-")
-enterprise.deployment.util.resource.validation=JNDI lookup failed for the resource: Name: [{0}], Lookup: [{1}], Type: [{2}]
+enterprise.deployment.util.resource.validation=JNDI lookup failed for the resource: Name: [{0}], Lookup: [{1}], Type: [{2}]
+enterprise.deployment.util.ra.validation=Resource Adapter not present: RA Name: [{0}], Type: [{1}]

appserver/deployment/dol/src/main/java/com/sun/enterprise/deployment/util/ResourceValidator.java

@@ -83,6 +83,14 @@ public class ResourceValidator implements EventListener, ResourceValidatorVisito
     )
     private static final String RESOURCE_REF_JNDI_LOOKUP_FAILED = "AS-DEPLOYMENT-00026";
 
+    @LogMessageInfo(
+            message = "Resource Adapter not present: RA Name: {0}, Type: {1}.",
+            level = "SEVERE",
+            cause = "Resource apapter specified is invalid.",
+            action = "Configure the required resource adapter."
+    )
+    private static final String RESOURCE_REF_INVALID_RA = "AS-DEPLOYMENT-00027";
+
     @LogMessageInfo(message = "Skipping resource validation")
     private static final String SKIP_RESOURCE_VALIDATION = "AS-DEPLOYMENT-00028";
 
@@ -525,13 +533,21 @@ private void parseResources(ServiceReferenceDescriptor serviceRef, JndiNameEnvir
 
     /**
      * Store the resource definitions in our namespace.
-     * CFD and AODD are not valid in an AppClient.
+     * CFD and AODD are not valid in an AppClient. O/w need to validate the ra-name in them.
      */
     private void parseResources(ResourceDescriptor resourceDescriptor, JndiNameEnvironment env, AppResources appResources) {
-        if (env instanceof ApplicationClientDescriptor)
-            if (resourceDescriptor.getResourceType().equals(JavaEEResourceType.CFD) || resourceDescriptor.getResourceType().equals(JavaEEResourceType.AODD))
+        JavaEEResourceType type = resourceDescriptor.getResourceType();
+        if (type.equals(JavaEEResourceType.CFD) || type.equals(JavaEEResourceType.AODD)) {
+            if (env instanceof ApplicationClientDescriptor)
                 return;
-        storeInNamespace(resourceDescriptor.getName(), env, appResources);
+            // No need to type check as CFD and AODD extend from AbstractConnectorResourceDescriptor
+            AbstractConnectorResourceDescriptor acrd = (AbstractConnectorResourceDescriptor) resourceDescriptor;
+            appResources.store(new AppResource(resourceDescriptor.getName(), acrd.getResourceAdapter(), type.toString(), env, true));
+        }
+        else {
+            // nothing to validate here. store the definitions in our namespace.
+            storeInNamespace(resourceDescriptor.getName(), env, appResources);
+        }
     }
 
     /**
@@ -692,9 +708,82 @@ else if (jndiName.startsWith(ResourceConstants.JAVA_MODULE_SCOPE_PREFIX)) {
      */
     private void validateResources(AppResources appResources) {
         for (AppResource resource : appResources.myResources) {
-            if (resource.validate)
+            if (!resource.validate)
+                continue;
+            if (resource.getType().equals("CFD") || resource.getType().equals("AODD"))
+                validateRAName(resource);
+            else
                 validateJNDIRefs(resource, appResources.myNamespace);
         }
+        // Validate the ra-names of app scoped resources
+        // RA-name and the type of this resource are stored
+        List<Map.Entry<String, String>> raNames = (List<Map.Entry<String, String>>)
+                dc.getTransientAppMetadata().get(ResourceConstants.APP_SCOPED_RESOURCES_RA_NAMES);
+        for (Map.Entry<String, String> entry: raNames) {
+            validateRAName(entry.getKey(), entry.getValue());
+        }
+    }
+
+    /**
+     * Validate the resource adapter names of @CFD, @AODD.
+     */
+    private void validateRAName(AppResource resource) {
+        validateRAName(resource.getJndiName(), resource.getType());
+    }
+
+    /**
+     * Strategy to validate the resource adapter name:
+     *
+     * 1) In case of stand-alone RA, look in the domain.xml and for default system RA's
+     * 2) In case of embedded RA, compare it with names of RAR descriptors
+     *
+     * In case of null ra name, we fail the deployment.
+     */
+    private void validateRAName(String raname, String type) {
+        // No ra-name specified
+        if (raname == null || raname.length() == 0) {
+            deplLogger.log(Level.SEVERE, RESOURCE_REF_INVALID_RA,
+                    new Object[] {null, type});
+            throw new DeploymentException(localStrings.getLocalString("enterprise.deployment.util.ra.validation",
+                    "Resource Adapter not present: RA Name: {0}, Type: {1}.",
+                    null, type));
+        }
+        int poundIndex = raname.indexOf("#");
+
+        // Pound not present: check for app named raname in domain.xml, check for system ra's
+        if (poundIndex < 0) {
+            if (domain.getApplications().getApplication(raname) != null)
+                return;
+            // System RA's - Copied from ConnectorConstants.java
+            if (raname.equals("jmsra") || raname.equals("__ds_jdbc_ra") || raname.equals("jaxr-ra") ||
+                    raname.equals("__cp_jdbc_ra") || raname.equals("__xa_jdbc_ra") || raname.equals("__dm_jdbc_ra"))
+                return;
+            if(isEmbedded(raname))
+                return;
+        }
+        // Embedded RA
+        // In case the app name does not match, we fail the deployment
+        else if (raname.substring(0, poundIndex).equals(application.getAppName())) {
+            raname = raname.substring(poundIndex + 1);
+            if(isEmbedded(raname))
+                return;
+        }
+        deplLogger.log(Level.SEVERE, RESOURCE_REF_INVALID_RA,
+                new Object[] {raname, type});
+        throw new DeploymentException(localStrings.getLocalString(
+                "enterprise.deployment.util.ra.validation",
+                "Resource Adapter not present: RA Name: {0}, Type: {1}.",
+                raname, type));
+    }
+
+    private boolean isEmbedded(String raname) {
+        String ranameWithRAR = raname + ".rar";
+        // check for rar named this
+        for (BundleDescriptor bd : application.getBundleDescriptors(ConnectorDescriptor.class)) {
+            if(raname.equals(bd.getModuleName()) || ranameWithRAR.equals(bd.getModuleName()))
+                return true;
+        }
+        return false;
     }
 
     /**

appserver/resources/resources-runtime/src/main/java/org/glassfish/resources/module/ResourcesDeployer.java

@@ -251,6 +251,7 @@ private void processArchive(DeploymentContext dc) {
 
                 Map<String,Map<String, List>> appScopedResources = new HashMap<String,Map<String,List>>();
                 Map<String, List<String>> jndiNames = new HashMap<String, List<String>>();
+                List<Map.Entry<String, String>> raNames = new ArrayList<>();
                 Map<String, String> fileNames = new HashMap<String, String>();
 
                 String appName = getAppNameFromDeployCmdParams(dc);
@@ -285,6 +286,9 @@ private void processArchive(DeploymentContext dc) {
                     resourcesList.put(NON_CONNECTOR_RESOURCES, nonConnectorResources);
                     for (org.glassfish.resources.api.Resource resource : nonConnectorResources) {
                         String jndiName = extractJNDIName(resource);
+                        if (hasRAName(resource)) {
+                            raNames.add(new AbstractMap.SimpleEntry<>(extractRAName(resource), resource.getType()));
+                        }
                         if (jndiName != null) {
                             jndiNamesList.add(jndiName);
                         }
@@ -295,6 +299,9 @@ private void processArchive(DeploymentContext dc) {
                     resourcesList.put(CONNECTOR_RESOURCES, connectorResources);
                     for (org.glassfish.resources.api.Resource resource : connectorResources) {
                         String jndiName = extractJNDIName(resource);
+                        if (hasRAName(resource)) {
+                            raNames.add(new AbstractMap.SimpleEntry<>(extractRAName(resource), resource.getType()));
+                        }
                         if (jndiName != null) {
                             jndiNamesList.add(jndiName);
                         }
@@ -304,6 +311,7 @@ private void processArchive(DeploymentContext dc) {
                     appScopedResources.put(moduleName, resourcesList);
                 }
                 dc.addTransientAppMetaData(APP_SCOPED_RESOURCES_JNDI_NAMES, jndiNames);
+                dc.addTransientAppMetaData(APP_SCOPED_RESOURCES_RA_NAMES, raNames);
                 dc.addTransientAppMetaData(APP_SCOPED_RESOURCES_MAP, appScopedResources);
                 ApplicationInfo appInfo = appRegistry.get(appName);
                 if(appInfo != null){
@@ -329,6 +337,26 @@ private String extractJNDIName(org.glassfish.resources.api.Resource resource) {
         return (String) attrs.get(JNDI_NAME);
     }
 
+    private boolean hasRAName(org.glassfish.resources.api.Resource resource) {
+        return resource.getType().equals(ADMIN_OBJECT_RESOURCE) ||
+                resource.getType().equals(CONNECTOR_CONNECTION_POOL) ||
+                resource.getType().equals(RESOURCE_ADAPTER_CONFIG) ||
+                resource.getType().equals(CONNECTOR_WORK_SECURITY_MAP);
+    }
+
+    /**
+     * Extract the RA name for a connector resource. Collecting for resource validation.
+     *
+     * @param resource
+     * @return resource adapter name
+     */
+    private String extractRAName(org.glassfish.resources.api.Resource resource) {
+        if (resource.getType().equals(ADMIN_OBJECT_RESOURCE))
+            return (String)resource.getAttributes().get(RES_ADAPTER);
+        else
+            return (String)resource.getAttributes().get(RES_ADAPTER_NAME);
+    }
+
     private static void validateResourcesXML(File file, ResourcesXMLParser parser) throws ResourceConflictException {
         String filePath = file.getPath();
         SunResourcesXML sunResourcesXML = new SunResourcesXML(filePath, parser.getResourcesList());

nucleus/resources/src/main/java/org/glassfish/resourcebase/resources/api/ResourceConstants.java

@@ -150,6 +150,7 @@ public static enum TriState {
 
     public final static String APP_META_DATA_RESOURCES = "app-level-resources-config";
     public final static String APP_SCOPED_RESOURCES_JNDI_NAMES = "app-scoped-resources-jndi-names";
+    public final static String APP_SCOPED_RESOURCES_RA_NAMES = "app-scoped-resources-ra-names";
     public final static String APP_SCOPED_RESOURCES_MAP = "app-scoped-resources-map";
 
 }