← Back to branch summary

~ubuntu-branches/ubuntu/saucy/gnutls28/saucy

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_pubkey_get_openpgp_key_id.3

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-07-30 21:40:07 UTC
  • mfrom: (14.1.9 saucy-proposed)
  • Revision ID: package-import@ubuntu.com-20130730214007-9mrd08xo61kla008
Tags: 3.2.3-1ubuntu1
https://launchpad.net/bugs/1068029
* Sync with Debian (LP: #1068029). Remaining change:
  - Drop gnutls-bin and -doc since we want to use the versions
    in gnutls26 as the defaults instead

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpages/gnutls_pubkey_get_openpgp_key_id.3
1
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2
 
.TH "gnutls_pubkey_get_openpgp_key_id" 3 "3.0.19" "gnutls" "gnutls"
 
2
.TH "gnutls_pubkey_get_openpgp_key_id" 3 "3.2.2" "gnutls" "gnutls"
3
3
.SH NAME
4
4
gnutls_pubkey_get_openpgp_key_id \- API function
5
5
.SH SYNOPSIS
10
10
.IP "gnutls_pubkey_t key" 12
11
11
Holds the public key
12
12
.IP "unsigned int flags" 12
13
 
should be 0 for now
 
13
should be 0 or \fBGNUTLS_PUBKEY_GET_OPENPGP_FINGERPRINT\fP
14
14
.IP "unsigned char * output_data" 12
15
15
will contain the key ID
16
16
.IP "size_t * output_data_size" 12
19
19
.IP "unsigned int * subkey" 12
20
20
Will be non zero if the key ID corresponds to a subkey
21
21
.SH "DESCRIPTION"
22
 
This function will return a unique ID the depends on the public
23
 
key parameters. This ID can be used in checking whether a
24
 
certificate corresponds to the given public key.
 
22
This function returns the OpenPGP key ID of the corresponding key.
 
23
The key is a unique ID that depends on the public
 
24
key parameters. 
 
25
 
 
26
If the flag \fBGNUTLS_PUBKEY_GET_OPENPGP_FINGERPRINT\fP is specified
 
27
this function returns the fingerprint of the master key.
25
28
 
26
29
If the buffer provided is not long enough to hold the output, then
27
30
*output_data_size is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will
28
 
be returned.  The output will normally be a SHA\-1 hash output,
29
 
which is 20 bytes.
 
31
be returned.  The output is \fBGNUTLS_OPENPGP_KEYID_SIZE\fP bytes long.
30
32
.SH "RETURNS"
31
33
In case of failure a negative error code will be
32
34
returned, and 0 on success.
40
42
GnuTLS home page: http://www.gnu.org/software/gnutls/
41
43
 
42
44
.SH COPYRIGHT
43
 
Copyright \(co 2012 Free Software Foundation, Inc..
 
45
Copyright \(co 2001-2013 Free Software Foundation, Inc..
44
46
.br
45
47
Copying and distribution of this file, with or without modification,
46
48
are permitted in any medium without royalty provided the copyright