Guida alla classe Cipher

1. Panoramica

In poche parole, la crittografia è il processo di codifica di un messaggio in modo tale che solo gli utenti autorizzati possano comprenderlo o accedervi.

Il messaggio, denominato testo in chiaro , viene crittografato utilizzando un algoritmo di crittografia - un cifrario - che genera testo cifrato che può essere letto solo da utenti autorizzati tramite decrittografia.

In questo articolo, descriviamo in dettaglio la classe Cipher principale , che fornisce funzionalità di crittografia e decrittografia crittografica in Java.

2. Cipher Class

Java Cryptography Extension (JCE) è la parte di Java Cryptography Architecture (JCA) che fornisce a un'applicazione cifrature crittografiche per la crittografia e la decrittografia dei dati, nonché l'hashing dei dati privati.

La classe Cipher , situata nel pacchetto javax.crypto , costituisce il nucleo del framework JCE, fornendo le funzionalità per la crittografia e la decrittografia.

2.1. Istanza di cifratura

Per istanziare un oggetto Cipher , chiamiamo il metodo statico getInstance , passando il nome della trasformazione richiesta . Facoltativamente, può essere specificato il nome di un provider.

Scriviamo una classe di esempio che illustri l'istanza di un cifrario :

public class Encryptor { public byte[] encryptMessage(byte[] message, byte[] keyBytes) throws InvalidKeyException, NoSuchPaddingException, NoSuchAlgorithmException { Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding"); //... } }

La trasformazione AES / ECB / PKCS5Padding indica al metodo getInstance di istanziare l' oggetto Cipher come cifrario AES con modalità operativa ECB e schema di riempimento PKCS5.

Possiamo anche istanziare l' oggetto Cipher specificando solo l'algoritmo nella trasformazione:

Cipher cipher = Cipher.getInstance("AES");

In questo caso, Java utilizzerà valori predefiniti specifici del provider per la modalità e lo schema di riempimento.

Si noti che getInstance genererà un'eccezione NoSuchAlgorithmException se la trasformazione è nulla , vuota o in un formato non valido o se il provider non la supporta.

Verrà generata un'eccezione NoSuchPaddingException se la trasformazione contiene uno schema di riempimento non supportato.

2.2. Thread-Safety

La classe Cipher è una con stato senza alcuna forma di sincronizzazione interna. È un dato di fatto, metodi come init () o update () cambieranno lo stato interno di una particolare istanza di Cipher .

Pertanto, la classe Cipher non è thread-safe. Quindi dovremmo creare un'istanza di Cipher per necessità di crittografia / decrittografia.

2.3. Chiavi

L' interfaccia Key rappresenta le chiavi per le operazioni crittografiche. Le chiavi sono contenitori opachi che contengono una chiave codificata, il formato di codifica della chiave e il suo algoritmo crittografico.

Le chiavi vengono generalmente ottenute tramite generatori di chiavi, certificati o specifiche di chiavi utilizzando una fabbrica di chiavi.

Creiamo una chiave simmetrica dai byte della chiave forniti:

SecretKey secretKey = new SecretKeySpec(keyBytes, "AES");

2.4. Inizializzazione della crittografia

Chiamiamo il metodo init () per inizializzare l' oggetto C ipher con una chiave o un certificato e un opmode che indica la modalità operativa del cifrario.

Facoltativamente, possiamo trasmettere una fonte di casualità . Per impostazione predefinita, viene utilizzata un'implementazione SecureRandom del provider installato con la priorità più alta. Altrimenti, utilizzerà una fonte fornita dal sistema.

Facoltativamente, possiamo specificare un insieme di parametri specifici dell'algoritmo. Ad esempio, possiamo passare un IvParameterSpec per specificare un vettore di inizializzazione .

Ecco le modalità operative di cifratura disponibili:

