; doc/emacs/misc.texi (Network Security): Fix typo.
[emacs.git] / src / gnutls.h
blob3c5573962c6497c838273207133e99c8ebad9e9a
1 /* GnuTLS glue for GNU Emacs.
2 Copyright (C) 2010-2018 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 (at
9 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 <https://www.gnu.org/licenses/>. */
19 #ifndef EMACS_GNUTLS_DEFINED
20 #define EMACS_GNUTLS_DEFINED
22 #ifdef HAVE_GNUTLS
23 #include <gnutls/gnutls.h>
24 #include <gnutls/x509.h>
26 #if 0x030000 <= GNUTLS_VERSION_NUMBER
27 # define HAVE_GNUTLS3
28 # include <gnutls/crypto.h>
29 #endif
31 #include "lisp.h"
33 /* This limits the attempts to handshake per process (connection). It
34 should work out to about one minute in asynchronous cases. */
35 #define GNUTLS_EMACS_HANDSHAKES_LIMIT 6000
37 typedef enum
39 /* Initialization stages. */
40 GNUTLS_STAGE_EMPTY = 0,
41 GNUTLS_STAGE_CRED_ALLOC,
42 GNUTLS_STAGE_FILES,
43 GNUTLS_STAGE_CALLBACKS,
44 GNUTLS_STAGE_INIT,
45 GNUTLS_STAGE_PRIORITY,
46 GNUTLS_STAGE_CRED_SET,
48 /* Handshake stages. */
49 GNUTLS_STAGE_HANDSHAKE_CANDO = GNUTLS_STAGE_CRED_SET,
50 GNUTLS_STAGE_TRANSPORT_POINTERS_SET,
51 GNUTLS_STAGE_HANDSHAKE_TRIED,
53 GNUTLS_STAGE_READY
54 } gnutls_initstage_t;
56 #define GNUTLS_EMACS_ERROR_NOT_LOADED (GNUTLS_E_APPLICATION_ERROR_MIN + 1)
57 #define GNUTLS_EMACS_ERROR_INVALID_TYPE GNUTLS_E_APPLICATION_ERROR_MIN
59 #define GNUTLS_INITSTAGE(proc) (XPROCESS (proc)->gnutls_initstage)
61 #define GNUTLS_PROCESS_USABLE(proc) \
62 (GNUTLS_INITSTAGE (proc) >= GNUTLS_STAGE_READY)
64 #define GNUTLS_LOG(level, max, string) \
65 do { \
66 if ((level) <= (max)) \
67 gnutls_log_function (level, "(Emacs) " string); \
68 } while (false)
70 #define GNUTLS_LOG2(level, max, string, extra) \
71 do { \
72 if ((level) <= (max)) \
73 gnutls_log_function2 (level, "(Emacs) " string, extra); \
74 } while (false)
76 #define GNUTLS_LOG2i(level, max, string, extra) \
77 do { \
78 if ((level) <= (max)) \
79 message ("gnutls.c: [%d] %s %d", level, string, extra); \
80 } while (false)
82 extern ptrdiff_t
83 emacs_gnutls_write (struct Lisp_Process *proc, const char *buf, ptrdiff_t nbyte);
84 extern ptrdiff_t
85 emacs_gnutls_read (struct Lisp_Process *proc, char *buf, ptrdiff_t nbyte);
87 extern ptrdiff_t emacs_gnutls_record_check_pending (gnutls_session_t state);
88 #ifdef WINDOWSNT
89 extern void emacs_gnutls_transport_set_errno (gnutls_session_t state, int err);
90 extern int w32_gnutls_rnd (gnutls_rnd_level_t, void *, size_t);
91 #endif
92 extern Lisp_Object emacs_gnutls_deinit (Lisp_Object);
93 extern Lisp_Object emacs_gnutls_global_init (void);
94 extern int gnutls_try_handshake (struct Lisp_Process *p);
95 extern Lisp_Object gnutls_verify_boot (Lisp_Object proc, Lisp_Object proplist);
97 #endif
99 extern void syms_of_gnutls (void);
101 #endif