security-and-privacy/gnupg
security-and-privacy/gnupg
1
0
Fork 0
mirror of git://git.gnupg.org/gnupg.git synced 2024-11-12 21:58:50 +01:00
Code Activity

* gpg.sgml: Warning not to try and parse --list-keys in scripts. Document

Browse Source 
the signature flags (1-3/L/R/P/N/X), Document expandos %g and %p.  Note
the default --personal-digest-preferences are "H2".

* DETAILS: Document the --attribute-fd data.
This commit is contained in:
David Shaw 2003-07-03 04:59:50 +00:00
parent dcc026f7e0
commit c1142ffd27
3 changed files with 69 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/ChangeLog
View File

@ -1,3 +1,11 @@
2003-07-02 David Shaw <dshaw@jabberwocky.com>
* gpg.sgml: Warning not to try and parse --list-keys in scripts.
Document the signature flags (1-3/L/R/P/N/X), Document expandos %g
and %p. Note the default --personal-digest-preferences are "H2".
* DETAILS: Document the --attribute-fd data.
2003-06-18 David Shaw <dshaw@jabberwocky.com>
* Add pointer in --ignore-time-conflict to see --ignore-valid

26
doc/DETAILS
View File

@ -425,6 +425,32 @@ more arguments in future versions.
0x04 = this attribute packet is expired
Format of the "--attribute-fd" output
=====================================
When --attribute-fd is set, during key listings (--list-keys,
--list-secret-keys) GnuPG dumps each attribute packet to the file
descriptor specified. --attribute-fd is intended for use with
--status-fd as part of the required information is carried on the
ATTRIBUTE status tag (see above).
The contents of the attribute data is specified by 2440bis, but for
convenience, here is the Photo ID format, as it is currently the only
attribute defined:
Byte 0-1: The length of the image header. Due to a historical
accident (i.e. oops!) back in the NAI PGP days, this is
a little-endian number. Currently 16 (0x10 0x00).
Byte 2: The image header version. Currently 0x01.
Byte 3: Encoding format. 0x01 == JPEG.
Byte 4-15: Reserved, and currently unused.
All other data after this header is raw image (JPEG) data.
Key generation
==============
Key generation shows progress by printing different characters to

46
doc/gpg.sgml
View File

@ -215,8 +215,13 @@ B<-k> [I<username>] [I<keyring>]
<term>--list-keys &OptParmNames;</term>
<term>--list-public-keys &OptParmNames;</term>
<listitem><para>
List all keys from the public keyrings, or just the
ones given on the command line.
List all keys from the public keyrings, or just the ones given on the
command line.
</para><para>
Avoid using the output of this command in scripts or other programs as
it is likely to change as GnuPG changes. See --with-colons for a
machine-parseable key listing command that is appropriate for use in
scripts and other programs.
</para></listitem></varlistentry>
@ -234,6 +239,16 @@ is not usable (for example, if it was created via
<term>--list-sigs &OptParmNames;</term>
<listitem><para>
Same as --list-keys, but the signatures are listed too.
</para><para>
For each signature listed, there are several flags in between the
"sig" tag and keyid. These flags give additional information about
each signature. From left to right, they are the numbers 1-3 for
certificate check level (see --default-cert-check-level), "L" for a
local or non-exportable signature (see --lsign-key), "R" for a
nonRevocable signature (see --nrsign-key), "P" for a signature that
contains a policy URL (see --cert-policy-url), "N" for a signature
that contains a notation (see --cert-notation), and "X" for an eXpired
signature (see --ask-cert-expire).
</para></listitem></varlistentry>
@ -1178,6 +1193,7 @@ photo ID attached to the key, if any. See also --photo-viewer.
<varlistentry>
<term>--photo-viewer &ParmString;</term>
<listitem><para>
This is the command line that should be run to view a photo ID. "%i"
will be expanded to a filename containing the photo. "%I" does the
same, except the file will not be deleted once the viewer exits.
@ -1188,7 +1204,8 @@ and "%%" for an actual percent sign. If neither %i or %I are present,
then the photo will be supplied to the viewer on standard input.
</para><para>
The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
stdin"
stdin". Note that if your image viewer program is not secure, then
executing it from GnuPG does not make it secure.
</para></listitem></varlistentry>
<varlistentry>
@ -1437,12 +1454,14 @@ sets both.
<para>
There are special codes that may be used in notation names. "%k" will
be expanded into the key ID of the key being signed, "%K" for the long
key ID of the key being signed, "%f" for the key fingerprint of the
key being signed, "%s" for the key ID of the key making the signature,
"%S" for the long key ID of the key making the signature, and "%%"
results in a single "%". %k, %K, and %f are only meaningful when
making a key signature (certification).
be expanded into the key ID of the key being signed, "%K" into the
long key ID of the key being signed, "%f" into the fingerprint of the
key being signed, "%s" into the key ID of the key making the
signature, "%S" into the long key ID of the key making the signature,
"%g" into the fingerprint of the key making the signature (which might
be a subkey), "%p" into the fingerprint of the primary key of the key
making the signature, and "%%" results in a single "%". %k, %K, and
%f are only meaningful when making a key signature (certification).
</para>
</listitem></varlistentry>
@ -2024,8 +2043,12 @@ verification is not needed.
<varlistentry>
<term>--with-colons</term>
<listitem><para>
Print key listings delimited by colons. Note, that the output will be
encoded in UTF-8 regardless of any --charset setting.
Print key listings delimited by colons. Note that the output will be
encoded in UTF-8 regardless of any --charset setting. This format is
useful when GnuPG is called from scripts and other programs as it is
easily machine parsed. The details of this format are documented in
the file doc/DETAILS, which is included in the GnuPG source
distribution.
</para></listitem></varlistentry>
@ -2217,6 +2240,7 @@ Set the list of personal digest preferences to &ParmString;, this list
should be a string similar to the one printed by the command "pref" in
the edit menu. This allows the user to factor in their own preferred
algorithms when algorithms are chosen via recipient key preferences.
The default value is "H2" indicating SHA-1.
</para></listitem></varlistentry>
<varlistentry>