  • ENCRYPT_MODE : inizializzazione cifrario oggetto di modalità di crittografia
  • DECRYPT_MODE : inizializzazione cifrario oggetto alla modalità di decrittazione
  • WRAP_MODE : inizializza l' oggetto cifrato in modalità key-wrapping
  • UNWRAP_MODE : inizializza l' oggetto di cifratura in modalità di decompressione della chiave

Inizializziamo l' oggetto Cipher :

Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding"); SecretKey secretKey = new SecretKeySpec(keyBytes, "AES"); cipher.init(Cipher.ENCRYPT_MODE, secretKey); // ...

Ora, il metodo init genera un'eccezione InvalidKeyException se la chiave fornita non è appropriata per l'inizializzazione del cifrario, come quando la lunghezza / codifica di una chiave non è valida.

It's also thrown when the cipher requires certain algorithm parameters that cannot be determined from the key, or if the key has a key size that exceeds the maximum allowable key size (determined from the configured JCE jurisdiction policy files).

Let's look at an example using a Certificate:

public byte[] encryptMessage(byte[] message, Certificate certificate) throws InvalidKeyException, NoSuchPaddingException, NoSuchAlgorithmException { Cipher cipher = Cipher.getInstance("RSA/ECB/PKCS1Padding"); cipher.init(Cipher.ENCRYPT_MODE, certificate); // ... }

The Cipher object gets the public key for data encryption from the certificate by calling the getPublicKey method.

2.5. Encryption and Decryption

After initializing the Cipher object, we call the doFinal() method to perform the encryption or decryption operation. This method returns a byte array containing the encrypted or decrypted message.

The doFinal() method also resets the Cipher object to the state it was in when previously initialized via a call to init() method, making the Cipher object available to encrypt or decrypt additional messages.

Let's call doFinal in our encryptMessage method:

public byte[] encryptMessage(byte[] message, byte[] keyBytes) throws InvalidKeyException, NoSuchPaddingException, NoSuchAlgorithmException, BadPaddingException, IllegalBlockSizeException { Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding"); SecretKey secretKey = new SecretKeySpec(keyBytes, "AES"); cipher.init(Cipher.ENCRYPT_MODE, secretKey); return cipher.doFinal(message); }

To perform a decrypt operation, we change the opmode to DECRYPT_MODE:

public byte[] decryptMessage(byte[] encryptedMessage, byte[] keyBytes) throws NoSuchPaddingException, NoSuchAlgorithmException, InvalidKeyException, BadPaddingException, IllegalBlockSizeException { Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding"); SecretKey secretKey = new SecretKeySpec(keyBytes, "AES"); cipher.init(Cipher.DECRYPT_MODE, secretKey); return cipher.doFinal(encryptedMessage); }

2.6. Providers

Designed to use a provider-based architecture, the JCE allows for qualified cryptography libraries such as BouncyCastle to be plugged in as security providers and new algorithms to be added seamlessly.

Now let's add BouncyCastle as a security provider. We can add a security provider either statically or dynamically.

To add BouncyCastle statically, we modify the java.security file located in /jre/lib/security folder.

We add the line at the end of the list:

... security.provider.4=com.sun.net.ssl.internal.ssl.Provider security.provider.5=com.sun.crypto.provider.SunJCE security.provider.6=sun.security.jgss.SunProvider security.provider.7=org.bouncycastle.jce.provider.BouncyCastleProvider

When adding the provider property, the property key is in the format security.provider.N where the number N is one more than the last one on the list.

We can also add the BouncyCastle security provider dynamically without having to modify the security file:

Security.addProvider(new BouncyCastleProvider());

We can now specify the provider during cipher initialization:

Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding", "BC");

BC specifies BouncyCastle as the provider. We can get the list of registered providers via the Security.getProviders() method.

3. Testing Encryption and Decryption

Let's write an example test to illustrate message encryption and decryption.

In this test, we use AES encryption algorithm with a 128-bit key and assert that the decrypted result is equal to the original message text:

@Test public void whenIsEncryptedAndDecrypted_thenDecryptedEqualsOriginal() throws Exception { String encryptionKeyString = "thisisa128bitkey"; String originalMessage = "This is a secret message"; byte[] encryptionKeyBytes = encryptionKeyString.getBytes(); Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding"); SecretKey secretKey = new SecretKeySpec(encryptionKeyBytes, "AES"); cipher.init(Cipher.ENCRYPT_MODE, secretKey); byte[] encryptedMessageBytes = cipher.doFinal(message.getBytes()); cipher.init(Cipher.DECRYPT_MODE, secretKey); byte[] decryptedMessageBytes = cipher.doFinal(encryptedMessageBytes); assertThat(originalMessage).isEqualTo(new String(decryptedMessageBytes)); }

4. Conclusion

In this article, we discussed the Cipher class and presented usage examples. More details on the Cipher class and the JCE Framework can be found in the class documentation and the Java Cryptography Architecture (JCA) Reference Guide.

L'implementazione di tutti questi esempi e frammenti di codice può essere trovata su GitHub . Questo è un progetto basato su Maven, quindi dovrebbe essere facile da importare ed eseguire così com'è.