1GnuPG::Key(3) User Contributed Perl Documentation GnuPG::Key(3)
2
6 GnuPG::Key - GnuPG Key Object
7
9 # assumes a GnuPG::Interface object in $gnupg
10 my @keys = $gnupg->get_public_keys( 'ftobin' );
11 # now GnuPG::PublicKey objects are in @keys
13
15 GnuPG::Key objects are generally not instantiated on their own, but
16 rather used as a superclass of GnuPG::PublicKey, GnuPG::SecretKey, or
17 GnuPG::SubKey objects.
18
20 Initialization Methods
21 new( %initialization_args )
22 This methods creates a new object. The optional arguments are
23 initialization of data members.
24 hash_init( %args ).
26 short_hex_id
27 This returns the commonly-used short, 8 character short hex id of
28 the key.
29 compare( $other, $deep )
31 Returns non-zero only when this Key is identical to the other
32 GnuPG::Key. If $deep is present and non-zero, the key's associated
33 signatures, revocations, and revokers will also be compared.
34
36 length
37 Number of bits in the key.
38 algo_num
40 They algorithm number that the Key is used for.
41 usage_flags
43 The Key Usage flags associated with this key, represented as a
44 string of lower-case letters. Possible values include: (a)
45 authenticate, (c) certify, (e) encrypt, and (s) sign.
46 A key may have any combination of them in any order. In addition
48 to these letters, the primary key has uppercase versions of the
49 letters to denote the _usable_ capabilities of the entire key, and
50 a potential letter 'D' to indicate a disabled key.
51 See "key capabilities" DETAILS from the GnuPG sources for more
53 details.
54 hex_data
56 The data of the key. WARNING: this seems to have never been
57 instantiated, and should always be undef.
58 pubkey_data
60 A list of Math::BigInt objects that correspond to the public key
61 material for the given key. This member is empty on secret keys in
62 GnuPG 1.4. It is populated on secret keys In GnuPG >= 2.2.0.
63 For DSA keys, the values are: prime (p), group order (q), group
65 generator (g), y
66 For RSA keys, the values are: modulus (n), exponent (e)
68 For El Gamal keys, the values are: prime (p), group generator (g),
70 y
71 For more details, see: http://tools.ietf.org/html/rfc4880#page-42
73 hex_id
75 The long hex id of the key. This is not the fingerprint nor the
76 short hex id, which is 8 hex characters.
77 creation_date_string
79 expiration_date_string
80 Formatted date of the key's creation and expiration. If the key
81 has no expiration, expiration_date_string will return undef.
82 creation_date
84 expiration_date
85 Date of the key's creation and expiration, stored as the number of
86 seconds since midnight 1970-01-01 UTC. If the key has no
87 expiration, expiration_date will return undef.
88 fingerprint
90 A GnuPG::Fingerprint object.
91 signatures
93 A list of GnuPG::Signature objects embodying the signatures on this
94 key. For subkeys, the signatures are usually subkey-binding
95 signatures. For primary keys, the signatures are statements about
96 the key itself.
97 revocations
99 A list of revocations associated with this key, stored as
100 GnuPG::Signature objects (since revocations are a type of
101 certification as well). Note that a revocation of a primary key
102 has a different semantic meaning than a revocation associated with
103 a subkey.
104 revokers
106 A list of GnuPG::Revoker objects associated with this key,
107 indicating other keys which are allowed to revoke certifications
108 made by this key.
109
111 GnuPG::Fingerprint, GnuPG::Signature, GnuPG::Revoker,
112perl v5.32.0 2020-07-28 GnuPG::Key(3)