Make a prefix to `eww-reload' work locally
[emacs.git] / src / gnutls.c
blob7c61445de92d2c637180286fb0e2b70577570013
1 /* GnuTLS glue for GNU Emacs.
2 Copyright (C) 2010-2014 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 "coding.h"
27 #ifdef HAVE_GNUTLS
28 #include <gnutls/gnutls.h>
30 #ifdef WINDOWSNT
31 #include <windows.h>
32 #include "w32.h"
33 #endif
35 static bool emacs_gnutls_handle_error (gnutls_session_t, int);
37 static Lisp_Object Qgnutls_dll;
38 static Lisp_Object Qgnutls_code;
39 static Lisp_Object Qgnutls_anon, Qgnutls_x509pki;
40 static Lisp_Object Qgnutls_e_interrupted, Qgnutls_e_again,
41 Qgnutls_e_invalid_session, Qgnutls_e_not_ready_for_handshake;
42 static bool gnutls_global_initialized;
44 /* The following are for the property list of `gnutls-boot'. */
45 static Lisp_Object QCgnutls_bootprop_priority;
46 static Lisp_Object QCgnutls_bootprop_trustfiles;
47 static Lisp_Object QCgnutls_bootprop_keylist;
48 static Lisp_Object QCgnutls_bootprop_crlfiles;
49 static Lisp_Object QCgnutls_bootprop_callbacks;
50 static Lisp_Object QCgnutls_bootprop_loglevel;
51 static Lisp_Object QCgnutls_bootprop_hostname;
52 static Lisp_Object QCgnutls_bootprop_min_prime_bits;
53 static Lisp_Object QCgnutls_bootprop_verify_flags;
54 static Lisp_Object QCgnutls_bootprop_verify_error;
56 /* Callback keys for `gnutls-boot'. Unused currently. */
57 static Lisp_Object QCgnutls_bootprop_callbacks_verify;
59 static void gnutls_log_function (int, const char *);
60 static void gnutls_log_function2 (int, const char *, const char *);
61 #ifdef HAVE_GNUTLS3
62 static void gnutls_audit_log_function (gnutls_session_t, const char *);
63 #endif
65 enum extra_peer_verification
67 CERTIFICATE_NOT_MATCHING = 2
71 #ifdef WINDOWSNT
73 /* Macro for defining functions that will be loaded from the GnuTLS DLL. */
74 #define DEF_GNUTLS_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
76 /* Macro for loading GnuTLS functions from the library. */
77 #define LOAD_GNUTLS_FN(lib,func) { \
78 fn_##func = (void *) GetProcAddress (lib, #func); \
79 if (!fn_##func) return 0; \
82 DEF_GNUTLS_FN (gnutls_alert_description_t, gnutls_alert_get,
83 (gnutls_session_t));
84 DEF_GNUTLS_FN (const char *, gnutls_alert_get_name,
85 (gnutls_alert_description_t));
86 DEF_GNUTLS_FN (int, gnutls_alert_send_appropriate, (gnutls_session_t, int));
87 DEF_GNUTLS_FN (int, gnutls_anon_allocate_client_credentials,
88 (gnutls_anon_client_credentials_t *));
89 DEF_GNUTLS_FN (void, gnutls_anon_free_client_credentials,
90 (gnutls_anon_client_credentials_t));
91 DEF_GNUTLS_FN (int, gnutls_bye, (gnutls_session_t, gnutls_close_request_t));
92 DEF_GNUTLS_FN (int, gnutls_certificate_allocate_credentials,
93 (gnutls_certificate_credentials_t *));
94 DEF_GNUTLS_FN (void, gnutls_certificate_free_credentials,
95 (gnutls_certificate_credentials_t));
96 DEF_GNUTLS_FN (const gnutls_datum_t *, gnutls_certificate_get_peers,
97 (gnutls_session_t, unsigned int *));
98 DEF_GNUTLS_FN (void, gnutls_certificate_set_verify_flags,
99 (gnutls_certificate_credentials_t, unsigned int));
100 DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_crl_file,
101 (gnutls_certificate_credentials_t, const char *,
102 gnutls_x509_crt_fmt_t));
103 DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_key_file,
104 (gnutls_certificate_credentials_t, const char *, const char *,
105 gnutls_x509_crt_fmt_t));
106 DEF_GNUTLS_FN (int, gnutls_certificate_set_x509_trust_file,
107 (gnutls_certificate_credentials_t, const char *,
108 gnutls_x509_crt_fmt_t));
109 DEF_GNUTLS_FN (gnutls_certificate_type_t, gnutls_certificate_type_get,
110 (gnutls_session_t));
111 DEF_GNUTLS_FN (int, gnutls_certificate_verify_peers2,
112 (gnutls_session_t, unsigned int *));
113 DEF_GNUTLS_FN (int, gnutls_credentials_set,
114 (gnutls_session_t, gnutls_credentials_type_t, void *));
115 DEF_GNUTLS_FN (void, gnutls_deinit, (gnutls_session_t));
116 DEF_GNUTLS_FN (void, gnutls_dh_set_prime_bits,
117 (gnutls_session_t, unsigned int));
118 DEF_GNUTLS_FN (int, gnutls_error_is_fatal, (int));
119 DEF_GNUTLS_FN (int, gnutls_global_init, (void));
120 DEF_GNUTLS_FN (void, gnutls_global_set_log_function, (gnutls_log_func));
121 #ifdef HAVE_GNUTLS3
122 DEF_GNUTLS_FN (void, gnutls_global_set_audit_log_function, (gnutls_audit_log_func));
123 #endif
124 DEF_GNUTLS_FN (void, gnutls_global_set_log_level, (int));
125 DEF_GNUTLS_FN (void, gnutls_global_set_mem_functions,
126 (gnutls_alloc_function, gnutls_alloc_function,
127 gnutls_is_secure_function, gnutls_realloc_function,
128 gnutls_free_function));
129 DEF_GNUTLS_FN (int, gnutls_handshake, (gnutls_session_t));
130 DEF_GNUTLS_FN (int, gnutls_init, (gnutls_session_t *, gnutls_connection_end_t));
131 DEF_GNUTLS_FN (int, gnutls_priority_set_direct,
132 (gnutls_session_t, const char *, const char **));
133 DEF_GNUTLS_FN (size_t, gnutls_record_check_pending, (gnutls_session_t));
134 DEF_GNUTLS_FN (ssize_t, gnutls_record_recv, (gnutls_session_t, void *, size_t));
135 DEF_GNUTLS_FN (ssize_t, gnutls_record_send,
136 (gnutls_session_t, const void *, size_t));
137 DEF_GNUTLS_FN (const char *, gnutls_strerror, (int));
138 DEF_GNUTLS_FN (void, gnutls_transport_set_errno, (gnutls_session_t, int));
139 DEF_GNUTLS_FN (const char *, gnutls_check_version, (const char *));
140 DEF_GNUTLS_FN (void, gnutls_transport_set_lowat, (gnutls_session_t, int));
141 DEF_GNUTLS_FN (void, gnutls_transport_set_ptr2,
142 (gnutls_session_t, gnutls_transport_ptr_t,
143 gnutls_transport_ptr_t));
144 DEF_GNUTLS_FN (void, gnutls_transport_set_pull_function,
145 (gnutls_session_t, gnutls_pull_func));
146 DEF_GNUTLS_FN (void, gnutls_transport_set_push_function,
147 (gnutls_session_t, gnutls_push_func));
148 DEF_GNUTLS_FN (int, gnutls_x509_crt_check_hostname,
149 (gnutls_x509_crt_t, const char *));
150 DEF_GNUTLS_FN (void, gnutls_x509_crt_deinit, (gnutls_x509_crt_t));
151 DEF_GNUTLS_FN (int, gnutls_x509_crt_import,
152 (gnutls_x509_crt_t, const gnutls_datum_t *,
153 gnutls_x509_crt_fmt_t));
154 DEF_GNUTLS_FN (int, gnutls_x509_crt_init, (gnutls_x509_crt_t *));
155 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_fingerprint,
156 (gnutls_x509_crt_t,
157 gnutls_digest_algorithm_t, void *, size_t *));
158 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_version,
159 (gnutls_x509_crt_t));
160 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_serial,
161 (gnutls_x509_crt_t, void *, size_t *));
162 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_issuer_dn,
163 (gnutls_x509_crt_t, char *, size_t *));
164 DEF_GNUTLS_FN (time_t, gnutls_x509_crt_get_activation_time,
165 (gnutls_x509_crt_t));
166 DEF_GNUTLS_FN (time_t, gnutls_x509_crt_get_expiration_time,
167 (gnutls_x509_crt_t));
168 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_dn,
169 (gnutls_x509_crt_t, char *, size_t *));
170 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_pk_algorithm,
171 (gnutls_x509_crt_t, unsigned int *));
172 DEF_GNUTLS_FN (const char*, gnutls_pk_algorithm_get_name,
173 (gnutls_pk_algorithm_t));
174 DEF_GNUTLS_FN (int, gnutls_pk_bits_to_sec_param,
175 (gnutls_pk_algorithm_t, unsigned int));
176 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_issuer_unique_id,
177 (gnutls_x509_crt_t, char *, size_t *));
178 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_subject_unique_id,
179 (gnutls_x509_crt_t, char *, size_t *));
180 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_signature_algorithm,
181 (gnutls_x509_crt_t));
182 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_signature,
183 (gnutls_x509_crt_t, char *, size_t *));
184 DEF_GNUTLS_FN (int, gnutls_x509_crt_get_key_id,
185 (gnutls_x509_crt_t, unsigned int,
186 unsigned char *, size_t *_size));
187 DEF_GNUTLS_FN (const char*, gnutls_sec_param_get_name, (gnutls_sec_param_t));
188 DEF_GNUTLS_FN (const char*, gnutls_sign_get_name,
189 (gnutls_sign_algorithm_t));
190 DEF_GNUTLS_FN (int, gnutls_server_name_set, (gnutls_session_t,
191 gnutls_server_name_type_t,
192 const void *, size_t));
194 static bool
195 init_gnutls_functions (void)
197 HMODULE library;
198 int max_log_level = 1;
200 if (!(library = w32_delayed_load (Qgnutls_dll)))
202 GNUTLS_LOG (1, max_log_level, "GnuTLS library not found");
203 return 0;
206 LOAD_GNUTLS_FN (library, gnutls_alert_get);
207 LOAD_GNUTLS_FN (library, gnutls_alert_get_name);
208 LOAD_GNUTLS_FN (library, gnutls_alert_send_appropriate);
209 LOAD_GNUTLS_FN (library, gnutls_anon_allocate_client_credentials);
210 LOAD_GNUTLS_FN (library, gnutls_anon_free_client_credentials);
211 LOAD_GNUTLS_FN (library, gnutls_bye);
212 LOAD_GNUTLS_FN (library, gnutls_certificate_allocate_credentials);
213 LOAD_GNUTLS_FN (library, gnutls_certificate_free_credentials);
214 LOAD_GNUTLS_FN (library, gnutls_certificate_get_peers);
215 LOAD_GNUTLS_FN (library, gnutls_certificate_set_verify_flags);
216 LOAD_GNUTLS_FN (library, gnutls_certificate_set_x509_crl_file);
217 LOAD_GNUTLS_FN (library, gnutls_certificate_set_x509_key_file);
218 LOAD_GNUTLS_FN (library, gnutls_certificate_set_x509_trust_file);
219 LOAD_GNUTLS_FN (library, gnutls_certificate_type_get);
220 LOAD_GNUTLS_FN (library, gnutls_certificate_verify_peers2);
221 LOAD_GNUTLS_FN (library, gnutls_credentials_set);
222 LOAD_GNUTLS_FN (library, gnutls_deinit);
223 LOAD_GNUTLS_FN (library, gnutls_dh_set_prime_bits);
224 LOAD_GNUTLS_FN (library, gnutls_error_is_fatal);
225 LOAD_GNUTLS_FN (library, gnutls_global_init);
226 LOAD_GNUTLS_FN (library, gnutls_global_set_log_function);
227 #ifdef HAVE_GNUTLS3
228 LOAD_GNUTLS_FN (library, gnutls_global_set_audit_log_function);
229 #endif
230 LOAD_GNUTLS_FN (library, gnutls_global_set_log_level);
231 LOAD_GNUTLS_FN (library, gnutls_global_set_mem_functions);
232 LOAD_GNUTLS_FN (library, gnutls_handshake);
233 LOAD_GNUTLS_FN (library, gnutls_init);
234 LOAD_GNUTLS_FN (library, gnutls_priority_set_direct);
235 LOAD_GNUTLS_FN (library, gnutls_record_check_pending);
236 LOAD_GNUTLS_FN (library, gnutls_record_recv);
237 LOAD_GNUTLS_FN (library, gnutls_record_send);
238 LOAD_GNUTLS_FN (library, gnutls_strerror);
239 LOAD_GNUTLS_FN (library, gnutls_transport_set_errno);
240 LOAD_GNUTLS_FN (library, gnutls_check_version);
241 /* We don't need to call gnutls_transport_set_lowat in GnuTLS 2.11.1
242 and later, and the function was removed entirely in 3.0.0. */
243 if (!fn_gnutls_check_version ("2.11.1"))
244 LOAD_GNUTLS_FN (library, gnutls_transport_set_lowat);
245 LOAD_GNUTLS_FN (library, gnutls_transport_set_ptr2);
246 LOAD_GNUTLS_FN (library, gnutls_transport_set_pull_function);
247 LOAD_GNUTLS_FN (library, gnutls_transport_set_push_function);
248 LOAD_GNUTLS_FN (library, gnutls_x509_crt_check_hostname);
249 LOAD_GNUTLS_FN (library, gnutls_x509_crt_deinit);
250 LOAD_GNUTLS_FN (library, gnutls_x509_crt_import);
251 LOAD_GNUTLS_FN (library, gnutls_x509_crt_init);
252 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_fingerprint);
253 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_version);
254 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_serial);
255 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_issuer_dn);
256 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_activation_time);
257 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_expiration_time);
258 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_dn);
259 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_pk_algorithm);
260 LOAD_GNUTLS_FN (library, gnutls_pk_algorithm_get_name);
261 LOAD_GNUTLS_FN (library, gnutls_pk_bits_to_sec_param);
262 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_issuer_unique_id);
263 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_subject_unique_id);
264 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_signature_algorithm);
265 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_signature);
266 LOAD_GNUTLS_FN (library, gnutls_x509_crt_get_key_id);
267 LOAD_GNUTLS_FN (library, gnutls_sec_param_get_name);
268 LOAD_GNUTLS_FN (library, gnutls_sign_get_name);
269 LOAD_GNUTLS_FN (library, gnutls_server_name_set);
271 max_log_level = global_gnutls_log_level;
274 Lisp_Object name = CAR_SAFE (Fget (Qgnutls_dll, QCloaded_from));
275 GNUTLS_LOG2 (1, max_log_level, "GnuTLS library loaded:",
276 STRINGP (name) ? (const char *) SDATA (name) : "unknown");
279 return 1;
282 #else /* !WINDOWSNT */
284 #define fn_gnutls_alert_get gnutls_alert_get
285 #define fn_gnutls_alert_get_name gnutls_alert_get_name
286 #define fn_gnutls_alert_send_appropriate gnutls_alert_send_appropriate
287 #define fn_gnutls_anon_allocate_client_credentials gnutls_anon_allocate_client_credentials
288 #define fn_gnutls_anon_free_client_credentials gnutls_anon_free_client_credentials
289 #define fn_gnutls_bye gnutls_bye
290 #define fn_gnutls_certificate_allocate_credentials gnutls_certificate_allocate_credentials
291 #define fn_gnutls_certificate_free_credentials gnutls_certificate_free_credentials
292 #define fn_gnutls_certificate_get_peers gnutls_certificate_get_peers
293 #define fn_gnutls_certificate_set_verify_flags gnutls_certificate_set_verify_flags
294 #define fn_gnutls_certificate_set_x509_crl_file gnutls_certificate_set_x509_crl_file
295 #define fn_gnutls_certificate_set_x509_key_file gnutls_certificate_set_x509_key_file
296 #define fn_gnutls_certificate_set_x509_trust_file gnutls_certificate_set_x509_trust_file
297 #define fn_gnutls_certificate_type_get gnutls_certificate_type_get
298 #define fn_gnutls_certificate_verify_peers2 gnutls_certificate_verify_peers2
299 #define fn_gnutls_credentials_set gnutls_credentials_set
300 #define fn_gnutls_deinit gnutls_deinit
301 #define fn_gnutls_dh_set_prime_bits gnutls_dh_set_prime_bits
302 #define fn_gnutls_error_is_fatal gnutls_error_is_fatal
303 #define fn_gnutls_global_init gnutls_global_init
304 #define fn_gnutls_global_set_log_function gnutls_global_set_log_function
305 #ifdef HAVE_GNUTLS3
306 #define fn_gnutls_global_set_audit_log_function gnutls_global_set_audit_log_function
307 #endif
308 #define fn_gnutls_global_set_log_level gnutls_global_set_log_level
309 #define fn_gnutls_global_set_mem_functions gnutls_global_set_mem_functions
310 #define fn_gnutls_handshake gnutls_handshake
311 #define fn_gnutls_init gnutls_init
312 #define fn_gnutls_priority_set_direct gnutls_priority_set_direct
313 #define fn_gnutls_record_check_pending gnutls_record_check_pending
314 #define fn_gnutls_record_recv gnutls_record_recv
315 #define fn_gnutls_record_send gnutls_record_send
316 #define fn_gnutls_strerror gnutls_strerror
317 #ifdef WINDOWSNT
318 #define fn_gnutls_transport_set_errno gnutls_transport_set_errno
319 #endif
320 #define fn_gnutls_transport_set_ptr2 gnutls_transport_set_ptr2
321 #define fn_gnutls_x509_crt_check_hostname gnutls_x509_crt_check_hostname
322 #define fn_gnutls_x509_crt_deinit gnutls_x509_crt_deinit
323 #define fn_gnutls_x509_crt_import gnutls_x509_crt_import
324 #define fn_gnutls_x509_crt_init gnutls_x509_crt_init
325 #define fn_gnutls_x509_crt_get_fingerprint gnutls_x509_crt_get_fingerprint
326 #define fn_gnutls_x509_crt_get_version gnutls_x509_crt_get_version
327 #define fn_gnutls_x509_crt_get_serial gnutls_x509_crt_get_serial
328 #define fn_gnutls_x509_crt_get_issuer_dn gnutls_x509_crt_get_issuer_dn
329 #define fn_gnutls_x509_crt_get_activation_time gnutls_x509_crt_get_activation_time
330 #define fn_gnutls_x509_crt_get_expiration_time gnutls_x509_crt_get_expiration_time
331 #define fn_gnutls_x509_crt_get_dn gnutls_x509_crt_get_dn
332 #define fn_gnutls_x509_crt_get_pk_algorithm gnutls_x509_crt_get_pk_algorithm
333 #define fn_gnutls_pk_algorithm_get_name gnutls_pk_algorithm_get_name
334 #define fn_gnutls_pk_bits_to_sec_param gnutls_pk_bits_to_sec_param
335 #define fn_gnutls_x509_crt_get_issuer_unique_id gnutls_x509_crt_get_issuer_unique_id
336 #define fn_gnutls_x509_crt_get_subject_unique_id gnutls_x509_crt_get_subject_unique_id
337 #define fn_gnutls_x509_crt_get_signature_algorithm gnutls_x509_crt_get_signature_algorithm
338 #define fn_gnutls_x509_crt_get_signature gnutls_x509_crt_get_signature
339 #define fn_gnutls_x509_crt_get_key_id gnutls_x509_crt_get_key_id
340 #define fn_gnutls_sec_param_get_name gnutls_sec_param_get_name
341 #define fn_gnutls_sign_get_name gnutls_sign_get_name
342 #define fn_gnutls_server_name_set gnutls_server_name_set
344 #endif /* !WINDOWSNT */
347 #ifdef HAVE_GNUTLS3
348 /* Function to log a simple audit message. */
349 static void
350 gnutls_audit_log_function (gnutls_session_t session, const char *string)
352 if (global_gnutls_log_level >= 1)
354 message ("gnutls.c: [audit] %s", string);
357 #endif
359 /* Function to log a simple message. */
360 static void
361 gnutls_log_function (int level, const char *string)
363 message ("gnutls.c: [%d] %s", level, string);
366 /* Function to log a message and a string. */
367 static void
368 gnutls_log_function2 (int level, const char *string, const char *extra)
370 message ("gnutls.c: [%d] %s %s", level, string, extra);
373 /* Function to log a message and an integer. */
374 static void
375 gnutls_log_function2i (int level, const char *string, int extra)
377 message ("gnutls.c: [%d] %s %d", level, string, extra);
380 static int
381 emacs_gnutls_handshake (struct Lisp_Process *proc)
383 gnutls_session_t state = proc->gnutls_state;
384 int ret;
386 if (proc->gnutls_initstage < GNUTLS_STAGE_HANDSHAKE_CANDO)
387 return -1;
389 if (proc->gnutls_initstage < GNUTLS_STAGE_TRANSPORT_POINTERS_SET)
391 #ifdef WINDOWSNT
392 /* On W32 we cannot transfer socket handles between different runtime
393 libraries, so we tell GnuTLS to use our special push/pull
394 functions. */
395 fn_gnutls_transport_set_ptr2 (state,
396 (gnutls_transport_ptr_t) proc,
397 (gnutls_transport_ptr_t) proc);
398 fn_gnutls_transport_set_push_function (state, &emacs_gnutls_push);
399 fn_gnutls_transport_set_pull_function (state, &emacs_gnutls_pull);
401 /* For non blocking sockets or other custom made pull/push
402 functions the gnutls_transport_set_lowat must be called, with
403 a zero low water mark value. (GnuTLS 2.10.4 documentation)
405 (Note: this is probably not strictly necessary as the lowat
406 value is only used when no custom pull/push functions are
407 set.) */
408 /* According to GnuTLS NEWS file, lowat level has been set to
409 zero by default in version 2.11.1, and the function
410 gnutls_transport_set_lowat was removed from the library in
411 version 2.99.0. */
412 if (!fn_gnutls_check_version ("2.11.1"))
413 fn_gnutls_transport_set_lowat (state, 0);
414 #else
415 /* This is how GnuTLS takes sockets: as file descriptors passed
416 in. For an Emacs process socket, infd and outfd are the
417 same but we use this two-argument version for clarity. */
418 fn_gnutls_transport_set_ptr2 (state,
419 (void *) (intptr_t) proc->infd,
420 (void *) (intptr_t) proc->outfd);
421 #endif
423 proc->gnutls_initstage = GNUTLS_STAGE_TRANSPORT_POINTERS_SET;
428 ret = fn_gnutls_handshake (state);
429 emacs_gnutls_handle_error (state, ret);
430 QUIT;
432 while (ret < 0 && fn_gnutls_error_is_fatal (ret) == 0);
434 proc->gnutls_initstage = GNUTLS_STAGE_HANDSHAKE_TRIED;
436 if (ret == GNUTLS_E_SUCCESS)
438 /* Here we're finally done. */
439 proc->gnutls_initstage = GNUTLS_STAGE_READY;
441 else
443 fn_gnutls_alert_send_appropriate (state, ret);
445 return ret;
448 ptrdiff_t
449 emacs_gnutls_record_check_pending (gnutls_session_t state)
451 return fn_gnutls_record_check_pending (state);
454 #ifdef WINDOWSNT
455 void
456 emacs_gnutls_transport_set_errno (gnutls_session_t state, int err)
458 fn_gnutls_transport_set_errno (state, err);
460 #endif
462 ptrdiff_t
463 emacs_gnutls_write (struct Lisp_Process *proc, const char *buf, ptrdiff_t nbyte)
465 ssize_t rtnval = 0;
466 ptrdiff_t bytes_written;
467 gnutls_session_t state = proc->gnutls_state;
469 if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
471 errno = EAGAIN;
472 return 0;
475 bytes_written = 0;
477 while (nbyte > 0)
479 rtnval = fn_gnutls_record_send (state, buf, nbyte);
481 if (rtnval < 0)
483 if (rtnval == GNUTLS_E_INTERRUPTED)
484 continue;
485 else
487 /* If we get GNUTLS_E_AGAIN, then set errno
488 appropriately so that send_process retries the
489 correct way instead of erroring out. */
490 if (rtnval == GNUTLS_E_AGAIN)
491 errno = EAGAIN;
492 break;
496 buf += rtnval;
497 nbyte -= rtnval;
498 bytes_written += rtnval;
501 emacs_gnutls_handle_error (state, rtnval);
502 return (bytes_written);
505 ptrdiff_t
506 emacs_gnutls_read (struct Lisp_Process *proc, char *buf, ptrdiff_t nbyte)
508 ssize_t rtnval;
509 gnutls_session_t state = proc->gnutls_state;
511 int log_level = proc->gnutls_log_level;
513 if (proc->gnutls_initstage != GNUTLS_STAGE_READY)
515 /* If the handshake count is under the limit, try the handshake
516 again and increment the handshake count. This count is kept
517 per process (connection), not globally. */
518 if (proc->gnutls_handshakes_tried < GNUTLS_EMACS_HANDSHAKES_LIMIT)
520 proc->gnutls_handshakes_tried++;
521 emacs_gnutls_handshake (proc);
522 GNUTLS_LOG2i (5, log_level, "Retried handshake",
523 proc->gnutls_handshakes_tried);
524 return -1;
527 GNUTLS_LOG (2, log_level, "Giving up on handshake; resetting retries");
528 proc->gnutls_handshakes_tried = 0;
529 return 0;
531 rtnval = fn_gnutls_record_recv (state, buf, nbyte);
532 if (rtnval >= 0)
533 return rtnval;
534 else if (rtnval == GNUTLS_E_UNEXPECTED_PACKET_LENGTH)
535 /* The peer closed the connection. */
536 return 0;
537 else if (emacs_gnutls_handle_error (state, rtnval))
538 /* non-fatal error */
539 return -1;
540 else {
541 /* a fatal error occurred */
542 return 0;
546 /* Report a GnuTLS error to the user.
547 Return true if the error code was successfully handled. */
548 static bool
549 emacs_gnutls_handle_error (gnutls_session_t session, int err)
551 int max_log_level = 0;
553 bool ret;
554 const char *str;
556 /* TODO: use a Lisp_Object generated by gnutls_make_error? */
557 if (err >= 0)
558 return 1;
560 max_log_level = global_gnutls_log_level;
562 /* TODO: use gnutls-error-fatalp and gnutls-error-string. */
564 str = fn_gnutls_strerror (err);
565 if (!str)
566 str = "unknown";
568 if (fn_gnutls_error_is_fatal (err))
570 ret = 0;
571 GNUTLS_LOG2 (0, max_log_level, "fatal error:", str);
573 else
575 ret = 1;
577 switch (err)
579 case GNUTLS_E_AGAIN:
580 GNUTLS_LOG2 (3,
581 max_log_level,
582 "retry:",
583 str);
584 default:
585 GNUTLS_LOG2 (1,
586 max_log_level,
587 "non-fatal error:",
588 str);
592 if (err == GNUTLS_E_WARNING_ALERT_RECEIVED
593 || err == GNUTLS_E_FATAL_ALERT_RECEIVED)
595 int alert = fn_gnutls_alert_get (session);
596 int level = (err == GNUTLS_E_FATAL_ALERT_RECEIVED) ? 0 : 1;
597 str = fn_gnutls_alert_get_name (alert);
598 if (!str)
599 str = "unknown";
601 GNUTLS_LOG2 (level, max_log_level, "Received alert: ", str);
603 return ret;
606 /* convert an integer error to a Lisp_Object; it will be either a
607 known symbol like `gnutls_e_interrupted' and `gnutls_e_again' or
608 simply the integer value of the error. GNUTLS_E_SUCCESS is mapped
609 to Qt. */
610 static Lisp_Object
611 gnutls_make_error (int err)
613 switch (err)
615 case GNUTLS_E_SUCCESS:
616 return Qt;
617 case GNUTLS_E_AGAIN:
618 return Qgnutls_e_again;
619 case GNUTLS_E_INTERRUPTED:
620 return Qgnutls_e_interrupted;
621 case GNUTLS_E_INVALID_SESSION:
622 return Qgnutls_e_invalid_session;
625 return make_number (err);
628 Lisp_Object
629 emacs_gnutls_deinit (Lisp_Object proc)
631 int log_level;
633 CHECK_PROCESS (proc);
635 if (XPROCESS (proc)->gnutls_p == 0)
636 return Qnil;
638 log_level = XPROCESS (proc)->gnutls_log_level;
640 if (XPROCESS (proc)->gnutls_x509_cred)
642 GNUTLS_LOG (2, log_level, "Deallocating x509 credentials");
643 fn_gnutls_certificate_free_credentials (XPROCESS (proc)->gnutls_x509_cred);
644 XPROCESS (proc)->gnutls_x509_cred = NULL;
647 if (XPROCESS (proc)->gnutls_anon_cred)
649 GNUTLS_LOG (2, log_level, "Deallocating anon credentials");
650 fn_gnutls_anon_free_client_credentials (XPROCESS (proc)->gnutls_anon_cred);
651 XPROCESS (proc)->gnutls_anon_cred = NULL;
654 if (XPROCESS (proc)->gnutls_state)
656 fn_gnutls_deinit (XPROCESS (proc)->gnutls_state);
657 XPROCESS (proc)->gnutls_state = NULL;
658 if (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_INIT)
659 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT - 1;
662 XPROCESS (proc)->gnutls_p = 0;
663 return Qt;
666 DEFUN ("gnutls-get-initstage", Fgnutls_get_initstage, Sgnutls_get_initstage, 1, 1, 0,
667 doc: /* Return the GnuTLS init stage of process PROC.
668 See also `gnutls-boot'. */)
669 (Lisp_Object proc)
671 CHECK_PROCESS (proc);
673 return make_number (GNUTLS_INITSTAGE (proc));
676 DEFUN ("gnutls-errorp", Fgnutls_errorp, Sgnutls_errorp, 1, 1, 0,
677 doc: /* Return t if ERROR indicates a GnuTLS problem.
678 ERROR is an integer or a symbol with an integer `gnutls-code' property.
679 usage: (gnutls-errorp ERROR) */)
680 (Lisp_Object err)
682 if (EQ (err, Qt)) return Qnil;
684 return Qt;
687 DEFUN ("gnutls-error-fatalp", Fgnutls_error_fatalp, Sgnutls_error_fatalp, 1, 1, 0,
688 doc: /* Check if ERROR is fatal.
689 ERROR is an integer or a symbol with an integer `gnutls-code' property.
690 usage: (gnutls-error-fatalp ERROR) */)
691 (Lisp_Object err)
693 Lisp_Object code;
695 if (EQ (err, Qt)) return Qnil;
697 if (SYMBOLP (err))
699 code = Fget (err, Qgnutls_code);
700 if (NUMBERP (code))
702 err = code;
704 else
706 error ("Symbol has no numeric gnutls-code property");
710 if (! TYPE_RANGED_INTEGERP (int, err))
711 error ("Not an error symbol or code");
713 if (0 == fn_gnutls_error_is_fatal (XINT (err)))
714 return Qnil;
716 return Qt;
719 DEFUN ("gnutls-error-string", Fgnutls_error_string, Sgnutls_error_string, 1, 1, 0,
720 doc: /* Return a description of ERROR.
721 ERROR is an integer or a symbol with an integer `gnutls-code' property.
722 usage: (gnutls-error-string ERROR) */)
723 (Lisp_Object err)
725 Lisp_Object code;
727 if (EQ (err, Qt)) return build_string ("Not an error");
729 if (SYMBOLP (err))
731 code = Fget (err, Qgnutls_code);
732 if (NUMBERP (code))
734 err = code;
736 else
738 return build_string ("Symbol has no numeric gnutls-code property");
742 if (! TYPE_RANGED_INTEGERP (int, err))
743 return build_string ("Not an error symbol or code");
745 return build_string (fn_gnutls_strerror (XINT (err)));
748 DEFUN ("gnutls-deinit", Fgnutls_deinit, Sgnutls_deinit, 1, 1, 0,
749 doc: /* Deallocate GnuTLS resources associated with process PROC.
750 See also `gnutls-init'. */)
751 (Lisp_Object proc)
753 return emacs_gnutls_deinit (proc);
756 DEFUN ("gnutls-available-p", Fgnutls_available_p, Sgnutls_available_p, 0, 0, 0,
757 doc: /* Return t if GnuTLS is available in this instance of Emacs. */)
758 (void)
760 #ifdef WINDOWSNT
761 Lisp_Object found = Fassq (Qgnutls_dll, Vlibrary_cache);
762 if (CONSP (found))
763 return XCDR (found);
764 else
766 Lisp_Object status;
767 status = init_gnutls_functions () ? Qt : Qnil;
768 Vlibrary_cache = Fcons (Fcons (Qgnutls_dll, status), Vlibrary_cache);
769 return status;
771 #else
772 return Qt;
773 #endif
776 static Lisp_Object
777 gnutls_hex_string (char *buf, size_t buf_size, const char *prefix)
779 size_t prefix_length = strlen (prefix);
780 char *string = malloc (buf_size * 3 + prefix_length);
781 Lisp_Object ret;
783 strcpy (string, prefix);
785 for (int i = 0; i < buf_size; i++)
786 sprintf (string + i * 3 + prefix_length,
787 i == buf_size - 1 ? "%02x" : "%02x:",
788 ((unsigned char*) buf)[i]);
790 ret = build_string (string);
791 free (string);
792 return ret;
795 static Lisp_Object
796 gnutls_certificate_details (gnutls_x509_crt_t cert)
798 Lisp_Object res = Qnil;
799 int err;
801 /* Version. */
803 int version = fn_gnutls_x509_crt_get_version (cert);
804 if (version >= GNUTLS_E_SUCCESS)
805 res = nconc2 (res, list2 (intern (":version"),
806 make_number (version)));
809 /* Serial. */
811 size_t serial_size = 0;
813 err = fn_gnutls_x509_crt_get_serial (cert, NULL, &serial_size);
814 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
816 char *serial = malloc (serial_size);
817 err = fn_gnutls_x509_crt_get_serial (cert, serial, &serial_size);
818 if (err >= GNUTLS_E_SUCCESS)
819 res = nconc2 (res, list2 (intern (":serial-number"),
820 gnutls_hex_string (serial, serial_size,
821 "")));
822 free (serial);
826 /* Issuer. */
828 size_t dn_size = 0;
830 err = fn_gnutls_x509_crt_get_issuer_dn (cert, NULL, &dn_size);
831 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
833 char *dn = malloc (dn_size);
834 err = fn_gnutls_x509_crt_get_issuer_dn (cert, dn, &dn_size);
835 if (err >= GNUTLS_E_SUCCESS)
836 res = nconc2 (res, list2 (intern (":issuer"),
837 make_string (dn, dn_size)));
838 free (dn);
842 /* Validity. */
844 char buf[11];
845 size_t buf_size = sizeof (buf);
846 struct tm t;
847 time_t tim = fn_gnutls_x509_crt_get_activation_time (cert);
849 if (gmtime_r (&tim, &t) != NULL &&
850 strftime (buf, buf_size, "%Y-%m-%d", &t) != 0)
851 res = nconc2 (res, list2 (intern (":valid-from"), build_string (buf)));
853 tim = fn_gnutls_x509_crt_get_expiration_time (cert);
854 if (gmtime_r (&tim, &t) != NULL &&
855 strftime (buf, buf_size, "%Y-%m-%d", &t) != 0)
856 res = nconc2 (res, list2 (intern (":valid-to"), build_string (buf)));
859 /* Subject. */
861 size_t dn_size = 0;
863 err = fn_gnutls_x509_crt_get_dn (cert, NULL, &dn_size);
864 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
866 char *dn = malloc (dn_size);
867 err = fn_gnutls_x509_crt_get_dn (cert, dn, &dn_size);
868 if (err >= GNUTLS_E_SUCCESS)
869 res = nconc2 (res, list2 (intern (":subject"),
870 make_string (dn, dn_size)));
871 free (dn);
875 /* Versions older than 2.11 doesn't have these four functions. */
876 #if GNUTLS_VERSION_NUMBER >= 0x020b00
877 /* SubjectPublicKeyInfo. */
879 unsigned int bits;
881 err = fn_gnutls_x509_crt_get_pk_algorithm (cert, &bits);
882 if (err >= GNUTLS_E_SUCCESS)
884 const char *name = fn_gnutls_pk_algorithm_get_name (err);
885 if (name)
886 res = nconc2 (res, list2 (intern (":public-key-algorithm"),
887 build_string (name)));
889 name = fn_gnutls_sec_param_get_name (fn_gnutls_pk_bits_to_sec_param
890 (err, bits));
891 res = nconc2 (res, list2 (intern (":certificate-security-level"),
892 build_string (name)));
896 /* Unique IDs. */
898 size_t buf_size = 0;
900 err = fn_gnutls_x509_crt_get_issuer_unique_id (cert, NULL, &buf_size);
901 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
903 char *buf = malloc (buf_size);
904 err = fn_gnutls_x509_crt_get_issuer_unique_id (cert, buf, &buf_size);
905 if (err >= GNUTLS_E_SUCCESS)
906 res = nconc2 (res, list2 (intern (":issuer-unique-id"),
907 make_string (buf, buf_size)));
908 free (buf);
911 buf_size = 0;
912 err = fn_gnutls_x509_crt_get_subject_unique_id (cert, NULL, &buf_size);
913 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
915 char *buf = malloc (buf_size);
916 err = fn_gnutls_x509_crt_get_subject_unique_id (cert, buf, &buf_size);
917 if (err >= GNUTLS_E_SUCCESS)
918 res = nconc2 (res, list2 (intern (":subject-unique-id"),
919 make_string (buf, buf_size)));
920 free (buf);
923 #endif
925 /* Signature. */
927 size_t buf_size = 0;
929 err = fn_gnutls_x509_crt_get_signature_algorithm (cert);
930 if (err >= GNUTLS_E_SUCCESS)
932 const char *name = fn_gnutls_sign_get_name (err);
933 if (name)
934 res = nconc2 (res, list2 (intern (":signature-algorithm"),
935 build_string (name)));
937 err = fn_gnutls_x509_crt_get_signature (cert, NULL, &buf_size);
938 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
940 char *buf = malloc (buf_size);
941 err = fn_gnutls_x509_crt_get_signature (cert, buf, &buf_size);
942 if (err >= GNUTLS_E_SUCCESS) {
943 res = nconc2 (res, list2 (intern (":signature"),
944 gnutls_hex_string (buf, buf_size, "")));
946 free (buf);
951 /* Public key ID. */
953 size_t buf_size = 0;
955 err = fn_gnutls_x509_crt_get_key_id (cert, 0, NULL, &buf_size);
956 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
958 unsigned char *buf = malloc (buf_size);
959 err = fn_gnutls_x509_crt_get_key_id (cert, 0, buf, &buf_size);
960 if (err >= GNUTLS_E_SUCCESS)
961 res = nconc2 (res, list2 (intern (":public-key-id"),
962 gnutls_hex_string ((char *)buf,
963 buf_size, "sha1:")));
964 free (buf);
968 /* Certificate fingerprint. */
970 size_t buf_size = 0;
972 err = fn_gnutls_x509_crt_get_fingerprint (cert, GNUTLS_DIG_SHA1,
973 NULL, &buf_size);
974 if (err == GNUTLS_E_SHORT_MEMORY_BUFFER)
976 unsigned char *buf = malloc (buf_size);
977 err = fn_gnutls_x509_crt_get_fingerprint (cert, GNUTLS_DIG_SHA1,
978 buf, &buf_size);
979 if (err >= GNUTLS_E_SUCCESS)
980 res = nconc2 (res, list2 (intern (":certificate-id"),
981 gnutls_hex_string ((char *)buf,
982 buf_size, "sha1:")));
983 free (buf);
987 return res;
990 DEFUN ("gnutls-peer-status-warning-describe", Fgnutls_peer_status_warning_describe, Sgnutls_peer_status_warning_describe, 1, 1, 0,
991 doc: /* Describe the warning of a GnuTLS peer status from `gnutls-peer-status'.*/)
992 (Lisp_Object status_symbol)
994 CHECK_SYMBOL (status_symbol);
996 if (EQ (status_symbol, intern (":invalid")))
997 return build_string ("certificate could not be verified");
999 if (EQ (status_symbol, intern (":revoked")))
1000 return build_string ("certificate was revoked (CRL)");
1002 if (EQ (status_symbol, intern (":self-signed")))
1003 return build_string ("certificate signer was not found (self-signed)");
1005 if (EQ (status_symbol, intern (":not-ca")))
1006 return build_string ("certificate signer is not a CA");
1008 if (EQ (status_symbol, intern (":insecure")))
1009 return build_string ("certificate was signed with an insecure algorithm");
1011 if (EQ (status_symbol, intern (":not-activated")))
1012 return build_string ("certificate is not yet activated");
1014 if (EQ (status_symbol, intern (":expired")))
1015 return build_string ("certificate has expired");
1017 if (EQ (status_symbol, intern (":no-host-match")))
1018 return build_string ("certificate host does not match hostname");
1020 return Qnil;
1023 DEFUN ("gnutls-peer-status", Fgnutls_peer_status, Sgnutls_peer_status, 1, 1, 0,
1024 doc: /* Describe a GnuTLS PROC peer certificate and any warnings about it.
1025 The return value is a property list with top-level keys :warnings and
1026 :certificate. The :warnings entry is a list of symbols you can describe with
1027 `gnutls-peer-status-warning-describe'. */)
1028 (Lisp_Object proc)
1030 Lisp_Object warnings = Qnil, result = Qnil;
1031 unsigned int verification;
1033 CHECK_PROCESS (proc);
1035 if (GNUTLS_INITSTAGE (proc) < GNUTLS_STAGE_INIT)
1036 return Qnil;
1038 /* Then collect any warnings already computed by the handshake. */
1039 verification = XPROCESS (proc)->gnutls_peer_verification;
1041 if (verification & GNUTLS_CERT_INVALID)
1042 warnings = Fcons (intern (":invalid"), warnings);
1044 if (verification & GNUTLS_CERT_REVOKED)
1045 warnings = Fcons (intern (":revoked"), warnings);
1047 if (verification & GNUTLS_CERT_SIGNER_NOT_FOUND)
1048 warnings = Fcons (intern (":self-signed"), warnings);
1050 if (verification & GNUTLS_CERT_SIGNER_NOT_CA)
1051 warnings = Fcons (intern (":not-ca"), warnings);
1053 if (verification & GNUTLS_CERT_INSECURE_ALGORITHM)
1054 warnings = Fcons (intern (":insecure"), warnings);
1056 if (verification & GNUTLS_CERT_NOT_ACTIVATED)
1057 warnings = Fcons (intern (":not-activated"), warnings);
1059 if (verification & GNUTLS_CERT_EXPIRED)
1060 warnings = Fcons (intern (":expired"), warnings);
1062 if (XPROCESS (proc)->gnutls_extra_peer_verification &
1063 CERTIFICATE_NOT_MATCHING)
1064 warnings = Fcons (intern (":no-host-match"), warnings);
1066 if (!NILP (warnings))
1067 result = list2 (intern (":warnings"), warnings);
1069 /* This could get called in the INIT stage, when the certificate is
1070 not yet set. */
1071 if (XPROCESS (proc)->gnutls_certificate != NULL)
1072 result = nconc2 (result, list2
1073 (intern (":certificate"),
1074 gnutls_certificate_details (XPROCESS (proc)->gnutls_certificate)));
1076 return result;
1080 /* Initializes global GnuTLS state to defaults.
1081 Call `gnutls-global-deinit' when GnuTLS usage is no longer needed.
1082 Returns zero on success. */
1083 static Lisp_Object
1084 emacs_gnutls_global_init (void)
1086 int ret = GNUTLS_E_SUCCESS;
1088 if (!gnutls_global_initialized)
1090 fn_gnutls_global_set_mem_functions (xmalloc, xmalloc, NULL,
1091 xrealloc, xfree);
1092 ret = fn_gnutls_global_init ();
1094 gnutls_global_initialized = 1;
1096 return gnutls_make_error (ret);
1099 static bool
1100 gnutls_ip_address_p (char *string)
1102 char c;
1104 while ((c = *string++) != 0)
1105 if (! ((c == '.' || c == ':' || (c >= '0' && c <= '9'))))
1106 return false;
1108 return true;
1111 #if 0
1112 /* Deinitializes global GnuTLS state.
1113 See also `gnutls-global-init'. */
1114 static Lisp_Object
1115 emacs_gnutls_global_deinit (void)
1117 if (gnutls_global_initialized)
1118 gnutls_global_deinit ();
1120 gnutls_global_initialized = 0;
1122 return gnutls_make_error (GNUTLS_E_SUCCESS);
1124 #endif
1126 DEFUN ("gnutls-boot", Fgnutls_boot, Sgnutls_boot, 3, 3, 0,
1127 doc: /* Initialize GnuTLS client for process PROC with TYPE+PROPLIST.
1128 Currently only client mode is supported. Return a success/failure
1129 value you can check with `gnutls-errorp'.
1131 TYPE is a symbol, either `gnutls-anon' or `gnutls-x509pki'.
1132 PROPLIST is a property list with the following keys:
1134 :hostname is a string naming the remote host.
1136 :priority is a GnuTLS priority string, defaults to "NORMAL".
1138 :trustfiles is a list of PEM-encoded trust files for `gnutls-x509pki'.
1140 :crlfiles is a list of PEM-encoded CRL lists for `gnutls-x509pki'.
1142 :keylist is an alist of PEM-encoded key files and PEM-encoded
1143 certificates for `gnutls-x509pki'.
1145 :callbacks is an alist of callback functions, see below.
1147 :loglevel is the debug level requested from GnuTLS, try 4.
1149 :verify-flags is a bitset as per GnuTLS'
1150 gnutls_certificate_set_verify_flags.
1152 :verify-hostname-error is ignored. Pass :hostname in :verify-error
1153 instead.
1155 :verify-error is a list of symbols to express verification checks or
1156 `t' to do all checks. Currently it can contain `:trustfiles' and
1157 `:hostname' to verify the certificate or the hostname respectively.
1159 :min-prime-bits is the minimum accepted number of bits the client will
1160 accept in Diffie-Hellman key exchange.
1162 The debug level will be set for this process AND globally for GnuTLS.
1163 So if you set it higher or lower at any point, it affects global
1164 debugging.
1166 Note that the priority is set on the client. The server does not use
1167 the protocols's priority except for disabling protocols that were not
1168 specified.
1170 Processes must be initialized with this function before other GnuTLS
1171 functions are used. This function allocates resources which can only
1172 be deallocated by calling `gnutls-deinit' or by calling it again.
1174 The callbacks alist can have a `verify' key, associated with a
1175 verification function (UNUSED).
1177 Each authentication type may need additional information in order to
1178 work. For X.509 PKI (`gnutls-x509pki'), you probably need at least
1179 one trustfile (usually a CA bundle). */)
1180 (Lisp_Object proc, Lisp_Object type, Lisp_Object proplist)
1182 int ret = GNUTLS_E_SUCCESS;
1183 int max_log_level = 0;
1184 bool verify_error_all = 0;
1186 gnutls_session_t state;
1187 gnutls_certificate_credentials_t x509_cred = NULL;
1188 gnutls_anon_client_credentials_t anon_cred = NULL;
1189 Lisp_Object global_init;
1190 char const *priority_string_ptr = "NORMAL"; /* default priority string. */
1191 unsigned int peer_verification;
1192 char *c_hostname;
1194 /* Placeholders for the property list elements. */
1195 Lisp_Object priority_string;
1196 Lisp_Object trustfiles;
1197 Lisp_Object crlfiles;
1198 Lisp_Object keylist;
1199 /* Lisp_Object callbacks; */
1200 Lisp_Object loglevel;
1201 Lisp_Object hostname;
1202 Lisp_Object verify_error;
1203 Lisp_Object prime_bits;
1204 Lisp_Object warnings;
1206 CHECK_PROCESS (proc);
1207 CHECK_SYMBOL (type);
1208 CHECK_LIST (proplist);
1210 if (NILP (Fgnutls_available_p ()))
1211 error ("GnuTLS not available");
1213 if (!EQ (type, Qgnutls_x509pki) && !EQ (type, Qgnutls_anon))
1214 error ("Invalid GnuTLS credential type");
1216 hostname = Fplist_get (proplist, QCgnutls_bootprop_hostname);
1217 priority_string = Fplist_get (proplist, QCgnutls_bootprop_priority);
1218 trustfiles = Fplist_get (proplist, QCgnutls_bootprop_trustfiles);
1219 keylist = Fplist_get (proplist, QCgnutls_bootprop_keylist);
1220 crlfiles = Fplist_get (proplist, QCgnutls_bootprop_crlfiles);
1221 loglevel = Fplist_get (proplist, QCgnutls_bootprop_loglevel);
1222 verify_error = Fplist_get (proplist, QCgnutls_bootprop_verify_error);
1223 prime_bits = Fplist_get (proplist, QCgnutls_bootprop_min_prime_bits);
1225 if (EQ (verify_error, Qt))
1227 verify_error_all = 1;
1229 else if (NILP (Flistp (verify_error)))
1231 error ("gnutls-boot: invalid :verify_error parameter (not a list)");
1234 if (!STRINGP (hostname))
1235 error ("gnutls-boot: invalid :hostname parameter (not a string)");
1236 c_hostname = SSDATA (hostname);
1238 state = XPROCESS (proc)->gnutls_state;
1240 if (TYPE_RANGED_INTEGERP (int, loglevel))
1242 fn_gnutls_global_set_log_function (gnutls_log_function);
1243 #ifdef HAVE_GNUTLS3
1244 fn_gnutls_global_set_audit_log_function (gnutls_audit_log_function);
1245 #endif
1246 fn_gnutls_global_set_log_level (XINT (loglevel));
1247 max_log_level = XINT (loglevel);
1248 XPROCESS (proc)->gnutls_log_level = max_log_level;
1251 GNUTLS_LOG2 (1, max_log_level, "connecting to host:", c_hostname);
1253 /* always initialize globals. */
1254 global_init = emacs_gnutls_global_init ();
1255 if (! NILP (Fgnutls_errorp (global_init)))
1256 return global_init;
1258 /* Before allocating new credentials, deallocate any credentials
1259 that PROC might already have. */
1260 emacs_gnutls_deinit (proc);
1262 /* Mark PROC as a GnuTLS process. */
1263 XPROCESS (proc)->gnutls_state = NULL;
1264 XPROCESS (proc)->gnutls_x509_cred = NULL;
1265 XPROCESS (proc)->gnutls_anon_cred = NULL;
1266 pset_gnutls_cred_type (XPROCESS (proc), type);
1267 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_EMPTY;
1269 GNUTLS_LOG (1, max_log_level, "allocating credentials");
1270 if (EQ (type, Qgnutls_x509pki))
1272 Lisp_Object verify_flags;
1273 unsigned int gnutls_verify_flags = GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT;
1275 GNUTLS_LOG (2, max_log_level, "allocating x509 credentials");
1276 fn_gnutls_certificate_allocate_credentials (&x509_cred);
1277 XPROCESS (proc)->gnutls_x509_cred = x509_cred;
1279 verify_flags = Fplist_get (proplist, QCgnutls_bootprop_verify_flags);
1280 if (NUMBERP (verify_flags))
1282 gnutls_verify_flags = XINT (verify_flags);
1283 GNUTLS_LOG (2, max_log_level, "setting verification flags");
1285 else if (NILP (verify_flags))
1286 GNUTLS_LOG (2, max_log_level, "using default verification flags");
1287 else
1288 GNUTLS_LOG (2, max_log_level, "ignoring invalid verify-flags");
1290 fn_gnutls_certificate_set_verify_flags (x509_cred, gnutls_verify_flags);
1292 else /* Qgnutls_anon: */
1294 GNUTLS_LOG (2, max_log_level, "allocating anon credentials");
1295 fn_gnutls_anon_allocate_client_credentials (&anon_cred);
1296 XPROCESS (proc)->gnutls_anon_cred = anon_cred;
1299 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_ALLOC;
1301 if (EQ (type, Qgnutls_x509pki))
1303 /* TODO: GNUTLS_X509_FMT_DER is also an option. */
1304 int file_format = GNUTLS_X509_FMT_PEM;
1305 Lisp_Object tail;
1307 for (tail = trustfiles; CONSP (tail); tail = XCDR (tail))
1309 Lisp_Object trustfile = XCAR (tail);
1310 if (STRINGP (trustfile))
1312 GNUTLS_LOG2 (1, max_log_level, "setting the trustfile: ",
1313 SSDATA (trustfile));
1314 trustfile = ENCODE_FILE (trustfile);
1315 #ifdef WINDOWSNT
1316 /* Since GnuTLS doesn't support UTF-8 or UTF-16 encoded
1317 file names on Windows, we need to re-encode the file
1318 name using the current ANSI codepage. */
1319 trustfile = ansi_encode_filename (trustfile);
1320 #endif
1321 ret = fn_gnutls_certificate_set_x509_trust_file
1322 (x509_cred,
1323 SSDATA (trustfile),
1324 file_format);
1326 if (ret < GNUTLS_E_SUCCESS)
1327 return gnutls_make_error (ret);
1329 else
1331 emacs_gnutls_deinit (proc);
1332 error ("Invalid trustfile");
1336 for (tail = crlfiles; CONSP (tail); tail = XCDR (tail))
1338 Lisp_Object crlfile = XCAR (tail);
1339 if (STRINGP (crlfile))
1341 GNUTLS_LOG2 (1, max_log_level, "setting the CRL file: ",
1342 SSDATA (crlfile));
1343 crlfile = ENCODE_FILE (crlfile);
1344 #ifdef WINDOWSNT
1345 crlfile = ansi_encode_filename (crlfile);
1346 #endif
1347 ret = fn_gnutls_certificate_set_x509_crl_file
1348 (x509_cred, SSDATA (crlfile), file_format);
1350 if (ret < GNUTLS_E_SUCCESS)
1351 return gnutls_make_error (ret);
1353 else
1355 emacs_gnutls_deinit (proc);
1356 error ("Invalid CRL file");
1360 for (tail = keylist; CONSP (tail); tail = XCDR (tail))
1362 Lisp_Object keyfile = Fcar (XCAR (tail));
1363 Lisp_Object certfile = Fcar (Fcdr (XCAR (tail)));
1364 if (STRINGP (keyfile) && STRINGP (certfile))
1366 GNUTLS_LOG2 (1, max_log_level, "setting the client key file: ",
1367 SSDATA (keyfile));
1368 GNUTLS_LOG2 (1, max_log_level, "setting the client cert file: ",
1369 SSDATA (certfile));
1370 keyfile = ENCODE_FILE (keyfile);
1371 certfile = ENCODE_FILE (certfile);
1372 #ifdef WINDOWSNT
1373 keyfile = ansi_encode_filename (keyfile);
1374 certfile = ansi_encode_filename (certfile);
1375 #endif
1376 ret = fn_gnutls_certificate_set_x509_key_file
1377 (x509_cred, SSDATA (certfile), SSDATA (keyfile), file_format);
1379 if (ret < GNUTLS_E_SUCCESS)
1380 return gnutls_make_error (ret);
1382 else
1384 emacs_gnutls_deinit (proc);
1385 error (STRINGP (keyfile) ? "Invalid client cert file"
1386 : "Invalid client key file");
1391 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_FILES;
1392 GNUTLS_LOG (1, max_log_level, "gnutls callbacks");
1393 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CALLBACKS;
1395 /* Call gnutls_init here: */
1397 GNUTLS_LOG (1, max_log_level, "gnutls_init");
1398 ret = fn_gnutls_init (&state, GNUTLS_CLIENT);
1399 XPROCESS (proc)->gnutls_state = state;
1400 if (ret < GNUTLS_E_SUCCESS)
1401 return gnutls_make_error (ret);
1402 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_INIT;
1404 if (STRINGP (priority_string))
1406 priority_string_ptr = SSDATA (priority_string);
1407 GNUTLS_LOG2 (1, max_log_level, "got non-default priority string:",
1408 priority_string_ptr);
1410 else
1412 GNUTLS_LOG2 (1, max_log_level, "using default priority string:",
1413 priority_string_ptr);
1416 GNUTLS_LOG (1, max_log_level, "setting the priority string");
1417 ret = fn_gnutls_priority_set_direct (state,
1418 priority_string_ptr,
1419 NULL);
1420 if (ret < GNUTLS_E_SUCCESS)
1421 return gnutls_make_error (ret);
1423 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_PRIORITY;
1425 if (INTEGERP (prime_bits))
1426 fn_gnutls_dh_set_prime_bits (state, XUINT (prime_bits));
1428 ret = EQ (type, Qgnutls_x509pki)
1429 ? fn_gnutls_credentials_set (state, GNUTLS_CRD_CERTIFICATE, x509_cred)
1430 : fn_gnutls_credentials_set (state, GNUTLS_CRD_ANON, anon_cred);
1431 if (ret < GNUTLS_E_SUCCESS)
1432 return gnutls_make_error (ret);
1434 if (!gnutls_ip_address_p (c_hostname))
1436 ret = fn_gnutls_server_name_set (state, GNUTLS_NAME_DNS, c_hostname,
1437 strlen (c_hostname));
1438 if (ret < GNUTLS_E_SUCCESS)
1439 return gnutls_make_error (ret);
1442 GNUTLS_INITSTAGE (proc) = GNUTLS_STAGE_CRED_SET;
1443 ret = emacs_gnutls_handshake (XPROCESS (proc));
1444 if (ret < GNUTLS_E_SUCCESS)
1445 return gnutls_make_error (ret);
1447 /* Now verify the peer, following
1448 http://www.gnu.org/software/gnutls/manual/html_node/Verifying-peer_0027s-certificate.html.
1449 The peer should present at least one certificate in the chain; do a
1450 check of the certificate's hostname with
1451 gnutls_x509_crt_check_hostname against :hostname. */
1453 ret = fn_gnutls_certificate_verify_peers2 (state, &peer_verification);
1454 if (ret < GNUTLS_E_SUCCESS)
1455 return gnutls_make_error (ret);
1457 XPROCESS (proc)->gnutls_peer_verification = peer_verification;
1459 warnings = Fplist_get (Fgnutls_peer_status (proc), intern (":warnings"));
1460 if (!NILP (warnings))
1462 Lisp_Object tail;
1463 for (tail = warnings; CONSP (tail); tail = XCDR (tail))
1465 Lisp_Object warning = XCAR (tail);
1466 Lisp_Object message = Fgnutls_peer_status_warning_describe (warning);
1467 if (!NILP (message))
1468 GNUTLS_LOG2 (1, max_log_level, "verification:", SSDATA (message));
1472 if (peer_verification != 0)
1474 if (verify_error_all
1475 || !NILP (Fmember (QCgnutls_bootprop_trustfiles, verify_error)))
1477 emacs_gnutls_deinit (proc);
1478 error ("Certificate validation failed %s, verification code %d",
1479 c_hostname, peer_verification);
1481 else
1483 GNUTLS_LOG2 (1, max_log_level, "certificate validation failed:",
1484 c_hostname);
1488 /* Up to here the process is the same for X.509 certificates and
1489 OpenPGP keys. From now on X.509 certificates are assumed. This
1490 can be easily extended to work with openpgp keys as well. */
1491 if (fn_gnutls_certificate_type_get (state) == GNUTLS_CRT_X509)
1493 gnutls_x509_crt_t gnutls_verify_cert;
1494 const gnutls_datum_t *gnutls_verify_cert_list;
1495 unsigned int gnutls_verify_cert_list_size;
1497 ret = fn_gnutls_x509_crt_init (&gnutls_verify_cert);
1498 if (ret < GNUTLS_E_SUCCESS)
1499 return gnutls_make_error (ret);
1501 gnutls_verify_cert_list =
1502 fn_gnutls_certificate_get_peers (state, &gnutls_verify_cert_list_size);
1504 if (gnutls_verify_cert_list == NULL)
1506 fn_gnutls_x509_crt_deinit (gnutls_verify_cert);
1507 emacs_gnutls_deinit (proc);
1508 error ("No x509 certificate was found\n");
1511 /* We only check the first certificate in the given chain. */
1512 ret = fn_gnutls_x509_crt_import (gnutls_verify_cert,
1513 &gnutls_verify_cert_list[0],
1514 GNUTLS_X509_FMT_DER);
1516 if (ret < GNUTLS_E_SUCCESS)
1518 fn_gnutls_x509_crt_deinit (gnutls_verify_cert);
1519 return gnutls_make_error (ret);
1522 XPROCESS (proc)->gnutls_certificate = gnutls_verify_cert;
1524 if (!fn_gnutls_x509_crt_check_hostname (gnutls_verify_cert, c_hostname))
1526 XPROCESS (proc)->gnutls_extra_peer_verification |=
1527 CERTIFICATE_NOT_MATCHING;
1528 if (verify_error_all
1529 || !NILP (Fmember (QCgnutls_bootprop_hostname, verify_error)))
1531 fn_gnutls_x509_crt_deinit (gnutls_verify_cert);
1532 emacs_gnutls_deinit (proc);
1533 error ("The x509 certificate does not match \"%s\"", c_hostname);
1535 else
1537 GNUTLS_LOG2 (1, max_log_level, "x509 certificate does not match:",
1538 c_hostname);
1543 /* Set this flag only if the whole initialization succeeded. */
1544 XPROCESS (proc)->gnutls_p = 1;
1546 return gnutls_make_error (ret);
1549 DEFUN ("gnutls-bye", Fgnutls_bye,
1550 Sgnutls_bye, 2, 2, 0,
1551 doc: /* Terminate current GnuTLS connection for process PROC.
1552 The connection should have been initiated using `gnutls-handshake'.
1554 If CONT is not nil the TLS connection gets terminated and further
1555 receives and sends will be disallowed. If the return value is zero you
1556 may continue using the connection. If CONT is nil, GnuTLS actually
1557 sends an alert containing a close request and waits for the peer to
1558 reply with the same message. In order to reuse the connection you
1559 should wait for an EOF from the peer.
1561 This function may also return `gnutls-e-again', or
1562 `gnutls-e-interrupted'. */)
1563 (Lisp_Object proc, Lisp_Object cont)
1565 gnutls_session_t state;
1566 int ret;
1568 CHECK_PROCESS (proc);
1570 state = XPROCESS (proc)->gnutls_state;
1572 fn_gnutls_x509_crt_deinit (XPROCESS (proc)->gnutls_certificate);
1574 ret = fn_gnutls_bye (state,
1575 NILP (cont) ? GNUTLS_SHUT_RDWR : GNUTLS_SHUT_WR);
1577 return gnutls_make_error (ret);
1580 void
1581 syms_of_gnutls (void)
1583 gnutls_global_initialized = 0;
1585 DEFSYM (Qgnutls_dll, "gnutls");
1586 DEFSYM (Qgnutls_code, "gnutls-code");
1587 DEFSYM (Qgnutls_anon, "gnutls-anon");
1588 DEFSYM (Qgnutls_x509pki, "gnutls-x509pki");
1589 DEFSYM (QCgnutls_bootprop_hostname, ":hostname");
1590 DEFSYM (QCgnutls_bootprop_priority, ":priority");
1591 DEFSYM (QCgnutls_bootprop_trustfiles, ":trustfiles");
1592 DEFSYM (QCgnutls_bootprop_keylist, ":keylist");
1593 DEFSYM (QCgnutls_bootprop_crlfiles, ":crlfiles");
1594 DEFSYM (QCgnutls_bootprop_callbacks, ":callbacks");
1595 DEFSYM (QCgnutls_bootprop_callbacks_verify, "verify");
1596 DEFSYM (QCgnutls_bootprop_min_prime_bits, ":min-prime-bits");
1597 DEFSYM (QCgnutls_bootprop_loglevel, ":loglevel");
1598 DEFSYM (QCgnutls_bootprop_verify_flags, ":verify-flags");
1599 DEFSYM (QCgnutls_bootprop_verify_error, ":verify-error");
1601 DEFSYM (Qgnutls_e_interrupted, "gnutls-e-interrupted");
1602 Fput (Qgnutls_e_interrupted, Qgnutls_code,
1603 make_number (GNUTLS_E_INTERRUPTED));
1605 DEFSYM (Qgnutls_e_again, "gnutls-e-again");
1606 Fput (Qgnutls_e_again, Qgnutls_code,
1607 make_number (GNUTLS_E_AGAIN));
1609 DEFSYM (Qgnutls_e_invalid_session, "gnutls-e-invalid-session");
1610 Fput (Qgnutls_e_invalid_session, Qgnutls_code,
1611 make_number (GNUTLS_E_INVALID_SESSION));
1613 DEFSYM (Qgnutls_e_not_ready_for_handshake, "gnutls-e-not-ready-for-handshake");
1614 Fput (Qgnutls_e_not_ready_for_handshake, Qgnutls_code,
1615 make_number (GNUTLS_E_APPLICATION_ERROR_MIN));
1617 defsubr (&Sgnutls_get_initstage);
1618 defsubr (&Sgnutls_errorp);
1619 defsubr (&Sgnutls_error_fatalp);
1620 defsubr (&Sgnutls_error_string);
1621 defsubr (&Sgnutls_boot);
1622 defsubr (&Sgnutls_deinit);
1623 defsubr (&Sgnutls_bye);
1624 defsubr (&Sgnutls_available_p);
1625 defsubr (&Sgnutls_peer_status);
1626 defsubr (&Sgnutls_peer_status_warning_describe);
1628 DEFVAR_INT ("gnutls-log-level", global_gnutls_log_level,
1629 doc: /* Logging level used by the GnuTLS functions.
1630 Set this larger than 0 to get debug output in the *Messages* buffer.
1631 1 is for important messages, 2 is for debug data, and higher numbers
1632 are as per the GnuTLS logging conventions. */);
1633 global_gnutls_log_level = 0;
1636 #endif /* HAVE_GNUTLS */