Skip to content

A framework for creating zero-knowledge web applications

License

Notifications You must be signed in to change notification settings

thecloakproject/crypton

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Crypton

A framework for creating zero-knowledge web applications

What is Zero Knowledge?

Zero Knowledge applications offer meaningful privacy assurance to end users because the servers running the application cannot read the data created and stored by the application.

To learn more, check out the Crypton website.

WARNING

This is an early stage project at v0.0.1 which is a proof of core concepts. It is not yet intended for production use until v0.1.0. There are known serious bugs and weaknesses.

Most importantly, it has not been through a first round of refactoring, general code cleanup, and security review. It does not have comprehensive test coverage. All of these things will change in the versions between v0.0.1 and v0.1.0, at which point we'll make a first stable release that we encourage for production and commercial uses.

Get Started

To get started with Crypton development, you will need node.js v0.8.x with npm, and uglify-js. You will also need a postgresql server running on localhost (or edit the config file in the server/ directory).

Clone the repository and run make to install the rest of the dependencies and run the tests.

Documentation

There are files describing the high-level specification in the client/doc/ and server/doc/ directories, but currently, the best way to get a complete picture of the Crypton system is by understanding the database schema, in server/lib/stores/postgresql/setup.sql, which has lots of explanatory comments.

Getting Help

If you have questions that aren't answered by the provided documentation, you may contact us at crypton-discussion@crypton.io

Contributing

Check out the code from our GitHub repository! This is where we are keeping our wiki and issue tracker for the project, along with the JavaScript reference implementation.

If you are not a developer but would like to contribute in other ways, consider:

  • Becoming a Zero Knowledge Privacy Ambassador
  • Purchasing from companies that provide a product with meaningful privacy built in.
  • Contacting the creators of the software products you use, and making it clear you would appreciate them including privacy features.

License

See the LICENSE file.

About

A framework for creating zero-knowledge web applications

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published