annotate libpurple/certificate.h @ 19025:c3e80350c270

- Added a lovely Doxygen signals tutorial
author William Ehlhardt <williamehlhardt@gmail.com>
date Sun, 15 Jul 2007 06:28:08 +0000
parents eb86ff3ba21a
children b3acaf46d9ad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
1 /**
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
2 * @file certificate.h Public-Key Certificate API
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
3 * @ingroup core
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
4 */
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
5
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
6 /*
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
7 *
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
8 * purple
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
9 *
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
10 * Purple is the legal property of its developers, whose names are too numerous
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
11 * to list here. Please refer to the COPYRIGHT file distributed with this
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
12 * source distribution.
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
13 *
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
14 * This program is free software; you can redistribute it and/or modify
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
15 * it under the terms of the GNU General Public License as published by
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
16 * the Free Software Foundation; either version 2 of the License, or
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
17 * (at your option) any later version.
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
18 *
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
19 * This program is distributed in the hope that it will be useful,
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
22 * GNU General Public License for more details.
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
23 *
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
24 * You should have received a copy of the GNU General Public License
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
25 * along with this program; if not, write to the Free Software
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
27 */
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
28
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
29 #ifndef _PURPLE_CERTIFICATE_H
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
30 #define _PURPLE_CERTIFICATE_H
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
31
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
32 #include <glib.h>
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
33
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
34 #ifdef __cplusplus
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
35 extern "C" {
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
36 #endif /* __cplusplus */
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
37
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
38
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
39 typedef enum
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
40 {
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
41 PURPLE_CERTIFICATE_INVALID = 0,
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
42 PURPLE_CERTIFICATE_VALID = 1
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
43 } PurpleCertificateVerificationStatus;
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
44
18189
030a2209ae96 - Style issues
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18188
diff changeset
45 typedef struct _PurpleCertificate PurpleCertificate;
18970
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
46 typedef struct _PurpleCertificatePool PurpleCertificatePool;
18189
030a2209ae96 - Style issues
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18188
diff changeset
47 typedef struct _PurpleCertificateScheme PurpleCertificateScheme;
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
48 typedef struct _PurpleCertificateVerifier PurpleCertificateVerifier;
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
49 typedef struct _PurpleCertificateVerificationRequest PurpleCertificateVerificationRequest;
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
50
18940
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
51 /**
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
52 * Callback function for the results of a verification check
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
53 * @param st Status code
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
54 * @param userdata User-defined data
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
55 */
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
56 typedef void (*PurpleCertificateVerifiedCallback)
18953
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
57 (PurpleCertificateVerificationStatus st,
18940
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
58 gpointer userdata);
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
59
17641
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
60 /** A certificate instance
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
61 *
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
62 * An opaque data structure representing a single certificate under some
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
63 * CertificateScheme
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
64 */
18189
030a2209ae96 - Style issues
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18188
diff changeset
65 struct _PurpleCertificate
17641
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
66 {
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
67 /** Scheme this certificate is under */
18189
030a2209ae96 - Style issues
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18188
diff changeset
68 PurpleCertificateScheme * scheme;
17641
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
69 /** Opaque pointer to internal data */
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
70 gpointer data;
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
71 };
55a0b0a42000 - Exposed the _Certificate struct definition in certificate.h
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17640
diff changeset
72
18970
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
73 /**
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
74 * Database for retrieval or storage of Certificates
18983
bb4acabd8fac Documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18982
diff changeset
75 *
18995
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
76 * More or less a hash table; all lookups and writes are controlled by a string
18983
bb4acabd8fac Documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18982
diff changeset
77 * key.
18970
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
78 */
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
79 struct _PurpleCertificatePool
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
80 {
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
81 /** Scheme this Pool operates for */
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
82 gchar *scheme_name;
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
83 /** Internal name to refer to the pool by */
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
84 gchar *name;
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
85
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
86 /** User-friendly name for this type
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
87 * ex: N_("SSL Servers")
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
88 * When this is displayed anywhere, it should be i18ned
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
89 * ex: _(pool->fullname)
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
90 */
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
91 gchar *fullname;
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
92
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
93 /** Internal pool data */
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
94 gpointer data;
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
95
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
96 /**
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
97 * Set up the Pool's internal state
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
98 *
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
99 * Upon calling purple_certificate_register_pool() , this function will
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
100 * be called. May be NULL.
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
101 * @return TRUE if the initialization succeeded, otherwise FALSE
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
102 */
18975
172b8d1dc2be - CertificatePool member functions no longer accept a Pool instance, as Pools are expected to be singletons
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18974
diff changeset
103 gboolean (* init)(void);
18970
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
104
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
105 /**
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
106 * Uninit the Pool's internal state
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
107 *
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
108 * Will be called by purple_certificate_unregister_pool() . May be NULL
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
109 */
18975
172b8d1dc2be - CertificatePool member functions no longer accept a Pool instance, as Pools are expected to be singletons
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18974
diff changeset
110 void (* uninit)(void);
18970
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
111
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
112 /** Check for presence of a certificate in the pool using unique ID */
18974
6b7c234b4984 - cert_in_pool_by_id is now just cert_in_pool; finding the uniqueID of the Certificate wanted is entirely the caller's problem
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18971
diff changeset
113 gboolean (* cert_in_pool)(const gchar *id);
18970
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
114 /** Retrieve a PurpleCertificate from the pool */
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
115 PurpleCertificate * (* get_cert)(const gchar *id);
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
116 /** Add a certificate to the pool. Must overwrite any other
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
117 * certificates sharing the same ID in the pool.
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
118 * @return TRUE if the operation succeeded, otherwise FALSE
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
119 */
18982
8948cd6bb8bc - CertificatePool put_cert now accepts an id argument
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18977
diff changeset
120 gboolean (* put_cert)(const gchar *id, PurpleCertificate *crt);
18970
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
121 };
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
122
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
123 /** A certificate type
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
124 *
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
125 * A CertificateScheme must implement all of the fields in the structure,
18936
895831f93380 - Documentation correction
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18934
diff changeset
126 * and register it using purple_certificate_register_scheme()
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
127 *
17640
945b60f02767 - Fixed a comment
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17638
diff changeset
128 * There may be only ONE CertificateScheme provided for each certificate
945b60f02767 - Fixed a comment
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17638
diff changeset
129 * type, as specified by the "name" field.
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
130 */
18189
030a2209ae96 - Style issues
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18188
diff changeset
131 struct _PurpleCertificateScheme
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
132 {
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
133 /** Name of the certificate type
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
134 * ex: "x509", "pgp", etc.
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
135 * This must be globally unique - you may not register more than one
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
136 * CertificateScheme of the same name at a time.
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
137 */
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
138 gchar * name;
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
139
18188
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
140 /** User-friendly name for this type
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
141 * ex: N_("X.509 Certificates")
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
142 * When this is displayed anywhere, it should be i18ned
18970
3d63bd78675d - Add CertificatePool struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18962
diff changeset
143 * ex: _(scheme->fullname)
18188
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
144 */
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
145 gchar * fullname;
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
146
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
147 /** Imports a certificate from a file
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
148 *
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
149 * @param filename File to import the certificate from
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
150 * @return Pointer to the newly allocated Certificate struct
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
151 * or NULL on failure.
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
152 */
18190
b2d110e9857f - Eliminate compiler warning
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18189
diff changeset
153 PurpleCertificate * (* import_certificate)(const gchar * filename);
18188
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
154
18977
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
155 /**
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
156 * Exports a certificate to a file
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
157 *
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
158 * @param filename File to export the certificate to
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
159 * @param crt Certificate to export
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
160 * @return TRUE if the export succeeded, otherwise FALSE
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
161 * @see purple_certificate_export()
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
162 */
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
163 gboolean (* export_certificate)(const gchar *filename, PurpleCertificate *crt);
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
164
19018
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
165 /**
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
166 * Duplicates a certificate
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
167 *
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
168 * Certificates are generally assumed to be read-only, so feel free to
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
169 * do any sort of reference-counting magic you want here. If this ever
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
170 * changes, please remember to change the magic accordingly.
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
171 * @return Reference to the new copy
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
172 */
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
173 PurpleCertificate * (* copy_certificate)(PurpleCertificate *crt);
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
174
18188
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
175 /** Destroys and frees a Certificate structure
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
176 *
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
177 * Destroys a Certificate's internal data structures and calls
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
178 * free(crt)
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
179 *
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
180 * @param crt Certificate instance to be destroyed. It WILL NOT be
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
181 * destroyed if it is not of the correct
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
182 * CertificateScheme. Can be NULL
e6271671eb24 - Expose some more functions in the x509 CertificateScheme. Doesn't
William Ehlhardt <williamehlhardt@gmail.com>
parents: 17641
diff changeset
183 */
18189
030a2209ae96 - Style issues
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18188
diff changeset
184 void (* destroy_certificate)(PurpleCertificate * crt);
18934
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
185
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
186 /**
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
187 * Retrieves the certificate public key fingerprint using SHA1
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
188 *
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
189 * @param crt Certificate instance
18937
eac58c6caae7 - More documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18936
diff changeset
190 * @return Binary representation of SHA1 hash - must be freed using
eac58c6caae7 - More documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18936
diff changeset
191 * g_byte_array_free()
18934
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
192 */
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
193 GByteArray * (* get_fingerprint_sha1)(PurpleCertificate *crt);
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
194
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
195 /**
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
196 * Retrieves a unique certificate identifier
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
197 *
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
198 * @param crt Certificate instance
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
199 * @return Newly allocated string that can be used to uniquely
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
200 * identify the certificate.
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
201 */
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
202 gchar * (* get_unique_id)(PurpleCertificate *crt);
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
203
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
204 /**
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
205 * Retrieves a unique identifier for the certificate's issuer
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
206 *
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
207 * @param crt Certificate instance
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
208 * @return Newly allocated string that can be used to uniquely
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
209 * identify the issuer's certificate.
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
210 */
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
211 gchar * (* get_issuer_unique_id)(PurpleCertificate *crt);
04be1b885ef3 - Add more to the Certificate struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18933
diff changeset
212
18962
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
213 /**
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
214 * Gets the certificate subject's name
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
215 *
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
216 * For X.509, this is the "Common Name" field, as we're only using it
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
217 * for hostname verification at the moment
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
218 *
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
219 * @see purple_certificate_get_subject_name()
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
220 *
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
221 * @param crt Certificate instance
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
222 * @return Newly allocated string with the certificate subject.
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
223 */
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
224 gchar * (* get_subject_name)(PurpleCertificate *crt);
19006
dc60287ce426 - Add get_activation_time and get_expiration_time to CertificateScheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18995
diff changeset
225
19008
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
226 /**
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
227 * Check the subject name against that on the certificate
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
228 * @see purple_certificate_check_subject_name()
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
229 * @return TRUE if it is a match, else FALSE
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
230 */
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
231 gboolean (* check_subject_name)(PurpleCertificate *crt, const gchar *name);
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
232
19006
dc60287ce426 - Add get_activation_time and get_expiration_time to CertificateScheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18995
diff changeset
233 /** Retrieve the certificate activation time */
19011
b4207894b534 - Verbosity in struct members.
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19010
diff changeset
234 time_t (* get_activation)(PurpleCertificate *crt);
19006
dc60287ce426 - Add get_activation_time and get_expiration_time to CertificateScheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18995
diff changeset
235 /** Retrieve the expiration time */
19011
b4207894b534 - Verbosity in struct members.
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19010
diff changeset
236 time_t (* get_expiration)(PurpleCertificate *crt);
19006
dc60287ce426 - Add get_activation_time and get_expiration_time to CertificateScheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18995
diff changeset
237
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
238 /* TODO: Fill out this structure */
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
239 };
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
240
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
241 /** A set of operations used to provide logic for verifying a Certificate's
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
242 * authenticity.
18941
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
243 *
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
244 * A Verifier provider must fill out these fields, then register it using
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
245 * purple_certificate_register_verifier()
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
246 *
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
247 * The (scheme_name, name) value must be unique for each Verifier - you may not
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
248 * register more than one Verifier of the same name for each Scheme
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
249 */
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
250 struct _PurpleCertificateVerifier
18940
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
251 {
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
252 /** Name of the scheme this Verifier operates on
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
253 *
18940
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
254 * The scheme will be looked up by name when a Request is generated
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
255 * using this Verifier
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
256 */
18940
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
257 gchar *scheme_name;
18941
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
258
18951
11e88e451bfb - Reorder struct for clarity
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18950
diff changeset
259 /** Name of the Verifier - case insensitive */
11e88e451bfb - Reorder struct for clarity
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18950
diff changeset
260 gchar *name;
11e88e451bfb - Reorder struct for clarity
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18950
diff changeset
261
18941
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
262 /**
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
263 * Start the verification process
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
264 *
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
265 * To be called from purple_certificate_verify once it has
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
266 * constructed the request. This will use the information in the
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
267 * given VerificationRequest to check the certificate and callback
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
268 * the requester with the verification results.
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
269 *
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
270 * @param vrq Request to process
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
271 */
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
272 void (* start_verification)(PurpleCertificateVerificationRequest *vrq);
18947
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
273
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
274 /**
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
275 * Destroy a completed Request under this Verifier
18952
974d110cf7b1 - libpurple is now responsible for some cleanup and final deletion of a
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18951
diff changeset
276 * The function pointed to here is only responsible for cleaning up
974d110cf7b1 - libpurple is now responsible for some cleanup and final deletion of a
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18951
diff changeset
277 * whatever PurpleCertificateVerificationRequest::data points to.
974d110cf7b1 - libpurple is now responsible for some cleanup and final deletion of a
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18951
diff changeset
278 * It should not call free(vrq)
18947
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
279 *
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
280 * @param vrq Request to destroy
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
281 */
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
282 void (* destroy_request)(PurpleCertificateVerificationRequest *vrq);
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
283 };
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
284
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
285 /** Structure for a single certificate request
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
286 *
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
287 * Useful for keeping track of the state of a verification that involves
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
288 * several steps
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
289 */
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
290 struct _PurpleCertificateVerificationRequest
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
291 {
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
292 /** Reference to the verification logic used */
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
293 PurpleCertificateVerifier *verifier;
18941
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
294 /** Reference to the scheme used.
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
295 *
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
296 * This is looked up from the Verifier when the Request is generated
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
297 */
18942
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
298 PurpleCertificateScheme *scheme;
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
299
18940
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
300 /**
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
301 * Name to check that the certificate is issued to
18931
e634122cec47 - purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18928
diff changeset
302 *
e634122cec47 - purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18928
diff changeset
303 * For X.509 certificates, this is the Common Name
e634122cec47 - purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18928
diff changeset
304 */
e634122cec47 - purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18928
diff changeset
305 gchar *subject_name;
e634122cec47 - purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18928
diff changeset
306
e634122cec47 - purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18928
diff changeset
307 /** List of certificates in the chain to be verified (such as that returned by purple_ssl_get_peer_certificates )
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
308 *
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
309 * This is most relevant for X.509 certificates used in SSL sessions.
18931
e634122cec47 - purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18928
diff changeset
310 * The list order should be: certificate, issuer, issuer's issuer, etc.
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
311 */
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
312 GList *cert_chain;
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
313
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
314 /** Internal data used by the Verifier code */
18940
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
315 gpointer data;
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
316
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
317 /** Function to call with the verification result */
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
318 PurpleCertificateVerifiedCallback cb;
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
319 /** Data to pass to the post-verification callback */
5fa287322a82 - Fill out CertVerifier struct
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18937
diff changeset
320 gpointer cb_data;
18928
299022c9b32d - More API additions
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18926
diff changeset
321 };
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
322
18945
fa42d8fa7873 - Documentation segmentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18942
diff changeset
323 /*****************************************************************************/
18994
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
324 /** @name Certificate Verification Functions */
18945
fa42d8fa7873 - Documentation segmentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18942
diff changeset
325 /*****************************************************************************/
fa42d8fa7873 - Documentation segmentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18942
diff changeset
326 /*@{*/
fa42d8fa7873 - Documentation segmentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18942
diff changeset
327
18942
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
328 /**
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
329 * Constructs a verification request and passed control to the specified Verifier
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
330 *
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
331 * It is possible that the callback will be called immediately upon calling
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
332 * this function. Plan accordingly.
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
333 *
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
334 * @param verifier Verification logic to use.
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
335 * @see purple_certificate_find_verifier()
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
336 *
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
337 * @param subject_name Name that should match the first certificate in the
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
338 * chain for the certificate to be valid. Will be strdup'd
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
339 * into the Request struct
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
340 *
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
341 * @param cert_chain Certificate chain to check. If there is more than one
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
342 * certificate in the chain (X.509), the peer's
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
343 * certificate comes first, then the issuer/signer's
19021
fcca10d0ac7d - purple_certificate_verify no longer takes possession of the
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19020
diff changeset
344 * certificate, etc. The whole list is duplicated into the
fcca10d0ac7d - purple_certificate_verify no longer takes possession of the
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19020
diff changeset
345 * Request struct.
18942
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
346 *
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
347 * @param cb Callback function to be called with whether the
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
348 * certificate was approved or not.
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
349 * @param cb_data User-defined data for the above.
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
350 */
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
351 void
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
352 purple_certificate_verify (PurpleCertificateVerifier *verifier,
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
353 const gchar *subject_name, GList *cert_chain,
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
354 PurpleCertificateVerifiedCallback cb,
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
355 gpointer cb_data);
02102eccc4be - purple_certificate_verify now takes a Verifier argument, creates its
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18941
diff changeset
356
18946
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
357 /**
18947
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
358 * Disposes of a VerificationRequest once it is complete
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
359 *
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
360 * @param vrq Request to destroy. Will be free()'d.
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
361 * The certificate chain involved will also be destroyed.
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
362 */
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
363 void
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
364 purple_certificate_verify_destroy (PurpleCertificateVerificationRequest *vrq);
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
365
18994
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
366 /*@}*/
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
367
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
368 /*****************************************************************************/
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
369 /** @name Certificate Functions */
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
370 /*****************************************************************************/
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
371 /*@{*/
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
372
18947
3c6bf77bf7c4 - Add purple_certificate_verify_destroy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18946
diff changeset
373 /**
19018
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
374 * Makes a duplicate of a certificate
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
375 *
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
376 * @param crt Instance to duplicate
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
377 * @return Pointer to new instance
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
378 */
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
379 PurpleCertificate *
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
380 purple_certificate_copy(PurpleCertificate *crt);
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
381
d6f902265076 - Add purple_certificate_copy and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19012
diff changeset
382 /**
19020
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
383 * Duplicates an entire list of certificates
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
384 *
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
385 * @param crt_list List to duplicate
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
386 * @return New list copy
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
387 */
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
388 GList *
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
389 purple_certificate_copy_list(GList *crt_list);
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
390
d69355001a6e - Add purple_certificate_copy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19018
diff changeset
391 /**
18946
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
392 * Destroys and free()'s a Certificate
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
393 *
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
394 * @param crt Instance to destroy. May be NULL.
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
395 */
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
396 void
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
397 purple_certificate_destroy (PurpleCertificate *crt);
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
398
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
399 /**
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
400 * Destroy an entire list of Certificate instances and the containing list
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
401 *
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
402 * @param crt_list List of certificates to destroy. May be NULL.
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
403 */
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
404 void
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
405 purple_certificate_destroy_list (GList * crt_list);
617447a71ab7 - Add certificate_destroy and certificate_destroy_list
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18945
diff changeset
406
18953
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
407 /**
18988
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
408 * Imports a PurpleCertificate from a file
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
409 *
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
410 * @param scheme Scheme to import under
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
411 * @param filename File path to import from
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
412 * @return Pointer to a new PurpleCertificate, or NULL on failure
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
413 */
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
414 PurpleCertificate *
18989
43d1ee6a3ed5 - Fixed naming issues in previous revision
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18988
diff changeset
415 purple_certificate_import(PurpleCertificateScheme *scheme, const gchar *filename);
18988
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
416
4189fc3befba - Add purple_certificate_import
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18984
diff changeset
417 /**
18977
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
418 * Exports a PurpleCertificate to a file
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
419 *
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
420 * @param filename File to export the certificate to
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
421 * @param crt Certificate to export
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
422 * @return TRUE if the export succeeded, otherwise FALSE
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
423 */
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
424 gboolean
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
425 purple_certificate_export(const gchar *filename, PurpleCertificate *crt);
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
426
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
427
31bdbb82de7e - Add purple_certificate_export and associated libpurple stuff
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18975
diff changeset
428 /**
18953
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
429 * Retrieves the certificate public key fingerprint using SHA1.
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
430 *
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
431 * @param crt Certificate instance
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
432 * @return Binary representation of the hash. You are responsible for free()ing
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
433 * this.
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
434 * @see purple_base16_encode_chunked()
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
435 */
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
436 GByteArray *
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
437 purple_certificate_get_fingerprint_sha1(PurpleCertificate *crt);
89b32569890c - Add purple_certificate_get_fingerprint_sha1
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18952
diff changeset
438
18962
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
439
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
440 /**
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
441 * Gets the certificate subject's name
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
442 *
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
443 * For X.509, this is the "Common Name" field, as we're only using it
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
444 * for hostname verification at the moment
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
445 *
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
446 * @param crt Certificate instance
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
447 * @return Newly allocated string with the certificate subject.
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
448 */
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
449 gchar *
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
450 purple_certificate_get_subject_name(PurpleCertificate *crt);
fcd05c39803e - Add purple_certificate_get_subject_name and associated libpurple
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18957
diff changeset
451
19008
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
452 /**
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
453 * Check the subject name against that on the certificate
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
454 * @param crt Certificate instance
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
455 * @param name Name to check.
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
456 * @return TRUE if it is a match, else FALSE
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
457 */
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
458 gboolean
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
459 purple_certificate_check_subject_name(PurpleCertificate *crt, const gchar *name);
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
460
19012
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
461 /**
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
462 * Get the expiration/activation times.
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
463 *
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
464 * @param crt Certificate instance
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
465 * @param activation Reference to store the activation time at. May be NULL
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
466 * if you don't actually want it.
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
467 * @param expiration Reference to store the expiration time at. May be NULL
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
468 * if you don't actually want it.
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
469 * @return TRUE if the requested values were obtained, otherwise FALSE.
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
470 */
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
471 gboolean
b1090cbfc286 - Add expiration/activation functions for Certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19011
diff changeset
472 purple_certificate_get_times(PurpleCertificate *crt, time_t *activation, time_t *expiration);
19008
7fd9bd55f8d0 - Add certificate_check_subject_name and associated machinery
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19007
diff changeset
473
18994
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
474 /*@}*/
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
475
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
476 /*****************************************************************************/
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
477 /** @name Certificate Pool Functions */
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
478 /*****************************************************************************/
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
479 /*@{*/
18984
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
480 /**
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
481 * Helper function for generating file paths in ~/.purple/certificates for
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
482 * CertificatePools that use them.
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
483 *
19010
0d4b84820390 - Fix overzealous escaping cause by ancestor revision
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19009
diff changeset
484 * All components will be escaped for filesystem friendliness.
0d4b84820390 - Fix overzealous escaping cause by ancestor revision
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19009
diff changeset
485 *
18984
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
486 * @param pool CertificatePool to build a path for
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
487 * @param id Key to look up a Certificate by. May be NULL.
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
488 * @return A newly allocated path of the form
19010
0d4b84820390 - Fix overzealous escaping cause by ancestor revision
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19009
diff changeset
489 * ~/.purple/certificates/scheme_name/pool_name/unique_id
18984
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
490 */
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
491 gchar *
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
492 purple_certificate_pool_mkpath(PurpleCertificatePool *pool, const gchar *id);
2b4150624cf2 - Add purple_certificate_pool_mkpath helper function
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18983
diff changeset
493
18995
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
494 /**
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
495 * Check for presence of an ID in a pool.
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
496 * @param pool Pool to look in
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
497 * @param id ID to look for
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
498 * @return TRUE if the ID is in the pool, else FALSE
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
499 */
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
500 gboolean
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
501 purple_certificate_pool_contains(PurpleCertificatePool *pool, const gchar *id);
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
502
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
503 /**
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
504 * Retrieve a certificate from a pool.
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
505 * @param pool Pool to fish in
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
506 * @param id ID to look up
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
507 * @return Retrieved certificate, or NULL if it wasn't there
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
508 */
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
509 PurpleCertificate *
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
510 purple_certificate_pool_retrieve(PurpleCertificatePool *pool, const gchar *id);
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
511
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
512 /**
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
513 * Add a certificate to a pool
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
514 *
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
515 * Any pre-existing certificate of the same ID will be overwritten.
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
516 *
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
517 * @param pool Pool to add to
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
518 * @param id ID to store the certificate with
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
519 * @param crt Certificate to store
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
520 * @return TRUE if the operation succeeded, otherwise FALSE
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
521 */
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
522 gboolean
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
523 purple_certificate_pool_store(PurpleCertificatePool *pool, const gchar *id, PurpleCertificate *crt);
47b06daea9d1 - Add pool retrieve, contains, and store functions to certificate API
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18994
diff changeset
524
18945
fa42d8fa7873 - Documentation segmentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18942
diff changeset
525 /*@}*/
fa42d8fa7873 - Documentation segmentation
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18942
diff changeset
526
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
527 /*****************************************************************************/
18994
bf23d58ec9c3 - Rearrange certificate.h for better organization
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18989
diff changeset
528 /** @name Certificate Subsystem API */
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
529 /*****************************************************************************/
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
530 /*@{*/
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
531
18950
f78a9efa9eaf - Add purple_certificate_register_builtins
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18947
diff changeset
532 /**
18957
9205841eed06 - Certificate system now has init and uninit like other systems
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18953
diff changeset
533 * Initialize the certificate system
18950
f78a9efa9eaf - Add purple_certificate_register_builtins
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18947
diff changeset
534 */
f78a9efa9eaf - Add purple_certificate_register_builtins
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18947
diff changeset
535 void
18957
9205841eed06 - Certificate system now has init and uninit like other systems
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18953
diff changeset
536 purple_certificate_init(void);
9205841eed06 - Certificate system now has init and uninit like other systems
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18953
diff changeset
537
9205841eed06 - Certificate system now has init and uninit like other systems
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18953
diff changeset
538 /**
9205841eed06 - Certificate system now has init and uninit like other systems
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18953
diff changeset
539 * Un-initialize the certificate system
9205841eed06 - Certificate system now has init and uninit like other systems
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18953
diff changeset
540 */
9205841eed06 - Certificate system now has init and uninit like other systems
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18953
diff changeset
541 void
9205841eed06 - Certificate system now has init and uninit like other systems
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18953
diff changeset
542 purple_certificate_uninit(void);
18950
f78a9efa9eaf - Add purple_certificate_register_builtins
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18947
diff changeset
543
19022
1f07f96dc1ce - Add purple_certificate_get_handle
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19021
diff changeset
544 /**
1f07f96dc1ce - Add purple_certificate_get_handle
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19021
diff changeset
545 * Get the Certificate subsystem handle for signalling purposes
1f07f96dc1ce - Add purple_certificate_get_handle
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19021
diff changeset
546 */
1f07f96dc1ce - Add purple_certificate_get_handle
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19021
diff changeset
547 gpointer
1f07f96dc1ce - Add purple_certificate_get_handle
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19021
diff changeset
548 purple_certificate_get_handle(void);
1f07f96dc1ce - Add purple_certificate_get_handle
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19021
diff changeset
549
18192
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
550 /** Look up a registered CertificateScheme by name
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
551 * @param name The scheme name. Case insensitive.
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
552 * @return Pointer to the located Scheme, or NULL if it isn't found.
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
553 */
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
554 PurpleCertificateScheme *
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
555 purple_certificate_find_scheme(const gchar *name);
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
556
19023
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
557 /**
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
558 * Get all registered CertificateSchemes
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
559 *
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
560 * @return GList pointing to all registered CertificateSchemes
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
561 */
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
562 GList *
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
563 purple_certificate_get_schemes(void);
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
564
18192
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
565 /** Register a CertificateScheme with libpurple
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
566 *
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
567 * No two schemes can be registered with the same name; this function enforces
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
568 * that.
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
569 *
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
570 * @param scheme Pointer to the scheme to register.
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
571 * @return TRUE if the scheme was successfully added, otherwise FALSE
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
572 */
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
573 gboolean
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
574 purple_certificate_register_scheme(PurpleCertificateScheme *scheme);
dc7e7b8bdc8c - Add chunks of the certificate scheme registration interface
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18190
diff changeset
575
18926
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
576 /** Unregister a CertificateScheme from libpurple
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
577 *
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
578 * @param scheme Scheme to unregister.
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
579 * If the scheme is not registered, this is a no-op.
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
580 *
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
581 * @return TRUE if the unregister completed successfully
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
582 */
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
583 gboolean
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
584 purple_certificate_unregister_scheme(PurpleCertificateScheme *scheme);
8c4d52bc0319 - Add unregister_scheme
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18192
diff changeset
585
18941
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
586 /** Look up a registered PurpleCertificateVerifier by scheme and name
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
587 * @param scheme_name Scheme name. Case insensitive.
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
588 * @param ver_name The verifier name. Case insensitive.
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
589 * @return Pointer to the located Verifier, or NULL if it isn't found.
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
590 */
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
591 PurpleCertificateVerifier *
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
592 purple_certificate_find_verifier(const gchar *scheme_name, const gchar *ver_name);
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
593
19023
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
594 /**
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
595 * Get the list of registered CertificateVerifiers
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
596 *
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
597 * @return GList of all registered PurpleCertificateVerifier
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
598 */
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
599 GList *
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
600 purple_certificate_get_verifiers(void);
18941
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
601
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
602 /**
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
603 * Register a CertificateVerifier with libpurple
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
604 *
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
605 * @param vr Verifier to register.
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
606 * @return TRUE if register succeeded, otherwise FALSE
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
607 */
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
608 gboolean
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
609 purple_certificate_register_verifier(PurpleCertificateVerifier *vr);
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
610
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
611 /**
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
612 * Unregister a CertificateVerifier with libpurple
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
613 *
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
614 * @param vr Verifier to unregister.
18971
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
615 * @return TRUE if unregister succeeded, otherwise FALSE
18941
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
616 */
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
617 gboolean
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
618 purple_certificate_unregister_verifier(PurpleCertificateVerifier *vr);
425f494bd1ec - CertificateVerifier register/unregister/find
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18940
diff changeset
619
18971
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
620 /** Look up a registered PurpleCertificatePool by scheme and name
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
621 * @param scheme_name Scheme name. Case insensitive.
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
622 * @param pool_name Pool name. Case insensitive.
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
623 * @return Pointer to the located Pool, or NULL if it isn't found.
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
624 */
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
625 PurpleCertificatePool *
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
626 purple_certificate_find_pool(const gchar *scheme_name, const gchar *pool_name);
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
627
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
628 /**
19023
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
629 * Get the list of registered Pools
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
630 *
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
631 * @return GList of all registered PurpleCertificatePool s
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
632 */
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
633 GList *
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
634 purple_certificate_get_pools(void);
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
635
eb86ff3ba21a - Add get_pools, get_verifiers, and get_schemes
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19022
diff changeset
636 /**
18971
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
637 * Register a CertificatePool with libpurple and call its init function
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
638 *
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
639 * @param pool Pool to register.
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
640 * @return TRUE if the register succeeded, otherwise FALSE
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
641 */
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
642 gboolean
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
643 purple_certificate_register_pool(PurpleCertificatePool *pool);
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
644
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
645 /**
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
646 * Unregister a CertificatePool with libpurple and call its uninit function
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
647 *
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
648 * @param pool Pool to unregister.
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
649 * @return TRUE if the unregister succeeded, otherwise FALSE
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
650 */
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
651 gboolean
898e2bd70f23 - Add find, register, and unregister for CertificatePools
William Ehlhardt <williamehlhardt@gmail.com>
parents: 18970
diff changeset
652 purple_certificate_unregister_pool(PurpleCertificatePool *pool);
17638
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
653
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
654 /*@}*/
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
655
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
656
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
657 #ifdef __cplusplus
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
658 }
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
659 #endif /* __cplusplus */
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
660
668a294f9a72 - Added certificate.[ch] and got them integrated into the build
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
661 #endif /* _PURPLE_CERTIFICATE_H */