Go to file
rugk b01a28d580
remove some more this, slightly change comments
2017-02-08 14:15:58 +01:00
.github 📝 Simplify isue & PR template 2017-02-08 09:29:31 +01:00
cfg Add CSP sandbox 2017-02-01 18:34:13 +01:00
css tagging 1.1 release and updating documentation 2016-12-26 12:13:50 +01:00
doc introduced JSDoc: changes for JSDoc compatibility and resolving inconsistencies in documentation, both semantic and in the logic 2017-01-14 15:29:12 +01:00
i18n Update ru.json 2017-02-06 20:42:37 +03:00
img moved images to img folder 2017-01-08 10:13:12 +01:00
js remove some more this, slightly change comments 2017-02-08 14:15:58 +01:00
lib Add CSP sandbox 2017-02-01 18:34:13 +01:00
tpl Use revealing module pattern 2017-02-08 13:20:51 +01:00
tst starting to work on JSVerify & Mocha based unit tests for our JS code base 2017-01-29 14:31:44 +01:00
vendor Add CSP sandbox 2017-02-01 18:34:13 +01:00
.codeclimate.yml reverting some of the changes done to try to support HHVM building, simplifying the dependencies 2016-07-11 15:52:08 +02:00
.csslintrc add codeclimate settings 2016-07-06 13:20:14 +02:00
.dockerignore Add .dockerignore 2016-12-23 20:01:17 +01:00
.editorconfig Add missing fixers from PHP CS 2016-10-31 11:29:25 +01:00
.eslintignore add codeclimate settings 2016-07-06 13:20:14 +02:00
.eslintrc Use revealing module pattern 2017-02-08 13:20:51 +01:00
.gitattributes starting to work on JSVerify & Mocha based unit tests for our JS code base 2017-01-29 14:31:44 +01:00
.gitignore ignoring composer.lock, so it isn't accidentally checked in (again) 2017-01-29 15:11:04 +01:00
.htaccess.disabled Add Facebook to robot block list 2017-01-03 17:46:26 +01:00
.php_cs Add missing fixers from PHP CS 2016-10-31 11:29:25 +01:00
.styleci.yml Add missing fixers from PHP CS 2016-10-31 11:29:25 +01:00
.travis.yml reverting some of the changes done to try to support HHVM building, simplifying the dependencies 2016-07-11 15:52:08 +02:00
CHANGELOG.md added supported language, updated credits and changelog 2017-01-10 20:37:14 +01:00
CREDITS.md added supported language, updated credits and changelog 2017-01-10 20:37:14 +01:00
Dockerfile Add a Dockerfile 2016-12-23 18:56:49 +01:00
INSTALL.md imported changes from the wiki by @Based-Skid and @rugk 2017-01-14 15:32:14 +01:00
LICENSE.md updating docs 2016-08-22 10:34:37 +02:00
README.md tagging 1.1 release and updating documentation 2016-12-26 12:13:50 +01:00
browserconfig.xml moved images to img folder 2017-01-08 10:13:12 +01:00
composer.json fixing composer package versions, thanks @jelhan (#84) 2017-01-30 20:36:38 +01:00
index.php updated SRI hashes, added missing formula for slowene plurals and unit test for it, updated credits and changelog 2017-01-01 14:35:39 +01:00
manifest.json moved images to img folder 2017-01-08 10:13:12 +01:00
robots.txt Some rewording 2016-07-19 13:05:07 +02:00

README.md

PrivateBin

Build Status Build Status
Codacy Badge Code Climate Scrutinizer Code Quality SensioLabsInsight
Codacy Badge Test Coverage Code Coverage

Current version: 1.1

PrivateBin is a minimalist, open source online pastebin where the server has zero knowledge of pasted data.

Data is encrypted/decrypted in the browser using 256bit AES in Galois Counter mode.

This is a fork of ZeroBin, originally developed by Sébastien Sauvage. It was refactored to allow easier and cleaner extensions and has now much more features than the original. It is however still fully compatible to the original ZeroBin 0.19 data storage scheme. Therefore such installations can be upgraded to this fork without loosing any data.

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 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, your internet provider and any country the traffic passes not to inject any malicious javascript code. For a basic security the PrivateBin installation has to provide HTTPS! Additionally it should be secured by HSTS and ideally by HPKP using a certificate either validated by a trusted third party (check the certificate when first using a new PrivateBin instance) or self-signed by the server operator, validated using a DNSSEC protected DANE record.

  • The "key" used to encrypt the paste is part of the URL. If you publicly post 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 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. PrivateBin 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 PrivateBin.
    Therefore do not access any PrivateBin instance if you think it has been compromised. As long as no user accesses this instance with a previously generated URL, the content can''t be decrypted.

Options

Some features are optional and can be enabled or disabled in the configuration file:

  • Password protection

  • Discussions, anonymous or with nicknames and IP based identicons or vizhashes

  • Expiration times, including a "forever" and "burn after reading" option

  • Markdown format support for HTML formatted pastes, including preview function

  • 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 are bootstrap CSS, darkstrap and "classic ZeroBin" themes 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

Run into any issues? Have ideas for further developments? Please report them!