From 3272e995ab10b0ec8852350a31cd9b907633abe3 Mon Sep 17 00:00:00 2001 From: LexManos Date: Tue, 18 Jun 2024 11:47:11 -0700 Subject: [PATCH] Some code cleanup in ModInfo/ModFileInfo to use less streams and make things easier to debug. --- .../fml/loading/moddiscovery/ModFileInfo.java | 150 ++++++++++-------- .../fml/loading/moddiscovery/ModInfo.java | 119 +++++++------- 2 files changed, 148 insertions(+), 121 deletions(-) diff --git a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFileInfo.java b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFileInfo.java index 0dc3119eaf..804aa848c4 100644 --- a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFileInfo.java +++ b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFileInfo.java @@ -7,7 +7,6 @@ package net.minecraftforge.fml.loading.moddiscovery; import com.google.common.base.Strings; import com.mojang.logging.LogUtils; -import cpw.mods.modlauncher.api.LamdbaExceptionUtils; import net.minecraftforge.fml.loading.LogMarkers; import net.minecraftforge.fml.loading.StringUtils; import net.minecraftforge.forgespi.language.IConfigurable; @@ -18,17 +17,15 @@ import org.jetbrains.annotations.ApiStatus; import org.slf4j.Logger; import javax.security.auth.x500.X500Principal; import java.net.URL; -import java.security.CodeSigner; import java.security.InvalidKeyException; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.security.NoSuchProviderException; import java.security.SignatureException; -import java.security.cert.Certificate; +import java.security.cert.CertificateEncodingException; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import java.util.ArrayList; -import java.util.Arrays; import java.util.Collections; import java.util.LinkedHashMap; import java.util.List; @@ -37,10 +34,8 @@ import java.util.Objects; import java.util.Optional; import java.util.function.Consumer; import java.util.stream.Collectors; -import java.util.stream.Stream; -public class ModFileInfo implements IModFileInfo, IConfigurable -{ +public class ModFileInfo implements IModFileInfo, IConfigurable { private static final Logger LOGGER = LogUtils.getLogger(); private static final String MAYBE_NOT_JAVAFML_VER = "[2,)"; private static final String JAVAFML = "javafml"; @@ -60,8 +55,7 @@ public class ModFileInfo implements IModFileInfo, IConfigurable private final String license; private final List usesServices; - ModFileInfo(final ModFile modFile, final IConfigurable config, Consumer configFileConsumer) - { + ModFileInfo(final ModFile modFile, final IConfigurable config, Consumer configFileConsumer) { this.modFile = modFile; this.config = config; configFileConsumer.accept(this); @@ -86,10 +80,6 @@ public class ModFileInfo implements IModFileInfo, IConfigurable .orElse(false); this.clientSideOnly = config.getConfigElement("clientSideOnly") .orElse(false); - if (this.clientSideOnly) { - // if clientSideOnly, then this is definitely a Forge mod - maybeNotAForgeMod = false; - } this.showAsDataPack = config.getConfigElement("showAsDataPack") .orElse(false); this.usesServices = config.>getConfigElement("services") @@ -98,6 +88,10 @@ public class ModFileInfo implements IModFileInfo, IConfigurable .map(StringUtils::toURL) .orElse(null); + // if clientSideOnly, then this is definitely a Forge mod + if (this.clientSideOnly) + maybeNotAForgeMod = false; + if (maybeNotAForgeMod) { // mark this file as not a Forge mod. Note: this marker may be removed later based on the mod dependencies this.properties = config.>getConfigElement("properties") @@ -111,14 +105,13 @@ public class ModFileInfo implements IModFileInfo, IConfigurable final List modConfigs = config.getConfigList("mods"); if (modConfigs.isEmpty()) - { throw new InvalidModFileException("Missing mods list", this); - } + this.mods = modConfigs.stream() .map(mi-> (IModInfo)new ModInfo(this, mi)) .toList(); - if (LOGGER.isDebugEnabled(LogMarkers.LOADING)) - { + + if (LOGGER.isDebugEnabled(LogMarkers.LOADING)) { LOGGER.debug(LogMarkers.LOADING, "Found valid mod file {} with {} mods - versions {}", this.modFile.getFileName(), this.mods.stream().map(IModInfo::getModId).collect(Collectors.joining(",", "{", "}")), @@ -132,13 +125,11 @@ public class ModFileInfo implements IModFileInfo, IConfigurable } @Override - public List getMods() - { + public List getMods() { return mods; } - public ModFile getFile() - { + public ModFile getFile() { return this.modFile; } @@ -148,44 +139,37 @@ public class ModFileInfo implements IModFileInfo, IConfigurable } @Override - public Map getFileProperties() - { + public Map getFileProperties() { return this.properties; } @Override - public boolean showAsResourcePack() - { + public boolean showAsResourcePack() { return this.showAsResourcePack; } @Override - public boolean isClientSideOnly() - { + public boolean isClientSideOnly() { return this.clientSideOnly; } @Override - public boolean showAsDataPack() - { + public boolean showAsDataPack() { return this.showAsDataPack; } @Override - public Optional getConfigElement(final String... key) - { + public Optional getConfigElement(final String... key) { return this.config.getConfigElement(key); } @Override - public List getConfigList(final String... key) - { + public List getConfigList(final String... key) { return this.config.getConfigList(key); } @Override - public String getLicense() - { + public String getLicense() { return license; } @@ -194,49 +178,78 @@ public class ModFileInfo implements IModFileInfo, IConfigurable return this; } - public URL getIssueURL() - { + public URL getIssueURL() { return issueURL; } - public boolean missingLicense() - { + public boolean missingLicense() { return Strings.isNullOrEmpty(license); } + private final char[] HEX = "0123456789ABCDEF".toCharArray(); public Optional getCodeSigningFingerprint() { var signers = this.modFile.getSecureJar().getManifestSigners(); - return (signers == null ? Stream.of() : Arrays.stream(signers)) - .flatMap(csa->csa.getSignerCertPath().getCertificates().stream()) - .findFirst() - .map(LamdbaExceptionUtils.rethrowFunction(Certificate::getEncoded)) - .map(bytes->LamdbaExceptionUtils.uncheck(()->MessageDigest.getInstance("SHA-256")).digest(bytes)) - .map(StringUtils::binToHex) - .map(str-> String.join(":", str.split("(?<=\\G.{2})"))); + if (signers == null) + return Optional.empty(); + + for (var signer : signers) { + for (var cert : signer.getSignerCertPath().getCertificates()) { + try { + var encoded = cert.getEncoded(); + var sha256 = MessageDigest.getInstance("SHA-256"); + var digest = sha256.digest(encoded); + var buf = new StringBuilder(digest.length * 3); + for (int x = 0; x < digest.length - 1; x++) { + buf.append(HEX[(digest[x] & 0xF0) >> 4]); + buf.append(HEX[(digest[x] & 0x0F) ]); + buf.append(':'); + } + buf.append(HEX[(digest[digest.length - 1] & 0xF0) >> 4]); + buf.append(HEX[(digest[digest.length - 1] & 0x0F) ]); + + // We only care about the first. Should we list them all? + return Optional.of(buf.toString()); + } catch (CertificateEncodingException | NoSuchAlgorithmException e) { + sneak(e); + } + } + } + + return Optional.empty(); + } public Optional getTrustData() { - return Arrays.stream(this.modFile.getSecureJar().getManifestSigners()) - .flatMap(csa->csa.getSignerCertPath().getCertificates().stream()) - .findFirst() - .map(X509Certificate.class::cast) - .map(c->{ - StringBuffer sb = new StringBuffer(); - sb.append(c.getSubjectX500Principal().getName(X500Principal.RFC2253).split(",")[0]); - boolean selfSigned = false; - try { - c.verify(c.getPublicKey()); - selfSigned = true; - } catch (CertificateException | NoSuchAlgorithmException | InvalidKeyException | SignatureException | NoSuchProviderException e) { - // not self signed - } - if (selfSigned) { + var signers = this.modFile.getSecureJar().getManifestSigners(); + if (signers == null) + return Optional.empty(); + + for (var signer : signers) { + for (var cert : signer.getSignerCertPath().getCertificates()) { + if (!(cert instanceof X509Certificate x509)) + continue; + + var sb = new StringBuilder(); + sb.append(x509.getSubjectX500Principal().getName(X500Principal.RFC2253).split(",")[0]); + + var selfSigned = false; + try { + x509.verify(x509.getPublicKey()); + selfSigned = true; + } catch (CertificateException | NoSuchAlgorithmException | InvalidKeyException | SignatureException | NoSuchProviderException e) { + // not self signed + } + + if (selfSigned) sb.append(" self-signed"); - } else { - sb.append(" signed by ").append(c.getIssuerX500Principal().getName(X500Principal.RFC2253).split(",")[0]); - }; - return sb.toString(); - }); + else + sb.append(" signed by ").append(x509.getIssuerX500Principal().getName(X500Principal.RFC2253).split(",")[0]); + + return Optional.of(sb.toString()); + } + } + + return Optional.empty(); } @Override @@ -253,4 +266,9 @@ public class ModFileInfo implements IModFileInfo, IConfigurable public List usesServices() { return usesServices; } + + @SuppressWarnings("unchecked") + private static R sneak(Throwable e) throws E { + throw (E)e; + } } diff --git a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModInfo.java b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModInfo.java index b725bd331d..a4fccb38af 100644 --- a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModInfo.java +++ b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModInfo.java @@ -19,11 +19,11 @@ import org.jetbrains.annotations.ApiStatus; import org.slf4j.Logger; import java.net.URL; +import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Map; import java.util.Optional; -import java.util.function.Supplier; import java.util.regex.Pattern; @ApiStatus.Internal @@ -50,34 +50,39 @@ public class ModInfo implements IModInfo, IConfigurable { private final IConfigurable config; private final Optional modUrl; - public ModInfo(final ModFileInfo owningFile, final IConfigurable config) - { + public ModInfo(final ModFileInfo owningFile, final IConfigurable config) { Optional ownFile = Optional.ofNullable(owningFile); this.owningFile = owningFile; this.config = config; + // These are sourced from the mod specific [[mod]] entry this.modId = config.getConfigElement("modId") .orElseThrow(() -> new InvalidModFileException("Missing modId", owningFile)); + // verify we have a valid modid if (!VALID_MODID.matcher(this.modId).matches()) { LOGGER.error(LogUtils.FATAL_MARKER, "Invalid modId found in file {} - {} does not match the standard: {}", this.owningFile.getFile().getFilePath(), this.modId, VALID_MODID.pattern()); throw new InvalidModFileException("Invalid modId found : " + this.modId, owningFile); } + this.namespace = config.getConfigElement("namespace") .orElse(this.modId); + // verify our namespace is valid if (!VALID_NAMESPACE.matcher(this.namespace).matches()) { LOGGER.error(LogUtils.FATAL_MARKER, "Invalid override namespace found in file {} - {} does not match the standard: {}", this.owningFile.getFile().getFilePath(), this.namespace, VALID_NAMESPACE.pattern()); throw new InvalidModFileException("Invalid override namespace found : " + this.namespace, owningFile); } + this.version = config.getConfigElement("version") .map(s -> StringSubstitutor.replace(s, ownFile.map(ModFileInfo::getFile).orElse(null))) .map(DefaultArtifactVersion::new) .orElse(DEFAULT_VERSION); + // verify we have a valid mod version - if (!VALID_VERSION.matcher(this.version.toString()).matches()) { - throw new InvalidModFileException("Illegal version number specified "+this.version, this.getOwningFile()); - } + if (!VALID_VERSION.matcher(this.version.toString()).matches()) + throw new InvalidModFileException("Illegal version number specified " + this.version, this.getOwningFile()); + // The remaining properties all default to sensible values and are not essential this.displayName = config.getConfigElement("displayName") .orElse(this.modId); @@ -88,25 +93,48 @@ public class ModInfo implements IModInfo, IConfigurable { .orElseGet(() -> ownFile.flatMap(mf -> mf.getConfigElement("logoFile")) .orElse(null))); this.logoBlur = config.getConfigElement("logoBlur") - .orElseGet(() -> ownFile.flatMap(f -> f.getConfigElement("logoBlur")) + .orElseGet(() -> ownFile.flatMap(mf -> mf.getConfigElement("logoBlur")) .orElse(true)); this.updateJSONURL = config.getConfigElement("updateJSONURL") .map(StringUtils::toURL); this.modUrl = config.getConfigElement("modUrl") .map(StringUtils::toURL); + // These are sourced from the file rather than the mod-specific block, but with a modid tag - this.dependencies = ownFile.map(mfi -> mfi.getConfigList("dependencies", this.modId)) - .orElse(Collections.emptyList()) - .stream() - .map(dep -> new ModVersion(this, dep)) - .toList(); - this.features = ownFile.flatMap(mfi -> mfi.>getConfigElement("features", this.modId)) - .stream() - .flatMap(m->m.entrySet().stream()) - .map(this::makeBound) - .toList(); - this.properties = ownFile.flatMap(mfi -> mfi.>getConfigElement("modproperties", this.modId)) - .orElse(Collections.emptyMap()); + if (ownFile.isEmpty()) { + this.dependencies = Collections.emptyList(); + this.features = Collections.emptyList(); + this.properties = Collections.emptyMap(); + } else { + var deps = this.owningFile.getConfigList("dependencies", this.modId); + if (deps == null || deps.isEmpty()) { + this.dependencies = Collections.emptyList(); + } else { + var tmp = new ArrayList(); + for (var dep : deps) + tmp.add(new ModVersion(this, dep)); + this.dependencies = Collections.unmodifiableList(tmp); + } + + var feats = this.owningFile.>getConfigElement("features", this.modId).orElse(null); + if (feats == null) { + this.features = Collections.emptyList(); + } else { + var tmp = new ArrayList(); + for (var entry : feats.entrySet()) { + if (!(entry.getValue() instanceof String val)) + throw new InvalidModFileException("Invalid feature bound {" + entry.getValue() + "} for key {" + entry.getKey() + "} only strings are accepted", this.owningFile); + tmp.add(new ForgeFeature.Bound(entry.getKey(), val, this)); + } + this.features = Collections.unmodifiableList(tmp); + } + + var props = this.owningFile.>getConfigElement("modproperties", this.modId).orElse(null); + if (props == null) + this.properties = Collections.emptyMap(); + else + this.properties = Collections.unmodifiableMap(props); + } } @Override @@ -120,14 +148,12 @@ public class ModInfo implements IModInfo, IConfigurable { } @Override - public String getDisplayName() - { + public String getDisplayName() { return this.displayName; } @Override - public String getDescription() - { + public String getDescription() { return this.description; } @@ -157,14 +183,12 @@ public class ModInfo implements IModInfo, IConfigurable { } @Override - public Optional getLogoFile() - { + public Optional getLogoFile() { return this.logoFile; } @Override - public boolean getLogoBlur() - { + public boolean getLogoBlur() { return this.logoBlur; } @@ -193,14 +217,6 @@ public class ModInfo implements IModInfo, IConfigurable { return modUrl; } - private ForgeFeature.Bound makeBound(Map.Entry e) { - if (e.getValue() instanceof String val) { - return new ForgeFeature.Bound(e.getKey(), val, this); - } else { - throw new InvalidModFileException("Invalid feature bound {" + e.getValue() + "} for key {" + e.getKey() + "} only strings are accepted", this.owningFile); - } - } - class ModVersion implements net.minecraftforge.forgespi.language.IModInfo.ModVersion { private IModInfo owner; private final String modId; @@ -214,6 +230,7 @@ public class ModInfo implements IModInfo, IConfigurable { this.owner = owner; this.modId = config.getConfigElement("modId") .orElseThrow(()->new InvalidModFileException("Missing required field modid in dependency", getOwningFile())); + if (this.modId.equals("forge")) { var fileProps = owner.getOwningFile().getFileProperties(); // Checking containsKey to avoid a possible exception if the property is not present (due to Collections.emptyMap()) @@ -223,14 +240,15 @@ public class ModInfo implements IModInfo, IConfigurable { fileProps.remove(ModFileInfo.NOT_A_FORGE_MOD_PROP); } } + var mandatory = config.getConfigElement("mandatory"); - if (mandatory.isPresent()) { + if (mandatory.isPresent()) this.mandatory = mandatory.get(); - } else if (owner.getOwningFile().getFileProperties().containsKey(ModFileInfo.NOT_A_FORGE_MOD_PROP)) { + else if (owner.getOwningFile().getFileProperties().containsKey(ModFileInfo.NOT_A_FORGE_MOD_PROP)) this.mandatory = true; - } else { + else throw new InvalidModFileException("Missing required field mandatory in dependency", getOwningFile()); - } + this.versionRange = config.getConfigElement("versionRange") .map(MavenVersionAdapter::createFromVersionSpec) .orElse(UNBOUNDED); @@ -244,46 +262,38 @@ public class ModInfo implements IModInfo, IConfigurable { .map(StringUtils::toURL); } - @Override - public String getModId() - { + public String getModId() { return modId; } @Override - public VersionRange getVersionRange() - { + public VersionRange getVersionRange() { return versionRange; } @Override - public boolean isMandatory() - { + public boolean isMandatory() { return mandatory; } @Override - public Ordering getOrdering() - { + public Ordering getOrdering() { return ordering; } @Override - public DependencySide getSide() - { + public DependencySide getSide() { return side; } @Override - public void setOwner(final IModInfo owner) - { + public void setOwner(final IModInfo owner) { this.owner = owner; } @Override - public IModInfo getOwner() - { + public IModInfo getOwner() { return owner; } @@ -292,5 +302,4 @@ public class ModInfo implements IModInfo, IConfigurable { return referralUrl; } } - }