1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 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 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 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 235 236 237 238 239 240 241 242 243 244 245
|
;;; netrc.el --- .netrc parsing functionality -*- lexical-binding: t -*-
;; Copyright (C) 1996-2025 Free Software Foundation, Inc.
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: news
;; Obsolete-since: 29.1
;;
;; Instead of using `netrc-parse', use `auth-source-netrc-parse-all'.
;;
;; Modularized by Ted Zlatanov <tzz@lifelogs.com>
;; when it was part of Gnus.
;; 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
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Just the .netrc parsing functionality, abstracted so other packages
;; besides Gnus can use it.
;;; Code:
;;;
;;; .netrc and .authinfo rc parsing
;;;
(defgroup netrc nil
"Netrc configuration."
:group 'comm)
(defcustom netrc-file "~/.authinfo"
"File where user credentials are stored."
:version "24.1"
:type 'file)
(defvar netrc-services-file "/etc/services"
"The name of the services file.")
(defvar netrc-cache nil)
(defun netrc-parse (&optional file)
"Parse FILE and return a list of all entries in the file."
(declare (obsolete auth-source-netrc-parse-all "29.1"))
(interactive "fFile to Parse: ")
(unless file
(setq file netrc-file))
(if (listp file)
;; We got already parsed contents; just return it.
file
(when (file-exists-p file)
(with-temp-buffer
(let ((tokens '("machine" "default" "login"
"password" "account" "macdef" "force"
"port"))
alist elem result pair)
(if (and netrc-cache
(time-equal-p (car netrc-cache)
(file-attribute-modification-time
(file-attributes file))))
(insert (base64-decode-string (rot13-string (cdr netrc-cache))))
(insert-file-contents file)
(when (string-match "\\.gpg\\'" file)
;; Store the contents of the file heavily encrypted in memory.
(setq netrc-cache (cons (file-attribute-modification-time
(file-attributes file))
(rot13-string
(base64-encode-string
(buffer-string)))))))
(goto-char (point-min))
;; Go through the file, line by line.
(while (not (eobp))
(narrow-to-region (point) (line-end-position))
;; For each line, get the tokens and values.
(while (not (eobp))
(skip-chars-forward "\t ")
;; Skip lines that begin with a "#".
(if (eq (char-after) ?#)
(goto-char (point-max))
(unless (eobp)
(setq elem
(if (= (following-char) ?\")
(read (current-buffer))
(buffer-substring
(point) (progn (skip-chars-forward "^\t ")
(point)))))
(cond
((equal elem "macdef")
;; We skip past the macro definition.
(widen)
(while (and (zerop (forward-line 1))
(looking-at "$")))
(narrow-to-region (point) (point)))
((member elem tokens)
;; Tokens that don't have a following value are ignored,
;; except "default".
(when (and pair (or (cdr pair)
(equal (car pair) "default")))
(push pair alist))
(setq pair (list elem)))
(t
;; Values that haven't got a preceding token are ignored.
(when pair
(setcdr pair elem)
(push pair alist)
(setq pair nil)))))))
(when alist
(push (nreverse alist) result))
(setq alist nil
pair nil)
(widen)
(forward-line 1))
(nreverse result))))))
(defun netrc-machine (list machine &optional port defaultport)
"Return the netrc values from LIST for MACHINE or for the default entry.
If PORT specified, only return entries with matching port tokens.
Entries without port tokens default to DEFAULTPORT."
(let ((rest list)
result)
(while list
(when (equal (cdr (assoc "machine" (car list))) machine)
(push (car list) result))
(pop list))
(unless result
;; No machine name matches, so we look for default entries.
(while rest
(when (assoc "default" (car rest))
(let ((elem (car rest)))
(setq elem (delete (assoc "default" elem) elem))
(push elem result)))
(pop rest)))
(when result
(setq result (nreverse result))
(if (not port)
(car result)
(while (and result
(not (netrc-port-equal
(or port defaultport "nntp")
;; when port is not given in the netrc file,
;; it should mean "any port"
(or (netrc-get (car result) "port")
defaultport port))))
(pop result))
(car result)))))
(defun netrc-machine-user-or-password (mode authinfo-file-or-list machines ports defaults)
"Get the user name or password according to MODE from AUTHINFO-FILE-OR-LIST.
Matches a machine from MACHINES and a port from PORTS, giving
default ports DEFAULTS to `netrc-machine'.
MODE can be \"login\" or \"password\", suitable for passing to
`netrc-get'."
(let ((authinfo-list (if (stringp authinfo-file-or-list)
(with-suppressed-warnings ((obsolete netrc-parse))
(netrc-parse authinfo-file-or-list))
authinfo-file-or-list))
(ports (or ports '(nil)))
(defaults (or defaults '(nil)))
info)
(if (listp mode)
(setq info
(mapcar
(lambda (mode-element)
(netrc-machine-user-or-password
mode-element
authinfo-list
machines
ports
defaults))
mode))
(dolist (machine machines)
(dolist (default defaults)
(dolist (port ports)
(let ((alist (netrc-machine authinfo-list machine port default)))
(setq info (or (netrc-get alist mode) info)))))))
info))
(defun netrc-get (alist type)
"Return the value of token TYPE from ALIST."
(cdr (assoc type alist)))
(defun netrc-port-equal (port1 port2)
(when (numberp port1)
(setq port1 (or (netrc-find-service-name port1) port1)))
(when (numberp port2)
(setq port2 (or (netrc-find-service-name port2) port2)))
(equal port1 port2))
(defun netrc-parse-services ()
(when (file-exists-p netrc-services-file)
(let ((services nil))
(with-temp-buffer
(insert-file-contents netrc-services-file)
(while (search-forward "#" nil t)
(delete-region (1- (point)) (line-end-position)))
(goto-char (point-min))
(while (re-search-forward
"^ *\\([^ \n\t]+\\)[ \t]+\\([0-9]+\\)/\\([^ \t\n]+\\)" nil t)
(push (list (match-string 1) (string-to-number (match-string 2))
(intern (downcase (match-string 3))))
services))
(nreverse services)))))
(defun netrc-find-service-name (number &optional type)
(let ((services (netrc-parse-services))
service)
(setq type (or type 'tcp))
(while (and (setq service (pop services))
(not (and (= number (cadr service))
(eq type (car (cddr service)))))))
(car service)))
;;;###autoload
(defun netrc-credentials (machine &rest ports)
"Return a user name/password pair.
Port specifications will be prioritized in the order they are
listed in the PORTS list."
(let ((list (with-suppressed-warnings ((obsolete netrc-parse))
(netrc-parse)))
found)
(if (not ports)
(setq found (netrc-machine list machine))
(while (and ports
(not found))
(setq found (netrc-machine list machine (pop ports)))))
(when found
(list (cdr (assoc "login" found))
(cdr (assoc "password" found))))))
(provide 'netrc)
;;; netrc.el ends here
|