Improved glitch fix
[emacs.git] / src / gnutls.c
blob35f0eb48bc110665fc3e3a4ac2d4b4573c6915fe
1 /* GnuTLS glue for GNU Emacs.
2 Copyright (C) 2010-2015 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19 #include <config.h>
20 #include <errno.h>
21 #include <stdio.h>
23 #include "lisp.h"
24 #include "process.h"
25 #include "gnutls.h"
26 #include "coding.h"
28 #ifdef HAVE_GNUTLS
29 #include <gnutls/gnutls.h>
31 #ifdef WINDOWSNT
32 #include <windows.h>
33 #include "w32.h"
34 #endif
36 static bool emacs_gnutls_handle_error (gnutls_session_t, int);
38 static bool gnutls_global_initialized;
40 static void gnutls_log_function (int, const char *);
41 static void gnutls_log_function2 (int, const char *, const char *);
42 #ifdef HAVE_GNUTLS3
43 static void gnutls_audit_log_function (gnutls_session_t, const char *);
44 #endif
46 enum extra_peer_verification
48 CERTIFICATE_NOT_MATCHING = 2
52 #ifdef WINDOWSNT
54 DEF_DLL_FN (gnutls_alert_description_t, gnutls_alert_get,
55 (gnutls_session_t));
56 DEF_DLL_FN (const char *, gnutls_alert_get_name,
57 (gnutls_alert_description_t));
58 DEF_DLL_FN (int, gnutls_alert_send_appropriate, (gnutls_session_t, int));
59 DEF_DLL_FN (int, gnutls_anon_allocate_client_credentials,
60 (gnutls_anon_client_credentials_t *));
61 DEF_DLL_FN (void, gnutls_anon_free_client_credentials,
62 (gnutls_anon_client_credentials_t));
63 DEF_DLL_FN (int, gnutls_bye, (gnutls_session_t, gnutls_close_request_t));
64 DEF_DLL_FN (int, gnutls_certificate_allocate_credentials,
65 (gnutls_certificate_credentials_t *));
66 DEF_DLL_FN (void, gnutls_certificate_free_credentials,
67 (gnutls_certificate_credentials_t));
68 DEF_DLL_FN (const gnutls_datum_t *, gnutls_certificate_get_peers,
69 (gnutls_session_t, unsigned int *));
70 DEF_DLL_FN (void, gnutls_certificate_set_verify_flags,
71 (gnutls_certificate_credentials_t, unsigned int));
72 DEF_DLL_FN (int, gnutls_certificate_set_x509_crl_file,
73 (gnutls_certificate_credentials_t, const char *,
74 gnutls_x509_crt_fmt_t));
75 DEF_DLL_FN (int, gnutls_certificate_set_x509_key_file,
76 (gnutls_certificate_credentials_t, const char *, const char *,
77 gnutls_x509_crt_fmt_t));
78 # if ((GNUTLS_VERSION_MAJOR \
79 + (GNUTLS_VERSION_MINOR > 0 || GNUTLS_VERSION_PATCH >= 20)) \
80 > 3)
81 DEF_DLL_FN (int, gnutls_certificate_set_x509_system_trust,
82 (gnutls_certificate_credentials_t));
83 # endif
84 DEF_DLL_FN (int, gnutls_certificate_set_x509_trust_file,
85 (gnutls_certificate_credentials_t, const char *,
86 gnutls_x509_crt_fmt_t));
87 DEF_DLL_FN (gnutls_certificate_type_t, gnutls_certificate_type_get,
88 (gnutls_session_t));
89 DEF_DLL_FN (int, gnutls_certificate_verify_peers2,
90 (gnutls_session_t, unsigned int *));
91 DEF_DLL_FN (int, gnutls_credentials_set,
92 (gnutls_session_t, gnutls_credentials_type_t, void *));
93 DEF_DLL_FN (void, gnutls_deinit, (gnutls_session_t));
94 DEF_DLL_FN (void, gnutls_dh_set_prime_bits,
95 (gnutls_session_t, unsigned int));
96 DEF_DLL_FN (int, gnutls_dh_get_prime_bits, (gnutls_session_t));
97 DEF_DLL_FN (int, gnutls_error_is_fatal, (int));
98 DEF_DLL_FN (int, gnutls_global_init, (void));
99 DEF_DLL_FN (void, gnutls_global_set_log_function, (gnutls_log_func));
100 # ifdef HAVE_GNUTLS3
101 DEF_DLL_FN (void, gnutls_global_set_audit_log_function, (gnutls_audit_log_func));
102 # endif
103 DEF_DLL_FN (void, gnutls_global_set_log_level, (int));
104 DEF_DLL_FN (int, gnutls_handshake, (gnutls_session_t));
105 DEF_DLL_FN (int, gnutls_init, (gnutls_session_t *, unsigned int));
106 DEF_DLL_FN (int, gnutls_priority_set_direct,
107 (gnutls_session_t, const char *, const char **));
108 DEF_DLL_FN (size_t, gnutls_record_check_pending, (gnutls_session_t));
109 DEF_DLL_FN (ssize_t, gnutls_record_recv, (gnutls_session_t, void *, size_t));
110 DEF_DLL_FN (ssize_t, gnutls_record_send,
111 (gnutls_session_t, const void *, size_t));
112 DEF_DLL_FN (const char *, gnutls_strerror, (int));
113 DEF_DLL_FN (void, gnutls_transport_set_errno, (gnutls_session_t, int));
114 DEF_DLL_FN (const char *, gnutls_check_version, (const char *));
115 DEF_DLL_FN (void, gnutls_transport_set_lowat, (gnutls_session_t, int));
116 DEF_DLL_FN (void, gnutls_transport_set_ptr2,
117 (gnutls_session_t, gnutls_transport_ptr_t,
118 gnutls_transport_ptr_t));
119 DEF_DLL_FN (void, gnutls_transport_set_pull_function,
120 (gnutls_session_t, gnutls_pull_func));
121 DEF_DLL_FN (void, gnutls_transport_set_push_function,
122 (gnutls_session_t, gnutls_push_func));
123 DEF_DLL_FN (int, gnutls_x509_crt_check_hostname,
124 (gnutls_x509_crt_t, const char *));
125 DEF_DLL_FN (int, gnutls_x509_crt_check_issuer,
126 (gnutls_x509_crt_t, gnutls_x509_crt_t));
127 DEF_DLL_FN (void, gnutls_x509_crt_deinit, (gnutls_x509_crt_t));
128 DEF_DLL_FN (int, gnutls_x509_crt_import,
129 (gnutls_x509_crt_t, const gnutls_datum_t *,
130 gnutls_x509_crt_fmt_t));
131 DEF_DLL_FN (int, gnutls_x509_crt_init, (gnutls_x509_crt_t *));
132 DEF_DLL_FN (int, gnutls_x509_crt_get_fingerprint,
133 (gnutls_x509_crt_t,
134 gnutls_digest_algorithm_t, void *, size_t *));
135 DEF_DLL_FN (int, gnutls_x509_crt_get_version,
136 (gnutls_x509_crt_t));
137 DEF_DLL_FN (int, gnutls_x509_crt_get_serial,
138 (gnutls_x509_crt_t, void *, size_t *));
139 DEF_DLL_FN (int, gnutls_x509_crt_get_issuer_dn,
140 (gnutls_x509_crt_t, char *, size_t *));
141 DEF_DLL_FN (time_t, gnutls_x509_crt_get_activation_time,
142 (gnutls_x509_crt_t));
143 DEF_DLL_FN (time_t, gnutls_x509_crt_get_expiration_time,
144 (gnutls_x509_crt_t));
145 DEF_DLL_FN (int, gnutls_x509_crt_get_dn,
146 (gnutls_x509_crt_t, char *, size_t *));
147 DEF_DLL_FN (int, gnutls_x509_crt_get_pk_algorithm,
148 (gnutls_x509_crt_t, unsigned int *));
149 DEF_DLL_FN (const char*, gnutls_pk_algorithm_get_name,
150 (gnutls_pk_algorithm_t));
151 DEF_DLL_FN (int, gnutls_pk_bits_to_sec_param,
152 (gnutls_pk_algorithm_t, unsigned int));
153 DEF_DLL_FN (int, gnutls_x509_crt_get_issuer_unique_id,
154 (gnutls_x509_crt_t, char *, size_t *));
155 DEF_DLL_FN (int, gnutls_x509_crt_get_subject_unique_id,
156 (gnutls_x509_crt_t, char *, size_t *));
157 DEF_DLL_FN (int, gnutls_x509_crt_get_signature_algorithm,
158 (gnutls_x509_crt_t));
159 DEF_DLL_FN (int, gnutls_x509_crt_get_signature,
160 (gnutls_x509_crt_t, char *, size_t *));
161 DEF_DLL_FN (int, gnutls_x509_crt_get_key_id,
162 (gnutls_x509_crt_t, unsigned int, unsigned char *, size_t *_size));
163 DEF_DLL_FN (const char*, gnutls_sec_param_get_name, (gnutls_sec_param_t));
164 DEF_DLL_FN (const char*, gnutls_sign_get_name, (gnutls_sign_algorithm_t));
165 DEF_DLL_FN (int, gnutls_server_name_set,
166 (gnutls_session_t, gnutls_server_name_type_t,
167 const void *, size_t));
168 DEF_DLL_FN (gnutls_kx_algorithm_t, gnutls_kx_get, (gnutls_session_t));
169 DEF_DLL_FN (const char*, gnutls_kx_get_name, (gnutls_kx_algorithm_t));
170 DEF_DLL_FN (gnutls_protocol_t, gnutls_protocol_get_version,
171 (gnutls_session_t));
172 DEF_DLL_FN (const char*, gnutls_protocol_get_name, (gnutls_protocol_t));
173 DEF_DLL_FN (gnutls_cipher_algorithm_t, gnutls_cipher_get,
174 (gnutls_session_t));
175 DEF_DLL_FN (const char*, gnutls_cipher_get_name,
176 (gnutls_cipher_algorithm_t));
177 DEF_DLL_FN (gnutls_mac_algorithm_t, gnutls_mac_get, (gnutls_session_t));
178 DEF_DLL_FN (const char*, gnutls_mac_get_name, (gnutls_mac_algorithm_t));
181 static bool
182 init_gnutls_functions (void)
184 HMODULE library;
185 int max_log_level = 1;
187 if (!(library = w32_delayed_load (Qgnutls_dll)))
189 GNUTLS_LOG (1, max_log_level, "GnuTLS library not found");
190 return 0;
193 LOAD_DLL_FN (library, gnutls_alert_get);
194 LOAD_DLL_FN (library, gnutls_alert_get_name);
195 LOAD_DLL_FN (library, gnutls_alert_send_appropriate);
196 LOAD_DLL_FN (library, gnutls_anon_allocate_client_credentials);
197 LOAD_DLL_FN (library, gnutls_anon_free_client_credentials);
198 LOAD_DLL_FN (library, gnutls_bye);
199 LOAD_DLL_FN (library, gnutls_certificate_allocate_credentials);
200 LOAD_DLL_FN (library, gnutls_certificate_free_credentials);
201 LOAD_DLL_FN (library, gnutls_certificate_get_peers);
202 LOAD_DLL_FN (library, gnutls_certificate_set_verify_flags);
203 LOAD_DLL_FN (library, gnutls_certificate_set_x509_crl_file);
204 LOAD_DLL_FN (library, gnutls_certificate_set_x509_key_file);
205 # if ((GNUTLS_VERSION_MAJOR \
206 + (GNUTLS_VERSION_MINOR > 0 || GNUTLS_VERSION_PATCH >= 20)) \
207 > 3)
208 LOAD_DLL_FN (library, gnutls_certificate_set_x509_system_trust);
209 # endif
210 LOAD_DLL_FN (library, gnutls_certificate_set_x509_trust_file);
211 LOAD_DLL_FN (library, gnutls_certificate_type_get);
212 LOAD_DLL_FN (library, gnutls_certificate_verify_peers2);
213 LOAD_DLL_FN (library, gnutls_credentials_set);
214 LOAD_DLL_FN (library, gnutls_deinit);
215 LOAD_DLL_FN (library, gnutls_dh_set_prime_bits);
216 LOAD_DLL_FN (library, gnutls_dh_get_prime_bits);
217 LOAD_DLL_FN (library, gnutls_error_is_fatal);
218 LOAD_DLL_FN (library, gnutls_global_init);
219 LOAD_DLL_FN (library, gnutls_global_set_log_function);
220 # ifdef HAVE_GNUTLS3
221 LOAD_DLL_FN (library, gnutls_global_set_audit_log_function);
222 # endif
223 LOAD_DLL_FN (library, gnutls_global_set_log_level);
224 LOAD_DLL_FN (library, gnutls_handshake);
225 LOAD_DLL_FN (library, gnutls_init);
226 LOAD_DLL_FN (library, gnutls_priority_set_direct);
227 LOAD_DLL_FN (library, gnutls_record_check_pending);
228 LOAD_DLL_FN (library, gnutls_record_recv);
229 LOAD_DLL_FN (library, gnutls_record_send);
230 LOAD_DLL_FN (library, gnutls_strerror);
231 LOAD_DLL_FN (library, gnutls_transport_set_errno);
232 LOAD_DLL_FN (library, gnutls_check_version);
233 /* We don't need to call gnutls_transport_set_lowat in GnuTLS 2.11.1
234 and later, and the function was removed entirely in 3.0.0. */
235 if (!fn_gnutls_check_version ("2.11.1"))
236 LOAD_DLL_FN (library, gnutls_transport_set_lowat);
237 LOAD_DLL_FN (library, gnutls_transport_set_ptr2);
238 LOAD_DLL_FN (library, gnutls_transport_set_pull_function);
239 LOAD_DLL_FN (library, gnutls_transport_set_push_function);
240 LOAD_DLL_FN (library, gnutls_x509_crt_check_hostname);
241 LOAD_DLL_FN (library, gnutls_x509_crt_check_issuer);
242 LOAD_DLL_FN (library, gnutls_x509_crt_deinit);
243 LOAD_DLL_FN (library, gnutls_x509_crt_import);
244 LOAD_DLL_FN (library, gnutls_x509_crt_init);
245 LOAD_DLL_FN (library, gnutls_x509_crt_get_fingerprint);
246 LOAD_DLL_FN (library, gnutls_x509_crt_get_version);
247 LOAD_DLL_FN (library, gnutls_x509_crt_get_serial);
248 LOAD_DLL_FN (library, gnutls_x509_crt_get_issuer_dn);
249 LOAD_DLL_FN (library, gnutls_x509_crt_get_activation_time);
250 LOAD_DLL_FN (library, gnutls_x509_crt_get_expiration_time);
251 LOAD_DLL_FN (library, gnutls_x509_crt_get_dn);
252 LOAD_DLL_FN (library, gnutls_x509_crt_get_pk_algorithm);
253 LOAD_DLL_FN (library, gnutls_pk_algorithm_get_name);
254 LOAD_DLL_FN (library, gnutls_pk_bits_to_sec_param);
255 LOAD_DLL_FN (library, gnutls_x509_crt_get_issuer_unique_id);
256 LOAD_DLL_FN (library, gnutls_x509_crt_get_subject_unique_id);
257 LOAD_DLL_FN (library, gnutls_x509_crt_get_signature_algorithm);
258 LOAD_DLL_FN (library, gnutls_x509_crt_get_signature);
259 LOAD_DLL_FN (library, gnutls_x509_crt_get_key_id);
260 LOAD_DLL_FN (library, gnutls_sec_param_get_name);
261 LOAD_DLL_FN (library, gnutls_sign_get_name);
262 LOAD_DLL_FN (library, gnutls_server_name_set);
263 LOAD_DLL_FN (library, gnutls_kx_get);
264 LOAD_DLL_FN (library, gnutls_kx_get_name);
265 LOAD_DLL_FN (library, gnutls_protocol_get_version);
266 LOAD_DLL_FN (library, gnutls_protocol_get_name);
267 LOAD_DLL_FN (library, gnutls_cipher_get);
268 LOAD_DLL_FN (library, gnutls_cipher_get_name);
269 LOAD_DLL_FN (library, gnutls_mac_get);
270 LOAD_DLL_FN (library, gnutls_mac_get_name);
272 max_log_level = global_gnutls_log_level;
275 Lisp_Object name = CAR_SAFE (Fget (Qgnutls_dll, QCloaded_from));
276 GNUTLS_LOG2 (1, max_log_level, "GnuTLS library loaded:",
277 STRINGP (name) ? (const char *) SDATA (name) : "unknown");
280 return 1;
283 # define gnutls_alert_get fn_gnutls_alert_get
284 # define gnutls_alert_get_name fn_gnutls_alert_get_name
285 # define gnutls_alert_send_appropriate fn_gnutls_alert_send_appropriate
286 # define gnutls_anon_allocate_client_credentials fn_gnutls_anon_allocate_client_credentials
287 # define gnutls_anon_free_client_credentials fn_gnutls_anon_free_client_credentials
288 # define gnutls_bye fn_gnutls_bye
289 # define gnutls_certificate_allocate_credentials fn_gnutls_certificate_allocate_credentials
290 # define gnutls_certificate_free_credentials fn_gnutls_certificate_free_credentials
291 # define gnutls_certificate_get_peers fn_gnutls_certificate_get_peers
292 # define gnutls_certificate_set_verify_flags fn_gnutls_certificate_set_verify_flags
293 # define gnutls_certificate_set_x509_crl_file fn_gnutls_certificate_set_x509_crl_file
294 # define gnutls_certificate_set_x509_key_file fn_gnutls_certificate_set_x509_key_file
295 # define gnutls_certificate_set_x509_system_trust fn_gnutls_certificate_set_x509_system_trust
296 # define gnutls_certificate_set_x509_trust_file fn_gnutls_certificate_set_x509_trust_file
297 # define gnutls_certificate_type_get fn_gnutls_certificate_type_get
298 # define gnutls_certificate_verify_peers2 fn_gnutls_certificate_verify_peers2
299 # define gnutls_check_version fn_gnutls_check_version
300 # define gnutls_cipher_get fn_gnutls_cipher_get
301 # define gnutls_cipher_get_name fn_gnutls_cipher_get_name
302 # define gnutls_credentials_set fn_gnutls_credentials_set
303 # define gnutls_deinit fn_gnutls_deinit
304 # define gnutls_dh_get_prime_bits fn_gnutls_dh_get_prime_bits
305 # define gnutls_dh_set_prime_bits fn_gnutls_dh_set_prime_bits
306 # define gnutls_error_is_fatal fn_gnutls_error_is_fatal
307 # define gnutls_global_init fn_gnutls_global_init
308 # define gnutls_global_set_audit_log_function fn_gnutls_global_set_audit_log_function
309 # define gnutls_global_set_log_function fn_gnutls_global_set_log_function
310 # define gnutls_global_set_log_level fn_gnutls_global_set_log_level
311 # define gnutls_handshake fn_gnutls_handshake
312 # define gnutls_init fn_gnutls_init
313 # define gnutls_kx_get fn_gnutls_kx_get
314 # define gnutls_kx_get_name fn_gnutls_kx_get_name
315 # define gnutls_mac_get fn_gnutls_mac_get
316 # define gnutls_mac_get_name fn_gnutls_mac_get_name
317 # define gnutls_pk_algorithm_get_name fn_gnutls_pk_algorithm_get_name
318 # define gnutls_pk_bits_to_sec_param fn_gnutls_pk_bits_to_sec_param
319 # define gnutls_priority_set_direct fn_gnutls_priority_set_direct
320 # define gnutls_protocol_get_name fn_gnutls_protocol_get_name
321 # define gnutls_protocol_get_version fn_gnutls_protocol_get_version
322 # define gnutls_record_check_pending fn_gnutls_record_check_pending
323 # define gnutls_record_recv fn_gnutls_record_recv
324 # define gnutls_record_send fn_gnutls_record_send
325 # define gnutls_sec_param_get_name fn_gnutls_sec_param_get_name
326 # define gnutls_server_name_set fn_gnutls_server_name_set
327 # define gnutls_sign_get_name fn_gnutls_sign_get_name
328 # define gnutls_strerror fn_gnutls_strerror
329 # define gnutls_transport_set_errno fn_gnutls_transport_set_errno
330 # define gnutls_transport_set_lowat fn_gnutls_transport_set_lowat
331 # define gnutls_transport_set_ptr2 fn_gnutls_transport_set_ptr2
332 # define gnutls_transport_set_pull_function fn_gnutls_transport_set_pull_function
333 # define gnutls_transport_set_push_function fn_gnutls_transport_set_push_function
334 # define gnutls_x509_crt_check_hostname fn_gnutls_x509_crt_check_hostname
335 # define gnutls_x509_crt_check_issuer fn_gnutls_x509_crt_check_issuer
336 # define gnutls_x509_crt_deinit fn_gnutls_x509_crt_deinit
337 # define gnutls_x509_crt_get_activation_time fn_gnutls_x509_crt_get_activation_time
338 # define gnutls_x509_crt_get_dn fn_gnutls_x509_crt_get_dn
339 # define gnutls_x509_crt_get_expiration_time fn_gnutls_x509_crt_get_expiration_time
340 # define gnutls_x509_crt_get_fingerprint fn_gnutls_x509_crt_get_fingerprint
341 # define gnutls_x509_crt_get_issuer_dn fn_gnutls_x509_crt_get_issuer_dn
342 # define gnutls_x509_crt_get_issuer_unique_id fn_gnutls_x509_crt_get_issuer_unique_id
343 # define gnutls_x509_crt_get_key_id fn_gnutls_x509_crt_get_key_id
344 # define gnutls_x509_crt_get_pk_algorithm fn_gnutls_x509_crt_get_pk_algorithm
345 # define gnutls_x509_crt_get_serial fn_gnutls_x509_crt_get_serial
346 # define gnutls_x509_crt_get_signature fn_gnutls_x509_crt_get_signature
347 # define gnutls_x509_crt_get_signature_algorithm fn_gnutls_x509_crt_get_signature_algorithm
348 # define gnutls_x509_crt_get_subject_unique_id fn_gnutls_x509_crt_get_subject_unique_id
349 # define gnutls_x509_crt_get_version fn_gnutls_x509_crt_get_version
350 # define gnutls_x509_crt_import fn_gnutls_x509_crt_import
351 # define gnutls_x509_crt_init fn_gnutls_x509_crt_init
353 #endif
356 /* Report memory exhaustion if ERR is an out-of-memory indication. */
357 static void
358 check_memory_full (int err)
360 /* When GnuTLS exhausts memory, it doesn't say how much memory it
361 asked for, so tell the Emacs allocator that GnuTLS asked for no
362 bytes. This isn't accurate, but it's good enough. */
363 if (err == GNUTLS_E_MEMORY_ERROR)
364 memory_full (0);
367 #ifdef HAVE_GNUTLS3
368 /* Log a simple audit message. */
369 static void
370 gnutls_audit_log_function (gnutls_session_t session, const char *string)
372 if (global_gnutls_log_level >= 1)
374 message ("gnutls.c: [audit] %s", string);
377 #endif
379 /* Log a simple message. */
380 static void
381 gnutls_log_function (int level, const char *string)
383 message ("gnutls.c: [%d] %s", level, string);
386 /* Log a message and a string. */
387 static void
388 gnutls_log_function2 (int level, const char *string, const char *extra)
390 message ("gnutls.c: [%d] %s %s", level, string, extra);
393 /* Log a message and an integer. */
394 static void
395 gnutls_log_function2i (int level, const char *string, int extra)
397 message ("gnutls.c: [%d] %s %d", level, string, extra);
400 static int
401 emacs_gnutls_handshake (struct Lisp_Process *proc)
403 gnutls_session_t state = proc->gnutls_state;
404 int ret;
406 if (proc->gnutls_initstage < GNUTLS_STAGE_HANDSHAKE_CANDO)
407 return -1;
409 if (proc->gnutls_initstage < GNUTLS_STAGE_TRANSPORT_POINTERS_SET)
411 #ifdef WINDOWSNT
412 /* On W32 we cannot transfer socket handles between different runtime
413 libraries, so we tell GnuTLS to use our special push/pull
414 functions. */
415 gnutls_transport_set_ptr2 (state,
416 (gnutls_transport_ptr_t) proc,
417 (gnutls_transport_ptr_t) proc);
418 gnutls_transport_set_push_function (state, &emacs_gnutls_push);
419 gnutls_transport_set_pull_function (state, &emacs_gnutls_pull);
421 /* For non blocking sockets or other custom made pull/push
422 functions the gnutls_transport_set_lowat must be called, with
423 a zero low water mark value. (GnuTLS 2.10.4 documentation)
425 (Note: this is probably not strictly necessary as the lowat
426 value is only used when no custom pull/push functions are
427 set.) */
428 /* According to GnuTLS NEWS file, lowat level has been set to
429 zero by default in version 2.11.1, and the function
430 gnutls_transport_set_lowat was removed from the library in
431 version 2.99.0. */
432 if (!gnutls_check_version ("2.11.1"))
433 gnutls_transport_set_lowat (state, 0);
434 #else
435 /* This is how GnuTLS takes sockets: as file descriptors passed
436 in. For an Emacs process socket, infd and outfd are the
437 same but we use this two-argument version for clarity. */
438 gnutls_transport_set_ptr2 (state,
439 (void *) (intptr_t) proc->infd,
440 (void *) (intptr_t) proc->outfd);
441 #endif
443 proc->gnutls_initstage = GNUTLS_STAGE_TRANSPORT_POINTERS_SET;
448 ret = gnutls_handshake (state);
449 emacs_gnutls_handle_error (state, ret);
450 QUIT;
452 while (ret < 0 && gnutls_error_is_fatal (ret) == 0);
454 proc->gnutls_initstage = GNUTLS_STAGE_HANDSHAKE_TRIED;
456 if (ret == GNUTLS_E_SUCCESS)
458 /* Here we're finally done. */
459 proc->gnutls_initstage = GNUTLS_STAGE_READY;
461 else
463 check_memory_full (gnutls_alert_send_appropriate (state, ret));
465 return ret;
468 ptrdiff_t
469 emacs_gnutls_record_check_pending (gnutls_session_t state)
471 return gnutls_record_check_pending (state);
474 #ifdef WINDOWSNT
475 void
476 emacs_gnutls_transport_set_errno (gnutls_session_t state, int err)
478 gnutls_transport_set_errno (state, err);
480 #endif
482 ptrdiff_t
483 emacs_gnutls_write (struct Lisp_Process *proc, const char *buf, ptrdiff_t nbyte)
485 ssize_t rtnval = 0;
486 ptrdiff_t bytes_written;
487 gnutls_session_t state = proc->gnutls_state;
489 if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
491 errno = EAGAIN;
492 return 0;
495 bytes_written = 0;
497 while (nbyte > 0)
499 rtnval = gnutls_record_send (state, buf, nbyte);
501 if (rtnval < 0)
503 if (rtnval == GNUTLS_E_INTERRUPTED)
504 continue;
505 else
507 /* If we get GNUTLS_E_AGAIN, then set errno
508 appropriately so that send_process retries the
509 correct way instead of erroring out. */
510 if (rtnval == GNUTLS_E_AGAIN)
511 errno = EAGAIN;
512 break;
516 buf += rtnval;
517 nbyte -= rtnval;
518 bytes_written += rtnval;
521 emacs_gnutls_handle_error (state, rtnval);
522 return (bytes_written);
525 ptrdiff_t
526 emacs_gnutls_read (struct Lisp_Process *proc, char *buf, ptrdiff_t nbyte)
528 ssize_t rtnval;
529 gnutls_session_t state = proc->gnutls_state;
531 int log_level = proc->gnutls_log_level;
533 if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
535 /* If the handshake count is under the limit, try the handshake
536 again and increment the handshake count. This count is kept
537 per process (connection), not globally. */
538 if (proc->gnutls_handshakes_tried < GNUTLS_EMACS_HANDSHAKES_LIMIT)
540 proc->gnutls_handshakes_tried++;
541 emacs_gnutls_handshake (proc);
542 GNUTLS_LOG2i (5, log_level, "Retried handshake",
543 proc->gnutls_handshakes_tried);
544 return -1;
547 GNUTLS_LOG (2, log_level, "Giving up on handshake; resetting retries");
548 proc->gnutls_handshakes_tried = 0;
549 return 0;
551 rtnval = gnutls_record_recv (state, buf, nbyte);
552 if (rtnval >= 0)
553 return rtnval;
554 else if (rtnval == GNUTLS_E_UNEXPECTED_PACKET_LENGTH)
555 /* The peer closed the connection. */
556 return 0;
557 else if (emacs_gnutls_handle_error (state, rtnval))
558 /* non-fatal error */
559 return -1;
560 else {
561 /* a fatal error occurred */
562 return 0;
566 /* Report a GnuTLS error to the user.
567 Return true if the error code was successfully handled. */
568 static bool
569 emacs_gnutls_handle_error (gnutls_session_t session, int err)
571 int max_log_level = 0;
573 bool ret;
574 const char *str;
576 /* TODO: use a Lisp_Object generated by gnutls_make_error? */
577 if (err >= 0)
578 return 1;
580 check_memory_full (err);
582 max_log_level = global_gnutls_log_level;
584 /* TODO: use gnutls-error-fatalp and gnutls-error-string. */
586 str = gnutls_strerror (err);
587 if (!str)
588 str = "unknown";
590 if (gnutls_error_is_fatal (err))
592 ret = 0;
593 GNUTLS_LOG2 (1, max_log_level, "fatal error:", str);
595 else
597 ret = 1;
599 switch (err)
601 case GNUTLS_E_AGAIN:
602 GNUTLS_LOG2 (3,
603 max_log_level,
604 "retry:",
605 str);
606 default:
607 GNUTLS_LOG2 (1,
608 max_log_level,
609 "non-fatal error:",
610 str);
614 if (err == GNUTLS_E_WARNING_ALERT_RECEIVED
615 || err == GNUTLS_E_FATAL_ALERT_RECEIVED)
617 int alert = gnutls_alert_get (session);
618 int level = (err == GNUTLS_E_FATAL_ALERT_RECEIVED) ? 0 : 1;
619 str = gnutls_alert_get_name (alert);
620 if (!str)
621 str = "unknown";
623 GNUTLS_LOG2 (level, max_log_level, "Received alert: ", str);
625 return ret;
628 /* convert an integer error to a Lisp_Object; it will be either a
629 known symbol like `gnutls_e_interrupted' and `gnutls_e_again' or
630 simply the integer value of the error. GNUTLS_E_SUCCESS is mapped
631 to Qt. */
632 static Lisp_Object
633 gnutls_make_error (int err)
635 switch (err)
637 case GNUTLS_E_SUCCESS:
638 return Qt;
639 case GNUTLS_E_AGAIN:
640 return Qgnutls_e_again;
641 case GNUTLS_E_INTERRUPTED:
642 return Qgnutls_e_interrupted;
643 case GNUTLS_E_INVALID_SESSION:
644 return Qgnutls_e_invalid_session;
647 check_memory_full (err);
648 return make_number (err);
651 Lisp_Object
652 emacs_gnutls_deinit (Lisp_Object proc)
654 int log_level;
656 CHECK_PROCESS (proc);
658 if (XPROCESS (proc)->gnutls_p == 0)
659 return Qnil;
661 log_level = XPROCESS (proc)->gnutls_log_level;
663 if (XPROCESS (proc)->gnutls_x509_cred)
665 GNUTLS_LOG (2, log_level, "Deallocating x509 credentials");
666 gnutls_certificate_free_credentials (XPROCESS (proc)->gnutls_x509_cred);
667 XPROCESS (proc)->gnutls_x509_cred = NULL;
670 if (XPROCESS (proc)->gnutls_anon_cred)
672 GNUTLS_LOG (2, log_level, "Deallocating anon credentials");
673 gnutls_anon_free_client_credentials (XPROCESS (proc)->gnutls_anon_cred);
674 XPROCESS (proc)->gnutls_anon_cred = NULL;
677 if (XPROCESS (proc)->gnutls_state)
679 gnutls_deinit (XPROCESS (proc)->gnutls_state);
680 XPROCESS (proc)->gnutls_state = NULL;
681 if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_INIT)
682 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT - 1;
685 XPROCESS (proc)->gnutls_p = 0;
686 return Qt;
689 DEFUN ("gnutls-get-initstage", Fgnutls_get_initstage, Sgnutls_get_initstage, 1, 1, 0,
690 doc: /* Return the GnuTLS init stage of process PROC.
691 See also `gnutls-boot'. */)
692 (Lisp_Object proc)
694 CHECK_PROCESS (proc);
696 return make_number (GNUTLS_INITSTAGE (proc));
699 DEFUN ("gnutls-errorp", Fgnutls_errorp, Sgnutls_errorp, 1, 1, 0,
700 doc: /* Return t if ERROR indicates a GnuTLS problem.
701 ERROR is an integer or a symbol with an integer `gnutls-code' property.
702 usage: (gnutls-errorp ERROR) */
703 attributes: const)
704 (Lisp_Object err)
706 if (EQ (err, Qt)) return Qnil;
708 return Qt;
711 DEFUN ("gnutls-error-fatalp", Fgnutls_error_fatalp, Sgnutls_error_fatalp, 1, 1, 0,
712 doc: /* Return non-nil if ERROR is fatal.
713 ERROR is an integer or a symbol with an integer `gnutls-code' property.
714 Usage: (gnutls-error-fatalp ERROR) */)
715 (Lisp_Object err)
717 Lisp_Object code;
719 if (EQ (err, Qt)) return Qnil;
721 if (SYMBOLP (err))
723 code = Fget (err, Qgnutls_code);
724 if (NUMBERP (code))
726 err = code;
728 else
730 error ("Symbol has no numeric gnutls-code property");
734 if (! TYPE_RANGED_INTEGERP (int, err))
735 error ("Not an error symbol or code");
737 if (0 == gnutls_error_is_fatal (XINT (err)))
738 return Qnil;
740 return Qt;
743 DEFUN ("gnutls-error-string", Fgnutls_error_string, Sgnutls_error_string, 1, 1, 0,
744 doc: /* Return a description of ERROR.
745 ERROR is an integer or a symbol with an integer `gnutls-code' property.
746 usage: (gnutls-error-string ERROR) */)
747 (Lisp_Object err)
749 Lisp_Object code;
751 if (EQ (err, Qt)) return build_string ("Not an error");
753 if (SYMBOLP (err))
755 code = Fget (err, Qgnutls_code);
756 if (NUMBERP (code))
758 err = code;
760 else
762 return build_string ("Symbol has no numeric gnutls-code property");
766 if (! TYPE_RANGED_INTEGERP (int, err))
767 return build_string ("Not an error symbol or code");
769 return build_string (gnutls_strerror (XINT (err)));
772 DEFUN ("gnutls-deinit", Fgnutls_deinit, Sgnutls_deinit, 1, 1, 0,
773 doc: /* Deallocate GnuTLS resources associated with process PROC.
774 See also `gnutls-init'. */)
775 (Lisp_Object proc)
777 return emacs_gnutls_deinit (proc);
780 static Lisp_Object
781 gnutls_hex_string (unsigned char *buf, ptrdiff_t buf_size, const char *prefix)
783 ptrdiff_t prefix_length = strlen (prefix);
784 if ((STRING_BYTES_BOUND - prefix_length) / 3 < buf_size)
785 string_overflow ();
786 Lisp_Object ret = make_uninit_string (prefix_length + 3 * buf_size
787 - (buf_size != 0));
788 char *string = SSDATA (ret);
789 strcpy (string, prefix);
791 for (ptrdiff_t i = 0; i < buf_size; i++)
792 sprintf (string + i * 3 + prefix_length,
793 i == buf_size - 1 ? "%02x" : "%02x:",
794 buf[i]);
796 return ret;
799 static Lisp_Object
800 gnutls_certificate_details (gnutls_x509_crt_t cert)
802 Lisp_Object res = Qnil;
803 int err;
804 size_t buf_size;
806 /* Version. */
808 int version = gnutls_x509_crt_get_version (cert);
809 check_memory_full (version);
810 if (version >= GNUTLS_E_SUCCESS)
811 res = nconc2 (res, list2 (intern (":version"),
812 make_number (version)));
815 /* Serial. */
816 buf_size = 0;
817 err = gnutls_x509_crt_get_serial (cert, NULL, &buf_size);
818 check_memory_full (err);
819 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
821 void *serial = xmalloc (buf_size);
822 err = gnutls_x509_crt_get_serial (cert, serial, &buf_size);
823 check_memory_full (err);
824 if (err >= GNUTLS_E_SUCCESS)
825 res = nconc2 (res, list2 (intern (":serial-number"),
826 gnutls_hex_string (serial, buf_size, "")));
827 xfree (serial);
830 /* Issuer. */
831 buf_size = 0;
832 err = gnutls_x509_crt_get_issuer_dn (cert, NULL, &buf_size);
833 check_memory_full (err);
834 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
836 char *dn = xmalloc (buf_size);
837 err = gnutls_x509_crt_get_issuer_dn (cert, dn, &buf_size);
838 check_memory_full (err);
839 if (err >= GNUTLS_E_SUCCESS)
840 res = nconc2 (res, list2 (intern (":issuer"),
841 make_string (dn, buf_size)));
842 xfree (dn);
845 /* Validity. */
847 /* Add 1 to the buffer size, since 1900 is added to tm_year and
848 that might add 1 to the year length. */
849 char buf[INT_STRLEN_BOUND (int) + 1 + sizeof "-12-31"];
850 struct tm t;
851 time_t tim = gnutls_x509_crt_get_activation_time (cert);
853 if (gmtime_r (&tim, &t) && strftime (buf, sizeof buf, "%Y-%m-%d", &t))
854 res = nconc2 (res, list2 (intern (":valid-from"), build_string (buf)));
856 tim = gnutls_x509_crt_get_expiration_time (cert);
857 if (gmtime_r (&tim, &t) && strftime (buf, sizeof buf, "%Y-%m-%d", &t))
858 res = nconc2 (res, list2 (intern (":valid-to"), build_string (buf)));
861 /* Subject. */
862 buf_size = 0;
863 err = gnutls_x509_crt_get_dn (cert, NULL, &buf_size);
864 check_memory_full (err);
865 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
867 char *dn = xmalloc (buf_size);
868 err = gnutls_x509_crt_get_dn (cert, dn, &buf_size);
869 check_memory_full (err);
870 if (err >= GNUTLS_E_SUCCESS)
871 res = nconc2 (res, list2 (intern (":subject"),
872 make_string (dn, buf_size)));
873 xfree (dn);
876 /* Versions older than 2.11 doesn't have these four functions. */
877 #if GNUTLS_VERSION_NUMBER >= 0x020b00
878 /* SubjectPublicKeyInfo. */
880 unsigned int bits;
882 err = gnutls_x509_crt_get_pk_algorithm (cert, &bits);
883 check_memory_full (err);
884 if (err >= GNUTLS_E_SUCCESS)
886 const char *name = gnutls_pk_algorithm_get_name (err);
887 if (name)
888 res = nconc2 (res, list2 (intern (":public-key-algorithm"),
889 build_string (name)));
891 name = gnutls_sec_param_get_name (gnutls_pk_bits_to_sec_param
892 (err, bits));
893 res = nconc2 (res, list2 (intern (":certificate-security-level"),
894 build_string (name)));
898 /* Unique IDs. */
899 buf_size = 0;
900 err = gnutls_x509_crt_get_issuer_unique_id (cert, NULL, &buf_size);
901 check_memory_full (err);
902 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
904 char *buf = xmalloc (buf_size);
905 err = gnutls_x509_crt_get_issuer_unique_id (cert, buf, &buf_size);
906 check_memory_full (err);
907 if (err >= GNUTLS_E_SUCCESS)
908 res = nconc2 (res, list2 (intern (":issuer-unique-id"),
909 make_string (buf, buf_size)));
910 xfree (buf);
913 buf_size = 0;
914 err = gnutls_x509_crt_get_subject_unique_id (cert, NULL, &buf_size);
915 check_memory_full (err);
916 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
918 char *buf = xmalloc (buf_size);
919 err = gnutls_x509_crt_get_subject_unique_id (cert, buf, &buf_size);
920 check_memory_full (err);
921 if (err >= GNUTLS_E_SUCCESS)
922 res = nconc2 (res, list2 (intern (":subject-unique-id"),
923 make_string (buf, buf_size)));
924 xfree (buf);
926 #endif
928 /* Signature. */
929 err = gnutls_x509_crt_get_signature_algorithm (cert);
930 check_memory_full (err);
931 if (err >= GNUTLS_E_SUCCESS)
933 const char *name = gnutls_sign_get_name (err);
934 if (name)
935 res = nconc2 (res, list2 (intern (":signature-algorithm"),
936 build_string (name)));
939 /* Public key ID. */
940 buf_size = 0;
941 err = gnutls_x509_crt_get_key_id (cert, 0, NULL, &buf_size);
942 check_memory_full (err);
943 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
945 void *buf = xmalloc (buf_size);
946 err = gnutls_x509_crt_get_key_id (cert, 0, buf, &buf_size);
947 check_memory_full (err);
948 if (err >= GNUTLS_E_SUCCESS)
949 res = nconc2 (res, list2 (intern (":public-key-id"),
950 gnutls_hex_string (buf, buf_size, "sha1:")));
951 xfree (buf);
954 /* Certificate fingerprint. */
955 buf_size = 0;
956 err = gnutls_x509_crt_get_fingerprint (cert, GNUTLS_DIG_SHA1,
957 NULL, &buf_size);
958 check_memory_full (err);
959 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
961 void *buf = xmalloc (buf_size);
962 err = gnutls_x509_crt_get_fingerprint (cert, GNUTLS_DIG_SHA1,
963 buf, &buf_size);
964 check_memory_full (err);
965 if (err >= GNUTLS_E_SUCCESS)
966 res = nconc2 (res, list2 (intern (":certificate-id"),
967 gnutls_hex_string (buf, buf_size, "sha1:")));
968 xfree (buf);
971 return res;
974 DEFUN ("gnutls-peer-status-warning-describe", Fgnutls_peer_status_warning_describe, Sgnutls_peer_status_warning_describe, 1, 1, 0,
975 doc: /* Describe the warning of a GnuTLS peer status from `gnutls-peer-status'. */)
976 (Lisp_Object status_symbol)
978 CHECK_SYMBOL (status_symbol);
980 if (EQ (status_symbol, intern (":invalid")))
981 return build_string ("certificate could not be verified");
983 if (EQ (status_symbol, intern (":revoked")))
984 return build_string ("certificate was revoked (CRL)");
986 if (EQ (status_symbol, intern (":self-signed")))
987 return build_string ("certificate signer was not found (self-signed)");
989 if (EQ (status_symbol, intern (":unknown-ca")))
990 return build_string ("the certificate was signed by an unknown "
991 "and therefore untrusted authority");
993 if (EQ (status_symbol, intern (":not-ca")))
994 return build_string ("certificate signer is not a CA");
996 if (EQ (status_symbol, intern (":insecure")))
997 return build_string ("certificate was signed with an insecure algorithm");
999 if (EQ (status_symbol, intern (":not-activated")))
1000 return build_string ("certificate is not yet activated");
1002 if (EQ (status_symbol, intern (":expired")))
1003 return build_string ("certificate has expired");
1005 if (EQ (status_symbol, intern (":no-host-match")))
1006 return build_string ("certificate host does not match hostname");
1008 return Qnil;
1011 DEFUN ("gnutls-peer-status", Fgnutls_peer_status, Sgnutls_peer_status, 1, 1, 0,
1012 doc: /* Describe a GnuTLS PROC peer certificate and any warnings about it.
1013 The return value is a property list with top-level keys :warnings and
1014 :certificate. The :warnings entry is a list of symbols you can describe with
1015 `gnutls-peer-status-warning-describe'. */)
1016 (Lisp_Object proc)
1018 Lisp_Object warnings = Qnil, result = Qnil;
1019 unsigned int verification;
1020 gnutls_session_t state;
1022 CHECK_PROCESS (proc);
1024 if (GNUTLS_INITSTAGE (proc) < GNUTLS_STAGE_INIT)
1025 return Qnil;
1027 /* Then collect any warnings already computed by the handshake. */
1028 verification = XPROCESS (proc)->gnutls_peer_verification;
1030 if (verification & GNUTLS_CERT_INVALID)
1031 warnings = Fcons (intern (":invalid"), warnings);
1033 if (verification & GNUTLS_CERT_REVOKED)
1034 warnings = Fcons (intern (":revoked"), warnings);
1036 if (verification & GNUTLS_CERT_SIGNER_NOT_FOUND)
1037 warnings = Fcons (intern (":unknown-ca"), warnings);
1039 if (verification & GNUTLS_CERT_SIGNER_NOT_CA)
1040 warnings = Fcons (intern (":not-ca"), warnings);
1042 if (verification & GNUTLS_CERT_INSECURE_ALGORITHM)
1043 warnings = Fcons (intern (":insecure"), warnings);
1045 if (verification & GNUTLS_CERT_NOT_ACTIVATED)
1046 warnings = Fcons (intern (":not-activated"), warnings);
1048 if (verification & GNUTLS_CERT_EXPIRED)
1049 warnings = Fcons (intern (":expired"), warnings);
1051 if (XPROCESS (proc)->gnutls_extra_peer_verification &
1052 CERTIFICATE_NOT_MATCHING)
1053 warnings = Fcons (intern (":no-host-match"), warnings);
1055 /* This could get called in the INIT stage, when the certificate is
1056 not yet set. */
1057 if (XPROCESS (proc)->gnutls_certificate != NULL &&
1058 gnutls_x509_crt_check_issuer(XPROCESS (proc)->gnutls_certificate,
1059 XPROCESS (proc)->gnutls_certificate))
1060 warnings = Fcons (intern (":self-signed"), warnings);
1062 if (!NILP (warnings))
1063 result = list2 (intern (":warnings"), warnings);
1065 /* This could get called in the INIT stage, when the certificate is
1066 not yet set. */
1067 if (XPROCESS (proc)->gnutls_certificate != NULL)
1068 result = nconc2 (result, list2
1069 (intern (":certificate"),
1070 gnutls_certificate_details (XPROCESS (proc)->gnutls_certificate)));
1072 state = XPROCESS (proc)->gnutls_state;
1074 /* Diffie-Hellman prime bits. */
1076 int bits = gnutls_dh_get_prime_bits (state);
1077 check_memory_full (bits);
1078 if (bits > 0)
1079 result = nconc2 (result, list2 (intern (":diffie-hellman-prime-bits"),
1080 make_number (bits)));
1083 /* Key exchange. */
1084 result = nconc2
1085 (result, list2 (intern (":key-exchange"),
1086 build_string (gnutls_kx_get_name
1087 (gnutls_kx_get (state)))));
1089 /* Protocol name. */
1090 result = nconc2
1091 (result, list2 (intern (":protocol"),
1092 build_string (gnutls_protocol_get_name
1093 (gnutls_protocol_get_version (state)))));
1095 /* Cipher name. */
1096 result = nconc2
1097 (result, list2 (intern (":cipher"),
1098 build_string (gnutls_cipher_get_name
1099 (gnutls_cipher_get (state)))));
1101 /* MAC name. */
1102 result = nconc2
1103 (result, list2 (intern (":mac"),
1104 build_string (gnutls_mac_get_name
1105 (gnutls_mac_get (state)))));
1108 return result;
1111 /* Initialize global GnuTLS state to defaults.
1112 Call `gnutls-global-deinit' when GnuTLS usage is no longer needed.
1113 Return zero on success. */
1114 static Lisp_Object
1115 emacs_gnutls_global_init (void)
1117 int ret = GNUTLS_E_SUCCESS;
1119 if (!gnutls_global_initialized)
1120 ret = gnutls_global_init ();
1122 gnutls_global_initialized = 1;
1124 return gnutls_make_error (ret);
1127 static bool
1128 gnutls_ip_address_p (char *string)
1130 char c;
1132 while ((c = *string++) != 0)
1133 if (! ((c == '.' || c == ':' || (c >= '0' && c <= '9'))))
1134 return false;
1136 return true;
1139 #if 0
1140 /* Deinitialize global GnuTLS state.
1141 See also `gnutls-global-init'. */
1142 static Lisp_Object
1143 emacs_gnutls_global_deinit (void)
1145 if (gnutls_global_initialized)
1146 gnutls_global_deinit ();
1148 gnutls_global_initialized = 0;
1150 return gnutls_make_error (GNUTLS_E_SUCCESS);
1152 #endif
1154 DEFUN ("gnutls-boot", Fgnutls_boot, Sgnutls_boot, 3, 3, 0,
1155 doc: /* Initialize GnuTLS client for process PROC with TYPE+PROPLIST.
1156 Currently only client mode is supported. Return a success/failure
1157 value you can check with `gnutls-errorp'.
1159 TYPE is a symbol, either `gnutls-anon' or `gnutls-x509pki'.
1160 PROPLIST is a property list with the following keys:
1162 :hostname is a string naming the remote host.
1164 :priority is a GnuTLS priority string, defaults to "NORMAL".
1166 :trustfiles is a list of PEM-encoded trust files for `gnutls-x509pki'.
1168 :crlfiles is a list of PEM-encoded CRL lists for `gnutls-x509pki'.
1170 :keylist is an alist of PEM-encoded key files and PEM-encoded
1171 certificates for `gnutls-x509pki'.
1173 :callbacks is an alist of callback functions, see below.
1175 :loglevel is the debug level requested from GnuTLS, try 4.
1177 :verify-flags is a bitset as per GnuTLS'
1178 gnutls_certificate_set_verify_flags.
1180 :verify-hostname-error is ignored. Pass :hostname in :verify-error
1181 instead.
1183 :verify-error is a list of symbols to express verification checks or
1184 `t' to do all checks. Currently it can contain `:trustfiles' and
1185 `:hostname' to verify the certificate or the hostname respectively.
1187 :min-prime-bits is the minimum accepted number of bits the client will
1188 accept in Diffie-Hellman key exchange.
1190 The debug level will be set for this process AND globally for GnuTLS.
1191 So if you set it higher or lower at any point, it affects global
1192 debugging.
1194 Note that the priority is set on the client. The server does not use
1195 the protocols's priority except for disabling protocols that were not
1196 specified.
1198 Processes must be initialized with this function before other GnuTLS
1199 functions are used. This function allocates resources which can only
1200 be deallocated by calling `gnutls-deinit' or by calling it again.
1202 The callbacks alist can have a `verify' key, associated with a
1203 verification function (UNUSED).
1205 Each authentication type may need additional information in order to
1206 work. For X.509 PKI (`gnutls-x509pki'), you probably need at least
1207 one trustfile (usually a CA bundle). */)
1208 (Lisp_Object proc, Lisp_Object type, Lisp_Object proplist)
1210 int ret = GNUTLS_E_SUCCESS;
1211 int max_log_level = 0;
1212 bool verify_error_all = 0;
1214 gnutls_session_t state;
1215 gnutls_certificate_credentials_t x509_cred = NULL;
1216 gnutls_anon_client_credentials_t anon_cred = NULL;
1217 Lisp_Object global_init;
1218 char const *priority_string_ptr = "NORMAL"; /* default priority string. */
1219 unsigned int peer_verification;
1220 char *c_hostname;
1222 /* Placeholders for the property list elements. */
1223 Lisp_Object priority_string;
1224 Lisp_Object trustfiles;
1225 Lisp_Object crlfiles;
1226 Lisp_Object keylist;
1227 /* Lisp_Object callbacks; */
1228 Lisp_Object loglevel;
1229 Lisp_Object hostname;
1230 Lisp_Object verify_error;
1231 Lisp_Object prime_bits;
1232 Lisp_Object warnings;
1234 CHECK_PROCESS (proc);
1235 CHECK_SYMBOL (type);
1236 CHECK_LIST (proplist);
1238 if (NILP (Fgnutls_available_p ()))
1239 error ("GnuTLS not available");
1241 if (!EQ (type, Qgnutls_x509pki) && !EQ (type, Qgnutls_anon))
1242 error ("Invalid GnuTLS credential type");
1244 hostname = Fplist_get (proplist, QCgnutls_bootprop_hostname);
1245 priority_string = Fplist_get (proplist, QCgnutls_bootprop_priority);
1246 trustfiles = Fplist_get (proplist, QCgnutls_bootprop_trustfiles);
1247 keylist = Fplist_get (proplist, QCgnutls_bootprop_keylist);
1248 crlfiles = Fplist_get (proplist, QCgnutls_bootprop_crlfiles);
1249 loglevel = Fplist_get (proplist, QCgnutls_bootprop_loglevel);
1250 verify_error = Fplist_get (proplist, QCgnutls_bootprop_verify_error);
1251 prime_bits = Fplist_get (proplist, QCgnutls_bootprop_min_prime_bits);
1253 if (EQ (verify_error, Qt))
1255 verify_error_all = 1;
1257 else if (NILP (Flistp (verify_error)))
1259 error ("gnutls-boot: invalid :verify_error parameter (not a list)");
1262 if (!STRINGP (hostname))
1263 error ("gnutls-boot: invalid :hostname parameter (not a string)");
1264 c_hostname = SSDATA (hostname);
1266 state = XPROCESS (proc)->gnutls_state;
1268 if (TYPE_RANGED_INTEGERP (int, loglevel))
1270 gnutls_global_set_log_function (gnutls_log_function);
1271 #ifdef HAVE_GNUTLS3
1272 gnutls_global_set_audit_log_function (gnutls_audit_log_function);
1273 #endif
1274 gnutls_global_set_log_level (XINT (loglevel));
1275 max_log_level = XINT (loglevel);
1276 XPROCESS (proc)->gnutls_log_level = max_log_level;
1279 GNUTLS_LOG2 (1, max_log_level, "connecting to host:", c_hostname);
1281 /* Always initialize globals. */
1282 global_init = emacs_gnutls_global_init ();
1283 if (! NILP (Fgnutls_errorp (global_init)))
1284 return global_init;
1286 /* Before allocating new credentials, deallocate any credentials
1287 that PROC might already have. */
1288 emacs_gnutls_deinit (proc);
1290 /* Mark PROC as a GnuTLS process. */
1291 XPROCESS (proc)->gnutls_state = NULL;
1292 XPROCESS (proc)->gnutls_x509_cred = NULL;
1293 XPROCESS (proc)->gnutls_anon_cred = NULL;
1294 pset_gnutls_cred_type (XPROCESS (proc), type);
1295 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_EMPTY;
1297 GNUTLS_LOG (1, max_log_level, "allocating credentials");
1298 if (EQ (type, Qgnutls_x509pki))
1300 Lisp_Object verify_flags;
1301 unsigned int gnutls_verify_flags = GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT;
1303 GNUTLS_LOG (2, max_log_level, "allocating x509 credentials");
1304 check_memory_full (gnutls_certificate_allocate_credentials (&x509_cred));
1305 XPROCESS (proc)->gnutls_x509_cred = x509_cred;
1307 verify_flags = Fplist_get (proplist, QCgnutls_bootprop_verify_flags);
1308 if (NUMBERP (verify_flags))
1310 gnutls_verify_flags = XINT (verify_flags);
1311 GNUTLS_LOG (2, max_log_level, "setting verification flags");
1313 else if (NILP (verify_flags))
1314 GNUTLS_LOG (2, max_log_level, "using default verification flags");
1315 else
1316 GNUTLS_LOG (2, max_log_level, "ignoring invalid verify-flags");
1318 gnutls_certificate_set_verify_flags (x509_cred, gnutls_verify_flags);
1320 else /* Qgnutls_anon: */
1322 GNUTLS_LOG (2, max_log_level, "allocating anon credentials");
1323 check_memory_full (gnutls_anon_allocate_client_credentials (&anon_cred));
1324 XPROCESS (proc)->gnutls_anon_cred = anon_cred;
1327 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_ALLOC;
1329 if (EQ (type, Qgnutls_x509pki))
1331 /* TODO: GNUTLS_X509_FMT_DER is also an option. */
1332 int file_format = GNUTLS_X509_FMT_PEM;
1333 Lisp_Object tail;
1335 #if GNUTLS_VERSION_MAJOR + \
1336 (GNUTLS_VERSION_MINOR > 0 || GNUTLS_VERSION_PATCH >= 20) > 3
1337 ret = gnutls_certificate_set_x509_system_trust (x509_cred);
1338 if (ret < GNUTLS_E_SUCCESS)
1340 check_memory_full (ret);
1341 GNUTLS_LOG2i (4, max_log_level,
1342 "setting system trust failed with code ", ret);
1344 #endif
1346 for (tail = trustfiles; CONSP (tail); tail = XCDR (tail))
1348 Lisp_Object trustfile = XCAR (tail);
1349 if (STRINGP (trustfile))
1351 GNUTLS_LOG2 (1, max_log_level, "setting the trustfile: ",
1352 SSDATA (trustfile));
1353 trustfile = ENCODE_FILE (trustfile);
1354 #ifdef WINDOWSNT
1355 /* Since GnuTLS doesn't support UTF-8 or UTF-16 encoded
1356 file names on Windows, we need to re-encode the file
1357 name using the current ANSI codepage. */
1358 trustfile = ansi_encode_filename (trustfile);
1359 #endif
1360 ret = gnutls_certificate_set_x509_trust_file
1361 (x509_cred,
1362 SSDATA (trustfile),
1363 file_format);
1365 if (ret < GNUTLS_E_SUCCESS)
1366 return gnutls_make_error (ret);
1368 else
1370 emacs_gnutls_deinit (proc);
1371 error ("Invalid trustfile");
1375 for (tail = crlfiles; CONSP (tail); tail = XCDR (tail))
1377 Lisp_Object crlfile = XCAR (tail);
1378 if (STRINGP (crlfile))
1380 GNUTLS_LOG2 (1, max_log_level, "setting the CRL file: ",
1381 SSDATA (crlfile));
1382 crlfile = ENCODE_FILE (crlfile);
1383 #ifdef WINDOWSNT
1384 crlfile = ansi_encode_filename (crlfile);
1385 #endif
1386 ret = gnutls_certificate_set_x509_crl_file
1387 (x509_cred, SSDATA (crlfile), file_format);
1389 if (ret < GNUTLS_E_SUCCESS)
1390 return gnutls_make_error (ret);
1392 else
1394 emacs_gnutls_deinit (proc);
1395 error ("Invalid CRL file");
1399 for (tail = keylist; CONSP (tail); tail = XCDR (tail))
1401 Lisp_Object keyfile = Fcar (XCAR (tail));
1402 Lisp_Object certfile = Fcar (Fcdr (XCAR (tail)));
1403 if (STRINGP (keyfile) && STRINGP (certfile))
1405 GNUTLS_LOG2 (1, max_log_level, "setting the client key file: ",
1406 SSDATA (keyfile));
1407 GNUTLS_LOG2 (1, max_log_level, "setting the client cert file: ",
1408 SSDATA (certfile));
1409 keyfile = ENCODE_FILE (keyfile);
1410 certfile = ENCODE_FILE (certfile);
1411 #ifdef WINDOWSNT
1412 keyfile = ansi_encode_filename (keyfile);
1413 certfile = ansi_encode_filename (certfile);
1414 #endif
1415 ret = gnutls_certificate_set_x509_key_file
1416 (x509_cred, SSDATA (certfile), SSDATA (keyfile), file_format);
1418 if (ret < GNUTLS_E_SUCCESS)
1419 return gnutls_make_error (ret);
1421 else
1423 emacs_gnutls_deinit (proc);
1424 error (STRINGP (keyfile) ? "Invalid client cert file"
1425 : "Invalid client key file");
1430 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_FILES;
1431 GNUTLS_LOG (1, max_log_level, "gnutls callbacks");
1432 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CALLBACKS;
1434 /* Call gnutls_init here: */
1436 GNUTLS_LOG (1, max_log_level, "gnutls_init");
1437 ret = gnutls_init (&state, GNUTLS_CLIENT);
1438 XPROCESS (proc)->gnutls_state = state;
1439 if (ret < GNUTLS_E_SUCCESS)
1440 return gnutls_make_error (ret);
1441 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT;
1443 if (STRINGP (priority_string))
1445 priority_string_ptr = SSDATA (priority_string);
1446 GNUTLS_LOG2 (1, max_log_level, "got non-default priority string:",
1447 priority_string_ptr);
1449 else
1451 GNUTLS_LOG2 (1, max_log_level, "using default priority string:",
1452 priority_string_ptr);
1455 GNUTLS_LOG (1, max_log_level, "setting the priority string");
1456 ret = gnutls_priority_set_direct (state, priority_string_ptr, NULL);
1457 if (ret < GNUTLS_E_SUCCESS)
1458 return gnutls_make_error (ret);
1460 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_PRIORITY;
1462 if (INTEGERP (prime_bits))
1463 gnutls_dh_set_prime_bits (state, XUINT (prime_bits));
1465 ret = EQ (type, Qgnutls_x509pki)
1466 ? gnutls_credentials_set (state, GNUTLS_CRD_CERTIFICATE, x509_cred)
1467 : gnutls_credentials_set (state, GNUTLS_CRD_ANON, anon_cred);
1468 if (ret < GNUTLS_E_SUCCESS)
1469 return gnutls_make_error (ret);
1471 if (!gnutls_ip_address_p (c_hostname))
1473 ret = gnutls_server_name_set (state, GNUTLS_NAME_DNS, c_hostname,
1474 strlen (c_hostname));
1475 if (ret < GNUTLS_E_SUCCESS)
1476 return gnutls_make_error (ret);
1479 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_SET;
1480 ret = emacs_gnutls_handshake (XPROCESS (proc));
1481 if (ret < GNUTLS_E_SUCCESS)
1482 return gnutls_make_error (ret);
1484 /* Now verify the peer, following
1485 http://www.gnu.org/software/gnutls/manual/html_node/Verifying-peer_0027s-certificate.html.
1486 The peer should present at least one certificate in the chain; do a
1487 check of the certificate's hostname with
1488 gnutls_x509_crt_check_hostname against :hostname. */
1490 ret = gnutls_certificate_verify_peers2 (state, &peer_verification);
1491 if (ret < GNUTLS_E_SUCCESS)
1492 return gnutls_make_error (ret);
1494 XPROCESS (proc)->gnutls_peer_verification = peer_verification;
1496 warnings = Fplist_get (Fgnutls_peer_status (proc), intern (":warnings"));
1497 if (!NILP (warnings))
1499 Lisp_Object tail;
1500 for (tail = warnings; CONSP (tail); tail = XCDR (tail))
1502 Lisp_Object warning = XCAR (tail);
1503 Lisp_Object message = Fgnutls_peer_status_warning_describe (warning);
1504 if (!NILP (message))
1505 GNUTLS_LOG2 (1, max_log_level, "verification:", SSDATA (message));
1509 if (peer_verification != 0)
1511 if (verify_error_all
1512 || !NILP (Fmember (QCgnutls_bootprop_trustfiles, verify_error)))
1514 emacs_gnutls_deinit (proc);
1515 error ("Certificate validation failed %s, verification code %d",
1516 c_hostname, peer_verification);
1518 else
1520 GNUTLS_LOG2 (1, max_log_level, "certificate validation failed:",
1521 c_hostname);
1525 /* Up to here the process is the same for X.509 certificates and
1526 OpenPGP keys. From now on X.509 certificates are assumed. This
1527 can be easily extended to work with openpgp keys as well. */
1528 if (gnutls_certificate_type_get (state) == GNUTLS_CRT_X509)
1530 gnutls_x509_crt_t gnutls_verify_cert;
1531 const gnutls_datum_t *gnutls_verify_cert_list;
1532 unsigned int gnutls_verify_cert_list_size;
1534 ret = gnutls_x509_crt_init (&gnutls_verify_cert);
1535 if (ret < GNUTLS_E_SUCCESS)
1536 return gnutls_make_error (ret);
1538 gnutls_verify_cert_list =
1539 gnutls_certificate_get_peers (state, &gnutls_verify_cert_list_size);
1541 if (gnutls_verify_cert_list == NULL)
1543 gnutls_x509_crt_deinit (gnutls_verify_cert);
1544 emacs_gnutls_deinit (proc);
1545 error ("No x509 certificate was found\n");
1548 /* We only check the first certificate in the given chain. */
1549 ret = gnutls_x509_crt_import (gnutls_verify_cert,
1550 &gnutls_verify_cert_list[0],
1551 GNUTLS_X509_FMT_DER);
1553 if (ret < GNUTLS_E_SUCCESS)
1555 gnutls_x509_crt_deinit (gnutls_verify_cert);
1556 return gnutls_make_error (ret);
1559 XPROCESS (proc)->gnutls_certificate = gnutls_verify_cert;
1561 int err = gnutls_x509_crt_check_hostname (gnutls_verify_cert,
1562 c_hostname);
1563 check_memory_full (err);
1564 if (!err)
1566 XPROCESS (proc)->gnutls_extra_peer_verification |=
1567 CERTIFICATE_NOT_MATCHING;
1568 if (verify_error_all
1569 || !NILP (Fmember (QCgnutls_bootprop_hostname, verify_error)))
1571 gnutls_x509_crt_deinit (gnutls_verify_cert);
1572 emacs_gnutls_deinit (proc);
1573 error ("The x509 certificate does not match \"%s\"", c_hostname);
1575 else
1577 GNUTLS_LOG2 (1, max_log_level, "x509 certificate does not match:",
1578 c_hostname);
1583 /* Set this flag only if the whole initialization succeeded. */
1584 XPROCESS (proc)->gnutls_p = 1;
1586 return gnutls_make_error (ret);
1589 DEFUN ("gnutls-bye", Fgnutls_bye,
1590 Sgnutls_bye, 2, 2, 0,
1591 doc: /* Terminate current GnuTLS connection for process PROC.
1592 The connection should have been initiated using `gnutls-handshake'.
1594 If CONT is not nil the TLS connection gets terminated and further
1595 receives and sends will be disallowed. If the return value is zero you
1596 may continue using the connection. If CONT is nil, GnuTLS actually
1597 sends an alert containing a close request and waits for the peer to
1598 reply with the same message. In order to reuse the connection you
1599 should wait for an EOF from the peer.
1601 This function may also return `gnutls-e-again', or
1602 `gnutls-e-interrupted'. */)
1603 (Lisp_Object proc, Lisp_Object cont)
1605 gnutls_session_t state;
1606 int ret;
1608 CHECK_PROCESS (proc);
1610 state = XPROCESS (proc)->gnutls_state;
1612 gnutls_x509_crt_deinit (XPROCESS (proc)->gnutls_certificate);
1614 ret = gnutls_bye (state, NILP (cont) ? GNUTLS_SHUT_RDWR : GNUTLS_SHUT_WR);
1616 return gnutls_make_error (ret);
1619 #endif /* HAVE_GNUTLS */
1621 DEFUN ("gnutls-available-p", Fgnutls_available_p, Sgnutls_available_p, 0, 0, 0,
1622 doc: /* Return t if GnuTLS is available in this instance of Emacs. */)
1623 (void)
1625 #ifdef HAVE_GNUTLS
1626 # ifdef WINDOWSNT
1627 Lisp_Object found = Fassq (Qgnutls_dll, Vlibrary_cache);
1628 if (CONSP (found))
1629 return XCDR (found);
1630 else
1632 Lisp_Object status;
1633 status = init_gnutls_functions () ? Qt : Qnil;
1634 Vlibrary_cache = Fcons (Fcons (Qgnutls_dll, status), Vlibrary_cache);
1635 return status;
1637 # else /* !WINDOWSNT */
1638 return Qt;
1639 # endif /* !WINDOWSNT */
1640 #else /* !HAVE_GNUTLS */
1641 return Qnil;
1642 #endif /* !HAVE_GNUTLS */
1645 void
1646 syms_of_gnutls (void)
1648 #ifdef HAVE_GNUTLS
1649 gnutls_global_initialized = 0;
1651 DEFSYM (Qgnutls_dll, "gnutls");
1652 DEFSYM (Qgnutls_code, "gnutls-code");
1653 DEFSYM (Qgnutls_anon, "gnutls-anon");
1654 DEFSYM (Qgnutls_x509pki, "gnutls-x509pki");
1656 /* The following are for the property list of 'gnutls-boot'. */
1657 DEFSYM (QCgnutls_bootprop_hostname, ":hostname");
1658 DEFSYM (QCgnutls_bootprop_priority, ":priority");
1659 DEFSYM (QCgnutls_bootprop_trustfiles, ":trustfiles");
1660 DEFSYM (QCgnutls_bootprop_keylist, ":keylist");
1661 DEFSYM (QCgnutls_bootprop_crlfiles, ":crlfiles");
1662 DEFSYM (QCgnutls_bootprop_callbacks, ":callbacks");
1663 DEFSYM (QCgnutls_bootprop_min_prime_bits, ":min-prime-bits");
1664 DEFSYM (QCgnutls_bootprop_loglevel, ":loglevel");
1665 DEFSYM (QCgnutls_bootprop_verify_flags, ":verify-flags");
1666 DEFSYM (QCgnutls_bootprop_verify_error, ":verify-error");
1668 DEFSYM (Qgnutls_e_interrupted, "gnutls-e-interrupted");
1669 Fput (Qgnutls_e_interrupted, Qgnutls_code,
1670 make_number (GNUTLS_E_INTERRUPTED));
1672 DEFSYM (Qgnutls_e_again, "gnutls-e-again");
1673 Fput (Qgnutls_e_again, Qgnutls_code,
1674 make_number (GNUTLS_E_AGAIN));
1676 DEFSYM (Qgnutls_e_invalid_session, "gnutls-e-invalid-session");
1677 Fput (Qgnutls_e_invalid_session, Qgnutls_code,
1678 make_number (GNUTLS_E_INVALID_SESSION));
1680 DEFSYM (Qgnutls_e_not_ready_for_handshake, "gnutls-e-not-ready-for-handshake");
1681 Fput (Qgnutls_e_not_ready_for_handshake, Qgnutls_code,
1682 make_number (GNUTLS_E_APPLICATION_ERROR_MIN));
1684 defsubr (&Sgnutls_get_initstage);
1685 defsubr (&Sgnutls_errorp);
1686 defsubr (&Sgnutls_error_fatalp);
1687 defsubr (&Sgnutls_error_string);
1688 defsubr (&Sgnutls_boot);
1689 defsubr (&Sgnutls_deinit);
1690 defsubr (&Sgnutls_bye);
1691 defsubr (&Sgnutls_peer_status);
1692 defsubr (&Sgnutls_peer_status_warning_describe);
1694 DEFVAR_INT ("gnutls-log-level", global_gnutls_log_level,
1695 doc: /* Logging level used by the GnuTLS functions.
1696 Set this larger than 0 to get debug output in the *Messages* buffer.
1697 1 is for important messages, 2 is for debug data, and higher numbers
1698 are as per the GnuTLS logging conventions. */);
1699 global_gnutls_log_level = 0;
1701 #endif /* HAVE_GNUTLS */
1703 defsubr (&Sgnutls_available_p);