Additional documentation cleanup.
PiperOrigin-RevId: 198059513
GitOrigin-RevId: b0d86b91c0a596d6e87d36bdc1e1876b77a23b7f
diff --git a/docs/PRIMITIVES.md b/docs/PRIMITIVES.md
index 1062395..d5ae624 100644
--- a/docs/PRIMITIVES.md
+++ b/docs/PRIMITIVES.md
@@ -13,6 +13,7 @@
This document describes the main properties of Tink’s primitives.
General properties of all primitives:
+
- stateless (hence thread-safe)
- copy-safe (for the parameters)
- at least 128-bit security (with an exception for RSA)
@@ -34,9 +35,10 @@
(within the range 0..2<sup>32</sup> bytes)
- CCA2 security
- at least 80-bit authentication strength
-- there are no secrecy or knowledge guarantees wrt. to the value of _associated data_
-- can encrypt at least 2<sup>32</sup> messages with a total of 2<sup>50</sup> bytes so that no
- attack has success probability larger than 2<sup>-32</sup>
+- there are no secrecy or knowledge guarantees wrt. to the value of _associated
+ data_
+- can encrypt at least 2<sup>32</sup> messages with a total of 2<sup>50</sup>
+ bytes so that no attack has success probability larger than 2<sup>-32</sup>
## Streaming Authenticated Encryption with Associated Data
@@ -51,11 +53,13 @@
ciphertext, without need of processing the entire ciphertext.
Encryption must be done in one session. There is no possibility to modify an
-existing ciphertext or to append to it (other than to reencrypt the entire file again).
+existing ciphertext or to append to it (other than to reencrypt the entire file
+again).
Instances of _Streaming AEAD_ follow the OAE2 definition proposed in the
-paper ["_Online Authenticated-Encryption and its Nonce-Reuse Misuse-Resistance_" by
-Hoang, Reyhanitabar, Rogaway and Vizár](https://eprint.iacr.org/2015/189.pdf).
+paper [_"Online Authenticated-Encryption and its Nonce-Reuse Misuse-Resistance"_
+by Hoang, Reyhanitabar, Rogaway and
+Vizár](https://eprint.iacr.org/2015/189.pdf).
Minimal properties:
@@ -64,7 +68,8 @@
0..2<sup>31</sup>-1 bytes
- CCA2 security
- at least 80-bit authentication strength
-- there are no secrecy or knowledge guarantees wrt. to the value of _associated data_
+- there are no secrecy or knowledge guarantees wrt. to the value of _associated
+ data_
- can encrypt at least 2<sup>32</sup> messages with a total of 2<sup>68</sup>
bytes so that no attack with up to 2<sup>32</sup> chosen plaintexts/chosen
ciphertexts has success probability larger than 2<sup>-32</sup>.
@@ -97,13 +102,14 @@
same message encrypted under 2<sup>32</sup> keys, they need to do
2<sup>128</sup> computations to obtain a single key.
- at least 80-bit authentication strength
-- there are no secrecy or knowledge guarantees wrt. to the value of _associated data_
+- there are no secrecy or knowledge guarantees wrt. to the value of _associated
+ data_
## Message Authentication Code
MAC primitive (Message Authentication Code) provides symmetric message
-authentication. A sender sharing a _symmetric key_ with a recipient can compute an
-_authentication tag_ for a given message, that allows for verifying that the
+authentication. A sender sharing a _symmetric key_ with a recipient can compute
+an _authentication tag_ for a given message, that allows for verifying that the
message comes from the sender and that it has not been modified. Instances of
MAC primitive are secure against existential forgery under chosen plaintext
attack, and can be deterministic or randomized. This interface should be used
@@ -114,8 +120,9 @@
Minimal properties:
- secure against existential forgery under CPA
-- at least 128-bit security, also in multi-user scenarios (when an attacker is not
- targeting a specific key, but any key from a set of up to 2<sup>32</sup> keys)
+- at least 128-bit security, also in multi-user scenarios (when an attacker is
+ not targeting a specific key, but any key from a set of up to 2<sup>32</sup>
+ keys)
- at least 80-bit authentication strength
## Hybrid Encryption
@@ -149,10 +156,12 @@
A concrete implementation of hybrid encryption can implement the binding of
_context info_ to the ciphertext in various ways, for example:
-- use context_info as "associated data"-input for the employed AEAD symmetric
+
+- use context\_info as "associated data"-input for the employed AEAD symmetric
encryption (cf. [RFC 5116](https://tools.ietf.org/html/rfc5116)).
-- use context_info as "CtxInfo"-input for HKDF (if the implementation uses HKDF
- as key derivation function, cf. [RFC 5869](https://tools.ietf.org/html/rfc5869)).
+- use context\_info as "CtxInfo"-input for HKDF (if the implementation uses HKDF
+ as key derivation function, cf.
+ [RFC 5869](https://tools.ietf.org/html/rfc5869)).
Minimal properties:
@@ -176,5 +185,5 @@
Minimal properties:
- data to be signed can have arbitrary length
-- 128-bit security for EC based schemes,
- 112-bit security for RSA based schemes (i.e. allow 2048 bit keys)
+- 128-bit security for EC based schemes
+- 112-bit security for RSA based schemes (i.e. allow 2048 bit keys)
diff --git a/examples/helloworld/cc/README.md b/examples/helloworld/cc/README.md
index 2e66e3e..f79a7f0 100644
--- a/examples/helloworld/cc/README.md
+++ b/examples/helloworld/cc/README.md
@@ -1,18 +1,18 @@
# C++ Hello World
-This is a command-line tool that can encrypt and decrypt small files using _authenticated
-encryption with associated data_ ([AEAD](https://github.com/google/tink/blob/master/doc/PRIMITIVES.md#authenticated-encryption-with-associated-data)).
+This is a command-line tool that can encrypt and decrypt small files using [AEAD
+(Authenticated Encryption with Associated
+Data)](../../../docs/PRIMITIVES.md#authenticated-encryption-with-associated-data).
It demonstrates the basic steps of using Tink, namely loading key material,
obtaining a primitive, and using the primitive to do crypto.
-Moreoever, since this app shares the same Bazel's WORKSPACE with Tink, its
-BUILD file can directly depend on Tink.
+Moreover, since this app shares the same Bazel WORKSPACE with Tink, its BUILD
+file can directly depend on Tink.
+## Build and Run
-## Build and run
-
-**Bazel**
+### Bazel
```shell
git clone https://github.com/google/tink
diff --git a/examples/helloworld/java/README.md b/examples/helloworld/java/README.md
index 5997599..4558d4c 100644
--- a/examples/helloworld/java/README.md
+++ b/examples/helloworld/java/README.md
@@ -9,15 +9,15 @@
It also shows how to add a dependency on Tink using Maven. Please checkout
the pom.xml file.
-Moreoever, since this app shares the same Bazel's WORKSPACE with Tink, its
-BUILD file can directly depend on Tink. Note that [a copy of this app]
-(https://github.com/thaidn/tink-examples/tree/master/helloworld/java) is
+Moreover, since this app shares the same Bazel's WORKSPACE with Tink, its
+BUILD file can directly depend on Tink. Note that [a copy of this
+app](https://github.com/thaidn/tink-examples/tree/master/helloworld/java) is
hosted in the tink-examples repo, which uses its own Bazel's WORKSAPCE,
-and has to add Tink as a dependency using Bazel's maven_jar rule.
+and has to add Tink as a dependency using Bazel's maven\_jar rule.
-## Build and run
+## Build and Run
-**Maven**
+### Maven
```shell
git clone https://github.com/google/tink
@@ -29,7 +29,7 @@
cat foo2.txt
```
-**Bazel**
+### Bazel
```shell
git clone https://github.com/google/tink
diff --git a/tools/tinkey/README.md b/tools/tinkey/README.md
index 5e1a76f..2a68554 100644
--- a/tools/tinkey/README.md
+++ b/tools/tinkey/README.md
@@ -1 +1 @@
-Moved to https://github.com/google/tink/blob/master/doc/TINKEY.md.
+Moved to [TINKEY.md](../../docs/TINKEY.md).
