tiararodney/httpaste
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merged in master (pull request #35)

Browse source 
docs: sound less like a smart-ass sales person
This commit is contained in:
Tiara Rodney 2022-04-10 11:45:39 +00:00
commit bab6c52706
5 changed files with 65 additions and 109 deletions
Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -2,28 +2,40 @@
![](docs/_assets/images/favpng_parrot-royalty-free-cartoon.png)
httpaste is a pastebin application for easily pasting and retrieving data over
HTTP from shell environments and web browsers. It is inspired by [sprunge.us](http://sprunge.us)
and [ix.io](http://ix.io/), but focuses on extendability, advanced security, with little to
no trade-off to simplicity. It can be hosted through WSGI, CGI, Fast CGI, or
as a standalone evaluation server. It offers multiple storage backends, such as
a filesystem backend, SQLite backend, MySQL backend, or MongoDB backend.
**NOTE**: httpaste is publicly hosted at [httpaste.it](http://httpaste.it) and as a hidden Tor service ([https://paste77ubkwxy4fqezffsmthxdh3xerwi72tlsw2mch7ecjhw2xn7iyd.onion](https://paste77ubkwxy4fqezffsmthxdh3xerwi72tlsw2mch7ecjhw2xn7iyd.onion)).
Both services are to be considered evaluatory, as long as the source code
is in pre-release. Regarding voidance of pre-release status, see [Open Issues](https://victorykit.atlassian.net/issues/?jql=project%20%3D%20HTTPASTE%20AND%20fixVersion%20in%20(1.1.0-beta%2C%201.2.0-beta%2C%201.3.0)), for more information.
All pastes are being encrypted on the fly and can only be retrieved by an
authorized user, either through knowing the paste id of a public paste, or
having authentication credentials, as well as the paste id of a private paste.
This makes httpaste ideal as a pastebin for sensitive environments such as the
Tor network. Authentication credentials are created on-the-fly and don’t require a sign-up process.
This program offers an HTTP interface for storing public and private data
(a.k.a. pastes), commonly referred to as a pastebin application. It is inspired by [sprunge.us](http://sprunge.us) and [ix.io](http://ix.io/). It can be hosted through WSGI, CGI, Fast
CGI, or as a standalone evaluation server. It offers multiple storage backends,
such as a filesystem backend, SQLite backend, or MySQL backend.
httpaste supports output formatting for syntax highlighting (powered by
Public data can be accessed through an URL, where as private pastes
additionally require HTTP basic authentication. Creation of authentication
credentials happens on the fly, there is no sign-up process. Public pastes can
only be accessed by knowing their paste ids, they are not listed on any index,
since it isn’t technically possible (by design).
All pastes are symetrically encrypted server-side with an HMAC derived key and
SHA-256 hashing, a server-side salt and a randomly generated password. Public
paste’s passwords are derived from their ids. Private paste’s passwords are
randomly generated and stored inside a symetrically encrypted personal
database, with the encryption key also being derived through the same HMAC
mechanism, where the HTTP basic authentication credentials act as the master
password.
Paste ids, usernames, and any other identifiable attributes are only stored
inside storage backends as keyed and salted BLAKE2 hashes.
The program supports output formatting for syntax highlighting (powered by
[pygments](https://pygments.org/)), as well as MIME type output manipulation, and input encoding.
Therefore httpaste can server as an anonymous object storage for small data.
The program can therefore serve as a minimalist, anonymous object storage for
small data.
Minute-based and ‘burn-after-read’ paste expiration are supported.
Minute-based and ‘burn-after-read’ paste expiration are also supported.
httpaste focuses on security through cryptography, making it a computationally intensive application.
# Get Started
# Getting Started
## Install

51
docs/README.rst
View file

@ -9,28 +9,41 @@ httpaste - versatile HTTP pastebin
.. image:: _assets/images/favpng_parrot-royalty-free-cartoon.png
httpaste is a pastebin application for easily pasting and retrieving data over
HTTP from shell environments and web browsers. It is inspired by `sprunge.us`_
and `ix.io`_, but focuses on extendability, advanced security, with little to
no trade-off to simplicity. It can be hosted through WSGI, CGI, Fast CGI, or
as a standalone evaluation server. It offers multiple storage backends, such as
a filesystem backend, SQLite backend, MySQL backend, or MongoDB backend.
.. note::
httpaste is publicly hosted at `httpaste.it`_ and as a hidden Tor service (`<https://paste77ubkwxy4fqezffsmthxdh3xerwi72tlsw2mch7ecjhw2xn7iyd.onion>`_).
Both services are to be considered evaluatory, as long as the source code
is in pre-release. Regarding voidance of pre-release status, see `Open Issues`_, for more information.
All pastes are being encrypted on the fly and can only be retrieved by an
authorized user, either through knowing the paste id of a public paste, or
having authentication credentials, as well as the paste id of a private paste.
This makes httpaste ideal as a pastebin for sensitive environments such as the
Tor network. Authentication credentials are created on-the-fly and don't require a sign-up process.
This program offers an HTTP interface for storing public and private data
(a.k.a. pastes), commonly referred to as a pastebin application. It is inspired by `sprunge.us`_ and `ix.io`_. It can be hosted through WSGI, CGI, Fast
CGI, or as a standalone evaluation server. It offers multiple storage backends,
such as a filesystem backend, SQLite backend, or MySQL backend.
httpaste supports output formatting for syntax highlighting (powered by
Public data can be accessed through an URL, where as private pastes
additionally require HTTP basic authentication. Creation of authentication
credentials happens on the fly, there is no sign-up process. Public pastes can
only be accessed by knowing their paste ids, they are not listed on any index,
since it isn't technically possible (by design).
All pastes are symetrically encrypted server-side with an HMAC derived key and
SHA-256 hashing, a server-side salt and a randomly generated password. Public
paste's passwords are derived from their ids. Private paste's passwords are
randomly generated and stored inside a symetrically encrypted personal
database, with the encryption key also being derived through the same HMAC
mechanism, where the HTTP basic authentication credentials act as the master
password.
Paste ids, usernames, and any other identifiable attributes are only stored
inside storage backends as keyed and salted BLAKE2 hashes.
The program supports output formatting for syntax highlighting (powered by
`pygments`_), as well as MIME type output manipulation, and input encoding.
Therefore httpaste can server as an anonymous object storage for small data.
The program can therefore serve as a minimalist, anonymous object storage for
small data.
Minute-based and 'burn-after-read' paste expiration are supported.
Minute-based and 'burn-after-read' paste expiration are also supported.
httpaste focuses on security through cryptography, making it a computationally intensive application.
.. include:: guide/get-started.rst
.. include:: guide/getting-started.rst
Documentation
-------------
@ -70,3 +83,7 @@ This program uses licensed third-party software.
.. _sprunge.us: http://sprunge.us
.. _pygments: https://pygments.org/
.. _icon: https://favpng.com/png_view/parrot-parrot-royalty-free-cartoon-png/gps7HM42
.. _Open Issues: https://victorykit.atlassian.net/issues/?jql=project%20%3D%20HTTPASTE%20AND%20fixVersion%20in%20(1.1.0-beta%2C%201.2.0-beta%2C%201.3.0)
.. _httpaste.it: http://httpaste.it

70
docs/guide/get-started.rst
View file

@ -1,70 +0,0 @@
Get Started
===========
Install
"""""""
.. code-block:: shell
$ python3 -m pip install httpaste-victorykit
$ httpaste --help
Create Configuration
""""""""""""""""""""
.. code-block:: shell
$ httpaste default-config --dump myconfig.ini
.. note::
The default configuration creates an in-memory SQLite backend, which is not
suitable for WWW deployments. Visit `backend`, for more
information on configuring the backend.
Run a Local Evaluation Server
"""""""""""""""""""""""""""""
.. code-block:: shell
$ httpaste standalone --config myconfig.ini --port 8080
Publish a Private Paste
"""""""""""""""""""""""
.. code-block:: shell
$ echo 'My first private paste' | curl -F 'data=<-' -u myusername:mypassword http://localhost:8080/paste/private
http://localhost:8080/paste/private/UALUA9
.. note::
If the user does not exist, they will be created upon authentication.
Retrieve a Private Paste
""""""""""""""""""""""""
.. code-block:: shell
$ curl -u myusername:mypassword http://localhost:8080/paste/private/UALUA9
My first private paste
Publish a Public Paste
""""""""""""""""""""""
.. code-block:: shell
$ echo 'My first public paste' | curl -F 'data=<-' http://localhost:8080/paste/public
http://localhost:8080/paste/public/X4L39J
Retrieve a Public Paste
""""""""""""""""""""""""
.. code-block:: shell
$ curl http://localhost:8080/paste/public/X4L39J
My first public paste

3
docs/guide/getting-started.rst
View file

@ -9,9 +9,6 @@ Install
$ python3 -m pip install httpaste-victorykit
$ httpaste --help
.. note::
httpaste is publicly available at `https://httpaste.it`_, and can be accessed
over the TOR network via `https://pastefao6mwyafs3cznoe2u2a6iizw5laulrznla3dytcnvaizte73yd.onion`_ aswell. Both are hosted on different servers of different service providers.
Create Configuration
""""""""""""""""""""

2
docs/index.rst
View file

@ -4,7 +4,7 @@
:maxdepth: 1
:caption: Guides
guide/get-started
guide/getting-started
guide/advanced-usage
guide/backend
guide/cli