Skip to content

feat: add Go crypto/x509 detection rules #434

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

Open
pranjal2004838 wants to merge 1 commit into
base: main
Choose a base branch
from
+622 −14
Open

feat: add Go crypto/x509 detection rules #434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 41 additions & 0 deletions engine/src/main/java/com/ibm/engine/model/context/CertificateContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* Sonar Cryptography Plugin
* Copyright (C) 2024 PQCA
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.ibm.engine.model.context;

import java.util.HashMap;
import java.util.Map;
import javax.annotation.Nonnull;

public class CertificateContext extends DetectionContext implements IDetectionContext {

public CertificateContext() {
super(new HashMap<>());
}

public CertificateContext(@Nonnull Map<String, String> properties) {
super(properties);
}

@Nonnull
@Override
public Class<? extends IDetectionContext> type() {
return CertificateContext.class;
}
}
5 changes: 3 additions & 2 deletions go/src/main/java/com/ibm/plugin/rules/detection/GoDetectionRules.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import com.ibm.plugin.rules.detection.gocrypto.GoCryptoSHA3;
import com.ibm.plugin.rules.detection.gocrypto.GoCryptoSHA512;
import com.ibm.plugin.rules.detection.gocrypto.GoCryptoTLS;
import com.ibm.plugin.rules.detection.gocrypto.GoCryptoX509;
import java.util.List;
import java.util.stream.Stream;
import javax.annotation.Nonnull;
Expand Down Expand Up @@ -72,8 +73,8 @@ public static List<IDetectionRule<Tree>> rules() {
GoCryptoSHA256.rules().stream(),
GoCryptoSHA3.rules().stream(),
GoCryptoSHA512.rules().stream(),
GoCryptoTLS.rules().stream())
// TODO: GoCryptoX509
GoCryptoTLS.rules().stream(),
GoCryptoX509.rules().stream())
.flatMap(i -> i)
.toList();
}
Expand Down
216 changes: 216 additions & 0 deletions go/src/main/java/com/ibm/plugin/rules/detection/gocrypto/GoCryptoX509.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
/*
* Sonar Cryptography Plugin
* Copyright (C) 2024 PQCA
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.ibm.plugin.rules.detection.gocrypto;

import com.ibm.engine.model.context.CertificateContext;
import com.ibm.engine.model.context.KeyContext;
import com.ibm.engine.model.context.PrivateKeyContext;
import com.ibm.engine.model.context.PublicKeyContext;
import com.ibm.engine.model.factory.ValueActionFactory;
import com.ibm.engine.rule.IDetectionRule;
import com.ibm.engine.rule.builder.DetectionRuleBuilder;
import java.util.List;
import java.util.Map;
import javax.annotation.Nonnull;
import org.sonar.plugins.go.api.Tree;

/**
* Detection rules for Go's crypto/x509 package.
*
* <p>Detects usage of:
*
* <ul>
* <li>x509.ParseCertificate(der) - parses a single DER-encoded certificate
* <li>x509.ParseCertificates(der) - parses a sequence of DER-encoded certificates
* <li>x509.CreateCertificate(rand, tmpl, parent, pub, priv) - creates a new certificate
* <li>x509.ParseCertificateRequest(der) - parses a DER-encoded CSR
* <li>x509.CreateCertificateRequest(rand, tmpl, priv) - creates a new CSR
* <li>x509.ParsePKIXPublicKey(der) - parses a DER-encoded PKIX public key
* <li>x509.MarshalPKIXPublicKey(pub) - marshals a public key to DER-encoded PKIX format
* <li>x509.ParsePKCS1PrivateKey(der) - parses a PKCS#1-encoded private key
* <li>x509.MarshalPKCS1PrivateKey(key) - marshals a private key to PKCS#1 DER format
* <li>x509.ParsePKCS8PrivateKey(der) - parses an unencrypted PKCS#8 private key
* <li>x509.MarshalPKCS8PrivateKey(key) - marshals a private key to PKCS#8 DER format
* <li>x509.ParseECPrivateKey(der) - parses an EC private key
* <li>x509.MarshalECPrivateKey(key) - marshals an EC private key to DER format
* </ul>
*/
@SuppressWarnings("java:S1192")
public final class GoCryptoX509 {

private GoCryptoX509() {
// private
}

// x509.ParseCertificate(der []byte) (*Certificate, error)
private static final IDetectionRule<Tree> PARSE_CERTIFICATE =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("ParseCertificate")
.shouldBeDetectedAs(new ValueActionFactory<>("X509"))
.withMethodParameter("[]byte")
.buildForContext(new CertificateContext(Map.of("format", "X.509")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.ParseCertificates(der []byte) ([]*Certificate, error)
private static final IDetectionRule<Tree> PARSE_CERTIFICATES =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("ParseCertificates")
.shouldBeDetectedAs(new ValueActionFactory<>("X509"))
.withMethodParameter("[]byte")
.buildForContext(new CertificateContext(Map.of("format", "X.509")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.CreateCertificate(rand io.Reader, tmpl *Certificate, parent *Certificate,
// pub any, priv any) ([]byte, error)
private static final IDetectionRule<Tree> CREATE_CERTIFICATE =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("CreateCertificate")
.shouldBeDetectedAs(new ValueActionFactory<>("X509"))
.withMethodParameter("io.Reader")
.withMethodParameter("*x509.Certificate")
.withMethodParameter("*x509.Certificate")
.withMethodParameter("any")
.withMethodParameter("any")
.buildForContext(new CertificateContext(Map.of("format", "X.509")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();


// x509.ParsePKIXPublicKey(der []byte) (pub any, err error)
private static final IDetectionRule<Tree> PARSE_PKIX_PUBLIC_KEY =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("ParsePKIXPublicKey")
.shouldBeDetectedAs(new ValueActionFactory<>("X509"))
.withMethodParameter("[]byte")
.buildForContext(new PublicKeyContext(Map.of("kind", "X509")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.MarshalPKIXPublicKey(pub any) ([]byte, error)
private static final IDetectionRule<Tree> MARSHAL_PKIX_PUBLIC_KEY =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("MarshalPKIXPublicKey")
.shouldBeDetectedAs(new ValueActionFactory<>("X509"))
.withMethodParameter("any")
.buildForContext(new PublicKeyContext(Map.of("kind", "X509")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.ParsePKCS1PrivateKey(der []byte) (*rsa.PrivateKey, error)
private static final IDetectionRule<Tree> PARSE_PKCS1_PRIVATE_KEY =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("ParsePKCS1PrivateKey")
.shouldBeDetectedAs(new ValueActionFactory<>("PKCS1"))
.withMethodParameter("[]byte")
.buildForContext(new PrivateKeyContext(Map.of("kind", "PKCS1")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.MarshalPKCS1PrivateKey(key *rsa.PrivateKey) ([]byte, error)
private static final IDetectionRule<Tree> MARSHAL_PKCS1_PRIVATE_KEY =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("MarshalPKCS1PrivateKey")
.shouldBeDetectedAs(new ValueActionFactory<>("PKCS1"))
.withMethodParameter("*rsa.PrivateKey")
.buildForContext(new PrivateKeyContext(Map.of("kind", "PKCS1")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.ParsePKCS8PrivateKey(der []byte) (any, error)
private static final IDetectionRule<Tree> PARSE_PKCS8_PRIVATE_KEY =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("ParsePKCS8PrivateKey")
.shouldBeDetectedAs(new ValueActionFactory<>("PKCS8"))
.withMethodParameter("[]byte")
.buildForContext(new PrivateKeyContext(Map.of("kind", "PKCS8")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.MarshalPKCS8PrivateKey(key any) ([]byte, error)
private static final IDetectionRule<Tree> MARSHAL_PKCS8_PRIVATE_KEY =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("MarshalPKCS8PrivateKey")
.shouldBeDetectedAs(new ValueActionFactory<>("PKCS8"))
.withMethodParameter("any")
.buildForContext(new PrivateKeyContext(Map.of("kind", "PKCS8")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.ParseECPrivateKey(der []byte) (*ecdsa.PrivateKey, error)
private static final IDetectionRule<Tree> PARSE_EC_PRIVATE_KEY =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("ParseECPrivateKey")
.shouldBeDetectedAs(new ValueActionFactory<>("EC"))
.withMethodParameter("[]byte")
.buildForContext(new PrivateKeyContext(Map.of("kind", "EC")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

// x509.MarshalECPrivateKey(key *ecdsa.PrivateKey) ([]byte, error)
private static final IDetectionRule<Tree> MARSHAL_EC_PRIVATE_KEY =
new DetectionRuleBuilder<Tree>()
.createDetectionRule()
.forObjectTypes("crypto/x509")
.forMethods("MarshalECPrivateKey")
.shouldBeDetectedAs(new ValueActionFactory<>("EC"))
.withMethodParameter("*ecdsa.PrivateKey")
.buildForContext(new PrivateKeyContext(Map.of("kind", "EC")))
.inBundle(() -> "GoCrypto")
.withoutDependingDetectionRules();

@Nonnull
public static List<IDetectionRule<Tree>> rules() {
return List.of(
PARSE_CERTIFICATE,
PARSE_CERTIFICATES,
CREATE_CERTIFICATE,

PARSE_PKIX_PUBLIC_KEY,
MARSHAL_PKIX_PUBLIC_KEY,
PARSE_PKCS1_PRIVATE_KEY,
MARSHAL_PKCS1_PRIVATE_KEY,
PARSE_PKCS8_PRIVATE_KEY,
MARSHAL_PKCS8_PRIVATE_KEY,
PARSE_EC_PRIVATE_KEY,
MARSHAL_EC_PRIVATE_KEY);
}
}
73 changes: 61 additions & 12 deletions go/src/main/java/com/ibm/plugin/translation/translator/contexts/GoKeyContextTranslator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,24 @@
import com.ibm.mapper.mapper.gocrypto.GoCryptoKEMMapper;
import com.ibm.mapper.mapper.gocrypto.GoCryptoKeyDerivationFunctionMapper;
import com.ibm.mapper.model.INode;
import com.ibm.mapper.model.Key;
import com.ibm.mapper.model.KeyLength;
import com.ibm.mapper.model.NumberOfIterations;
import com.ibm.mapper.model.PrivateKey;
import com.ibm.mapper.model.PublicKey;
import com.ibm.mapper.model.PublicKeyEncryption;
import com.ibm.mapper.model.SaltLength;
import com.ibm.mapper.model.Signature;
import com.ibm.mapper.model.Unknown;
import com.ibm.mapper.model.algorithms.DSA;
import com.ibm.mapper.model.algorithms.ECDH;
import com.ibm.mapper.model.algorithms.ECDSA;
import com.ibm.mapper.model.algorithms.Ed25519;
import com.ibm.mapper.model.algorithms.RSA;
import com.ibm.mapper.model.Certificate;
import com.ibm.engine.model.context.PrivateKeyContext;
import com.ibm.engine.model.context.PublicKeyContext;
import com.ibm.engine.model.context.CertificateContext;
import com.ibm.mapper.model.functionality.Decapsulate;
import com.ibm.mapper.model.functionality.Encapsulate;
import com.ibm.mapper.model.functionality.Generate;
Expand All @@ -67,33 +76,52 @@ public final class GoKeyContextTranslator implements IContextTranslation<Tree> {
@Nonnull DetectionLocation detectionLocation) {
if (value instanceof ValueAction<Tree>
&& detectionContext instanceof DetectionContext context) {

if (context instanceof CertificateContext) {
String format = context.get("format").orElse("X.509");
return Optional.of(new Certificate(format, detectionLocation));
}

final GoCryptoCurveMapper curveMapper = new GoCryptoCurveMapper();

String kind = context.get("kind").orElse("");
INode algorithmNode = null;
switch (kind) {
case "RSA":
return Optional.of(new RSA(PublicKeyEncryption.class, detectionLocation));
algorithmNode = new RSA(PublicKeyEncryption.class, detectionLocation);
break;
case "ECDSA":
return Optional.of(new ECDSA(detectionLocation));
algorithmNode = new ECDSA(detectionLocation);
break;
case "Ed25519":
return Optional.of(new Ed25519(detectionLocation));
algorithmNode = new Ed25519(detectionLocation);
break;
case "DSA":
return Optional.of(new DSA(detectionLocation));
algorithmNode = new DSA(detectionLocation);
break;
case "ECDH":
// Try to parse as curve name first (e.g., "P256", "X25519")
Optional<? extends INode> curveResult =
curveMapper.parse(value.asString(), detectionLocation).map(ECDH::new);
if (curveResult.isPresent()) {
return curveResult.map(n -> n);
}
// If value is "ECDH" itself (from GenerateKey/NewPrivateKey/NewPublicKey),
// return a generic ECDH node without curve details
if ("ECDH".equals(value.asString())) {
return Optional.of(new ECDH(detectionLocation));
algorithmNode = curveResult.get();
} else if ("ECDH".equals(value.asString())) {
algorithmNode = new ECDH(detectionLocation);
}
return Optional.empty();
break;
case "PKCS1":
algorithmNode = new RSA(detectionLocation);
break;
case "PKCS8":
case "X509":
algorithmNode = new Unknown(detectionLocation);
break;
case "EC":
return curveMapper.parse(value.asString(), detectionLocation).map(f -> f);
Optional<? extends INode> parsed = curveMapper.parse(value.asString(), detectionLocation);
if (parsed.isPresent()) {
algorithmNode = parsed.get();
}
break;
case "KDF":
final GoCryptoKeyDerivationFunctionMapper kdfMapper =
new GoCryptoKeyDerivationFunctionMapper();
Expand All @@ -104,6 +132,27 @@ public final class GoKeyContextTranslator implements IContextTranslation<Tree> {
default:
return Optional.empty();
}

if (algorithmNode != null) {
if (context instanceof PrivateKeyContext) {
if (algorithmNode instanceof PublicKeyEncryption pke) {
return Optional.of(new PrivateKey(pke));
} else if (algorithmNode instanceof Signature sig) {
return Optional.of(new PrivateKey(sig));
} else if (algorithmNode instanceof Key key) {
return Optional.of(new PrivateKey(key));
}
} else if (context instanceof PublicKeyContext) {
if (algorithmNode instanceof PublicKeyEncryption pke) {
return Optional.of(new PublicKey(pke));
} else if (algorithmNode instanceof Signature sig) {
return Optional.of(new PublicKey(sig));
} else if (algorithmNode instanceof Key key) {
return Optional.of(new PublicKey(key));
}
}
return Optional.of(algorithmNode);
}
} else if (value instanceof KeySize<Tree> keySize) {
return Optional.of(new KeyLength(keySize.getValue(), detectionLocation));
} else if (value instanceof KeyAction<Tree> keyAction) {
Expand Down
Loading