python-tuf/docs
Lukas Puehringer ff8819577b Adopt sslib keygen interface encryption changes
secure-systems-lab/securesystemslib#288 changes the key generation
interface functions in such a way that it is clear if a call opens
a blocking prompt, or writes the key unencrypted. To do this two
functions are added per key type:
 - `generate_and_write_*_keypair_with_prompt`
 - `generate_and_write_unencrypted_*_keypair`

The default `generate_and_write_*_keypair` function now only allows
encrypted keys and only using a passed password. This respects the
principle of secure defaults and least surprise.

sslib#288 furthermore adds a protected
`_generate_and_write_*_keypair`, which is not exposed publicly
because it does not encrypt by default, but is more flexible and
thus convenient e.g. to consume all arguments from a key generation
command line tool such as 'repo.py'.

This commit adds the new public functions to the tuf namespace and
adopts their usage accordingly.

NOTE regarding repo.py:
This commit does not fix any problematic password behavior of
'repo.py' like default passwords, etc. (see #881). It only adopts
the sslib#288 changes to maintain the current behvior, plus
removing one glaringly obsolete password prompt.

NOTE regarding key import:
The securesystemslib private key import functions were also changed
to no longer auto-prompt for decryption passwords , TUF, however,
only exposes custom wrappers (see repository_lib) that do
auto-prompt. sslib#288 changes to the prompt texts are nevertheless
propagated to tuf and reflected in this commit.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2020-11-11 10:27:56 +01:00
..
adr ADR0001: clarify when/where Python 3.6+ is expected 2020-10-27 11:25:42 +00:00
images Add banner_readme.png 2018-01-23 16:36:51 -05:00
latex Fix some typos in docs 2019-02-25 17:00:26 +07:00
papers Add Mercury paper and entry in README.rst 2017-08-31 10:13:05 -04:00
AUTHORS.txt Explaining GOVERNANCE structure to better match CNCF graduation ask 2018-10-11 10:50:47 -04:00
CHANGELOG.md Prepare 0.15.0 release (II) 2020-10-22 15:27:46 +02:00
CLI.md Add python 3 use case 2020-06-10 06:30:23 -05:00
CODE-OF-CONDUCT.md Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
CONTRIBUTORS.rst Add doc for the possible cmd args while testing 2020-10-01 15:20:59 +03:00
GETTING_STARTED.rst DOC: collapse CLI_EXAMPLES.md into CLI.md 2019-04-08 11:54:10 -04:00
GOVERNANCE.md Governance clarifications 2019-11-11 15:51:52 +01:00
INSTALLATION.rst Fix typo in section "Release Verification" 2019-12-20 10:06:44 +01:00
MAINTAINERS.txt Update MAINTAINERS 2020-05-05 21:30:28 +01:00
METADATA.md Update docs/METADATA.md to reflect recent spec change 2020-03-11 11:35:37 +00:00
OVERVIEW.rst Update deprecated links in docs 2019-02-26 08:58:59 +07:00
QUICKSTART.md Add securesystemslib[color] to packages installed in the tutorial 2020-02-18 15:05:13 +00:00
RELEASE.md Update release docs 2020-10-05 11:22:08 +01:00
ROADMAP.md DOC: Update the outdated ROADMAP.md 2019-02-26 11:22:47 -05:00
SECURITY.md Add slow retrieval disclaimer 2019-10-10 16:43:46 +02:00
TAP.rst Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
tuf-spec.0.9.txt Update link to historical tuf-spec.0.9.txt 2019-09-16 15:43:39 +02:00
tuf-spec.md Edit specifiation files to point to their new location 2017-10-11 15:49:47 -04:00
tuf-spec.txt Edit specifiation files to point to their new location 2017-10-11 15:49:47 -04:00
TUTORIAL.md Adopt sslib keygen interface encryption changes 2020-11-11 10:27:56 +01:00