summaryrefslogtreecommitdiff
path: root/tools/docs
AgeCommit message (Collapse)Author
2019-01-11Update Javadoc for Conscrypt-based classesAdam Vartanian
Test: make docs Bug: 117818628 Change-Id: Id9669326c725143be362fa03f2d6bf5a4bd19312
2018-02-05Update automated documentation tool.Adam Vartanian
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
2018-01-04Update crypto Javadoc.Adam Vartanian
Done using the process as described in libcore/tools/docs/crypto/README. Bug: 70704157 Test: make docs Change-Id: Ie28826c0a752297b4b5f0115279d59b762400d20
2017-10-20Remove --toolchain jdkNeil Fuller
Remove --toolchain jdk : it is the default and it's changing in vogar code. Bug: 67934307 Test: None Change-Id: Ife4cb2566ee5a0ece329908d7e21b99b61190b4a
2017-05-08Update the crypto autodocs README.Adam Vartanian
Bug: 35793879 Test: N/A Change-Id: Ie1b8b2ad54db79f0ba1381712fc4bf3243a83630
2017-05-05Add SSLEngine and SSLSocket cipher suite docs to autodocs.Adam Vartanian
Bug: 35793879 Test: Executed, replaced tables in Javadoc Change-Id: I9c0c857f2facc4b724b8c95b773c73f4060e18bd
2017-03-21Update autodoc to use non-normalized names of algorithms.Adam Vartanian
Also add some manual fixing of various inconsistencies in algorithm name capitalization used by providers. Bug: 35793879 Test: Ran run_update_crypto_support.sh Change-Id: I24a7403cf604e866bd372261f6f1a7e4742e9e55
2017-03-20Add Javadoc mode to documentation formatter.Adam Vartanian
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
2017-03-16Add special table formatting for Cipher.Adam Vartanian
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
2017-03-16Add Cipher support to autodocs.Adam Vartanian
Ciphers are more complicated than other categories because providers can declare that they provide a base algorithm but users request an algorithm/mode/padding triple, so we need to investigate the possible values of that triple and see which ones actually end up available. We ignore all the PBE ciphers because they're a mess and we don't want them to show up in the documentation. The starting API level for AES/GCM/NOPADDING is actually an educated guess, it's approximately correct but might be off by one or two. I'll update it if I later get better information. Bug: 35793879 Test: Ran run_update_crypto_support.sh Change-Id: Ifb827818626690ff223f691c8297731790074283
2017-03-14Add autodoc support for Signature.Adam Vartanian
There are a few algorithms that used to be known by one name but now are known by another, but the first name still shows up in our documentation, so I added handling to continue to support those names. I also had to do a little bit of sleuthing on when certain algorithms appeared, because they certainly were before API 26 but our API 25 docs don't mention them. They may be slightly off in one direction or another. Bug: 35793879 Test: Ran run_update_crypto_support.sh Change-Id: Ifc3e6fa3177afd82012d75eaaf7ecb26d750659d
2017-03-14Change ListProviders to run as an activity.Adam Vartanian
Contrary to what I thought before, our documentation includes Android KeyStore providers in our list of algorithm support, so run ListProviders as an activity so that those providers are included. Bug: 35793879 Test: Ran run_update_crypto_support.sh Change-Id: I88332bfa1faa67d113e5fd4bc94d0c651a59c51d
2017-03-14Crypto doc tool updates.Adam Vartanian
Add a README. Add an autogenerated-file warning to the top of the JSON file. Clean up trailing whitespace in the JSON file. Bug: 35793879 Test: Ran run_update_crypto_support.sh Change-Id: I7a997b6d13d397769132b553269313594f6c8ad4
2017-03-14Add support for more categories to crypto doc update tools.Adam Vartanian
This update includes all categories except Cipher and Signature, both of which are complicated and have lots of weird entries. Those will be added in another change. Bug: 35793879 Test: Ran run_update_crypto_support.sh Change-Id: I6e320486b5cfb2b4f6cba5575733bea959988f9b
2017-03-13Add tools for generation of crypto algorithm support documentation.Adam Vartanian
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