Mercurial > pidgin
annotate libpurple/sslconn.h @ 25659:481e07d69a10
Format the time as "localtimeformat [+-]HHMM". Iterative development is fun.
This shows up, for me, as "Local Time: 10:50:15 PM -0800". Marcus, I figure
this bypasses the need to localize 'GMT'.
Are there any locales where either the tz offset is always printed (my reading
is that this would show up in the conversation window, so I doubt it) or where
a tz offset is printed before the time?
author | Paul Aurich <paul@darkrain42.org> |
---|---|
date | Mon, 09 Feb 2009 07:13:44 +0000 |
parents | 8282911d5e17 |
children | 96af49d5758d 584063555949 |
rev | line source |
---|---|
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
1 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
2 * @file sslconn.h SSL API |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
3 * @ingroup core |
20074
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19681
diff
changeset
|
4 */ |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19681
diff
changeset
|
5 |
6bf32c9e15a7
remove gpl boilerplate from doxygen docs
Sean Egan <seanegan@gmail.com>
parents:
19681
diff
changeset
|
6 /* purple |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
7 * |
15822 | 8 * Purple is the legal property of its developers, whose names are too numerous |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
9 * to list here. Please refer to the COPYRIGHT file distributed with this |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
10 * source distribution. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
11 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
12 * This program is free software; you can redistribute it and/or modify |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
13 * it under the terms of the GNU General Public License as published by |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
14 * the Free Software Foundation; either version 2 of the License, or |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
15 * (at your option) any later version. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
16 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
17 * This program is distributed in the hope that it will be useful, |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
20 * GNU General Public License for more details. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
21 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
22 * You should have received a copy of the GNU General Public License |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
23 * along with this program; if not, write to the Free Software |
19681
44b4e8bd759b
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
18968
diff
changeset
|
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
25 */ |
15822 | 26 #ifndef _PURPLE_SSLCONN_H_ |
27 #define _PURPLE_SSLCONN_H_ | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
28 |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
29 /** Possible SSL errors. */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
30 typedef enum |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
31 { |
15822 | 32 PURPLE_SSL_HANDSHAKE_FAILED = 1, |
18954
d07258902ff3
- Add PURPLE_SSL_CERTIFICATE_INVALID error code
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18944
diff
changeset
|
33 PURPLE_SSL_CONNECT_FAILED = 2, |
d07258902ff3
- Add PURPLE_SSL_CERTIFICATE_INVALID error code
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18944
diff
changeset
|
34 PURPLE_SSL_CERTIFICATE_INVALID = 3 |
15822 | 35 } PurpleSslErrorType; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
36 |
20115
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
37 #include "certificate.h" |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
38 #include "proxy.h" |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
39 |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
40 #define PURPLE_SSL_DEFAULT_PORT 443 |
a68d51d60177
Create purple_connection_ssl_error(), which converts a PurpleSslErrorType
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
41 |
15822 | 42 typedef struct _PurpleSslConnection PurpleSslConnection; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
43 |
15822 | 44 typedef void (*PurpleSslInputFunction)(gpointer, PurpleSslConnection *, |
45 PurpleInputCondition); | |
46 typedef void (*PurpleSslErrorFunction)(PurpleSslConnection *, PurpleSslErrorType, | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
47 gpointer); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
48 |
15822 | 49 struct _PurpleSslConnection |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
50 { |
17231
a7887e79b723
Partial documentation on SslConnection struct
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17230
diff
changeset
|
51 /** Hostname to which the SSL connection will be made */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
52 char *host; |
17231
a7887e79b723
Partial documentation on SslConnection struct
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17230
diff
changeset
|
53 /** Port to connect to */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
54 int port; |
17232
bf516a0c430e
More documenting
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17231
diff
changeset
|
55 /** Data to pass to PurpleSslConnection::connect_cb() */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
56 void *connect_cb_data; |
17232
bf516a0c430e
More documenting
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17231
diff
changeset
|
57 /** Callback triggered once the SSL handshake is complete */ |
15822 | 58 PurpleSslInputFunction connect_cb; |
17233
3bccbafea8c1
- Completed SslConnection fields docs
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17232
diff
changeset
|
59 /** Callback triggered if there is an error during connection */ |
15822 | 60 PurpleSslErrorFunction error_cb; |
17232
bf516a0c430e
More documenting
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17231
diff
changeset
|
61 /** Data passed to PurpleSslConnection::recv_cb() */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
62 void *recv_cb_data; |
17233
3bccbafea8c1
- Completed SslConnection fields docs
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17232
diff
changeset
|
63 /** User-defined callback executed when the SSL connection receives data */ |
15822 | 64 PurpleSslInputFunction recv_cb; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
65 |
17231
a7887e79b723
Partial documentation on SslConnection struct
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17230
diff
changeset
|
66 /** File descriptor used to refer to the socket */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
67 int fd; |
17233
3bccbafea8c1
- Completed SslConnection fields docs
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17232
diff
changeset
|
68 /** Glib event source ID; used to refer to the received data callback |
3bccbafea8c1
- Completed SslConnection fields docs
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17232
diff
changeset
|
69 * in the glib eventloop */ |
24065
85bed17fe5c1
The variable we use to keep track of the watcher of the ssl connection
Mark Doliner <mark@kingant.net>
parents:
21355
diff
changeset
|
70 guint inpa; |
17233
3bccbafea8c1
- Completed SslConnection fields docs
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17232
diff
changeset
|
71 /** Data related to the underlying TCP connection */ |
15822 | 72 PurpleProxyConnectData *connect_data; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
73 |
17231
a7887e79b723
Partial documentation on SslConnection struct
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17230
diff
changeset
|
74 /** Internal connection data managed by the SSL backend (GnuTLS/LibNSS/whatever) */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
75 void *private_data; |
18944
3a71a46d171c
- Add verifier field to SslConnection
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18931
diff
changeset
|
76 |
3a71a46d171c
- Add verifier field to SslConnection
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18931
diff
changeset
|
77 /** Verifier to use in authenticating the peer */ |
3a71a46d171c
- Add verifier field to SslConnection
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18931
diff
changeset
|
78 PurpleCertificateVerifier *verifier; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
79 }; |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
80 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
81 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
82 * SSL implementation operations structure. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
83 * |
17232
bf516a0c430e
More documenting
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17231
diff
changeset
|
84 * Every SSL implementation must provide all of these and register it via purple_ssl_set_ops() |
17230
4248f884451f
Clarify documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17229
diff
changeset
|
85 * These should not be called directly! Instead, use the purple_ssl_* functions. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
86 */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
87 typedef struct |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
88 { |
17229
b765fdcde59e
Documented the SslOps structure
William Ehlhardt <williamehlhardt@gmail.com>
parents:
16664
diff
changeset
|
89 /** Initializes the SSL system provided. |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
90 * @return @a TRUE if initialization succeeded |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
91 * @see purple_ssl_init |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
92 */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
93 gboolean (*init)(void); |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
94 /** Unloads the SSL system. Inverse of PurpleSslOps::init. |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
95 * @see purple_ssl_uninit |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
96 */ |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
97 void (*uninit)(void); |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
98 /** Sets up the SSL connection for a #PurpleSslConnection once |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
99 * the TCP connection has been established |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
100 * @see purple_ssl_connect |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
101 */ |
15822 | 102 void (*connectfunc)(PurpleSslConnection *gsc); |
17230
4248f884451f
Clarify documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17229
diff
changeset
|
103 /** Destroys the internal data of the SSL connection provided. |
4248f884451f
Clarify documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17229
diff
changeset
|
104 * Freeing gsc itself is left to purple_ssl_close() |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
105 * @see purple_ssl_close |
17230
4248f884451f
Clarify documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17229
diff
changeset
|
106 */ |
15822 | 107 void (*close)(PurpleSslConnection *gsc); |
17229
b765fdcde59e
Documented the SslOps structure
William Ehlhardt <williamehlhardt@gmail.com>
parents:
16664
diff
changeset
|
108 /** Reads data from a connection (like POSIX read()) |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
109 * @param gsc Connection context |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
110 * @param data Pointer to buffer to drop data into |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
111 * @param len Maximum number of bytes to read |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
112 * @return Number of bytes actually written into @a data (which may be |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
113 * less than @a len), or <0 on error |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
114 * @see purple_ssl_read |
17229
b765fdcde59e
Documented the SslOps structure
William Ehlhardt <williamehlhardt@gmail.com>
parents:
16664
diff
changeset
|
115 */ |
15822 | 116 size_t (*read)(PurpleSslConnection *gsc, void *data, size_t len); |
17229
b765fdcde59e
Documented the SslOps structure
William Ehlhardt <williamehlhardt@gmail.com>
parents:
16664
diff
changeset
|
117 /** Writes data to a connection (like POSIX send()) |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
118 * @param gsc Connection context |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
119 * @param data Data buffer to send data from |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
120 * @param len Number of bytes to send from buffer |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
121 * @return The number of bytes written to @a data (may be less than |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
122 * @a len) or <0 on error |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
123 * @see purple_ssl_write |
17229
b765fdcde59e
Documented the SslOps structure
William Ehlhardt <williamehlhardt@gmail.com>
parents:
16664
diff
changeset
|
124 */ |
15822 | 125 size_t (*write)(PurpleSslConnection *gsc, const void *data, size_t len); |
18187
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
126 /** Obtains the certificate chain provided by the peer |
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
127 * |
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
128 * @param gsc Connection context |
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
129 * @return A newly allocated list containing the certificates |
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
130 * the peer provided. |
18944
3a71a46d171c
- Add verifier field to SslConnection
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18931
diff
changeset
|
131 * @see PurpleCertificate |
18187
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
132 * @todo Decide whether the ordering of certificates in this |
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
133 * list can be guaranteed. |
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
134 */ |
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
135 GList * (* get_peer_certificates)(PurpleSslConnection * gsc); |
33690062e8b3
- Expose get_peer_certificates in the SslOps struct, and modify gnutls
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17781
diff
changeset
|
136 |
16664
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15822
diff
changeset
|
137 void (*_purple_reserved2)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15822
diff
changeset
|
138 void (*_purple_reserved3)(void); |
516f14bef90e
Initial addition of padding for ui_ops and other class-like structs
Gary Kramlich <grim@reaperworld.com>
parents:
15822
diff
changeset
|
139 void (*_purple_reserved4)(void); |
15822 | 140 } PurpleSslOps; |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
141 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
142 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
143 extern "C" { |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
144 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
145 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
146 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
147 /** @name SSL API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
148 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
149 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
150 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
151 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
152 * Returns whether or not SSL is currently supported. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
153 * |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
154 * @return @a TRUE if SSL is supported, or @a FALSE otherwise. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
155 */ |
15822 | 156 gboolean purple_ssl_is_supported(void); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
157 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
158 /** |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
159 * Returns a human-readable string for an SSL error. |
18968
1677ead39ee3
- Add purple_ssl_strerror for handy error description power!
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18954
diff
changeset
|
160 * |
1677ead39ee3
- Add purple_ssl_strerror for handy error description power!
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18954
diff
changeset
|
161 * @param error Error code |
1677ead39ee3
- Add purple_ssl_strerror for handy error description power!
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18954
diff
changeset
|
162 * @return Human-readable error explanation |
1677ead39ee3
- Add purple_ssl_strerror for handy error description power!
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18954
diff
changeset
|
163 */ |
1677ead39ee3
- Add purple_ssl_strerror for handy error description power!
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18954
diff
changeset
|
164 const gchar * purple_ssl_strerror(PurpleSslErrorType error); |
1677ead39ee3
- Add purple_ssl_strerror for handy error description power!
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18954
diff
changeset
|
165 |
1677ead39ee3
- Add purple_ssl_strerror for handy error description power!
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18954
diff
changeset
|
166 /** |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
167 * Makes a SSL connection to the specified host and port. The caller |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
168 * should keep track of the returned value and use it to cancel the |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
169 * connection, if needed. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
170 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
171 * @param account The account making the connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
172 * @param host The destination host. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
173 * @param port The destination port. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
174 * @param func The SSL input handler function. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
175 * @param error_func The SSL error handler function. This function |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
176 * should <strong>NOT</strong> call purple_ssl_close(). In |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
177 * the event of an error the #PurpleSslConnection will be |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
178 * destroyed for you. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
179 * @param data User-defined data. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
180 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
181 * @return The SSL connection handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
182 */ |
15822 | 183 PurpleSslConnection *purple_ssl_connect(PurpleAccount *account, const char *host, |
184 int port, PurpleSslInputFunction func, | |
185 PurpleSslErrorFunction error_func, | |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
186 void *data); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
187 |
24350
8282911d5e17
Build everything with the *_DISABLE_DEPRECATED flags set. This allows us
Richard Laager <rlaager@wiktel.com>
parents:
24065
diff
changeset
|
188 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_SSLCONN_C_) |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
189 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
190 * Makes a SSL connection using an already open file descriptor. |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
191 * |
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
192 * @deprecated Use purple_ssl_connect_with_host_fd() instead. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
193 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
194 * @param account The account making the connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
195 * @param fd The file descriptor. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
196 * @param func The SSL input handler function. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
197 * @param error_func The SSL error handler function. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
198 * @param data User-defined data. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
199 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
200 * @return The SSL connection handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
201 */ |
15822 | 202 PurpleSslConnection *purple_ssl_connect_fd(PurpleAccount *account, int fd, |
203 PurpleSslInputFunction func, | |
204 PurpleSslErrorFunction error_func, | |
18929
67cb28c0ec89
applied changes from e52b685d84ca8874da6e3e71199829e513500642
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18187
diff
changeset
|
205 void *data); |
21190
34de8ef19294
Honor a PURPLE_DISABLE_DEPRECATED define to allow plugins to catch
Richard Laager <rlaager@wiktel.com>
parents:
20134
diff
changeset
|
206 #endif |
18929
67cb28c0ec89
applied changes from e52b685d84ca8874da6e3e71199829e513500642
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18187
diff
changeset
|
207 |
67cb28c0ec89
applied changes from e52b685d84ca8874da6e3e71199829e513500642
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18187
diff
changeset
|
208 /** |
20875
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
209 * Makes a SSL connection using an already open file descriptor. |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
210 * |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
211 * @param account The account making the connection. |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
212 * @param fd The file descriptor. |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
213 * @param func The SSL input handler function. |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
214 * @param error_func The SSL error handler function. |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
215 * @param host The hostname of the other peer (to verify the CN) |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
216 * @param data User-defined data. |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
217 * |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
218 * @return The SSL connection handle. |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
219 * |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
220 * @since 2.2.0 |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
221 */ |
18929
67cb28c0ec89
applied changes from e52b685d84ca8874da6e3e71199829e513500642
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18187
diff
changeset
|
222 PurpleSslConnection *purple_ssl_connect_with_host_fd(PurpleAccount *account, int fd, |
67cb28c0ec89
applied changes from e52b685d84ca8874da6e3e71199829e513500642
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18187
diff
changeset
|
223 PurpleSslInputFunction func, |
67cb28c0ec89
applied changes from e52b685d84ca8874da6e3e71199829e513500642
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18187
diff
changeset
|
224 PurpleSslErrorFunction error_func, |
67cb28c0ec89
applied changes from e52b685d84ca8874da6e3e71199829e513500642
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18187
diff
changeset
|
225 const char *host, |
67cb28c0ec89
applied changes from e52b685d84ca8874da6e3e71199829e513500642
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18187
diff
changeset
|
226 void *data); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
227 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
228 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
229 * Adds an input watcher for the specified SSL connection. |
17251
2d2c72f70e8c
Add note on use of purple_ssl_input_add
William Ehlhardt <williamehlhardt@gmail.com>
parents:
17233
diff
changeset
|
230 * Once the SSL handshake is complete, use this to watch for actual data across it. |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
231 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
232 * @param gsc The SSL connection handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
233 * @param func The callback function. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
234 * @param data User-defined data. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
235 */ |
15822 | 236 void purple_ssl_input_add(PurpleSslConnection *gsc, PurpleSslInputFunction func, |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
237 void *data); |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
238 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
239 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
240 * Closes a SSL connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
241 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
242 * @param gsc The SSL connection to close. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
243 */ |
15822 | 244 void purple_ssl_close(PurpleSslConnection *gsc); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
245 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
246 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
247 * Reads data from an SSL connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
248 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
249 * @param gsc The SSL connection handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
250 * @param buffer The destination buffer. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
251 * @param len The maximum number of bytes to read. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
252 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
253 * @return The number of bytes read. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
254 */ |
15822 | 255 size_t purple_ssl_read(PurpleSslConnection *gsc, void *buffer, size_t len); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
256 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
257 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
258 * Writes data to an SSL connection. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
259 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
260 * @param gsc The SSL connection handle. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
261 * @param buffer The buffer to write. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
262 * @param len The length of the data to write. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
263 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
264 * @return The number of bytes written. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
265 */ |
15822 | 266 size_t purple_ssl_write(PurpleSslConnection *gsc, const void *buffer, size_t len); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
267 |
18931
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
268 /** |
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
269 * Obtains the peer's presented certificates |
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
270 * |
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
271 * @param gsc The SSL connection handle |
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
272 * |
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
273 * @return The peer certificate chain, in the order of certificate, issuer, |
20134
f56ce942adf2
Bunch of documentation tidying for the ssl api, and add a doxycomment to
Will Thompson <will.thompson@collabora.co.uk>
parents:
20074
diff
changeset
|
274 * issuer's issuer, etc. @a NULL if no certificates have been provided, |
20875
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
275 * |
4511d15a8f80
Doxygen @since tags for libpurple and pidgin.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20134
diff
changeset
|
276 * @since 2.2.0 |
18931
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
277 */ |
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
278 GList * purple_ssl_get_peer_certificates(PurpleSslConnection *gsc); |
e634122cec47
- purple_ssl_get_peer_certificates
William Ehlhardt <williamehlhardt@gmail.com>
parents:
18929
diff
changeset
|
279 |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
280 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
281 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
282 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
283 /** @name Subsystem API */ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
284 /**************************************************************************/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
285 /*@{*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
286 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
287 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
288 * Sets the current SSL operations structure. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
289 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
290 * @param ops The SSL operations structure to assign. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
291 */ |
15822 | 292 void purple_ssl_set_ops(PurpleSslOps *ops); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
293 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
294 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
295 * Returns the current SSL operations structure. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
296 * |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
297 * @return The SSL operations structure. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
298 */ |
15822 | 299 PurpleSslOps *purple_ssl_get_ops(void); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
300 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
301 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
302 * Initializes the SSL subsystem. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
303 */ |
15822 | 304 void purple_ssl_init(void); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
305 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
306 /** |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
307 * Uninitializes the SSL subsystem. |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
308 */ |
15822 | 309 void purple_ssl_uninit(void); |
15373
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
310 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
311 /*@}*/ |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
312 |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
313 #ifdef __cplusplus |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
314 } |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
315 #endif |
5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
Sean Egan <seanegan@gmail.com>
parents:
diff
changeset
|
316 |
15822 | 317 #endif /* _PURPLE_SSLCONN_H_ */ |