Data Fields
_PurpleCertificateScheme Struct Reference

A certificate type. More...

#include <certificate.h>

Data Fields

gchar * name
 Name of the certificate type ex: "x509", "pgp", etc. More...
 
gchar * fullname
 User-friendly name for this type ex: N_("X.509 Certificates") When this is displayed anywhere, it should be i18ned ex: _(scheme->fullname)
 
PurpleCertificate *(* import_certificate )(const gchar *filename)
 Imports a certificate from a file. More...
 
gboolean(* export_certificate )(const gchar *filename, PurpleCertificate *crt)
 Exports a certificate to a file. More...
 
PurpleCertificate *(* copy_certificate )(PurpleCertificate *crt)
 Duplicates a certificate. More...
 
void(* destroy_certificate )(PurpleCertificate *crt)
 Destroys and frees a Certificate structure. More...
 
gboolean(* signed_by )(PurpleCertificate *crt, PurpleCertificate *issuer)
 Find whether "crt" has a valid signature from "issuer," including appropriate values for the CA flag in the basic constraints extension. More...
 
GByteArray *(* get_fingerprint_sha1 )(PurpleCertificate *crt)
 Retrieves the certificate public key fingerprint using SHA1. More...
 
gchar *(* get_unique_id )(PurpleCertificate *crt)
 Retrieves a unique certificate identifier. More...
 
gchar *(* get_issuer_unique_id )(PurpleCertificate *crt)
 Retrieves a unique identifier for the certificate's issuer. More...
 
gchar *(* get_subject_name )(PurpleCertificate *crt)
 Gets the certificate subject's name. More...
 
gboolean(* check_subject_name )(PurpleCertificate *crt, const gchar *name)
 Check the subject name against that on the certificate. More...
 
gboolean(* get_times )(PurpleCertificate *crt, time_t *activation, time_t *expiration)
 Retrieve the certificate activation/expiration times.
 
GSList *(* import_certificates )(const gchar *filename)
 Imports certificates from a file. More...
 
gboolean(* register_trusted_tls_cert )(PurpleCertificate *crt, gboolean ca)
 Register a certificate as "trusted.".
 
void(* verify_cert )(PurpleCertificateVerificationRequest *vrq, PurpleCertificateInvalidityFlags *flags)
 Verify that a certificate is valid, performing all necessary checks including date range, valid cert chain, recognized and valid CAs, etc.
 
void(* _purple_reserved3 )(void)
 

Detailed Description

A certificate type.

A CertificateScheme must implement all of the fields in the structure, and register it using purple_certificate_register_scheme()

There may be only ONE CertificateScheme provided for each certificate type, as specified by the "name" field.

Definition at line 190 of file certificate.h.

Field Documentation

gboolean(* _PurpleCertificateScheme::check_subject_name) (PurpleCertificate *crt, const gchar *name)

Check the subject name against that on the certificate.

See also
purple_certificate_check_subject_name()
Returns
TRUE if it is a match, else FALSE

Definition at line 294 of file certificate.h.

PurpleCertificate*(* _PurpleCertificateScheme::copy_certificate) (PurpleCertificate *crt)

Duplicates a certificate.

Certificates are generally assumed to be read-only, so feel free to do any sort of reference-counting magic you want here. If this ever changes, please remember to change the magic accordingly.

Returns
Reference to the new copy

Definition at line 232 of file certificate.h.

void(* _PurpleCertificateScheme::destroy_certificate) (PurpleCertificate *crt)

Destroys and frees a Certificate structure.

Destroys a Certificate's internal data structures and calls free(crt)

Parameters
crtCertificate instance to be destroyed. It WILL NOT be destroyed if it is not of the correct CertificateScheme. Can be NULL

Definition at line 243 of file certificate.h.

gboolean(* _PurpleCertificateScheme::export_certificate) (const gchar *filename, PurpleCertificate *crt)

Exports a certificate to a file.

Parameters
filenameFile to export the certificate to
crtCertificate to export
Returns
TRUE if the export succeeded, otherwise FALSE
See also
purple_certificate_export()

Definition at line 222 of file certificate.h.

GByteArray*(* _PurpleCertificateScheme::get_fingerprint_sha1) (PurpleCertificate *crt)

Retrieves the certificate public key fingerprint using SHA1.

Parameters
crtCertificate instance
Returns
Binary representation of SHA1 hash - must be freed using g_byte_array_free()

Definition at line 256 of file certificate.h.

gchar*(* _PurpleCertificateScheme::get_issuer_unique_id) (PurpleCertificate *crt)

Retrieves a unique identifier for the certificate's issuer.

Parameters
crtCertificate instance
Returns
Newly allocated string that can be used to uniquely identify the issuer's certificate.

Definition at line 274 of file certificate.h.

gchar*(* _PurpleCertificateScheme::get_subject_name) (PurpleCertificate *crt)

Gets the certificate subject's name.

For X.509, this is the "Common Name" field, as we're only using it for hostname verification at the moment

See also
purple_certificate_get_subject_name()
Parameters
crtCertificate instance
Returns
Newly allocated string with the certificate subject.

Definition at line 287 of file certificate.h.

gchar*(* _PurpleCertificateScheme::get_unique_id) (PurpleCertificate *crt)

Retrieves a unique certificate identifier.

Parameters
crtCertificate instance
Returns
Newly allocated string that can be used to uniquely identify the certificate.

Definition at line 265 of file certificate.h.

PurpleCertificate*(* _PurpleCertificateScheme::import_certificate) (const gchar *filename)

Imports a certificate from a file.

Parameters
filenameFile to import the certificate from
Returns
Pointer to the newly allocated Certificate struct or NULL on failure.

Definition at line 212 of file certificate.h.

GSList*(* _PurpleCertificateScheme::import_certificates) (const gchar *filename)

Imports certificates from a file.

Parameters
filenameFile to import the certificates from
Returns
GSList of pointers to the newly allocated Certificate structs or NULL on failure.

Definition at line 305 of file certificate.h.

gchar* _PurpleCertificateScheme::name

Name of the certificate type ex: "x509", "pgp", etc.

This must be globally unique - you may not register more than one CertificateScheme of the same name at a time.

Definition at line 197 of file certificate.h.

gboolean(* _PurpleCertificateScheme::signed_by) (PurpleCertificate *crt, PurpleCertificate *issuer)

Find whether "crt" has a valid signature from "issuer," including appropriate values for the CA flag in the basic constraints extension.

See also
purple_certificate_signed_by()

Definition at line 248 of file certificate.h.


The documentation for this struct was generated from the following file: