nsm.el 19.4 KB
Newer Older
1 2
;;; nsm.el --- Network Security Manager

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2014-2018 Free Software Foundation, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: encryption, security, network

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
22 23 24 25 26 27

;;; Commentary:

;;; Code:

(require 'cl-lib)
28
(require 'rmc)                       ; read-multiple-choice
29
(require 'subr-x)
30 31 32 33 34 35 36 37 38

(defvar nsm-permanent-host-settings nil)
(defvar nsm-temporary-host-settings nil)

(defgroup nsm nil
  "Network Security Manager"
  :version "25.1"
  :group 'comm)

39
(defcustom network-security-level 'medium
40 41 42 43 44 45 46 47
  "How secure the network should be.
If a potential problem with the security of the network
connection is found, the user is asked to give input into how the
connection should be handled.

The following values are possible:

`low': Absolutely no checks are performed.
48 49 50 51
`medium': This is the default level, should be reasonable for most usage.
`high': This warns about additional things that many people would
not find useful.
`paranoid': On this level, the user is queried for most new connections.
52

53 54
See the Emacs manual for a description of all things that are
checked and warned against."
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
  :version "25.1"
  :group 'nsm
  :type '(choice (const :tag "Low" low)
		 (const :tag "Medium" medium)
		 (const :tag "High" high)
		 (const :tag "Paranoid" paranoid)))

(defcustom nsm-settings-file (expand-file-name "network-security.data"
						 user-emacs-directory)
  "The file the security manager settings will be stored in."
  :version "25.1"
  :group 'nsm
  :type 'file)

(defcustom nsm-save-host-names nil
  "If non-nil, always save host names in the structures in `nsm-settings-file'.
By default, only hosts that have exceptions have their names
stored in plain text."
  :version "25.1"
  :group 'nsm
  :type 'boolean)

(defvar nsm-noninteractive nil
  "If non-nil, the connection is opened in a non-interactive context.
This means that no queries should be performed.")

81 82
(declare-function gnutls-peer-status "gnutls.c" (proc))

83 84 85 86 87 88 89 90 91
(defun nsm-verify-connection (process host port &optional
				      save-fingerprint warn-unencrypted)
  "Verify the security status of PROCESS that's connected to HOST:PORT.
If PROCESS is a gnutls connection, the certificate validity will
be examined.  If it's a non-TLS connection, it may be compared
against previous connections.  If the function determines that
there is something odd about the connection, the user will be
queried about what to do about it.

Mark Oteiza's avatar
Mark Oteiza committed
92
The process is returned if everything is OK, and otherwise, the
93 94 95 96 97 98 99 100
process will be deleted and nil is returned.

If SAVE-FINGERPRINT, always save the fingerprint of the
server (if the connection is a TLS connection).  This is useful
to keep track of the TLS status of STARTTLS servers.

If WARN-UNENCRYPTED, query the user if the connection is
unencrypted."
101
  (if (eq network-security-level 'low)
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
      process
    (let* ((status (gnutls-peer-status process))
	   (id (nsm-id host port))
	   (settings (nsm-host-settings id)))
      (cond
       ((not (process-live-p process))
	nil)
       ((not status)
	;; This is a non-TLS connection.
	(nsm-check-plain-connection process host port settings
				    warn-unencrypted))
       (t
	(let ((process
	       (nsm-check-tls-connection process host port status settings)))
	  (when (and process save-fingerprint
		     (null (nsm-host-settings id)))
	    (nsm-save-host host port status 'fingerprint 'always))
	  process))))))

(defun nsm-check-tls-connection (process host port status settings)
122 123 124 125
  (when-let ((process
              (nsm-check-certificate process host port status settings)))
    ;; Do further protocol-level checks.
    (nsm-check-protocol process host port status settings)))
126

127 128 129
(declare-function gnutls-peer-status-warning-describe "gnutls.c"
		  (status-symbol))

130
(defun nsm-check-certificate (process host port status settings)
131 132 133 134 135 136 137
  (let ((warnings (plist-get status :warnings)))
    (cond

     ;; The certificate validated, but perhaps we want to do
     ;; certificate pinning.
     ((null warnings)
      (cond
138
       ((< (nsm-level network-security-level) (nsm-level 'high))
139 140 141
	process)
       ;; The certificate is fine, but if we're paranoid, we might
       ;; want to check whether it's changed anyway.
142
       ((and (>= (nsm-level network-security-level) (nsm-level 'high))
143 144 145 146
	     (not (nsm-fingerprint-ok-p host port status settings)))
	(delete-process process)
	nil)
       ;; We haven't seen this before, and we're paranoid.
147
       ((and (eq network-security-level 'paranoid)
148 149 150 151
	     (null settings)
	     (not (nsm-new-fingerprint-ok-p host port status)))
	(delete-process process)
	nil)
152
       ((>= (nsm-level network-security-level) (nsm-level 'high))
153 154 155 156 157 158 159 160
	;; Save the host fingerprint so that we can check it the
	;; next time we connect.
	(nsm-save-host host port status 'fingerprint 'always)
	process)
       (t
	process)))

     ;; The certificate did not validate.
161
     ((not (equal network-security-level 'low))
162 163 164 165 166 167 168 169 170 171
      ;; We always want to pin the certificate of invalid connections
      ;; to track man-in-the-middle or the like.
      (if (not (nsm-fingerprint-ok-p host port status settings))
	  (progn
	    (delete-process process)
	    nil)
	;; We have a warning, so query the user.
	(if (and (not (nsm-warnings-ok-p status settings))
		 (not (nsm-query
		       host port status 'conditions
172
		       "The TLS connection to %s:%s is insecure for the following reason%s:\n\n%s"
173 174 175
		       host port
		       (if (> (length warnings) 1)
			   "s" "")
176 177 178
		       (mapconcat #'gnutls-peer-status-warning-describe
                                  warnings
                                  "\n"))))
179 180 181 182 183
	    (progn
	      (delete-process process)
	      nil)
	  process))))))

184
(defvar network-security-protocol-checks
185 186 187
  '((diffie-hellman-prime-bits medium 1024)
    (rc4 medium)
    (signature-sha1 medium)
188
    (intermediate-sha1 medium)
189 190
    (3des high)
    (ssl medium))
191 192 193 194 195 196 197 198 199
  "This variable specifies what TLS connection checks to perform.
It's an alist where the first element is the name of the check,
the second is the security level where the check kicks in, and the
optional third element is a parameter supplied to the check.

An element like `(rc4 medium)' will result in the function
`nsm-protocol-check--rc4' being called with the parameters
HOST PORT STATUS OPTIONAL-PARAMETER.")

200
(defun nsm-check-protocol (process host port status settings)
201 202 203 204 205 206
  (cl-loop for check in network-security-protocol-checks
           for type = (intern (format ":%s" (car check)) obarray)
           while process
           ;; Skip the check if the user has already said that this
           ;; host is OK for this type of "error".
           when (and (not (memq type (plist-get settings :conditions)))
207 208
                     (>= (nsm-level network-security-level)
                         (nsm-level (cadr check))))
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
           do (let ((result
                     (funcall (intern (format "nsm-protocol-check--%s"
                                              (car check))
                                      obarray)
                              host port status (nth 2 check))))
                (unless result
                  (delete-process process)
                  (setq process nil))))
  ;; If a test failed we return nil, otherwise the process object.
  process)

(defun nsm--encryption (status)
  (format "%s-%s-%s"
          (plist-get status :key-exchange)
	  (plist-get status :cipher)
	  (plist-get status :mac)))

(defun nsm-protocol-check--diffie-hellman-prime-bits (host port status bits)
  (let ((prime-bits (plist-get status :diffie-hellman-prime-bits)))
    (or (not prime-bits)
        (>= prime-bits bits)
	(nsm-query
	 host port status :diffie-hellman-prime-bits
	 "The Diffie-Hellman prime bits (%s) used for this connection to %s:%s is less than what is considered safe (%s)."
	 prime-bits host port bits))))

235 236 237 238 239 240 241
(defun nsm-protocol-check--3des (host port status _)
  (or (not (string-match "\\b3DES\\b" (plist-get status :cipher)))
      (nsm-query
       host port status :rc4
       "The connection to %s:%s uses the 3DES cipher (%s), which is believed to be unsafe."
       host port (plist-get status :cipher))))

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
(defun nsm-protocol-check--rc4 (host port status _)
  (or (not (string-match "\\bRC4\\b" (nsm--encryption status)))
      (nsm-query
       host port status :rc4
       "The connection to %s:%s uses the RC4 algorithm (%s), which is believed to be unsafe."
       host port (nsm--encryption status))))

(defun nsm-protocol-check--signature-sha1 (host port status _)
  (let ((signature-algorithm
         (plist-get (plist-get status :certificate) :signature-algorithm)))
    (or (not (string-match "\\bSHA1\\b" signature-algorithm))
        (nsm-query
         host port status :signature-sha1
         "The certificate used to verify the connection to %s:%s uses the SHA1 algorithm (%s), which is believed to be unsafe."
         host port signature-algorithm))))

258
(defun nsm-protocol-check--intermediate-sha1 (host port status _)
259 260
  ;; Skip the first certificate, because that's the host certificate.
  (cl-loop for certificate in (cdr (plist-get status :certificates))
261
           for algo = (plist-get certificate :signature-algorithm)
262 263 264 265 266
           ;; Don't check root certificates -- SHA1 isn't dangerous
           ;; there.
           when (and (not (equal (plist-get certificate :issuer)
                                 (plist-get certificate :subject)))
                     (string-match "\\bSHA1\\b" algo)
267
                     (not (nsm-query
268
                           host port status :intermediate-sha1
269
                           "An intermediate certificate used to verify the connection to %s:%s uses the SHA1 algorithm (%s), which is believed to be unsafe."
270 271 272 273
                           host port algo)))
           do (cl-return nil)
           finally (cl-return t)))

274 275 276 277 278 279 280 281
(defun nsm-protocol-check--ssl (host port status _)
  (let ((protocol (plist-get status :protocol)))
    (or (not protocol)
	(not (string-match "SSL" protocol))
	(nsm-query
	 host port status :ssl
	 "The connection to %s:%s uses the %s protocol, which is believed to be unsafe."
	 host port protocol))))
282

283 284 285 286 287 288 289 290 291 292 293 294 295
(defun nsm-fingerprint (status)
  (plist-get (plist-get status :certificate) :public-key-id))

(defun nsm-fingerprint-ok-p (host port status settings)
  (let ((did-query nil))
    (if (and settings
	     (not (eq (plist-get settings :fingerprint) :none))
	     (not (equal (nsm-fingerprint status)
			 (plist-get settings :fingerprint)))
	     (not
	      (setq did-query
		    (nsm-query
		     host port status 'fingerprint
296
		     "The fingerprint for the connection to %s:%s has changed from %s to %s"
297 298 299 300 301 302 303 304 305 306 307 308 309
		     host port
		     (plist-get settings :fingerprint)
		     (nsm-fingerprint status)))))
	;; Not OK.
	nil
      (when did-query
	;; Remove any exceptions that have been set on the previous
	;; certificate.
	(plist-put settings :conditions nil))
      t)))

(defun nsm-new-fingerprint-ok-p (host port status)
  (nsm-query
310
   host port status 'fingerprint
311
   "The fingerprint for the connection to %s:%s is new: %s"
312 313 314 315 316 317 318 319 320 321 322 323 324
   host port
   (nsm-fingerprint status)))

(defun nsm-check-plain-connection (process host port settings warn-unencrypted)
  ;; If this connection used to be TLS, but is now plain, then it's
  ;; possible that we're being Man-In-The-Middled by a proxy that's
  ;; stripping out STARTTLS announcements.
  (cond
   ((and (plist-get settings :fingerprint)
	 (not (eq (plist-get settings :fingerprint) :none))
	 (not
	  (nsm-query
	   host port nil 'conditions
325
	   "The connection to %s:%s used to be an encrypted connection, but is now unencrypted.  This might mean that there's a man-in-the-middle tapping this connection."
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
	   host port)))
    (delete-process process)
    nil)
   ((and warn-unencrypted
	 (not (memq :unencrypted (plist-get settings :conditions)))
	 (not (nsm-query
	       host port nil 'conditions
	       "The connection to %s:%s is unencrypted."
	       host port)))
    (delete-process process)
    nil)
   (t
    process)))

(defun nsm-query (host port status what message &rest args)
  ;; If there is no user to answer queries, then say `no' to everything.
  (if (or noninteractive
	  nsm-noninteractive)
      nil
    (let ((response
	   (condition-case nil
Lars Ingebrigtsen's avatar
Lars Ingebrigtsen committed
347 348 349 350 351
               (intern
                (car (split-string
                      (nsm-query-user message args
                                      (nsm-format-certificate status))))
                obarray)
352 353 354 355 356
	     ;; Make sure we manage to close the process if the user hits
	     ;; `C-g'.
	     (quit 'no)
	     (error 'no))))
      (if (eq response 'no)
357 358 359 360 361 362 363
          (progn
            (message "Aborting connection to %s:%s" host port)
            nil)
        (message (if (eq response 'session)
                     "Accepting certificate for %s:%s this session only"
                   "Permanently accepting certificate for %s:%s")
                 host port)
364 365 366 367 368
	(nsm-save-host host port status what response)
	t))))

(defun nsm-query-user (message args cert)
  (let ((buffer (get-buffer-create "*Network Security Manager*")))
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
    (save-window-excursion
      ;; First format the certificate and warnings.
      (with-help-window buffer
        (with-current-buffer buffer
          (erase-buffer)
          (when (> (length cert) 0)
            (insert cert "\n"))
          (let ((start (point)))
            (insert (apply #'format-message message args))
            (goto-char start)
            ;; Fill the first line of the message, which usually
            ;; contains lots of explanatory text.
            (fill-region (point) (line-end-position)))))
      ;; Then ask the user what to do about it.
      (unwind-protect
          (cadr
           (read-multiple-choice
            "Continue connecting?"
            '((?a "always" "Accept this certificate this session and for all future sessions.")
              (?s "session only" "Accept this certificate this session only.")
              (?n "no" "Refuse to use this certificate, and close the connection."))))
        (kill-buffer buffer)))))
391 392 393 394 395 396 397 398 399 400 401 402 403

(defun nsm-save-host (host port status what permanency)
  (let* ((id (nsm-id host port))
	 (saved
	  (list :id id
		:fingerprint (or (nsm-fingerprint status)
				 ;; Plain connection.
				 :none))))
    (when (or (eq what 'conditions)
	      nsm-save-host-names)
      (nconc saved (list :host (format "%s:%s" host port))))
    ;; We either want to save/update the fingerprint or the conditions
    ;; of the certificate/unencrypted connection.
404 405
    (cond
     ((eq what 'conditions)
406 407
      (cond
       ((not status)
408
	(nconc saved '(:conditions (:unencrypted))))
409 410
       ((plist-get status :warnings)
	(nconc saved
411 412 413 414 415 416 417 418 419
	       (list :conditions (plist-get status :warnings))))))
     ((not (eq what 'fingerprint))
      ;; Store additional protocol settings.
      (let ((settings (nsm-host-settings id)))
	(when settings
	  (setq saved settings))
	(if (plist-get saved :conditions)
	    (nconc (plist-get saved :conditions) (list what))
	  (nconc saved (list :conditions (list what)))))))
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    (if (eq permanency 'always)
	(progn
	  (nsm-remove-temporary-setting id)
	  (nsm-remove-permanent-setting id)
	  (push saved nsm-permanent-host-settings)
	  (nsm-write-settings))
      (nsm-remove-temporary-setting id)
      (push saved nsm-temporary-host-settings))))

(defun nsm-write-settings ()
  (with-temp-file nsm-settings-file
    (insert "(\n")
    (dolist (setting nsm-permanent-host-settings)
      (insert " ")
      (prin1 setting (current-buffer))
      (insert "\n"))
    (insert ")\n")))

(defun nsm-read-settings ()
  (setq nsm-permanent-host-settings
	(with-temp-buffer
	  (insert-file-contents nsm-settings-file)
	  (goto-char (point-min))
	  (ignore-errors (read (current-buffer))))))

(defun nsm-id (host port)
  (concat "sha1:" (sha1 (format "%s:%s" host port))))

(defun nsm-host-settings (id)
  (when (and (not nsm-permanent-host-settings)
	     (file-exists-p nsm-settings-file))
    (nsm-read-settings))
  (let ((result nil))
    (dolist (elem (append nsm-temporary-host-settings
			  nsm-permanent-host-settings))
      (when (and (not result)
		 (equal (plist-get elem :id) id))
	(setq result elem)))
    result))

(defun nsm-warnings-ok-p (status settings)
461 462 463 464 465 466
  (let ((ok t)
	(conditions (plist-get settings :conditions)))
    (dolist (warning (plist-get status :warnings))
      (unless (memq warning conditions)
	(setq ok nil)))
    ok))
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

(defun nsm-remove-permanent-setting (id)
  (setq nsm-permanent-host-settings
	(cl-delete-if
	 (lambda (elem)
	   (equal (plist-get elem :id) id))
	 nsm-permanent-host-settings)))

(defun nsm-remove-temporary-setting (id)
  (setq nsm-temporary-host-settings
	(cl-delete-if
	 (lambda (elem)
	   (equal (plist-get elem :id) id))
	 nsm-temporary-host-settings)))

(defun nsm-format-certificate (status)
  (let ((cert (plist-get status :certificate)))
    (when cert
      (with-temp-buffer
	(insert
	 "Certificate information\n"
	 "Issued by:"
	 (nsm-certificate-part (plist-get cert :issuer) "CN" t) "\n"
	 "Issued to:"
	 (or (nsm-certificate-part (plist-get cert :subject) "O")
	     (nsm-certificate-part (plist-get cert :subject) "OU" t))
	 "\n"
	 "Hostname:"
495 496 497 498 499 500
	 (nsm-certificate-part (plist-get cert :subject) "CN" t) "\n")
	(when (and (plist-get cert :public-key-algorithm)
		   (plist-get cert :signature-algorithm))
	  (insert
	   "Public key:" (plist-get cert :public-key-algorithm)
	   ", signature: " (plist-get cert :signature-algorithm) "\n"))
501 502 503 504 505 506 507 508 509
	(when (and (plist-get status :key-exchange)
		   (plist-get status :cipher)
		   (plist-get status :mac)
		   (plist-get status :protocol))
	  (insert
	   "Protocol:" (plist-get status :protocol)
	   ", key: " (plist-get status :key-exchange)
	   ", cipher: " (plist-get status :cipher)
	   ", mac: " (plist-get status :mac) "\n"))
510 511 512 513 514 515 516
	(when (plist-get cert :certificate-security-level)
	  (insert
	   "Security level:"
	   (propertize (plist-get cert :certificate-security-level)
		       'face 'bold)
	   "\n"))
	(insert
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
	 "Valid:From " (plist-get cert :valid-from)
	 " to " (plist-get cert :valid-to) "\n\n")
	(goto-char (point-min))
	(while (re-search-forward "^[^:]+:" nil t)
	  (insert (make-string (- 20 (current-column)) ? )))
	(buffer-string)))))

(defun nsm-certificate-part (string part &optional full)
  (let ((part (cadr (assoc part (nsm-parse-subject string)))))
    (cond
     (part part)
     (full string)
     (t nil))))

(defun nsm-parse-subject (string)
  (with-temp-buffer
    (insert string)
    (goto-char (point-min))
    (let ((start (point))
	  (result nil))
      (while (not (eobp))
	(push (replace-regexp-in-string
	       "[\\]\\(.\\)" "\\1"
	       (buffer-substring start
				 (if (re-search-forward "[^\\]," nil 'move)
				     (1- (point))
				   (point))))
	      result)
	(setq start (point)))
      (mapcar
       (lambda (elem)
	 (let ((pos (cl-position ?= elem)))
	   (if pos
	       (list (substring elem 0 pos)
		     (substring elem (1+ pos)))
	     elem)))
       (nreverse result)))))

(defun nsm-level (symbol)
  "Return a numerical level for SYMBOL for easier comparison."
  (cond
   ((eq symbol 'low) 0)
   ((eq symbol 'medium) 1)
   ((eq symbol 'high) 2)
   (t 3)))

(provide 'nsm)

;;; nsm.el ends here