-;;; hidepw.el --- Minor mode to hide passwords
+;;; hidepw.el --- Minor mode to hide passwords -*- lexical-binding: t; -*-
;; Author: Chris Forno <jekorNOSPAMjekor.com>
-;; Package-Version: 0.1.0
-;; Keywords: hide, hidden, password
+;; Package-Version: 0.3.0
+;; Keywords: hide, hidden, password, faces
+;; URL: https://github.com/jekor/hidepw
-;; Copyright (C) 2014, Chris Forno
+;; Copyright (C) 2014, 2020 Chris Forno
;; All rights reserved.
;;
;; Redistribution and use in source and binary forms, with or without
;;; Commentary:
-;; This is a minor mode for hiding passwords. It's useful if you
+;; This is a minor mode for hiding passwords. It's useful if you
;; manage your passwords in text files (perhaps automatically
;; encrypted and decrypted by EasyPG) and want to prevent shoulder
;; surfing.
;; When enabled, any passwords will appear as ******, but you'll still
;; be able to copy the password to the clipboard.
;;
-;; By default, passwords are marked by delimiting them with pipes (|).
+;; By default, passwords are marked by delimiting them with braces ([]).
;; For example:
;;
-;; root: |supersecret|
+;; root: [supersecret]
;;
;; will display as
;;
-;; root: |******|
+;; root: [******]
;;
;; You can customize hidepw-pattern to match against arbitrary regular
-;; expressions. Just make sure to include one capturing group (\(\))
-;; since the group marks the actual password. You can also customize
+;; expressions. Just make sure to include one capturing group (\(\))
+;; since the group marks the actual password. You can also customize
;; the mask (******) that obscures the password.
;;
;; You can enable hidepw-mode automatically on .gpg files with:
;;
-;; (add-to-list 'auto-mode-alist
-;; '("\\.gpg\\'" . (lambda () (hidepw-mode))))
+;; (add-to-list 'auto-mode-alist '("\\.gpg\\'" . hidepw-mode))
+;;
+;; Using with pass (https://www.passwordstore.org/):
+;;
+;; pass requires that the first line of the file is a password. To hide
+;; the first line, customize the hidepw-hide-first-line variable.
+;;
+;; Differences from password-mode (https://github.com/juergenhoetzel/password-mode/):
+;;
+;; | | password-mode | hidepw |
+;; |-------------------+-----------------+---------------------------|
+;; | hiding via | overlay | font-lock |
+;; | password input | password prompt | normal input |
+;; | match via | prefix regexp | regexp with capture group |
+;; | multiple patterns | yes | yes |
+;; | supports pass | no* | yes |
+;;
+;; While the password prompt is a nice feature of password-mode, I found
+;; it to be difficult to use and that it could get into inconsistent states.
+;; If you'd like to input passwords without them ever being visible, input the
+;; delimiters ([]) first and then input the password between them.
+;;
+;; * It might be possible to use pass with password-mode with the right
+;; regexp.
;;
;; Notes:
;;
;; You won't be able to move the cursor within the password (it will
;; behave like a single character), but deleting the delimiter from
-;; either side will reveal the password and make it editable. Just add
+;; either side will reveal the password and make it editable. Just add
;; the delimiter back to hide it again.
;;
;; This mode turns on font-lock-mode (and won't turn it off when you
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; User Variables:
-(defgroup hidepw nil "Settings for hiding passwords")
+(defgroup hidepw nil "Settings for hiding passwords."
+ :group 'text)
-(defcustom hidepw-pattern "|\\(.*\\)|"
- "Pattern for identifying a password (must contain 1 capturing group)"
- :type 'regexp
+(defcustom hidepw-patterns '("\\[\\(.+\\)\\]")
+ "Patterns for identifying a password (must contain 1 capturing group).
+
+If you keep multiple passwords on a line, you can use non-greedy
+capturing groups (.+?) but you must use a closing delimiter that
+does not appear in your passwords."
+ :type '(repeat regexp)
:group 'hidepw)
(defcustom hidepw-mask "******"
- "String to obscure passwords with"
+ "String to obscure passwords with."
:type 'string
:group 'hidepw)
+(defcustom hidepw-hide-first-line nil
+ "Hide the first line of the buffer. Useful if you're using pass."
+ :type 'boolean
+ :group 'hidepw
+ :link '(url-link "https://www.passwordstore.org/"))
+
(defun hidepw-font-lock-keywords ()
- `((,hidepw-pattern 1 (hidepw-render))))
+ "Define the patterns to mask via font-lock."
+ (mapcar (lambda (pat) `(,pat 1 (hidepw-render)))
+ `(,@hidepw-patterns ,@(when hidepw-hide-first-line '("\\`\\(.*\\)$")))))
(defun hidepw-render ()
"Render a password (hidden)."
display ,hidepw-mask))
(defun hidepw-turn-on ()
- "Turn on hidepw-mode."
+ "Turn on `hidepw-mode'."
(let ((props (make-local-variable 'font-lock-extra-managed-props)))
(add-to-list props 'display))
(font-lock-add-keywords nil (hidepw-font-lock-keywords)))
(defun hidepw-turn-off ()
- "Turn off hidepw-mode."
+ "Turn off `hidepw-mode'."
(font-lock-remove-keywords nil (hidepw-font-lock-keywords)))
;;;###autoload
-(define-minor-mode
- hidepw-mode
+(define-minor-mode hidepw-mode
"Hide passwords."
:lighter " HidePW"
(progn
projects / emacsconfig.git / commitdiff