A cross-platform secure QR code generator for Java and Node.js that encrypts data before encoding it into QR codes.
- Generate QR codes with AES-256 encrypted content
- Cross-platform compatibility between Java and Node.js
- Configurable encryption keys
- Export as PNG file or Base64 image string
- High error correction level for reliable scanning
- Simple API with intuitive methods
Add the following dependency to your pom.xml:
com.secureqr
secure-qr
1.0.0
Add the following to your build.gradle:
implementation 'com.secureqr:secure-qr:1.0.0'Install via npm:
npm install secure-qrimport com.secureqr.SecureQR;
import java.nio.file.Paths;
// Generate a new encryption key
String encryptionKey = SecureQR.generateEncryptionKey(256);
System.out.println("Key: " + encryptionKey);
// Create SecureQR instance with the key
SecureQR secureQR = new SecureQR(encryptionKey);
// Generate encrypted QR code and save to file
secureQR.generateEncryptedQR("https://example.com/secure-data", 300, 300,
Paths.get("secure-qr.png"));
// Generate QR as Base64 string
String base64QR = secureQR.generateEncryptedQRBase64("https://example.com/secure-data", 300, 300);
// Decrypt QR data (after scanning)
String encryptedData = "..."; // Data from QR scan
String decryptedData = secureQR.decryptQR(encryptedData);const SecureQR = require('secure-qr');
// Generate a new encryption key
const encryptionKey = SecureQR.generateEncryptionKey(256);
console.log('Key:', encryptionKey);
// Create SecureQR instance with the key
const secureQR = new SecureQR(encryptionKey);
// Generate encrypted QR code and save to file
await secureQR.generateEncryptedQR('https://example.com/secure-data', {
outPath: 'secure-qr.png',
width: 300
});
// Generate QR as Base64 data URL
const base64QR = await secureQR.generateEncryptedQRBase64('https://example.com/secure-data');
// Decrypt QR data (after scanning)
const encryptedData = '...'; // Data from QR scan
const decryptedData = secureQR.decryptQR(encryptedData);public SecureQR(String encryptionKey)encryptionKey: Ba AA64 se64 encoded key (must be 16, 24, or 32 bytes for AES-128, AES-192, or AES-256)
public void generateEncryptedQR(String data, int width, int height, Path filePath) throws Exception- Encrypts
dataand generates a QR code image saved atfilePath
public String generateEncryptedQRBase64(String data, int width, int height) throws Exception- Encrypts
dataand returns QR code as Base64 encoded image string
public String encrypt(String data) throws Exception- Encrypts
dataand returns Base64 encoded encrypted string
public String decryptQR(String encryptedData) throws Exception- Decrypts
encryptedDataand returns original plaintext
public static String generateEncryptionKey(int keySize)- Generates a random encryption key of specified size (128, 192, or 256 bits)
new SecureQR(encryptionKey)encryptionKey: Base64 encoded key (must be 16, 24, or 32 bytes for AES-128, AES-192, or AES-256)
async generateEncryptedQR(data, options = {})- Encrypts
dataand generates a QR code options: Object with QR configuration (see QR options below)
async generateEncryptedQRBase64(data, options = {})- Encrypts
dataand returns QR code as Base64 data URL
encrypt(data)- Encrypts
dataand returns Base64 encoded encrypted string
decryptQR(encryptedData)- Decrypts
encryptedDataand returns original plaintext
static generateEncryptionKey(keySize = 256)- Generates a random encryption key of specified size (128, 192, or 256 bits)
outPath: File path to save the QR code (optional)width: Width of QR code in pixels (default: 300)errorCorrectionLevel: Error correction level (default: 'H')margin: White border around QR (default: 1)color.dark: Color of QR modules (default: '#000000')color.light: Background color (default: '#ffffff')
To read encrypted QR codes in your mobile app:
- Scan the QR code using your preferred scanning library
- Extract the encrypted data from the QR code
- Use the same encryption key to decrypt the data
// Assuming you've already scanned the QR and have the encrypted data
String encryptedData = qrScanResult;
SecureQR secureQR = new SecureQR(YOUR_ENCRYPTION_KEY);
String decryptedData = secureQR.decryptQR(encryptedData);Add the equivalent decryption function to your iOS app:
import CryptoSwift
func decryptQR(encryptedData: String, key: String) throws -> String {
let data = Data(base64Encoded: encryptedData)!
// Extract IV and ciphertext
let iv = data.subdata(in: 0..<12)
let authTag = data.subdata(in: data.count-16..<data.count)
let ciphertext = data.subdata(in: 12..<data.count-16)
// Decrypt using AES-GCM
let keyData = Data(base64Encoded: key)!
let aes = try AES(key: [UInt8](keyData), blockMode: GCM(iv: [UInt8](iv), authenticationTag: [UInt8](authTag)))
let decryptedBytes = try aes.decrypt([UInt8](ciphertext))
return String(bytes: decryptedBytes, encoding: .utf8)!
}-
Key Management: Store your encryption key securely. Consider using a key management service for production.
-
Cross-Platform Compatibility: The encryption implementations in Java and Node.js are designed to be compatible, using AES-GCM with the same parameters.
-
Key Rotation: Consider implementing key rotation for enhanced security.
This project is licensed under the MIT License - see the LICENSE file for details.