diff --git a/DIRECTORY.md b/DIRECTORY.md index 6e9524120e9c..90b26ae98797 100644 --- a/DIRECTORY.md +++ b/DIRECTORY.md @@ -633,6 +633,7 @@ * [SingleBitOperationsTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/bitmanipulation/SingleBitOperationsTest.java) * ciphers * a5 + * [A5CipherTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/ciphers/a5/A5CipherTest.java) * [A5KeyStreamGeneratorTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/ciphers/a5/A5KeyStreamGeneratorTest.java) * [LFSRTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/ciphers/a5/LFSRTest.java) * [AutokeyTest](https://github.com/TheAlgorithms/Java/blob/master/src/test/java/com/thealgorithms/ciphers/AutokeyTest.java) diff --git a/src/main/java/com/thealgorithms/ciphers/a5/A5Cipher.java b/src/main/java/com/thealgorithms/ciphers/a5/A5Cipher.java index b7d36db5c809..cc2e9105229a 100644 --- a/src/main/java/com/thealgorithms/ciphers/a5/A5Cipher.java +++ b/src/main/java/com/thealgorithms/ciphers/a5/A5Cipher.java @@ -2,17 +2,43 @@ import java.util.BitSet; -// https://en.wikipedia.org/wiki/A5/1 +/** + * The A5Cipher class implements the A5/1 stream cipher, which is a widely used + * encryption algorithm, particularly in mobile communications. + * + * This implementation uses a key stream generator to produce a stream of bits + * that are XORed with the plaintext bits to produce the ciphertext. + * + *
+ * For more details about the A5/1 algorithm, refer to + * Wikipedia. + *
+ */ public class A5Cipher { private final A5KeyStreamGenerator keyStreamGenerator; - private static final int KEY_STREAM_LENGTH = 228; // 28.5 bytes so we need to pad bytes or something - + private static final int KEY_STREAM_LENGTH = 228; // Length of the key stream in bits (28.5 bytes) + + /** + * Constructs an A5Cipher instance with the specified session key and frame counter. + * + * @param sessionKey a BitSet representing the session key used for encryption. + * @param frameCounter a BitSet representing the frame counter that helps in key stream generation. + */ public A5Cipher(BitSet sessionKey, BitSet frameCounter) { keyStreamGenerator = new A5KeyStreamGenerator(); keyStreamGenerator.initialize(sessionKey, frameCounter); } + /** + * Encrypts the given plaintext bits using the A5/1 cipher algorithm. + * + * This method generates a key stream and XORs it with the provided plaintext + * bits to produce the ciphertext. + * + * @param plainTextBits a BitSet representing the plaintext bits to be encrypted. + * @return a BitSet containing the encrypted ciphertext bits. + */ public BitSet encrypt(BitSet plainTextBits) { // create a copy var result = new BitSet(KEY_STREAM_LENGTH); @@ -24,6 +50,13 @@ public BitSet encrypt(BitSet plainTextBits) { return result; } + /** + * Resets the internal counter of the key stream generator. + * + * This method can be called to re-initialize the state of the key stream + * generator, allowing for new key streams to be generated for subsequent + * encryptions. + */ public void resetCounter() { keyStreamGenerator.reInitialize(); } diff --git a/src/test/java/com/thealgorithms/ciphers/a5/A5CipherTest.java b/src/test/java/com/thealgorithms/ciphers/a5/A5CipherTest.java new file mode 100644 index 000000000000..aa725b644a86 --- /dev/null +++ b/src/test/java/com/thealgorithms/ciphers/a5/A5CipherTest.java @@ -0,0 +1,51 @@ +package com.thealgorithms.ciphers.a5; + +import static org.junit.jupiter.api.Assertions.assertNotEquals; + +import java.util.BitSet; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +public class A5CipherTest { + + private A5Cipher a5Cipher; + private BitSet sessionKey; + private BitSet frameCounter; + + @BeforeEach + void setUp() { + // Initialize the session key and frame counter + sessionKey = BitSet.valueOf(new long[] {0b1010101010101010L}); + frameCounter = BitSet.valueOf(new long[] {0b0000000000000001L}); + a5Cipher = new A5Cipher(sessionKey, frameCounter); + } + + @Test + void testEncryptWithValidInput() { + BitSet plainText = BitSet.valueOf(new long[] {0b1100110011001100L}); // Example plaintext + BitSet encrypted = a5Cipher.encrypt(plainText); + + // The expected result depends on the key stream generated. + // In a real test, you would replace this with the actual expected result. + // For now, we will just assert that the encrypted result is not equal to the plaintext. + assertNotEquals(plainText, encrypted, "Encrypted output should not equal plaintext"); + } + + @Test + void testEncryptAllOnesInput() { + BitSet plainText = BitSet.valueOf(new long[] {0b1111111111111111L}); // All ones + BitSet encrypted = a5Cipher.encrypt(plainText); + + // Similar to testEncryptWithValidInput, ensure that output isn't the same as input + assertNotEquals(plainText, encrypted, "Encrypted output should not equal plaintext of all ones"); + } + + @Test + void testEncryptAllZerosInput() { + BitSet plainText = new BitSet(); // All zeros + BitSet encrypted = a5Cipher.encrypt(plainText); + + // Check that the encrypted output is not the same + assertNotEquals(plainText, encrypted, "Encrypted output should not equal plaintext of all zeros"); + } +}