diff options
| author | Andres Erbsen <andreser@google.com> | 2023-06-20 19:05:23 +0000 |
|---|---|---|
| committer | Boringssl LUCI CQ <boringssl-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2023-06-20 21:17:23 +0000 |
| commit | 9c30e5389c6878fc95d21e754df935a1d71f333d (patch) | |
| tree | 7ef12405f1e8cd3ff5ec6ea367f409204453d242 /third_party | |
| parent | 9fcaec6435a42cda37f3e8d4c5b8eed480c0e917 (diff) | |
| download | boringssl-9c30e5389c6878fc95d21e754df935a1d71f333d.zip boringssl-9c30e5389c6878fc95d21e754df935a1d71f333d.tar.gz boringssl-9c30e5389c6878fc95d21e754df935a1d71f333d.tar.bz2 | |
Credit CryptOpt in third_party/fiat/README.md
Change-Id: I824560a5bddb9183e61c663ca4cbdc4530177e66
Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/60945
Reviewed-by: Adam Langley <agl@google.com>
Auto-Submit: Andres Erbsen <andreser@google.com>
Commit-Queue: Adam Langley <agl@google.com>
Reviewed-by: Bob Beck <bbe@google.com>
Diffstat (limited to 'third_party')
| -rw-r--r-- | third_party/fiat/README.md | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/third_party/fiat/README.md b/third_party/fiat/README.md index 56accd4..9c1fc87 100644 --- a/third_party/fiat/README.md +++ b/third_party/fiat/README.md @@ -1,8 +1,23 @@ -# Fiat +# Fiat Cryptography -This directory contains code generated by -[Fiat](https://github.com/mit-plv/fiat-crypto) and thus these files are -licensed under the MIT license. (See LICENSE file.) +The files in this directory are generated using [Fiat +Cryptography](https://github.com/mit-plv/fiat-crypto) from the associated +library of arithmetic-implementation templates. These files are included under +the MIT license. (See LICENSE file.) -The files are imported from the `fiat-c/src` directory of the Fiat repository. -Their contents are `#include`d into source files, so we rename them to `.h`. +Some files are included directly from the `fiat-c/src` directory of the Fiat +Cryptography repository. Their contents are `#include`d into source files, so +we rename them to `.h`. Implementations that use saturated arithmetic on 64-bit +words are further manually edited to use platform-appropriate incantations for +operations such as addition with carry; these changes are marked with "`NOTE: +edited after generation`". + +# CryptOpt + +Files in the `asm` directory are compiled from Fiat-Cryptography templates +using [CryptOpt](https://github.com/0xADE1A1DE/CryptOpt). These generated +assembly files have been edited to support call-stack unwinding. The modified +files have been checked for functional correctness using the CryptOpt +translation validator that is included in the Fiat-Cryptography repository. +Correct unwinding and manual assembler-directive changes related to object-file +conventions are validated using unit tests. |