diff options
| author | Kian-Meng, Ang <kianmeng@cpan.org> | 2021-10-23 10:15:21 +0800 |
|---|---|---|
| committer | Sybren A. Stüvel <sybren@stuvel.eu> | 2021-11-24 10:28:25 +0100 |
| commit | 3e9b33834ea005b76001d1d439fe0c1c02e7017c (patch) | |
| tree | 0904328b6f7db51fc2135a7d0dfe5c7250c3a9da /doc | |
| parent | a038aef614c656d24c5dfede07e8efe5106ed72e (diff) | |
| download | rsa-git-3e9b33834ea005b76001d1d439fe0c1c02e7017c.tar.gz | |
Fix typos
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli.rst | 2 | ||||
| -rw-r--r-- | doc/usage.rst | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/cli.rst b/doc/cli.rst index 30864d7..e06d5ee 100644 --- a/doc/cli.rst +++ b/doc/cli.rst @@ -16,7 +16,7 @@ on how to use them. Here is a short overview: +-------------------------+--------------------------------------------------+-----------------------------------------+ | Command | Usage | Core function | +=========================+==================================================+=========================================+ -| pyrsa-keygen | Generates a new RSA keypair in PEM or DER format | :py:func:`rsa.newkeys` | +| pyrsa-keygen | Generates a new RSA key pair in PEM or DER format | :py:func:`rsa.newkeys` | +-------------------------+--------------------------------------------------+-----------------------------------------+ | pyrsa-encrypt | Encrypts a file. The file must be shorter than | :py:func:`rsa.encrypt` | | | the key length in order to be encrypted. | | diff --git a/doc/usage.rst b/doc/usage.rst index 5cb5ae7..a55a2bc 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -27,7 +27,7 @@ after signing. Generating keys --------------- -You can use the :py:func:`rsa.newkeys` function to create a keypair: +You can use the :py:func:`rsa.newkeys` function to create a key pair: >>> import rsa >>> (pubkey, privkey) = rsa.newkeys(512) @@ -44,7 +44,7 @@ Alternatively you can use :py:meth:`rsa.PrivateKey.load_pkcs1` and Time to generate a key ++++++++++++++++++++++ -Generating a keypair may take a long time, depending on the number of +Generating a key pair may take a long time, depending on the number of bits required. The number of bits determines the cryptographic strength of the key, as well as the size of the message you can encrypt. If you don't mind having a slightly smaller key than you @@ -98,7 +98,7 @@ To encrypt or decrypt a message, use :py:func:`rsa.encrypt` resp. :py:func:`rsa.decrypt`. Let's say that Alice wants to send a message that only Bob can read. -#. Bob generates a keypair, and gives the public key to Alice. This is +#. Bob generates a key pair, and gives the public key to Alice. This is done such that Alice knows for sure that the key is really Bob's (for example by handing over a USB stick that contains the key). |