github / github/codeql

Secure Java RSA Crypto Not Recognized By CodeQL

Open
#12,390 2 comments 1 reaction 0 assignees View on GitHub
false-positive Java
Dominant language
CodeQL
Stars
10.1k
Forks
2.1k
Avg merge
2d 15h
Merged PRs (30d)
141

Description

**Description of the false positive**

CodeQL is generating false positive alerts on Java applications that implement RSA cryptography securely. It is risky for Developers to get in the habit of just “Dismissing Alerts”. Instead, I would rather work with the GHAS Engineering team so the CodeQL scanner is continuously improved to better recognize and handle correctly without generating these alerts in the first place.

**Code samples or links to source code**

Not only does this code generate "Use of a broken or risky cryptographic algorithm" and "Use of a potentially broken or risky cryptographic algorithm" false positive alerts, examples on how to implement Java using RSA algorithm with recommended padding scheme is missing from these two alert recommendations. In addition to eliminating these two false positives, adding this Java RSA example to these two alert recommendations would be helpful.

```
// JAVA RSA Example
String ALGORITHM_NAME = "RSA" ;
String PADDING_SCHEME = "OAEPWITHSHA-512ANDMGF1PADDING" ;
String MODE_OF_OPERATION = "ECB" ; // This essentially means none behind the scenes for RSA

Cipher encryptCipher = Cipher.getInstance(ALGORITHM_NAME + "/" + MODE_OF_OPERATION + "/" + PADDING_SCHEME);
encryptCipher.init(Cipher.ENCRYPT_MODE, publicKey);
```
![image](https://user-images.githubusercontent.com/97243098/222767949-497f337d-72b0-4205-847b-a2ee0d52ef7a.png)

```
import java.io.DataInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.security.KeyFactory;
import java.util.Base64;
import javax.crypto.Cipher;
import java.security.spec.X509EncodedKeySpec;
import java.nio.charset.StandardCharsets;
import java.security.interfaces.RSAPrivateKey;
import java.security.interfaces.RSAPublicKey;
import java.security.spec.PKCS8EncodedKeySpec;

public class JavaRSAEncryptionTest
{
public static void main( String[] args )
{
System.out.println( "Java RSA Encryption Test!" );

String ALGORITHM_NAME = "RSA" ;
String PADDING_SCHEME = "OAEPWITHSHA-512ANDMGF1PADDING" ;
String MODE_OF_OPERATION = "ECB" ; // This essentially means none behind the scene

File publicKeyFile = new File("public_key.der");
File privateKeyFile = new File("private_key.der");

try
{
// Read in keys

// Get the private key
FileInputStream privateKeyFis = new FileInputStream(privateKeyFile);
DataInputStream privateKeyDis = new DataInputStream(privateKeyFis);
byte[] privateKeyBytes = new byte[(int) privateKeyFile.length()];
privateKeyDis.readFully(privateKeyBytes);
privateKeyDis.close();

PKCS8EncodedKeySpec privateKeySpec = new PKCS8EncodedKeySpec(privateKeyBytes);
KeyFactory keyFactoryPrivate = KeyFactory.getInstance(ALGORITHM_NAME);
RSAPrivateKey privateKey = (RSAPrivateKey) keyFactoryPrivate.generatePrivate(privateKeySpec);

// Get the public key
FileInputStream publicKeyFis = new FileInputStream(publicKeyFile);
DataInputStream publicKeyDis = new DataInputStream(publicKeyFis);
byte[] publicKeyBytes = new byte[(int) publicKeyFile.length()];
publicKeyDis.readFully(publicKeyBytes);
publicKeyDis.close();

X509EncodedKeySpec publicKeySpec = new X509EncodedKeySpec(publicKeyBytes);
KeyFactory keyFactoryPublic = KeyFactory.getInstance(ALGORITHM_NAME);
RSAPublicKey publicKey = (RSAPublicKey) keyFactoryPublic.generatePublic(publicKeySpec);

// Encrypt test string.
String secretMessage = "Test secret message";

Cipher encryptCipher = Cipher.getInstance(ALGORITHM_NAME + "/" + MODE_OF_OPERATION + "/" + PADDING_SCHEME);
encryptCipher.init(Cipher.ENCRYPT_MODE, publicKey);

byte[] secretMessageBytes = secretMessage.getBytes(StandardCharsets.UTF_8);
byte[] encryptedMessageBytes = encryptCipher.doFinal(secretMessageBytes);

String encodedMessage = Base64.getEncoder().encodeToString(encryptedMessageBytes);

Cipher decryptCipher = Cipher.getInstance(ALGORITHM_NAME + "/" + MODE_OF_OPERATION + "/" + PADDING_SCHEME);
decryptCipher.init(Cipher.DECRYPT_MODE, privateKey);
byte[] decryptedMessageBytes = decryptCipher.doFinal(encryptedMessageBytes);
String decryptedMessage = new String(decryptedMessageBytes, StandardCharsets.UTF_8);

if (secretMessage.equals(decryptedMessage))
{
System.out.println("Secret message decrypted successfully.");
}
else
{
System.out.println("Secret message decryption failed.");
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.