gnutls-pkcs12.html
Prev
ch01.html
Up
index.html
Home
GNU TLS API Reference Manual
gnutls-openssl.html
Next
openpgp
openpgp —
Synopsis
enum
gnutls-openpgp.html#gnutls-openpgp-key-fmt-t
gnutls_openpgp_key_fmt_t
;
gnutls-gnutls.html#gnutls-openpgp-key-int
gnutls_openpgp_key_int
;
gnutls-gnutls.html#gnutls-openpgp-privkey-int
gnutls_openpgp_privkey_int
;
struct
gnutls-openpgp.html#gnutls-openpgp-keyring-int
gnutls_openpgp_keyring_int
;
struct
gnutls-openpgp.html#gnutls-openpgp-trustdb-int
gnutls_openpgp_trustdb_int
;
typedef
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
;
typedef
gnutls-openpgp.html#gnutls-openpgp-trustdb-t
gnutls_openpgp_trustdb_t
;
int
gnutls-openpgp.html#gnutls-openpgp-key-get-name
gnutls_openpgp_key_get_name
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
int idx,
char *buf,
size_t *sizeof_buf);
int
gnutls-openpgp.html#gnutls-openpgp-key-get-fingerprint
gnutls_openpgp_key_get_fingerprint
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
../shishi/shishi-shishi.html#void
void
*fpr,
size_t *fprlen);
int
gnutls-openpgp.html#gnutls-openpgp-key-get-pk-algorithm
gnutls_openpgp_key_get_pk_algorithm
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
unsigned int *r_bits);
int
gnutls-openpgp.html#gnutls-openpgp-key-get-version
gnutls_openpgp_key_get_version
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key);
time_t
gnutls-openpgp.html#gnutls-openpgp-key-get-creation-time
gnutls_openpgp_key_get_creation_time
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key);
time_t
gnutls-openpgp.html#gnutls-openpgp-key-get-expiration-time
gnutls_openpgp_key_get_expiration_time
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key);
int
gnutls-openpgp.html#gnutls-openpgp-key-get-id
gnutls_openpgp_key_get_id
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
unsigned char keyid[8]);
int
gnutls-openpgp.html#gnutls-openpgp-key-init
gnutls_openpgp_key_init
(gnutls_openpgp_key *key);
../shishi/shishi-shishi.html#void
void
gnutls-openpgp.html#gnutls-openpgp-key-deinit
gnutls_openpgp_key_deinit
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key);
int
gnutls-openpgp.html#gnutls-openpgp-key-import
gnutls_openpgp_key_import
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
const
gnutls-gnutls.html#gnutls-datum-t
gnutls_datum_t
*data,
gnutls_openpgp_key_fmt format);
int
gnutls-openpgp.html#gnutls-openpgp-key-export
gnutls_openpgp_key_export
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
gnutls-openpgp.html#gnutls-openpgp-key-fmt-t
gnutls_openpgp_key_fmt_t
format,
../shishi/shishi-shishi.html#void
void
*output_data,
size_t *output_data_size);
../shishi/shishi-shishi.html#void
void
gnutls-openpgp.html#gnutls-openpgp-keyring-deinit
gnutls_openpgp_keyring_deinit
(
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
ring);
int
gnutls-openpgp.html#gnutls-openpgp-keyring-init
gnutls_openpgp_keyring_init
(gnutls_openpgp_keyring *ring);
int
gnutls-openpgp.html#gnutls-openpgp-keyring-import
gnutls_openpgp_keyring_import
(
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
ring,
const
gnutls-gnutls.html#gnutls-datum-t
gnutls_datum_t
*data,
gnutls_openpgp_key_fmt format);
int
gnutls-openpgp.html#gnutls-openpgp-keyring-check-id
gnutls_openpgp_keyring_check_id
(
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
ring,
unsigned char keyid[8],
unsigned int flags);
../shishi/shishi-shishi.html#void
void
gnutls-openpgp.html#gnutls-openpgp-trustdb-deinit
gnutls_openpgp_trustdb_deinit
(
gnutls-openpgp.html#gnutls-openpgp-trustdb-t
gnutls_openpgp_trustdb_t
db);
int
gnutls-openpgp.html#gnutls-openpgp-trustdb-init
gnutls_openpgp_trustdb_init
(gnutls_openpgp_trustdb *db);
int
gnutls-openpgp.html#gnutls-openpgp-trustdb-import-file
gnutls_openpgp_trustdb_import_file
(
gnutls-openpgp.html#gnutls-openpgp-trustdb-t
gnutls_openpgp_trustdb_t
trustdb,
const char *file);
int
gnutls-openpgp.html#gnutls-openpgp-key-verify-ring
gnutls_openpgp_key_verify_ring
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
ring,
unsigned int flags,
unsigned int *verify);
int
gnutls-openpgp.html#gnutls-openpgp-key-verify-trustdb
gnutls_openpgp_key_verify_trustdb
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
gnutls-openpgp.html#gnutls-openpgp-trustdb-t
gnutls_openpgp_trustdb_t
db,
unsigned int flags,
unsigned int *verify);
int
gnutls-openpgp.html#gnutls-openpgp-key-verify-self
gnutls_openpgp_key_verify_self
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
unsigned int flags,
unsigned int *verify);
../shishi/shishi-shishi.html#void
void
gnutls-openpgp.html#gnutls-openpgp-privkey-deinit
gnutls_openpgp_privkey_deinit
(
gnutls-gnutls.html#gnutls-openpgp-privkey-t
gnutls_openpgp_privkey_t
key);
Description
Details
enum gnutls_openpgp_key_fmt_t
typedef enum gnutls_openpgp_key_fmt_t {
GNUTLS_OPENPGP_FMT_RAW, GNUTLS_OPENPGP_FMT_BASE64
} gnutls_openpgp_key_fmt_t;
gnutls_openpgp_key_int
typedef struct {
cdk_kbnode_t knode;
cdk_stream_t inp;
} gnutls_openpgp_key_int;
gnutls_openpgp_privkey_int
typedef struct {
gnutls_privkey pkey;
} gnutls_openpgp_privkey_int;
struct gnutls_openpgp_keyring_int
struct gnutls_openpgp_keyring_int;
struct gnutls_openpgp_trustdb_int
struct gnutls_openpgp_trustdb_int;
gnutls_openpgp_keyring_t
gnutls_openpgp_trustdb_t
gnutls_openpgp_key_get_name ()
int         gnutls_openpgp_key_get_name     (
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
int idx,
char *buf,
size_t *sizeof_buf);
Extracts the userID from the parsed OpenPGP key.
key
:
idx
:
buf
:
sizeof_buf
:
Returns
:
gnutls_openpgp_key_get_fingerprint ()
int         gnutls_openpgp_key_get_fingerprint
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
../shishi/shishi-shishi.html#void
void
*fpr,
size_t *fprlen);
key
:
fpr
:
fprlen
:
Returns
:
gnutls_openpgp_key_get_pk_algorithm ()
int         gnutls_openpgp_key_get_pk_algorithm
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
unsigned int *r_bits);
This function will return the public key algorithm of an OpenPGP
certificate.
If bits is non null, it should have enough size to hold the parameters
size in bits. For RSA the bits returned is the modulus.
For DSA the bits returned are of the public exponent.
key
:
r_bits
:
Returns
:
gnutls_openpgp_key_get_version ()
int         gnutls_openpgp_key_get_version  (
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key);
Extract the version of the OpenPGP key.
key
:
Returns
:
gnutls_openpgp_key_get_creation_time ()
time_t      gnutls_openpgp_key_get_creation_time
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key);
key
:
Returns
:
gnutls_openpgp_key_get_expiration_time ()
time_t      gnutls_openpgp_key_get_expiration_time
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key);
key
:
Returns
:
gnutls_openpgp_key_get_id ()
int         gnutls_openpgp_key_get_id       (
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
unsigned char keyid[8]);
key
:
keyid
:
Returns
:
gnutls_openpgp_key_init ()
int         gnutls_openpgp_key_init         (gnutls_openpgp_key *key);
This function will initialize an OpenPGP key structure.
key
:
Returns
:
gnutls_openpgp_key_deinit ()
../shishi/shishi-shishi.html#void
void
gnutls_openpgp_key_deinit       (
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key);
This function will deinitialize a key structure.
key
:
gnutls_openpgp_key_import ()
int         gnutls_openpgp_key_import       (
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
const
gnutls-gnutls.html#gnutls-datum-t
gnutls_datum_t
*data,
gnutls_openpgp_key_fmt format);
This function will convert the given RAW or Base64 encoded key
to the native gnutls_openpgp_key_t format. The output will be stored in 'key'.
key
:
data
:
format
:
Returns
:
gnutls_openpgp_key_export ()
int         gnutls_openpgp_key_export       (
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
gnutls-openpgp.html#gnutls-openpgp-key-fmt-t
gnutls_openpgp_key_fmt_t
format,
../shishi/shishi-shishi.html#void
void
*output_data,
size_t *output_data_size);
This function will convert the given key to RAW or Base64 format.
If the buffer provided is not long enough to hold the output, then
GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
key
:
format
:
output_data
:
output_data_size
:
Returns
:
gnutls_openpgp_keyring_deinit ()
../shishi/shishi-shishi.html#void
void
gnutls_openpgp_keyring_deinit   (
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
ring);
This function will deinitialize a CRL structure.
ring
:
gnutls_openpgp_keyring_init ()
int         gnutls_openpgp_keyring_init     (gnutls_openpgp_keyring *ring);
This function will initialize an OpenPGP keyring structure.
ring
:
Returns
:
gnutls_openpgp_keyring_import ()
int         gnutls_openpgp_keyring_import   (
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
ring,
const
gnutls-gnutls.html#gnutls-datum-t
gnutls_datum_t
*data,
gnutls_openpgp_key_fmt format);
This function will convert the given RAW or Base64 encoded keyring
to the native gnutls_openpgp_keyring_t format. The output will be stored in 'keyring'.
ring
:
data
:
format
:
Returns
:
gnutls_openpgp_keyring_check_id ()
int         gnutls_openpgp_keyring_check_id (
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
ring,
unsigned char keyid[8],
unsigned int flags);
Check if a given key ID exists in the keyring.
ring
:
keyid
:
flags
:
Returns
:
gnutls_openpgp_trustdb_deinit ()
../shishi/shishi-shishi.html#void
void
gnutls_openpgp_trustdb_deinit   (
gnutls-openpgp.html#gnutls-openpgp-trustdb-t
gnutls_openpgp_trustdb_t
db);
This function will deinitialize a CRL structure.
db
:
gnutls_openpgp_trustdb_init ()
int         gnutls_openpgp_trustdb_init     (gnutls_openpgp_trustdb *db);
This function will initialize an OpenPGP trustdb structure.
db
:
Returns
:
gnutls_openpgp_trustdb_import_file ()
int         gnutls_openpgp_trustdb_import_file
(
gnutls-openpgp.html#gnutls-openpgp-trustdb-t
gnutls_openpgp_trustdb_t
trustdb,
const char *file);
This function will convert the given RAW or Base64 encoded trustdb
to the native gnutls_openpgp_trustdb_t format. The output will be stored in 'trustdb'.
trustdb
:
file
:
Returns
:
gnutls_openpgp_key_verify_ring ()
int         gnutls_openpgp_key_verify_ring  (
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
gnutls-openpgp.html#gnutls-openpgp-keyring-t
gnutls_openpgp_keyring_t
ring,
unsigned int flags,
unsigned int *verify);
Verify all signatures in the key, using the given set of keys (keyring).
The key verification output will be put in
verify
and will be
one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd.
GNUTLS_CERT_INVALID: A signature on the key is invalid.
GNUTLS_CERT_REVOKED: The key has been revoked.
NOTE: this function does not verify using any "web of trust". You
may use GnuPG for that purpose, or any other external PGP application.
key
:
ring
:
flags
:
verify
:
Returns
:
gnutls_openpgp_key_verify_trustdb ()
int         gnutls_openpgp_key_verify_trustdb
(
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
gnutls-openpgp.html#gnutls-openpgp-trustdb-t
gnutls_openpgp_trustdb_t
db,
unsigned int flags,
unsigned int *verify);
Checks if the key is revoked or disabled, in the trustdb.
The verification output will be put in
verify
and will be
one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd.
GNUTLS_CERT_INVALID: A signature on the key is invalid.
GNUTLS_CERT_REVOKED: The key has been revoked.
NOTE: this function does not verify using any "web of trust". You
may use GnuPG for that purpose, or any other external PGP application.
key
:
db
:
flags
:
verify
:
Returns
:
gnutls_openpgp_key_verify_self ()
int         gnutls_openpgp_key_verify_self  (
gnutls-gnutls.html#gnutls-openpgp-key-t
gnutls_openpgp_key_t
key,
unsigned int flags,
unsigned int *verify);
Verifies the self signature in the key.
The key verification output will be put in
verify
and will be
one or more of the gnutls_certificate_status_t enumerated elements bitwise or'd.
GNUTLS_CERT_INVALID: The self signature on the key is invalid.
key
:
flags
:
verify
:
Returns
:
gnutls_openpgp_privkey_deinit ()
../shishi/shishi-shishi.html#void
void
gnutls_openpgp_privkey_deinit   (
gnutls-gnutls.html#gnutls-openpgp-privkey-t
gnutls_openpgp_privkey_t
key);
This function will deinitialize a key structure.
key
:
gnutls-pkcs12.html
<< pkcs12
gnutls-openssl.html
openssl >>
