croodle

Croodle is a web application to schedule a date or to do a poll on a general topics. Stored content data like title and description, number and labels of options and available answers and names of users and there selections is encrypted/decrypted in the browser using 256 bits AES.

This is an alpha version. Changes could brake backward compatibility. Also it is not well tested and some features are missing. It is not ment for productive use yet.

Croodle is inspired by PrivateBin and, of course, by Doodle.

Security notice

As any other web application based end-to-end encryption Croodle could be attacked by an injection of malicious code on serverside or threw a man-in-the-middle attack. If an attacker could inject for example JavaScript, he would be able to read decrypted content in the browser or the encryption key used and send it to a server under his controll.

Therefore you have to

use an encrypted connection to the server hosting Croodle. In most use cases this will be an httpS connection. We strongly recomend people hosting Croodle to force an encrypted connection.
trust the server.

You could check for an attack like this by analysing the source code retrieved from server and/or using developer tools of your browser and check what data is send over the network or stored in cookies, localStorage or similar browser techniques.

Requirements

Croodle is designed to have as few as possible requirements on the server it is running on. Croodle runs on almost every web space with PHP >= 5.6. Croodle stores the data in textfiles, so there is no need for a database server like mySQL.

Due to security reasons you should have SSL encryption enabled and provide a valid certificate.

Build process and installation

Production builds are provided as github release assets.

If you like to build yourself you have to install yarn, ember-cli and composer before.

git clone git@github.com:jelhan/croodle.git
cd croodle
yarn install
cd api/ && composer install --no-dev && cd ..
ember build --prod

Afterwards copy all files in /dist folder to your werbserver.

Configuration

Api could be configured by creating a config.php inside api/ folder which returns an associative array. Have a look at api/config.default.php for available options.

Webserver configuration

data/ folder has to be writeable by web server, but must not be accessible publicy. Protect it in your webserver configuration or move it out of webroot by changing dataDir api option.
Croodle uses subresource integrity (SRI) for assets. Therefore you must not tamper with build output (e.g. you have to disable cloudflare Auto Minify feature). If that's not an option for you, you have to disable SRI and build yourself.
HTTPS connection should be forced. You should consider using HTTP Strict Transport Security (HSTS) and HTTP Public Key Pinning (HPKP).
Content-Security-Policy (CSP) should be used. Default CSP headers are provided in .htaccess file but commented out.
Execute php api/cron.php on a regular basis to delete outdated polls. A cronjob running once a day should be fine.

Development

ember serve generates a development build of croodle and starts a server listening on http://localhost:4200 which is serving it. If source files are changing, a rebuild and reload is triggered.

By default croodle uses an api mock in development. Since that one does not persist records all polls are gone after a reload.

If you like to test against real api, run api via php built-in web server: php -S 127.0.0.1:8080 -t dist/ Afterwards start ember-cli development server using --proxy option: ember server --proxy http://127.0.0.1:8080.

Ember-cli clears dist folder on each rebuild. If you like to keep created polls over rebuild, configure api to use a non default folder to save your polls: CROODLE__DATA_DIR=/tmp/croodle_data php -S 127.0.0.1:8080 -t dist/

Running tests

Ember

ember test --server is the prefered way to run tests in Chrome. Results are reported in command-line and browser. Files are watched for changes.

If you like to run tests only once in a headless Chrome execute ember test. This is also used in CI.

Additionally tests are available in all development builds. This allows you to execute the tests in any browser of your choice by running ember serve and opening http://locahost:4200/tests.

Tests are run against a mock-api provided by ember-cli-mirage. Therefor they don't cover system integration.

Api

Api tests are provided by Codeception. To run them change current directory to /api and execute ./vendor/bin/codecept run. You have to install composer development requirements before (composer install without --no-dev option).

License

croodle is MIT Licensed.

mspae/croodle