Skip to content

feat: add user, system certificate in existing network security config #3724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 17, 2024
Merged

feat: add user, system certificate in existing network security config #3724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a72c37
add user, system certificate in existing network security config rath…
swngarg-lt Nov 11, 2024
753c2c9
prevent deleting existing network security config to modify the exist…
swngarg-lt Nov 11, 2024
d32d3ce
modified test case for certificate check.
swngarg-lt Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions brut.apktool/apktool-lib/src/main/java/brut/androlib/ApkBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,12 +343,6 @@ private void buildResourcesFull(File outDir, File manifest) throws AndrolibExcep
}

File netSecConfOrig = new File(mApkDir, "res/xml/network_security_config.xml");
if (netSecConfOrig.exists()) {
LOGGER.info("Replacing existing network_security_config.xml!");
//noinspection ResultOfMethodCallIgnored
netSecConfOrig.delete();
}

ResXmlPatcher.modNetworkSecurityConfig(netSecConfOrig);
ResXmlPatcher.setNetworkSecurityConfig(manifest);
LOGGER.info("Added permissive network security config in manifest");
Expand Down
71 changes: 50 additions & 21 deletions brut.apktool/apktool-lib/src/main/java/brut/androlib/res/xml/ResXmlPatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,30 +146,59 @@ public static void setNetworkSecurityConfig(File file) {
*/
public static void modNetworkSecurityConfig(File file)
throws ParserConfigurationException, TransformerException, IOException, SAXException {

DocumentBuilderFactory documentFactory = DocumentBuilderFactory.newInstance();
DocumentBuilder documentBuilder = documentFactory.newDocumentBuilder();
Document document = documentBuilder.newDocument();

Element root = document.createElement("network-security-config");
document.appendChild(root);
Element baseConfig = document.createElement("base-config");
root.appendChild(baseConfig);
Element trustAnchors = document.createElement("trust-anchors");
baseConfig.appendChild(trustAnchors);

Element certSystem = document.createElement("certificates");
Attr attrSystem = document.createAttribute("src");
attrSystem.setValue("system");
certSystem.setAttributeNode(attrSystem);
trustAnchors.appendChild(certSystem);

Element certUser = document.createElement("certificates");
Attr attrUser = document.createAttribute("src");
attrUser.setValue("user");
certUser.setAttributeNode(attrUser);
trustAnchors.appendChild(certUser);
Document document;
if (file.exists()) {
document = documentBuilder.parse(file);
document.getDocumentElement().normalize();
} else {
document = documentBuilder.newDocument();
}

Element root = (Element) document.getElementsByTagName("network-security-config").item(0);
if (root == null) {
root = document.createElement("network-security-config");
document.appendChild(root);
}

Element baseConfig = (Element) document.getElementsByTagName("base-config").item(0);
if (baseConfig == null) {
baseConfig = document.createElement("base-config");
root.appendChild(baseConfig);
}

Element trustAnchors = (Element) document.getElementsByTagName("trust-anchors").item(0);
if (trustAnchors == null) {
trustAnchors = document.createElement("trust-anchors");
baseConfig.appendChild(trustAnchors);
}

NodeList certificates = document.getElementsByTagName("certificates");
boolean hasSystemCert = false;
boolean hasUserCert = false;
for (int i = 0; i < certificates.getLength(); i++) {
Element cert = (Element) certificates.item(i);
String src = cert.getAttribute("src");
if ("system".equals(src)) {
hasSystemCert = true;
} else if ("user".equals(src)) {
hasUserCert = true;
}
}

if (!hasSystemCert) {
Element certSystem = document.createElement("certificates");
certSystem.setAttribute("src", "system");
trustAnchors.appendChild(certSystem);
}

if (!hasUserCert) {
Element certUser = document.createElement("certificates");
certUser.setAttribute("src", "user");
trustAnchors.appendChild(certUser);
}

saveDocument(file, document);
}

Expand Down
43 changes: 30 additions & 13 deletions brut.apktool/apktool-lib/src/test/java/brut/androlib/aapt2/NetworkConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,31 @@
package brut.androlib.aapt2;

import brut.androlib.*;
import brut.androlib.Config;
import brut.common.BrutException;
import brut.directory.ExtFile;
import brut.util.OS;
import org.custommonkey.xmlunit.XMLUnit;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
import javax.xml.xpath.XPathExpression;
import javax.xml.xpath.XPathExpressionException;

import java.io.*;
import java.nio.file.Files;
import java.nio.file.Paths;

import static org.custommonkey.xmlunit.XMLAssert.assertXMLEqual;
import static org.junit.Assert.*;

public class NetworkConfigTest extends BaseTest {
Expand Down Expand Up @@ -72,20 +78,31 @@ public void buildAndDecodeTest() {
}

@Test
public void netSecConfGeneric() throws IOException, SAXException {
LOGGER.info("Comparing network security configuration file...");
String expected = TestUtils.replaceNewlines("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>" +
"<network-security-config><base-config><trust-anchors><certificates src=\"system\"/><certificates src=\"us" +
"er\"/></trust-anchors></base-config></network-security-config>");
public void netSecConfGeneric() throws IOException, SAXException, ParserConfigurationException, XPathExpressionException {
LOGGER.info("Verifying network security configuration file contains user and system certificates...");

byte[] encoded = Files.readAllBytes(Paths.get(String.valueOf(sTestNewDir), "res/xml/network_security_config.xml"));
String obtained = TestUtils.replaceNewlines(new String(encoded));
String obtained = new String(encoded);

// Load the XML document
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setNamespaceAware(true);
DocumentBuilder builder = factory.newDocumentBuilder();
Document document = builder.parse(new ByteArrayInputStream(obtained.getBytes()));

XMLUnit.setIgnoreWhitespace(true);
XMLUnit.setIgnoreAttributeOrder(true);
XMLUnit.setCompareUnmatched(false);
// XPath expression to check for user and system certificates
XPathFactory xPathFactory = XPathFactory.newInstance();
XPath xpath = xPathFactory.newXPath();

// Check if 'system' certificate exists
XPathExpression systemCertExpr = xpath.compile("//certificates[@src='system']");
NodeList systemCertNodes = (NodeList) systemCertExpr.evaluate(document, XPathConstants.NODESET);
assertTrue(systemCertNodes.getLength() > 0);

assertXMLEqual(expected, obtained);
// Check if 'user' certificate exists
XPathExpression userCertExpr = xpath.compile("//certificates[@src='user']");
NodeList userCertNodes = (NodeList) userCertExpr.evaluate(document, XPathConstants.NODESET);
assertTrue(userCertNodes.getLength() > 0);
}

@Test
Expand Down