Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/keyweeusr/org-epa-gpg

Enable toggling inline images in org-mode for epa-enabled / encrypted files
https://github.com/keyweeusr/org-epa-gpg

easypg emacs emacs-lisp emacs-package epa gpg gpg-encryption org org-mode

Last synced: 25 days ago
JSON representation

Enable toggling inline images in org-mode for epa-enabled / encrypted files

Awesome Lists containing this project

README 

        
# org-epa-gpg

[![MELPA][melpa-badge]][melpa-package]

[![MELPA Stable][melpa-stable-badge]][melpa-stable-package]

[![CI][ci-badge]][ci-workflow]

[![Coverage Status][cover-badge]][cover-link]

[![Buy me a coffee][bmc-badge]][bmc-link]

[![Liberapay][lp-badge]][lp-link]

[![PayPal][ppl-badge]][ppl-link]



This is a patch that attempts to fix image inlining (C-c C-x C-v) in

the org-mode for images that are encrypted AND end with ".gpg" extension.



## How to



Install it from [Melpa](https://melpa.org/#/getting-started) or clone and

install manually.



To start, add these mandatory lines to your config file:



```emacs-lisp

(use-package org-epa-gpg

  :ensure t

  :after epa-file

  :config (org-epa-gpg-enable))

```



## Notes on purging



The cleaning of the decrypted content (in /tmp via (make-temp-file) )

is currently done via patching (org-remove-inline-images) with a custom

hook (so that it's purged on (C-c C-x C-v) untoggling and via attaching

to multiple standard hooks.



### Attempted



What I attempted to make it less insane:

* purge the files right after decrypting and loading

  -> this causes an empty rectangle to be shown in the buffer

* hook to standard hooks such as:

  * buffer-list-update-hook

    -> basically kills Emacs by making it frozen due to too many updates

    and the initial startup with few hundreds of buffers opened is

    a time to go for a coffee

  * change-major-mode / after-change-major-mode-hook / org-mode-hook

    -> is unreliable from security perspective due to being too slow



### Current behavior



So I added the purging to these hooks so that an action of "going away"

from the org buffer or from Emacs alone, which would potentially endanger

the unencrypted data, would also purge them. It's also trying to minimize

their overall presence too `org-epa-gpg-purging-hooks`.



A timer could possibly be added with a very short interval, but it doesn't seem

feasible if the amount of images is more than a few (large Org documents) due

to 1:1 (image:purger) relationship in `list-timers' possibly hogging Emacs down

readability-/resource-wise.  Or at least, if turned on by default.



[melpa-badge]: http://melpa.org/packages/org-epa-gpg-badge.svg

[melpa-package]: http://melpa.org/#/org-epa-gpg

[melpa-stable-badge]: http://stable.melpa.org/packages/org-epa-gpg-badge.svg

[melpa-stable-package]: http://stable.melpa.org/#/org-epa-gpg

[bmc-badge]: https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee

[bmc-link]: https://www.buymeacoffee.com/peterbadida

[ppl-badge]: https://img.shields.io/badge/-paypal-grey?logo=paypal

[ppl-link]: https://paypal.me/peterbadida

[lp-badge]: https://img.shields.io/badge/-liberapay-grey?logo=liberapay

[lp-link]: https://liberapay.com/keyweeusr

[ci-badge]: https://github.com/KeyWeeUsr/org-epa-gpg/actions/workflows/test.yml/badge.svg

[ci-workflow]: https://github.com/KeyWeeUsr/org-epa-gpg/actions/workflows/test.yml

[cover-badge]: https://coveralls.io/repos/github/KeyWeeUsr/org-epa-gpg/badge.svg?branch=master

[cover-link]: https://coveralls.io/github/KeyWeeUsr/org-epa-gpg?branch=master