aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/utils
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-05-21 02:07:49 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-05-21 02:07:49 +0300
commitc14df0068fc2bf20686788a7dc8eb066d351dd5e (patch)
tree88b772d5b8586b5da29c6bf1adaa54ba41c20909 /utils
parenttest: README update (diff)
downloadaes-tools-c14df0068fc2bf20686788a7dc8eb066d351dd5e.tar.gz
aes-tools-c14df0068fc2bf20686788a7dc8eb066d351dd5e.zip
README updates
Diffstat (limited to 'utils')
-rw-r--r--utils/README.md59
1 files changed, 33 insertions, 26 deletions
diff --git a/utils/README.md b/utils/README.md
index a1cfeb5..312c754 100644
--- a/utils/README.md
+++ b/utils/README.md
@@ -1,24 +1,21 @@
# Utilities
-Here are a couple of useful utilities built on top of the library.
+A couple of useful utilities built on top of the library.
Each of the utilities accepts the `--help` flag, which can be used to examine
-utility's usage info.
+the utility's usage info.
The included utilities are:
-* [block encryption](#block-encryption) utilities,
-* [file encryption](#file-encryption) utilities,
-* and [bitmap encryption](#bitmap-encryption) utilities.
-
-On older CPUs, you can run the utilities
-[using Intel SDE](../README.md#running-on-older-cpus).
+* [block encryption] utilities,
+* [file encryption] utilities,
+* and [bitmap encryption] utilities.
## Block encryption
-The block encryption utilities can produce verbose human-readable output,
-including round keys, intermediate initialization vector values, etc.
-This is primarily intended for debugging purposes.
-Enable verbose output by passing the `--verbose` flag to the utilities.
+Block encryption utilities can produce verbose human-readable output, including
+round keys, intermediate initialization vector values, etc.
+Those are primarily intended for debugging purposes.
+Enable verbose output by passing the `--verbose` flag to a utilities.
Please note that verbose output can only be produced when *not* using the
"boxes" interface (the `--use-boxes` flag).
@@ -27,8 +24,6 @@ Please note that verbose output can only be produced when *not* using the
Encrypts blocks using the selected algorithm in the specified mode of
operation.
-#### Usage examples
-
For example, to encrypt
* the plaintext block `0x00112233445566778899aabbccddeeff`
@@ -55,8 +50,6 @@ run:
Decrypts blocks using the selected algorithm in the specified mode of
operation.
-#### Usage examples
-
For example, to decrypt
* the ciphertext block `0x69c4e0d86a7b0430d8cdb78070b4c55a`
@@ -85,9 +78,7 @@ run:
Encrypts a file using the selected algorithm in the specified mode of
operation.
-#### Usage examples
-
-For example, to encrypt the plaintext `input.txt`
+For example, to encrypt the plaintext from `input.txt`
* using AES-128 in ECB mode
* with key `0x11111111111111111111111111111111`
@@ -113,8 +104,6 @@ run
Decrypts a file using the selected algorithm in the specified mode of
operation.
-#### Usage examples
-
To decrypt the ciphertext from `input.txt`
* using AES-128 in ECB mode
@@ -143,16 +132,34 @@ ECB mode (namely, the fact that identical plaintext blocks get mapped to
identical ciphertext blocks).
This can be explicitly shown using 8-bit-per-pixel bitmaps:
-Plaintext BMP | Encrypted in ECB mode | Encrypted in CBC mode
-------------- | --------------------- | ---------------------
-![Plaintext butterfly](bmp/butterfly.bmp?raw=true) | ![Ciphertext butterfly in ECB mode](bmp/cipherfly_ecb.bmp?raw=true) | ![Ciphertext butterfly in CBC mode](bmp/cipherfly_cbc.bmp?raw=true)
+Plaintext BMP | Encrypted in ECB mode | Encrypted in CBC mode
+---------------- | --------------------- | ---------------------
+![butterfly.bmp] | ![cipherfly_ecb.bmp] | ![cipherfly_cbc.bmp]
### encrypt_bmp.exe
Encrypts the pixels in a BMP image file, preserving the header.
-The usage is the same as for [encrypt_file.exe](#encrypt_fileexe).
+The usage is the same as for [encrypt_file.exe].
### decrypt_bmp.exe
Decrypts the pixels in a BMP image file, preserving the header.
-The usage is the same as for [decrypt_file.exe](#decrypt_fileexe).
+The usage is the same as for [decrypt_file.exe].
+
+## See also
+
+* [Building]
+* [License]
+
+
+
+[building]: ../README.md#building
+[license]: ../README.md#license
+[block encryption]: #block-encryption
+[file encryption]: #file-encryption
+[bitmap encryption]: #bitmap-encryption
+[encrypt_file.exe]: #encrypt_fileexe
+[decrypt_file.exe]: #decrypt_fileexe
+[butterfly.bmp]: bmp/butterfly.bmp?raw=true
+[cipherfly_ecb.bmp]: bmp/cipherfly_ecb.bmp?raw=true
+[cipherfly_cbc.bmp]: bmp/cipherfly_cbc.bmp?raw=true