aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Kangas2024-07-27 03:27:57 +0200
committerStefan Kangas2024-07-27 03:28:49 +0200
commit9e9121ed6356e02173b57ea612feb7f55c07f2c8 (patch)
tree313e8b51019ce799cb9df843f9b3ff626a134dc2
parent33c6b4df40e4408b63a2d908a26a91dba80b6a04 (diff)
downloademacs-9e9121ed6356e02173b57ea612feb7f55c07f2c8.tar.gz
emacs-9e9121ed6356e02173b57ea612feb7f55c07f2c8.zip
* lisp/net/nsm.el (nsm-verify-connection): Improve docstring.
-rw-r--r--lisp/net/nsm.el23
1 files changed, 11 insertions, 12 deletions
diff --git a/lisp/net/nsm.el b/lisp/net/nsm.el
index ab655dbb13b..e8fdb9b183b 100644
--- a/lisp/net/nsm.el
+++ b/lisp/net/nsm.el
@@ -100,21 +100,20 @@ This means that no queries should be performed.")
100(defun nsm-verify-connection (process host port &optional 100(defun nsm-verify-connection (process host port &optional
101 save-fingerprint warn-unencrypted) 101 save-fingerprint warn-unencrypted)
102 "Verify the security status of PROCESS that's connected to HOST:PORT. 102 "Verify the security status of PROCESS that's connected to HOST:PORT.
103If PROCESS is a gnutls connection, the certificate validity will 103If PROCESS is a GnuTLS connection, the certificate validity will be
104be examined. If it's a non-TLS connection, it may be compared 104examined. If it's a non-TLS connection, it may be compared against
105against previous connections. If the function determines that 105previous connections. If the function determines that there is
106there is something odd about the connection, the user will be 106something odd about the connection, the user will be queried about what
107queried about what to do about it. 107to do about it.
108 108
109The process is returned if everything is OK, and otherwise, the 109Return the process if all the checks pass. Otherwise, delete the
110process will be deleted and nil is returned. 110process and return nil.
111 111
112If SAVE-FINGERPRINT, always save the fingerprint of the 112If SAVE-FINGERPRINT, always save the fingerprint of the server (if the
113server (if the connection is a TLS connection). This is useful 113connection is a TLS connection). This is useful to keep track of the
114to keep track of the TLS status of STARTTLS servers. 114TLS status of STARTTLS servers.
115 115
116If WARN-UNENCRYPTED, query the user if the connection is 116If WARN-UNENCRYPTED, query the user if the connection is unencrypted."
117unencrypted."
118 (let* ((status (gnutls-peer-status process)) 117 (let* ((status (gnutls-peer-status process))
119 (id (nsm-id host port)) 118 (id (nsm-id host port))
120 (settings (nsm-host-settings id))) 119 (settings (nsm-host-settings id)))