emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* org-crypt.el --- Public key encryption for org-mode entries
@ 2007-09-29  3:48 John Wiegley
  2007-09-29 17:53 ` Jason F. McBrayer
                   ` (2 more replies)
  0 siblings, 3 replies; 5+ messages in thread
From: John Wiegley @ 2007-09-29  3:48 UTC (permalink / raw)
  To: emacs-orgmode

The following code is preliminary, but gets the job done in my simple tests.
Now's the time to beat down on, and refine, the user interface and behavior.

John

;;; org-crypt.el --- Public key encryption for org-mode entries

;; Copyright (C) 2007 John Wiegley <johnw@gnu.org>

;; Emacs Lisp Archive Entry
;; Filename: org-crypt.el
;; Version: 0.1
;; Keywords: org-mode
;; Author: John Wiegley <johnw@gnu.org>
;; Maintainer: John Wiegley <johnw@gnu.org>
;; Description: Adds public key encryption to org-mode buffers
;; URL: http://www.newartisans.com/software/emacs.html
;; Compatibility: Emacs22

;; This file is not part of GNU Emacs.

;; This 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 2, or (at your option) any later
;; version.
;;
;; This 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; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
;; MA 02111-1307, USA.

;;; Commentary:

;; Right now this is just a set of functions to play with.  It depends on the
;; epg library.  Here's how you would use it:
;;
;; 1. To mark an entry for encryption, use `M-x org-set-property' to set the
;;    property CRYPTKEY to any address in your public keyring.  The text of
;;    the entry (but not its properties or headline) will be encrypted for
;;    this user.  For them to read it, the corresponding secret key must be
;;    located in the secret key ring of the account where you try to decrypt
;;    it.  This makes it possible to leave secure notes that only the intended
;;    recipient can read in a shared-org-mode-files scenario.
;;
;; 2. Next, at the top of your org-mode buffer, add this line:
;;
;;      -*- mode: org; after-save-hook: (org-encrypt-entries) -*-
;;
;;    This ensures that entries marked for encryption are encrypted whenever
;;    the file is saved.  If you want encryption to be manual, use `M-x
;;    org-encrypt-entries'.  Note that in this version -- mainly because I
;;    don't know epg.el better -- you will be asked for your password for
;;    every entry that needs encryption.
;;
;; 3. To later decrypt an entry, use `M-x org-decrypt-entry'.  It might be
;;    useful to bind this to a key, like C-c C-/.  I hope that in the future,
;;    C-c C-r can be might overloaded to also decrypt an entry if it's
;;    encrypted, since that fits nicely with the meaning of "reveal".

(require 'epg)

(defun org-encrypt-entries ()
  (interactive)
  (save-excursion
    (goto-char (point-min))
    (while (not (eobp))
      (outline-next-heading)
      (let* ((props (org-entry-properties))
	     (crypt-key (and props (cdr (assoc "CRYPTKEY" props)))))
	(when (and crypt-key (stringp crypt-key))
	  (forward-line)
	  (unless (looking-at "-----BEGIN PGP MESSAGE-----")
	    (let* ((begin (point))
		   (end (save-excursion
			  (goto-char (car (org-get-property-block begin)))
			  (forward-line -1)
			  (point)))
		   (epg-context (epg-make-context nil t t))
		   (encrypted-text
		    (epg-encrypt-string
		     epg-context
		     (buffer-substring-no-properties begin end)
		     (epg-list-keys epg-context crypt-key) t)))
	      (delete-region begin end)
	      (insert encrypted-text))))))))

(defun org-decrypt-entry ()
  (interactive)
  (save-excursion
    (let* ((props (org-entry-properties))
	   (crypt-key (and props (cdr (assoc "CRYPTKEY" props)))))
      (when (and crypt-key (stringp crypt-key))
	(org-back-to-heading t)
	(forward-line)
	(when (looking-at "-----BEGIN PGP MESSAGE-----")
	  (let* ((begin (point))
		 (end (save-excursion
			(goto-char (car (org-get-property-block begin)))
			(forward-line -1)
			(point)))
		 (epg-context (epg-make-context nil t t))
		 (decrypted-text
		  (epg-decrypt-string
		   epg-context
		   (buffer-substring-no-properties begin end))))
	    (delete-region begin end)
	    (insert decrypted-text)))))))

(provide 'org-crypt)

;;; org-crypt.el ends here

^ permalink raw reply	[flat|nested] 5+ messages in thread
end of thread, other threads:[~2010-03-21  7:18 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2007-09-29  3:48 org-crypt.el --- Public key encryption for org-mode entries John Wiegley
2007-09-29 17:53 ` Jason F. McBrayer
2007-09-29 23:38   ` John Wiegley
2007-12-29 20:19 ` Adam Spiers
2010-03-21  7:18 ` Carsten Dominik

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).