Include gnulib headers.
[elisp/starttls.git] / starttls.el
1 ;;; starttls.el --- STARTTLS functions
2
3 ;; Copyright (C) 1999, 2000 Free Software Foundation, Inc.
4
5 ;; Author: Daiki Ueno <ueno@unixuser.org>
6 ;; Created: 1999/11/20
7 ;; Keywords: TLS, SSL, OpenSSL
8
9 ;; This file is not part of any package.
10
11 ;; This program is free software; you can redistribute it and/or
12 ;; modify it under the terms of the GNU General Public License as
13 ;; published by the Free Software Foundation; either version 2, or (at
14 ;; your option) any later version.
15
16 ;; This program is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 ;; General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;; This module defines some utility functions for STARTTLS profiles.
29
30 ;; [RFC 2595] "Using TLS with IMAP, POP3 and ACAP"
31 ;;      by Chris Newman <chris.newman@innosoft.com> (1999/06)
32
33 ;;; Code:
34
35 (defgroup starttls nil
36   "Support for `Transport Layer Security' protocol."
37   :group 'ssl)
38
39 (defcustom starttls-program "starttls"
40   "The program to run in a subprocess to open an TLSv1 connection."
41   :group 'starttls)
42
43 (defcustom starttls-negotiation-by-kill-program nil
44   "Starting starttls negotiation by kill command if non-nil."
45   :group 'starttls)
46
47 (defcustom starttls-kill-program "c:\\cygwin\\bin\\kill"
48   "External kill command to send SIGALRM to starttls."
49   :group 'starttls)
50
51 (defcustom starttls-extra-args nil
52   "Extra arguments to `starttls-program'"
53   :group 'starttls)
54
55 (defun starttls-negotiate (process)
56   (if starttls-negotiation-by-kill-program
57       (call-process starttls-kill-program nil nil nil
58                     "-ALRM" (format "%d" (process-id process)))
59     (signal-process (process-id process) 'SIGALRM)))
60
61 (defun starttls-open-stream (name buffer host service)
62   "Open a TLS connection for a service to a host.
63 Returns a subprocess-object to represent the connection.
64 Input and output work as for subprocesses; `delete-process' closes it.
65 Args are NAME BUFFER HOST SERVICE.
66 NAME is name for process.  It is modified if necessary to make it unique.
67 BUFFER is the buffer (or `buffer-name') to associate with the process.
68  Process output goes at end of that buffer, unless you specify
69  an output stream or filter function to handle the output.
70  BUFFER may be also nil, meaning that this process is not associated
71  with any buffer
72 Third arg is name of the host to connect to, or its IP address.
73 Fourth arg SERVICE is name of the service desired, or an integer
74 specifying a port number to connect to."
75   (let* ((process-connection-type nil)
76          (process (apply #'start-process
77                          name buffer starttls-program
78                          host (format "%s" service)
79                          starttls-extra-args)))
80     (process-kill-without-query process)
81     process))
82
83 (provide 'starttls)
84
85 ;;; starttls.el ends here