]> git.eshelyaron.com Git - emacs.git/commitdiff
Mention the NSM in the gnutls variable doc strings
authorLars Ingebrigtsen <larsi@gnus.org>
Sun, 24 Jun 2018 12:48:30 +0000 (14:48 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 8 Jul 2018 13:59:27 +0000 (15:59 +0200)
* gnutls.el (gnutls-algorithm-priority): Mention the Network
Security Manager here since this variable is an obvious place
for people concerned about network security to look.
(gnutls-verify-error): Ditto.
(gnutls-min-prime-bits): Ditto.

lisp/net/gnutls.el

index 85c9308c0d291b7b275a32e129e2a0b1339f3d18..4cc1f5f4c3db5855a5142f2a0784d802b00bcb0b 100644 (file)
 (defcustom gnutls-algorithm-priority nil
   "If non-nil, this should be a TLS priority string.
 For instance, if you want to skip the \"dhe-rsa\" algorithm,
-set this variable to \"normal:-dhe-rsa\"."
+set this variable to \"normal:-dhe-rsa\".
+
+This variable can be useful for modifying low-level TLS
+connection parameters (for instance if you need to connect to a
+host that only accepts a specific algorithm), but general Emacs
+network security is handled by the Network Security Manager.  See
+Info node `(emacs) Network Security'."
   :group 'gnutls
   :type '(choice (const nil)
                  string))
@@ -72,7 +78,13 @@ corresponding conditions to be tested are:
 If the condition test fails, an error will be signaled.
 
 If the value of this variable is t, every connection will be subjected
-to all of the tests described above."
+to all of the tests described above.
+
+The default value of this variable is nil, which means that no
+checks are performed at the gnutls level.  Instead the checks are
+performed via `open-network-stream' at a higher level by the
+Network Security Manager.  See Info node `(emacs) Network
+Security'."
   :group 'gnutls
   :version "24.4"
   :type '(choice
@@ -111,7 +123,14 @@ number with fewer than this number of bits, the handshake is
 rejected.  \(The smaller the prime number, the less secure the
 key exchange is against man-in-the-middle attacks.)
 
-A value of nil says to use the default GnuTLS value."
+A value of nil says to use the default GnuTLS value.
+
+The default value of this variable is such that virtually any
+connection can be established, whether this connection can be
+considered cryptographically \"safe\" or not.  However, Emacs
+network security is handled at a higher level via
+`open-network-stream' and the Network Security Manager.  See Info
+node `(emacs) Network Security'."
   :type '(choice (const :tag "Use default value" nil)
                  (integer :tag "Number of bits" 512))
   :group 'gnutls)