cenotes 0.7.0

Cryptographical Expendable Notes

CENotes
=======

.. image:: https://travis-ci.org/cenotes/cenotes.svg?branch=master
:target: https://travis-ci.org/cenotes/cenotes

.. image:: https://readthedocs.org/projects/cenotes/badge/?version=latest
:target: https://cenotes.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

**C(ryptographical) E(xpendable) Notes**

- Free software: GNU General Public License v3

- `Backend & Frontend Demo`_

- Source code:

- `Backend`_
- `Frontend`_
- `CLI`_
- `Libraries`_

- `Documentation`_

- `Backend Design`_

What is this?
-------------
A **backend** project to support encryption/decryption of expendable notes

An example using this backend can be found at https://cenot.es

What this isn't
---------------
UI/Frontend. This is a **backend** project. Frontend solutions will be different projects.
The reason for this is to allow flexibility in frontend choice and to avoid huge bundle projects.

A **frontend** project that communicates with the **backend** can be found
`here <https://github.com/cenotes/cenotes-reaction>`_

Features
--------

* Symmetric encryption of notes using the `pynacl`_ project
* On the fly encryption/decryption
* Notes can be encrypted/decrypted on the fly without storing anything on the server
* Expiration date notes
* After that date, the notes are deleted and cannot be retrieved (default is never)
* Notes that are deleted after N visits
* After N retrievals of a note, the note is deleted (default is 1)
* Duress key for immediate note deletion
* Using the duress key instead of the real decryption key will delete the note and respond as if
the note didn't exist (to avoid indicating the use of the duress key)
* Persistent visit notes
* Notes can be marked as "persistent visit" so that that they are not deleted based on visit count


How does this work?
-------------------

See :doc:`design`


How to run
----------

See :doc:`run`


How to deploy
-------------

See :doc:`deployment`

Features to be added sometime
-----------------------------

* Modification of a note's settings
* Zero visit count
* Change max visits option
* Change expiration date
* Public key encryption and user database

Q&A
---

See :doc:`qa`


.. _Backend & Frontend Demo: https://cenot.es
.. _Backend: https://github.com/cenotes/cenotes
.. _Frontend: https://github.com/cenotes/cenotes-reaction
.. _CLI: https://github.com/cenotes/cenotes-cli
.. _Libraries: https://github.com/cenotes/cenotes-lib
.. _Documentation: https://cenotes.readthedocs.io
.. _Backend Design: https://cenotes.readthedocs.io/en/latest/design.html
.. _pynacl: https://pynacl.readthedocs.io/en/latest/
.. _design: https://cenotes.readthedocs.io/en/latest/design.html


=======
History
=======

0.7.0 (2017-12-14)
------------------
* Use the external package cenotes-lib

0.6.0 (2017-12-12)
------------------
* Use the external package cenotes-cli that provides cenotes_lib
* Officially drop py < 3.4 support

0.5.3 (2017-11-12)
------------------

* Big updates in documentation about design choices, and better documentation structure
* Updates obsolete HISTORY file

0.5.2 (2017-11-11)
------------------

* Fix MANIFEST typo

0.5.1 (2017-11-10)
------------------

* Add cleanup command for expired notes

0.5.0 (2017-11-09)
------------------

* Add duress key support to allow an immediate deletion in cases of emergency
* Update documentation

0.4.0 (2017-11-09)
------------------

* Allow post request for decrypt mode to have shorter urls in no-store cases
* Update documentation

0.3.0 (2017-10-23)
------------------

* Fixes on the packaged version

0.2.2 (2017-10-23)
------------------

* First release