security-and-privacy/gnupg
security-and-privacy/gnupg
1
0
Fork 0
mirror of git://git.gnupg.org/gnupg.git synced 2024-06-14 00:19:50 +02:00
Code Activity

doc: Fix description of --s2k-* options to match gpg 2.1.

Browse Source 
--

GnuPG-bug-id: 2220
This commit is contained in:
Werner Koch 2016-01-18 08:33:55 +01:00
parent 3cccd5a83b
commit 56275e4392
No known key found for this signature in database
GPG Key ID: E3FDFF218E45B72B
1 changed files with 18 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
doc/gpg.texi
View File

@ -185,7 +185,7 @@ passphrase).
@item --store @item --store
@opindex store @opindex store
Store only (make a simple RFC1991 literal data packet). Store only (make a simple literal data packet).
@item --decrypt @item --decrypt
@itemx -d @itemx -d
@ -2268,33 +2268,32 @@ to consider (e.g. @option{--symmetric}).
@item --s2k-cipher-algo @code{name} @item --s2k-cipher-algo @code{name}
@opindex s2k-cipher-algo @opindex s2k-cipher-algo
Use @code{name} as the cipher algorithm used to protect secret keys. Use @code{name} as the cipher algorithm for symmetric encryption with
The default cipher is @value{GPGSYMENCALGO}. This cipher is also used a passphrase if @option{--personal-cipher-preferences} and
for symmetric encryption with a passphrase if @option{--cipher-algo} are not given. The default is @value{GPGSYMENCALGO}.
@option{--personal-cipher-preferences} and @option{--cipher-algo} is
not given.
@item --s2k-digest-algo @code{name} @item --s2k-digest-algo @code{name}
@opindex s2k-digest-algo @opindex s2k-digest-algo
Use @code{name} as the digest algorithm used to mangle the passphrases. Use @code{name} as the digest algorithm used to mangle the passphrases
The default algorithm is SHA-1. for symmetric encryption. The defaulte is SHA-1.
@item --s2k-mode @code{n} @item --s2k-mode @code{n}
@opindex s2k-mode @opindex s2k-mode
Selects how passphrases are mangled. If @code{n} is 0 a plain Selects how passphrases for symmetric encryption are mangled. If
passphrase (which is not recommended) will be used, a 1 adds a salt to @code{n} is 0 a plain passphrase (which is in general not recommended)
the passphrase and a 3 (the default) iterates the whole process a will be used, a 1 adds a salt (which should not be used) to the
number of times (see --s2k-count). Unless @option{--rfc1991} is used, passphrase and a 3 (the default) iterates the whole process a number
this mode is also used for symmetric encryption with a passphrase. of times (see @option{--s2k-count}).
@item --s2k-count @code{n} @item --s2k-count @code{n}
@opindex s2k-count @opindex s2k-count
Specify how many times the passphrase mangling is repeated. This Specify how many times the passphrases mangling for symmetric
value may range between 1024 and 65011712 inclusive. The default is encryption is repeated. This value may range between 1024 and
inquired from gpg-agent. Note that not all values in the 65011712 inclusive. The default is inquired from gpg-agent. Note
1024-65011712 range are legal and if an illegal value is selected, that not all values in the 1024-65011712 range are legal and if an
GnuPG will round up to the nearest legal value. This option is only illegal value is selected, GnuPG will round up to the nearest legal
meaningful if @option{--s2k-mode} is 3. value. This option is only meaningful if @option{--s2k-mode} is set
to the default of 3.
@end table @end table
@ -2340,32 +2339,6 @@ behavior. Note that this is currently the same thing as
Reset all packet, cipher and digest options to strict RFC-2440 Reset all packet, cipher and digest options to strict RFC-2440
behavior. behavior.
@ifclear gpgtowone
@item --rfc1991
@opindex rfc1991
Try to be more RFC-1991 (PGP 2.x) compliant. This option is
deprecated will be removed in GnuPG 2.1.
@item --pgp2
@opindex pgp2
Set up all options to be as PGP 2.x compliant as possible, and warn if
an action is taken (e.g. encrypting to a non-RSA key) that will create
a message that PGP 2.x will not be able to handle. Note that `PGP
2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x
available, but the MIT release is a good common baseline.
This option implies
@option{--rfc1991 --disable-mdc --no-force-v4-certs
--escape-from-lines --force-v3-sigs --allow-weak-digest-algos
--cipher-algo IDEA --digest-algo MD5 --compress-algo ZIP}.
It also disables @option{--textmode} when encrypting.
This option is deprecated will be removed in GnuPG 2.1. The reason
for dropping PGP-2 support is that the PGP 2 format is not anymore
considered safe (for example due to the use of the broken MD5 algorithm).
Note that the decryption of PGP-2 created messages will continue to work.
@end ifclear
@item --pgp6 @item --pgp6
@opindex pgp6 @opindex pgp6
Set up all options to be as PGP 6 compliant as possible. This Set up all options to be as PGP 6 compliant as possible. This