emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Pieter Praet <pieter@praet.org>
To: emacs-orgmode@gnu.org
Cc: Dave Abrahams <dave@boostpro.com>, Bastien <bzg@altern.org>,
	Nick Dokos <nicholas.dokos@hp.com>
Subject: [PATCH] org-crypt: make org-decrypt disable auto-save-mode (configurable)
Date: Tue, 28 Jun 2011 08:57:39 +0200	[thread overview]
Message-ID: <1309244259-16494-1-git-send-email-pieter@praet.org> (raw)
In-Reply-To: <87k4c6fnrh.fsf@praet.org>

As auto-save-mode can only cause leakage when there's actual decrypted
data lying around, don't check for it (and potentially cause annoyance)
on init, but only when org-decrypt-entry is called.

* lisp/org-crypt.el:
  - add defcustom `org-crypt-disable-auto-save'
  - `org-decrypt-entry': before decrypting, check whether
    `auto-save-mode' is enabled for the current buffer, and act
    on it according to how `org-crypt-disable-auto-save' is set.
  - remove comment re "encrypt[ing] Org auto-saved buffers"
  - remove on-init check for `auto-save-default'

Signed-off-by: Pieter Praet <pieter@praet.org>
---
 lisp/org-crypt.el |   60 +++++++++++++++++++++++++++++++++++++++++-----------
 1 files changed, 47 insertions(+), 13 deletions(-)

diff --git a/lisp/org-crypt.el b/lisp/org-crypt.el
index 4bff7a1..1ff24b9 100644
--- a/lisp/org-crypt.el
+++ b/lisp/org-crypt.el
@@ -94,6 +94,29 @@ This setting can also be overridden in the CRYPTKEY property."
   :type 'string 
   :group 'org-crypt)
 
+(defcustom org-crypt-disable-auto-save 'ask
+  "What org-decrypt should do if `auto-save-mode' is enabled.
+
+t        : Disable auto-save-mode for the current buffer
+           prior to decrypting an entry.
+
+nil      : Leave auto-save-mode enabled.
+           This may cause data to be written to disk unencrypted!
+
+'ask     : Ask user whether or not to disable auto-save-mode
+           for the current buffer.
+
+'encrypt : Leave auto-save-mode enabled for the current buffer,
+           but automatically re-encrypt all decrypted entries
+           *before* auto-saving.
+           NOTE: This only works for entries which have a tag
+           that matches `org-crypt-tag-matcher'."
+  :group 'org-crypt
+  :type '(choice (const :tag "Always"  t)
+                 (const :tag "Never"   nil)
+                 (const :tag "Ask"     ask)
+                 (const :tag "Encrypt" encrypt)))
+
 (defun org-crypt-key-for-heading ()
   "Return the encryption key for the current heading."
   (save-excursion
@@ -142,6 +165,30 @@ This setting can also be overridden in the CRYPTKEY property."
 (defun org-decrypt-entry ()
   "Decrypt the content of the current headline."
   (interactive)
+
+  ; auto-save-mode may cause leakage, so check whether it's enabled.
+  (when buffer-auto-save-file-name
+    (cond
+     ((or
+       (eq org-crypt-disable-auto-save t)
+       (and
+        (eq org-crypt-disable-auto-save 'ask)
+        (y-or-n-p "org-decrypt: auto-save-mode may cause leakage. Disable it for current buffer? ")))
+      (message (concat "org-decrypt: Disabling auto-save-mode for " (or (buffer-file-name) (current-buffer))))
+      ; The argument to auto-save-mode has to be "-1", since
+      ; giving a "nil" argument toggles instead of disabling.
+      (auto-save-mode -1))
+     ((eq org-crypt-disable-auto-save nil)
+      (message "org-decrypt: Decrypting entry with auto-save-mode enabled. This may cause leakage."))
+     ((eq org-crypt-disable-auto-save 'encrypt)
+      (message "org-decrypt: Enabling re-encryption on auto-save.")
+      (add-hook 'auto-save-hook
+                (lambda ()
+                  (message "org-crypt: Re-encrypting all decrypted entries due to auto-save.")
+                  (org-encrypt-entries))
+                nil t))
+     (t nil)))
+
   (require 'epg)
   (unless (org-before-first-heading-p)
     (save-excursion
@@ -201,19 +248,6 @@ This setting can also be overridden in the CRYPTKEY property."
    'org-mode-hook
    (lambda () (add-hook 'before-save-hook 'org-encrypt-entries nil t))))
 
-;; FIXME Find a better way to encrypt Org auto-saved buffers?
-;; When `auto-save-default' is non-nil, make sure entries are
-;; encrypted before auto-saving
-;; (when auto-save-default
-;;    (add-hook
-;;     'org-mode-hook
-;;     (lambda () (add-hook 'auto-save-hook 'org-encrypt-entries nil t))))
-
-(when (and (functionp 'daemonp)
-	   (not (daemonp)) auto-save-default)
-  (message "Warning: turn auto-save-mode off in Org buffers containing crypted entries.")
-  (sit-for 1))
-
 (add-hook 'org-reveal-start-hook 'org-decrypt-entry)
 
 (provide 'org-crypt)
-- 
1.7.4.1

  reply	other threads:[~2011-06-28  6:58 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-04-30 21:34 Documentation suggestion re: buffers containing crypted entries Bill Day
2011-05-02  3:42 ` Darlan Cavalcante Moreira
2011-06-12 20:41   ` Dave Abrahams
2011-06-24 10:04     ` Eric S Fraga
2011-06-24 10:53       ` Bastien
2011-06-24 13:42         ` Eric S Fraga
2011-06-27 16:56           ` Bastien
2011-06-28 13:29             ` Darlan Cavalcante Moreira
2011-06-24 21:03         ` [PATCH] org-crypt: only warn about auto-save-mode when running org-decrypt Pieter Praet
2011-06-24 21:50           ` Nick Dokos
2011-06-26  6:38             ` Pieter Praet
2011-06-26  8:38               ` [PATCH] org-crypt: make org-decrypt disable auto-save-mode (configurable) Pieter Praet
2011-06-27 16:31               ` [PATCH] org-crypt: only warn about auto-save-mode when running org-decrypt Bastien
2011-06-28  6:55                 ` Pieter Praet
2011-06-28  6:57                   ` Pieter Praet [this message]
2011-06-28 10:04                     ` [PATCH] org-crypt: make org-decrypt disable auto-save-mode (configurable) Bastien
2011-06-28 10:05                   ` [PATCH] org-crypt: only warn about auto-save-mode when running org-decrypt Bastien
2011-06-24 11:57       ` Documentation suggestion re: buffers containing crypted entries Bernt Hansen
2011-06-27 16:55 ` Bastien

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1309244259-16494-1-git-send-email-pieter@praet.org \
    --to=pieter@praet.org \
    --cc=bzg@altern.org \
    --cc=dave@boostpro.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=nicholas.dokos@hp.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).