History log of /libcore/tools/docs/crypto/format_supported_algorithm_table.py
Revision Date Author Comments
1179672f16736ef3437dd4603132c5f25809179d 02-Feb-2018 Adam Vartanian <flooey@google.com> Update automated documentation tool.

Add the ability to include notes, and add a note to ChaCha20
specifying the exact ChaCha variant that's included.

Prefer the existing name over the name coming from the device,
allowing us to customize names by updating them in the JSON file. Use
AES/GCM/NoPadding over AES/GCM/NOPADDING to match other ciphers.

Wrap a number of fields with white-space:nowrap, so that algorithm
names and other identifiers aren't awkwardly broken in the middle,
like in OAEPwithSHA-1andMGF1Padding.

Add the ability to only output a single category, to more easily allow
updating Javadoc for a single class.

Bug: 70936054
Test: update_crypto_support_test.py
Change-Id: I4b2bb59adca7b003e357776783ee723bdf82302c
f28e4178ccc8943f0439f63eaf69e11dc798831f 04-May-2017 Adam Vartanian <flooey@google.com> Add SSLEngine and SSLSocket cipher suite docs to autodocs.

Bug: 35793879
Bug: 31526422
Test: Executed, replaced tables in Javadoc

(cherry picked from commit 22051136d1344e34c05659420bc49372040bd75e)

Change-Id: Ic114094dfa1c3ea6f55b65e468adda49e3153302
22051136d1344e34c05659420bc49372040bd75e 04-May-2017 Adam Vartanian <flooey@google.com> Add SSLEngine and SSLSocket cipher suite docs to autodocs.

Bug: 35793879
Test: Executed, replaced tables in Javadoc
Change-Id: I9c0c857f2facc4b724b8c95b773c73f4060e18bd
748190c9f4fb5171888cb0287adfb5b64f41607b 20-Mar-2017 Adam Vartanian <flooey@google.com> Add Javadoc mode to documentation formatter.

This required changing the output to be built up in a list and
then output at the end rather than just printed.

Bug: 35793879
Test: Ran format_supported_algorithm_table.py
Change-Id: I720a1884f77f455de00b6f6aa601ea2f6a2005a5
befc86a711b876ed6523fbe453dfa7a9adb345af 16-Mar-2017 Adam Vartanian <flooey@google.com> Add special table formatting for Cipher.

Extracts a new file for JSON loading and cleans up a couple style issues.

Updates the support for GCM to 10+, it was available at least in that
version.

Bug: 35793879
Test: Manual inspection of output
Change-Id: I84f74fd14506cb36e0744a77c0223f5e3b86ca1b
9ae0b401654f2faf408bb37808e7f6a5ede976b6 08-Mar-2017 Adam Vartanian <flooey@google.com> Add tools for generation of crypto algorithm support documentation.

The tool suite consists of:

* crypto_support.json, a JSON file that stores the name and API levels
of all the algorithms we provide or have provided in the past.
* ListProviders.java, which runs on a device and outputs a list of
all the algorithms provided by the security providers.
* update_crypto_support.py, which consumes the output of ListProviders
and rewrites the JSON file to reflect the currently-supported
algorithms.
* run_update_crypto_support.sh, which ties the previous two together
to make it more convenient to run.
* format_supported_algorithm_table.py, which reads the JSON file and
generates a set of HTML tables that can be copied-and-pasted into
documentation.

The intermediate JSON file makes it a lot easier to verify that the
tools have done the right thing after an update, instead of having
to compare the HTML output.

Only Mac and MessageDigest are included for now. I'll add additional
categories of algorithms in a future change, but I wanted to send the
code out for review before spending the time to add the data on
formerly-provided algorithms that's in the class documentation.

Bug: 35793879
Test: libcore/tools/update_crypto_support_test.py
Change-Id: Ib14722b2703cbbc45438d1168395e4e1194515a2