Function: allout-toggle-current-subtree-encryption

allout-toggle-current-subtree-encryption is an interactive and byte-compiled function defined in allout.el.gz.

Signature

(allout-toggle-current-subtree-encryption &optional KEYMODE-CUE)

Documentation

Encrypt clear or decrypt encoded topic text.

Allout uses Emacs epg library to perform encryption. Symmetric and keypair encryption are supported. All encryption is ascii armored.

Entry encryption defaults to symmetric key mode unless keypair recipients are associated with the file (see epa-file-encrypt-to) or the function is invoked with a
(KEYMODE-CUE) universal argument greater than 1.

When encrypting, KEYMODE-CUE universal argument greater than 1 causes prompting for recipients for public-key keypair encryption. Selecting no recipients results in symmetric key encryption.

Further, encrypting with a KEYMODE-CUE universal argument greater than 4 - eg, preceded by a doubled Ctrl-U - causes association of the specified recipients with the file, replacing those currently associated with it. This can be used to dissociate any recipients with the file, by selecting no recipients in the dialog.

Encrypted topic's bullets are set to a ~ to signal that the contents of the topic (body and subtopics, but not heading) is pending encryption or encrypted. * asterisk immediately after the bullet signals that the body is encrypted, its absence means the topic is meant to be encrypted but is not currently. When a file with topics pending encryption is saved, topics pending encryption are encrypted. See allout-encrypt-unencrypted-on-saves for auto-encryption specifics.

*NOTE WELL* that automatic encryption that happens during saves will
default to symmetric encryption -- you must deliberately (re)encrypt key-pair encrypted topics if you want them to continue to use the key-pair cipher.

Level-one topics, with prefix consisting solely of an * asterisk, cannot be encrypted. If you want to encrypt the contents of a top-level topic, use M-x allout-shift-in (allout-shift-in) to increase its depth.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/allout.el.gz
;;;_ #8 Encryption
;;;_  > allout-toggle-current-subtree-encryption (&optional keymode-cue)
(defun allout-toggle-current-subtree-encryption (&optional keymode-cue)
  "Encrypt clear or decrypt encoded topic text.

Allout uses Emacs `epg' library to perform encryption.  Symmetric
and keypair encryption are supported.  All encryption is ascii
armored.

Entry encryption defaults to symmetric key mode unless keypair
recipients are associated with the file (see
`epa-file-encrypt-to') or the function is invoked with a
\(KEYMODE-CUE) universal argument greater than 1.

When encrypting, KEYMODE-CUE universal argument greater than 1
causes prompting for recipients for public-key keypair
encryption.  Selecting no recipients results in symmetric key
encryption.

Further, encrypting with a KEYMODE-CUE universal argument greater
than 4 - eg, preceded by a doubled Ctrl-U - causes association of
the specified recipients with the file, replacing those currently
associated with it.  This can be used to dissociate any
recipients with the file, by selecting no recipients in the
dialog.

Encrypted topic's bullets are set to a `~' to signal that the
contents of the topic (body and subtopics, but not heading) is
pending encryption or encrypted.  `*' asterisk immediately after
the bullet signals that the body is encrypted, its absence means
the topic is meant to be encrypted but is not currently.  When a
file with topics pending encryption is saved, topics pending
encryption are encrypted.  See `allout-encrypt-unencrypted-on-saves'
for auto-encryption specifics.

*NOTE WELL* that automatic encryption that happens during saves will
default to symmetric encryption -- you must deliberately (re)encrypt key-pair
encrypted topics if you want them to continue to use the key-pair cipher.

Level-one topics, with prefix consisting solely of an `*' asterisk, cannot be
encrypted.  If you want to encrypt the contents of a top-level topic, use
\\[allout-shift-in] to increase its depth."
  (interactive "P")
  (save-excursion
    (allout-back-to-current-heading)
    (allout-toggle-subtree-encryption keymode-cue)))