From 0ba5bb4b84641f50722ecb9cc2d424db23a1c845 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Mon, 18 Jul 2016 01:32:21 +0300 Subject: README updates --- README.md | 2 +- test/README.md | 6 +++--- utils/README.md | 52 ++++++++++++++++++++++++---------------------------- 3 files changed, 28 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index ba4bc16..881bc00 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ without the support for these instructions, you can use [Intel Software Development Emulator]. After you install the emulator, you can run an executable like this: - > sde -- encrypt_block.exe -a aes128 -m ecb -- 000102030405060708090a0b0c0d0e0f 00112233445566778899aabbccddeeff + > sde -- encrypt_block -a aes128 -m ecb -- 000102030405060708090a0b0c0d0e0f 00112233445566778899aabbccddeeff 69c4e0d86a7b0430d8cdb78070b4c55a [Intel Software Development Emulator]: https://software.intel.com/en-us/articles/intel-software-development-emulator diff --git a/test/README.md b/test/README.md index db561f0..b1228d1 100644 --- a/test/README.md +++ b/test/README.md @@ -16,16 +16,16 @@ Manual testing -------------- You can validate the implementation manually using the block -encryption/decryption utilities `encrypt_block.exe` and `decrypt_block.exe`. +encryption/decryption utilities `encrypt_block` and `decrypt_block`. Pass the `--help` flag to examine the utility's usage info. ``` -> encrypt_block.exe -a aes128 -m ecb -- 000102030405060708090a0b0c0d0e0f 00112233445566778899aabbccddeeff +> encrypt_block -a aes128 -m ecb -- 000102030405060708090a0b0c0d0e0f 00112233445566778899aabbccddeeff 69c4e0d86a7b0430d8cdb78070b4c55a ``` ``` -> decrypt_block.exe -a aes192 -m cbc -- 8e73b0f7da0e6452c810f32b809079e562f8ead2522c6b7b 000102030405060708090a0b0c0d0e0f 4f021db243bc633d7178183a9fa071e8 b4d9ada9ad7dedf4e5e738763f69145a 571b242012fb7ae07fa9baac3df102e0 08b0e27988598881d920a9e64f5615cd +> decrypt_block -a aes192 -m cbc -- 8e73b0f7da0e6452c810f32b809079e562f8ead2522c6b7b 000102030405060708090a0b0c0d0e0f 4f021db243bc633d7178183a9fa071e8 b4d9ada9ad7dedf4e5e738763f69145a 571b242012fb7ae07fa9baac3df102e0 08b0e27988598881d920a9e64f5615cd 6bc1bee22e409f96e93d7e117393172a ae2d8a571e03ac9c9eb76fac45af8e51 30c81c46a35ce411e5fbc1191a0a52ef diff --git a/utils/README.md b/utils/README.md index 08d5847..1f380ef 100644 --- a/utils/README.md +++ b/utils/README.md @@ -15,7 +15,7 @@ Enable verbose output by passing the `--verbose` flag. Please note that verbose output can only be produced when *not* using the "boxes" interface (the `--use-boxes` flag). -### encrypt_block.exe +### encrypt_block Encrypts blocks using the selected algorithm in the specified mode of operation. @@ -28,7 +28,7 @@ For example, to encrypt run: - encrypt_block.exe -a aes128 -m ecb 000102030405060708090a0b0c0d0e0f 00112233445566778899aabbccddeeff + encrypt_block -a aes128 -m ecb 000102030405060708090a0b0c0d0e0f 00112233445566778899aabbccddeeff To encrypt @@ -39,9 +39,9 @@ To encrypt run: - encrypt_block.exe -a aes192 -m ofb 000102030405060708090a0b0c0d0e0f101112131415161718 22222222222222222222222222222222 00112233445566778899aabbccddeeff + encrypt_block -a aes192 -m ofb 000102030405060708090a0b0c0d0e0f101112131415161718 22222222222222222222222222222222 00112233445566778899aabbccddeeff -### decrypt_block.exe +### decrypt_block Decrypts blocks using the selected algorithm in the specified mode of operation. @@ -54,7 +54,7 @@ For example, to decrypt run: - decrypt_block.exe -a aes128 -m ecb 000102030405060708090a0b0c0d0e0f 69c4e0d86a7b0430d8cdb78070b4c55a + decrypt_block -a aes128 -m ecb 000102030405060708090a0b0c0d0e0f 69c4e0d86a7b0430d8cdb78070b4c55a To decrypt @@ -65,62 +65,62 @@ To decrypt run: - decrypt_block.exe -a aes192 -m ofb 000102030405060708090a0b0c0d0e0f101112131415161718 22222222222222222222222222222222 bda298884f5c3a9eb7068aa7063a3b75 + decrypt_block -a aes192 -m ofb 000102030405060708090a0b0c0d0e0f101112131415161718 22222222222222222222222222222222 bda298884f5c3a9eb7068aa7063a3b75 File encryption --------------- -### encrypt_file.exe +### encrypt_file Encrypts a file using the selected algorithm in the specified mode of operation. -For example, to encrypt the plaintext from `input.txt` +For example, to encrypt the plaintext from "input.txt" * using AES-128 in ECB mode * with key `0x11111111111111111111111111111111` -* and write the ciphertext to `output.txt`, +* and write the ciphertext to "output.txt", run: - encrypt_file.exe -a aes128 -m ecb -k 11111111111111111111111111111111 -i input.txt -o output.txt + encrypt_file -a aes128 -m ecb -k 11111111111111111111111111111111 -i input.txt -o output.txt -To encrypt the plaintext from `input.txt` +To encrypt the plaintext from "input.txt" * using AES-192 in OFB mode * with key `0x111111111111111111111111111111111111111111111111` * and initialization vector `0x22222222222222222222222222222222` -* and write the ciphertext to `output.txt`: +* and write the ciphertext to "output.txt": run - encrypt_file.exe -a aes192 -m ofb -k 111111111111111111111111111111111111111111111111 -v 22222222222222222222222222222222 -i input.txt -o output.txt + encrypt_file -a aes192 -m ofb -k 111111111111111111111111111111111111111111111111 -v 22222222222222222222222222222222 -i input.txt -o output.txt -### decrypt_file.exe +### decrypt_file Decrypts a file using the selected algorithm in the specified mode of operation. -To decrypt the ciphertext from `input.txt` +To decrypt the ciphertext from "input.txt" * using AES-128 in ECB mode * with key `0x11111111111111111111111111111111` -* and write the plaintext to `output.txt`, +* and write the plaintext to "output.txt", run - decrypt_file.exe -a aes128 -m ecb -k 11111111111111111111111111111111 -i input.txt -o output.txt + decrypt_file -a aes128 -m ecb -k 11111111111111111111111111111111 -i input.txt -o output.txt -To decrypt the ciphertext from `input.txt` +To decrypt the ciphertext from "input.txt" * using AES-192 in OFB mode * with key `0x111111111111111111111111111111111111111111111111` * and initialization vector `0x22222222222222222222222222222222` -* and write the plaintext to `output.txt`, +* and write the plaintext to "output.txt", run - decrypt_file.exe -a aes192 -m ofb -k 111111111111111111111111111111111111111111111111 -v 22222222222222222222222222222222 -i input.txt -o output.txt + decrypt_file -a aes192 -m ofb -k 111111111111111111111111111111111111111111111111 -v 22222222222222222222222222222222 -i input.txt -o output.txt Bitmap encryption ----------------- @@ -138,19 +138,15 @@ Plaintext BMP | Encrypted in ECB mode | Encrypted in CBC mode [cipherfly_ecb.bmp]: bmp/cipherfly_ecb.bmp [cipherfly_cbc.bmp]: bmp/cipherfly_cbc.bmp -### encrypt_bmp.exe +### encrypt_bmp Encrypts the pixels in a BMP image file, preserving the header. -The usage is the same as for [encrypt_file.exe]. +The usage is the same as for [encrypt_file](#encrypt_file). -[encrypt_file.exe]: #encrypt_fileexe - -### decrypt_bmp.exe +### decrypt_bmp Decrypts the pixels in a BMP image file, preserving the header. -The usage is the same as for [decrypt_file.exe]. - -[decrypt_file.exe]: #decrypt_fileexe +The usage is the same as for [decrypt_file](#decrypt_file). See also -------- -- cgit v1.2.3