PrivateBin/README.md

106 lines
5.2 KiB
Markdown
Raw Normal View History

2016-07-09 18:23:53 +08:00
# PrivateBin 0.22
2016-07-04 20:00:49 +08:00
[![Build Status](https://travis-ci.org/elrido/ZeroBin.svg?branch=master)](https://travis-ci.org/elrido/ZeroBin)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/094500f62abf4c9aa0c8a8a4520e4789)](https://www.codacy.com/app/PrivateBin/PrivateBin)
2016-07-09 18:33:33 +08:00
[![Code Climate](https://codeclimate.com/github/PrivateBin/PrivateBin/badges/gpa.svg)](https://codeclimate.com/github/PrivateBin/PrivateBin)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/094500f62abf4c9aa0c8a8a4520e4789)](https://www.codacy.com/app/PrivateBin/PrivateBin)
2016-07-09 18:33:33 +08:00
[![Test Coverage](https://codeclimate.com/github/PrivateBin/PrivateBin/badges/coverage.svg)](https://codeclimate.com/github/PrivateBin/PrivateBin/coverage)
2013-02-23 07:44:06 +08:00
2016-07-09 18:23:53 +08:00
PrivateBin is a minimalist, open source online pastebin where the server has zero
knowledge of pasted data.
2012-04-22 17:48:39 +08:00
Data is encrypted/decrypted in the browser using 256 bit AES.
2012-04-22 17:48:39 +08:00
This is a fork of ZeroBin, originally developed by
[Sébastien Sauvage](https://github.com/sebsauvage/ZeroBin). It was refactored
2016-07-04 18:55:49 +08:00
to allow easier and cleaner extensions and has now much more features than the
2016-07-09 18:23:53 +08:00
original. It is however still fully compatible to the original PrivateBin 0.19
data storage scheme. Therefore such installations can be upgraded to this fork
without loosing any data.
2016-07-09 18:23:53 +08:00
## What PrivateBin provides
+ As a server administrator you don't have to worry if your users post content
that is considered illegal in your country. You have no knowledge of any
of the pastes content. If requested or enforced, you can delete any paste from
your system.
+ Pastebin-like system to store text documents, code samples, etc.
+ Encryption of data sent to server.
+ Possibility to set a password which is required to read the paste. It further
2015-09-04 04:22:59 +08:00
protects a paste and prevents people stumbling upon your paste's link
from being able to read it without the password.
## What it doesn't provide
- As a user you have to trust the server administrator. If the server you use does
not use HTTPS (which is *not* recommend!) you also have to trust your internet provider
2015-09-04 04:22:59 +08:00
and any country the traffic passes not to inject any malicious javascript code.
All ZeroBin installation should use HTTPS. Ideally secured by
2015-11-10 03:43:24 +08:00
[HSTS](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) and
2016-02-03 07:33:50 +08:00
[HPKP](https://en.wikipedia.org/wiki/HTTP_Public_Key_Pinning) using a
certificate either validated by a trusted third party (in most cases Certificate
Authorities) or self-signed by the server operator, validated using a
2015-11-10 03:43:24 +08:00
[DNSSEC](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) protected
[DANE](https://en.wikipedia.org/wiki/DNS-based_Authentication_of_Named_Entities)
record.
- The "key" used to encrypt the paste is part of the URL. If you publicly post
2015-09-04 04:22:59 +08:00
the URL of a paste that is not password-protected, everybody can read it.
Use a password if you want your paste to be private. In this case make sure to
2016-07-09 17:52:26 +08:00
use a strong password and do only share it privately and end-to-end-encrypted.
- A server admin might be forced to hand over access logs to the authorities.
ZeroBin encrypts your text and the discussion contents, but who accessed it
first might still be disclosed via such access logs.
- In case of a server breach your data is secure as it is only stored encrypted on
the server. However the server could be misused or the server admin could be legally
forced into sending malicious JavaScript to all web users, which grabs the decryption key
and send it to the server when a user accesses a ZeroBin.
Therefore do not access any ZeroBin instance if you think it has been compromised. As long
as no user accesses this instance with a previously generated URL, the content cannot be
decrypted.
## Options
Some features are optional and can be enabled or disabled in the [configuration
file](https://github.com/PrivateBin/PrivateBin/wiki/Configuration):
* Password protection
2015-09-04 04:22:59 +08:00
* Discussions
* Expiration times, including a "forever" and "burn after reading" option
* Markdown format support for HTML formatted pastes
* Syntax highlighting for source code using prettify.js, including 4 prettify themes
* File upload support, images get displayed (disabled by default, possibility to adjust size limit)
* Templates: By default there is a bootstrap CSS and a "classic ZeroBin" theme
and it is easy to adapt these to your own websites layout or create your own.
* Translation system and automatic browser language detection (if enabled in browser)
* Language selection (disabled by default, as it uses a session cookie)
## Further resources
2012-04-22 17:48:39 +08:00
* [Installation guide](https://github.com/PrivateBin/PrivateBin/wiki/Installation)
2012-04-22 17:48:39 +08:00
* [Upgrading from 0.19 Alpha](https://github.com/PrivateBin/PrivateBin/wiki/Upgrading-from-ZeroBin-0.19-Alpha)
2012-04-22 17:48:39 +08:00
* [Configuration guide](https://github.com/PrivateBin/PrivateBin/wiki/Configuration)
2012-04-22 17:48:39 +08:00
* [Templates](https://github.com/PrivateBin/PrivateBin/wiki/Templates)
2012-04-22 17:48:39 +08:00
* [Translation guide](https://github.com/PrivateBin/PrivateBin/wiki/Translation)
2012-04-22 17:48:39 +08:00
* [Developer guide](https://github.com/PrivateBin/PrivateBin/wiki/Development)
2012-04-22 17:48:39 +08:00
Run into any issues? Have ideas for further developments? Please
[report](https://github.com/PrivateBin/PrivateBin/issues) them!