A major mode for password-store
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

681 lines
24 KiB

;;; pass.el --- Major mode for password-store.el -*- lexical-binding: t; -*-
;; Copyright (C) 2015-2019 Nicolas Petton & Damien Cassou
;; Author: Nicolas Petton <petton.nicolas@gmail.com>
;; Damien Cassou <damien@cassou.me>
;; Version: 2.0
;; GIT: https://github.com/NicolasPetton/pass
;; Package-Requires: ((emacs "25") (password-store "2.1.0") (password-store-otp "0.1.5") (f "0.17"))
;; Created: 09 Jun 2015
;; Keywords: password-store, password, keychain
;; This program 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.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Major mode for password-store.el
;;; Code:
(require 'password-store)
(require 'imenu)
(require 'button)
(require 'f)
(require 'subr-x)
(defgroup pass '()
"Major mode for password-store."
:group 'password-store)
(defcustom pass-show-keybindings t
"Whether the keybindings should be displayed in the pass buffer."
:group 'pass
:type 'boolean)
(defcustom pass-username-field "username"
"Field name used in the files to indicate an username."
:group 'pass
:type 'string)
(defvar pass-buffer-name "*Password-Store*"
"Name of the pass buffer.")
(defvar pass-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "n") #'pass-next-entry)
(define-key map (kbd "p") #'pass-prev-entry)
(define-key map (kbd "M-n") #'pass-next-directory)
(define-key map (kbd "M-p") #'pass-prev-directory)
(define-key map (kbd "k") #'pass-kill)
(define-key map (kbd "s") #'isearch-forward)
(define-key map (kbd "?") #'describe-mode)
(define-key map (kbd "g") #'pass-update-buffer)
(define-key map (kbd "i") #'pass-insert)
(define-key map (kbd "I") #'pass-insert-generated)
(define-key map (kbd "j") #'pass-goto-entry)
(define-key map (kbd "w") #'pass-copy)
(define-key map (kbd "b") #'pass-copy-username)
(define-key map (kbd "f") #'pass-copy-field)
(define-key map (kbd "u") #'pass-copy-url)
(define-key map (kbd "U") #'pass-browse-url)
(define-key map (kbd "v") #'pass-view)
(define-key map (kbd "r") #'pass-rename)
(define-key map (kbd "o") #'pass-otp-options)
(define-key map (kbd "RET") #'pass-view)
(define-key map (kbd "q") #'pass-quit)
"Keymap for `pass-mode'.")
(defface pass-mode-header-face '((t . (:inherit font-lock-keyword-face)))
"Face for displaying the header of the pass buffer."
:group 'pass)
(defface pass-mode-entry-face '((t . ()))
"Face for displaying pass entry names."
:group 'pass)
(defface pass-mode-directory-face '((t . (:inherit
"Face for displaying password-store directory names."
:group 'pass)
(define-derived-mode pass-mode fundamental-mode "Password-Store"
"Major mode for editing password-stores.
(setq default-directory (password-store-dir))
(setq imenu-prev-index-position-function
(setq imenu-extract-index-name-function
(defun pass--imenu-prev-index-position-function ()
"Move point to previous line in current buffer.
This function is used as a value for
(not (bobp)))
(defun pass--imenu-extract-index-name-function ()
"Return imenu name for pass entry at point.
This function is used as a value for
(defun pass-setup-buffer ()
"Setup the password-store buffer."
(defun pass ()
"Open the password-store buffer."
(if (get-buffer pass-buffer-name)
(switch-to-buffer pass-buffer-name)
(let ((buf (get-buffer-create pass-buffer-name)))
(pop-to-buffer buf)
(defmacro pass--with-writable-buffer (&rest body)
"Evaluate BODY as if the current buffer was not in `read-only-mode'."
(declare (indent 0) (debug t))
`(let ((inhibit-read-only t))
(defmacro pass--save-point (&rest body)
"Evaluate BODY and restore the point.
Similar to `save-excursion' but only restore the point."
(declare (indent 0) (debug t))
(let ((point (make-symbol "point")))
`(let ((,point (point)))
(goto-char (min ,point (point-max))))))
(defun pass-quit ()
"Kill the buffer quitting the window."
(when (y-or-n-p "Kill all pass entry buffers? ")
(dolist (buf (buffer-list))
(with-current-buffer buf
(when (eq major-mode 'pass-view-mode)
(kill-buffer buf)))))
(quit-window t))
(defun pass-next-entry ()
"Move point to the next entry found."
(pass--goto-next #'pass-entry-at-point))
(defun pass-prev-entry ()
"Move point to the previous entry."
(pass--goto-prev #'pass-entry-at-point))
(defun pass--target-entry-pos (target)
"Return position of TARGET entry or nil if it doesn't exist."
(goto-char (point-min))
(pass--goto-next (lambda () (equal (pass-entry-at-point) target)))
(unless (eobp)
(defun pass-goto-entry (entry)
"Move point to ENTRY and return its position.
If ENTRY doesn't exist in the buffer, then preserve point and return nil.
Note that ENTRY must reflect its deep level in the directory structure;
for instance, an entry `bar' inside the subdirectory `foo', must be
specified as `foo/bar'.
When called interactively, prompt users with completion using
all entries in the pass buffer."
(list (completing-read "Jump to entry: "
(password-store-list) nil 'match)))
(let ((entry-pos (pass--target-entry-pos entry)))
(if entry-pos
(goto-char entry-pos)
(message "No entry matches %s in current directory" entry)
(defun pass-next-directory ()
"Move point to the next directory found."
(pass--goto-next #'pass-directory-at-point))
(defun pass-prev-directory ()
"Move point to the previous directory."
(pass--goto-prev #'pass-directory-at-point))
(defmacro pass--with-closest-entry (varname &rest body)
"Bound VARNAME to the closest entry before point and evaluate BODY."
(declare (indent 1) (debug t))
`(let ((,varname (pass-closest-entry)))
(if ,varname
(progn ,@body)
(message "No entry at point"))))
(defun pass-rename (new-name)
"Rename the entry at point to NEW-NAME."
(interactive (list (read-string "Rename entry to: " (pass-closest-entry))))
(pass--with-closest-entry entry
(password-store-rename entry new-name)
(defun pass-kill ()
"Remove the entry at point."
(pass--with-closest-entry entry
(when (yes-or-no-p (format "Do you want remove the entry %s? " entry))
(password-store-remove entry)
(defun pass-update-buffer ()
"Update the current buffer contents."
(delete-region (point-min) (point-max))
(defun pass-insert (arg)
"Insert an entry to the password-store.
The password is read from user input.
When called with a prefix argument ARG, visit the entry file."
(interactive "P")
(if arg
(call-interactively #'password-store-insert)
(defun pass-insert-multiline ()
"This function behaves similarly to `pass -m'.
It creates an empty entry file, and visit it."
(let ((entry (format "%s.gpg" (read-string "Password entry: ")))
(default-directory (password-store-dir)))
(make-directory (file-name-directory entry) t)
(find-file (expand-file-name entry (password-store-dir)))))
(defun pass-insert-generated ()
"Insert an entry to the password-store.
Use a generated password instead of reading the password from
user input."
(call-interactively #'password-store-generate)
(defun pass-view ()
"Visit the entry at point."
(pass--with-closest-entry entry
(find-file (concat (f-join (password-store-dir) entry) ".gpg"))))
(defun pass-copy ()
"Add the password of entry at point to kill ring."
(pass--with-closest-entry entry
(password-store-copy entry)))
(defun pass--copy-field (field)
"Add FIELD of entry at point to kill ring."
(pass--with-closest-entry entry
(let* ((inhibit-message t)
(parsed-entries (password-store-parse-entry entry)))
(unless (assoc field parsed-entries)
(user-error "Field `%s' not in %s" field entry))
(password-store-copy-field entry field))))
(defun pass-copy-field (field)
"Add FIELD of entry at point to kill ring.
When called interactively, prompt users for field with completion
using all fields in the entry."
(pass--with-closest-entry entry
(list (password-store-read-field entry))))
(if (equal field "secret") (pass-copy)
(pass--copy-field field)))
(defun pass-copy-username ()
"Add username of entry at point to kill ring."
(pass--copy-field pass-username-field))
(defun pass-copy-url ()
"Add url of entry at point to kill ring."
(pass--copy-field password-store-url-field))
(defun pass-display-data ()
"Display the password-store data into the current buffer."
(let ((items (pass--tree)))
(pass-display-item items)))
(defun pass-display-header ()
"Display the header in to the current buffer."
(insert "Password-store directory:")
(put-text-property (point-at-bol) (point) 'face 'pass-mode-header-face)
(insert " ")
(insert "\n\n")
(when pass-show-keybindings
(pass--display-keybindings '((pass-copy . "Copy password")
(pass-copy-username . "Copy username")
(pass-copy-url . "Copy url")))
(insert "\n")
(pass--display-keybindings '((pass-copy-field . "Copy field")
(pass-goto-entry . "Jump to Entry")
(pass-browse-url . "Browse url")))
(insert "\n")
(pass--display-keybindings '((pass-insert . "Insert")
(pass-next-entry . "Next")
(pass-update-buffer . "Update")))
(insert "\n")
(pass--display-keybindings '((pass-insert-generated . "Generate")
(pass-prev-entry . "Previous")
(pass-otp-options . "OTP Support")))
(insert "\n")
(pass--display-keybindings '((pass-rename . "Rename")
(pass-next-directory . "Next dir")
(pass-view . "View entry")))
(insert "\n")
(pass--display-keybindings '((pass-kill . "Delete")
(pass-prev-directory . "Previous dir")
(describe-mode . "Help")))
(defun pass--display-keybindings-toggle ()
"Display a button to toggle whether keybindings should be displayed."
(let ((label (if pass-show-keybindings
"[Hide keybindings]"
"[Show keybindings]")))
(insert-button label 'action #'pass--toggle-display-keybindings)))
(defun pass--toggle-display-keybindings (&rest _)
"Toggle displaying the keybindings and update the buffer."
(setq pass-show-keybindings (not pass-show-keybindings))
(put pass-show-keybindings
(list (custom-quote (symbol-value pass-show-keybindings))))
(defun pass--display-keybindings (bindings)
"Display the keybinding in each item of BINDINGS.
BINDINGS is an alist of bindings."
(mapc (lambda (pair)
(pass--display-keybinding (car pair) (cdr pair)))
(defun pass--display-keybinding (command label)
"Insert the associated keybinding for COMMAND with LABEL."
(insert (format "%8s %-13s \t "
(format "%s"
(propertize (substitute-command-keys
(format "<\\[%s]>" (symbol-name command)))
'face 'font-lock-constant-face))
(defun pass-display-item (item &optional indent-level)
"Display the directory or entry ITEM into the current buffer.
If INDENT-LEVEL is specified, add enough spaces before displaying
(unless indent-level (setq indent-level 0))
(let ((directory (listp item)))
(pass-display-item-prefix indent-level)
(if directory
(pass-display-directory item indent-level)
(pass-display-entry item))))
(defun pass-display-entry (entry)
"Display the password-store entry ENTRY into the current buffer."
(let ((entry-name (f-filename entry)))
(insert entry-name)
(add-text-properties (point-at-bol) (point)
`(face pass-mode-entry-face pass-entry ,entry))
(defun pass-display-directory (directory indent-level)
"Display the directory DIRECTORY into the current buffer.
DIRECTORY is a list, its CAR being the name of the directory and its CDR
the entries of the directory. Add enough spaces so that each entry is
indented according to INDENT-LEVEL."
(let ((name (car directory))
(items (cdr directory)))
(insert name)
(add-text-properties (point-at-bol) (point)
`(face pass-mode-directory-face pass-directory ,name))
(dolist (item items)
(pass-display-item item (1+ indent-level)))))
(defun pass-display-item-prefix (indent-level)
"Display some indenting text according to INDENT-LEVEL."
(dotimes (_ (max 0 (* (1- indent-level) 4)))
(insert " "))
(unless (zerop indent-level)
(insert "├── ")))
(defun pass-entry-at-point ()
"Return the `pass-entry' property at point."
(get-text-property (point-at-eol) 'pass-entry))
(defun pass-directory-at-point ()
"Return the `pass-directory' property at point."
(get-text-property (point) 'pass-directory))
(defun pass-closest-entry ()
"Return the closest entry in the current buffer, looking backward."
(or (pass-entry-at-point)
(unless (bolp)
(forward-line -1)
(defun pass-otp-options (option)
"Dispatch otp actions depending on user OPTION input.
Display help message with OTP functionality options."
(read-char-choice "[i] Insert, [a] Append, [s] Append from screenshot, [o] Copy token, [u] Copy URI, or [C-g] to abort: "
'(?i ?a ?s ?o ?u))))
(unless (require 'password-store-otp nil t)
(user-error "You cannot do this without installing `password-store-otp' first"))
(pcase option
(?i (pass-otp-insert))
(?a (pass-otp-append))
(?s (pass-otp-from-screenshot))
(?o (pass-otp-token-copy))
(?u (pass-otp-uri-copy))))
(defun pass-otp-token-copy ()
"Add OTP Token from closest entry to kill ring."
(pass--with-closest-entry entry
(password-store-otp-token-copy entry)))
(defun pass-otp-uri-copy ()
"Add OTP URI from closest entry to kill ring."
(pass--with-closest-entry entry
(password-store-otp-uri-copy entry)))
(defun pass-otp-insert ()
"Insert an OTP URI entry to the password-store.
The password is read from user input."
(call-interactively #'password-store-otp-insert)
(defun pass-otp-append ()
"Append an OTP URI to an existing entry in the password-store.
The password is read from user input."
(pass--with-closest-entry entry
(password-store-otp-append entry (read-passwd "OTP URI: " t)))
(defun pass-otp-from-screenshot ()
"Append an OTP URI taken from a screenshot to an existing entry in the password-store."
(pass--with-closest-entry entry
(password-store-otp-append-from-image entry))
(defun pass--goto-next (pred)
"Move point to the next match of PRED."
(while (not (or (eobp) (funcall pred)))
(defun pass--goto-prev (pred)
"Move point to the previous match of PRED."
(forward-line -1)
(while (not (or (bobp) (funcall pred)))
(forward-line -1)))
(defun pass--tree (&optional subdir)
"Return a tree of all entries in SUBDIR.
If SUBDIR is nil, return the entries of `(password-store-dir)'."
(unless subdir (setq subdir ""))
(let ((path (f-join (password-store-dir) subdir)))
(if (f-directory? path)
(unless (string= (f-filename subdir) ".git")
(cons (f-filename path)
(delq nil
(mapcar 'pass--tree
(f-entries path)))))
(when (and (equal (f-ext path) "gpg")
(not (backup-file-name-p path)))
(password-store--file-to-entry path)))))
;;; major mode for viewing entries
(defvar pass-view-mask "·············"
"Mask used to hide passwords.")
(defvar pass-view-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-c") #'pass-view-toggle-password)
(define-key map (kbd "C-c C-w") #'pass-view-copy-password)
(make-variable-buffer-local 'pass-view-mode-map)
(defun pass-view-entry-name (&optional buffer)
"Return the entry name for BUFFER.
This function only works when `pass-view-mode' is enabled."
(with-current-buffer (or buffer (current-buffer))
(when (eq major-mode 'pass-view-mode)
(f-no-ext (replace-regexp-in-string
(format "^%s/" (f-expand (password-store-dir)))
(defun pass-view-toggle-password ()
"Enable or disable password hiding."
(goto-char (point-min))
(let ((buf-modified (buffer-modified-p)))
(if (string= (get-text-property (point) 'display)
(set-buffer-modified-p buf-modified))))
(defun pass-view-copy-password ()
"Copy the password of the entry in the current buffer."
(goto-char (point-min))
(copy-region-as-kill (point) (line-end-position))
(message "Password copied to kill ring.")))
(defun pass-view-mask-password ()
"Mask the password of the current buffer."
(let ((inhibit-read-only t))
(goto-char (point-min))
(set-text-properties (point-min) (line-end-position)
`(display ,pass-view-mask)))))
(defun pass-view-unmask-password ()
"Show the password in the current buffer."
(goto-char (point-min))
(remove-text-properties (point-min) (line-end-position)
'(display nil))))
(defun pass-view-copy-token ()
"Copy current `pass-view' buffer's OTP token into clipboard."
(when-let (entry-name (pass-view-entry-name))
(password-store-otp-token-copy entry-name)))
(defun pass-view-qrcode ()
"Open a new buffer that displays a QR Code for the current entry."
(when-let (entry-name (pass-view-entry-name))
(let ((qrcode-buffer (get-buffer-create "*pass-view-qrcode*")))
(with-current-buffer qrcode-buffer
(fundamental-mode) ;; Return buffer *back* to fundamental, in case it isn't already.
(insert (password-store-otp-qrcode entry-name "SVG"))
(local-set-key (kbd "q") 'kill-this-buffer))
(switch-to-buffer-other-window qrcode-buffer))))
(defun pass-view--otp-remaining-secs ()
"Return a string with the remaining countdown base 30."
(let* ((base 30)
(remaining (- base (% (truncate (time-to-seconds (current-time)))
(remaining-str (number-to-string remaining)))
(if (< remaining 10) ;; leftpad-ing
(concat "0" remaining-str)
(defun pass-view--set-otp-header (token remaining-secs)
"Display OTP TOKEN and REMAINING-SECS in Header Line."
(let ((otp-data (concat (propertize " " 'display '((space :align-to 0)))
(propertize "OTP: " 'face 'pass-mode-header-face)
token " - " remaining-secs "s remaining"))
(key-binding (concat (propertize (substitute-command-keys
(format "<\\[%s]>" "pass-view-copy-token"))
'face 'font-lock-constant-face)
" Copy token")))
(setq header-line-format (concat otp-data " " key-binding))
(defun pass-view--has-otp-p ()
"Return t-ish value if there's an OTP URI in the current buffer.
nil otherwise."
(goto-char (point-min))
(search-forward "otpauth://" nil t)))
(defun pass-view--otp-counter (buffer &optional last-token force-create)
"Reload BUFFER's OTP token and countdown, using LAST-TOKEN if any, and if FORCE-CREATE, build Header Line from scratch."
(when (buffer-live-p buffer)
(with-current-buffer buffer
(when (or header-line-format force-create)
(let* ((remaining-secs (pass-view--otp-remaining-secs))
(token (if (or (not last-token)
(string= remaining-secs "30"))
(password-store-otp-token (pass-view-entry-name buffer))
(pass-view--set-otp-header token remaining-secs)
(run-at-time 1 nil #'pass-view--otp-counter buffer token))))))
(defun pass-view--prepare-otp ()
"Start an OTP token/remaining secs counter in current buffer.
This function also binds a couple of handy OTP related key-bindings to
(when (and (require 'password-store-otp nil t)
;; Build OTP counter
(pass-view--otp-counter (current-buffer) nil t)
;; Rebuild header after saving.
(add-hook 'after-save-hook
#'(lambda ()
(if (pass-view--has-otp-p)
(pass-view--otp-counter (current-buffer) nil t)
;; Remove header line
(setq header-line-format nil)))
t t)
;; Define a couple of OTP helper shortcuts
(define-key pass-view-mode-map (kbd "C-c C-o") #'pass-view-copy-token)
(define-key pass-view-mode-map (kbd "C-c C-q") #'pass-view-qrcode)))
(defun pass-browse-url ()
"Browse URL in entry at point."
(pass--with-closest-entry entry
(password-store-url entry)))
(defvar pass-view-font-lock-keywords '("^[^\s\n]+:" . 'font-lock-keyword-face)
"Font lock keywords for ‘pass-view-mode’.")
(define-derived-mode pass-view-mode nil "Pass-View"
"Major mode for viewing password-store entries.
(setq-local font-lock-defaults '(pass-view-font-lock-keywords t))
(font-lock-mode 1)
"Press <\\[pass-view-toggle-password]> to display & edit the password")))
(add-to-list 'auto-mode-alist
(format "%s/.*\\.gpg\\'"
(expand-file-name (password-store-dir)))
(provide 'pass)
;;; pass.el ends here