unsakini 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c2db76ad117d5f468e15d77b47f47ee6e6235bc
-  data.tar.gz: 3d18db630e818d60aa071caa7cda14e7e4302b78
+  metadata.gz: e1f7610a7b1efe62c3b15aec2b07754e303a134e
+  data.tar.gz: 109ce1ca7cc41e28c30552208ae6464d6f913dfb
 SHA512:
-  metadata.gz: 316d42aba0b7cf7362f7bc84b481d576dcff778916d456ab9ad7bc390196fb853d5bc3b036886485734308349c3d224010ec40db6c4bc49559fb33dadc2d8f0a
-  data.tar.gz: 9b7aaa3f513a66d2d8916baf8f7439e5437db28acf78ffda14f8a70306b922c53f469206999097b727046285efb1c794ec5d84228b3dca8ecfee0b3482447662
+  metadata.gz: 59b4a535023fb8336a688f365d4020a129157c0a0724707f3a08dfe850f07653b999d566fd5cb60386df036e5d871d2c7d88c2d4a08d71a528454f20dfb87b7e
+  data.tar.gz: b1c52c6ccb7c51ac5b7fba768700c5444d715290196dc45fde2a47bae2aa92cf708885eb9bc90f4d95e413e83df8772e3912310a1d2855cf69570838d19d7c78

data/README.md

@@ -1,28 +1,80 @@
-# Unsakini
-Short description and motivation.
+[![Build Status](https://travis-ci.org/adonespitogo/unsakini.svg?branch=master)](https://travis-ci.org/adonespitogo/unsakini)
 
-## Usage
-How to use my plugin.
+UNSAKINI
+-----------
+*Created by and for online activists, information security enthusiasts and government surveillance evaders.*
 
-## Installation
-Add this line to your application's Gemfile:
 
-```ruby
-gem 'unsakini'
-```
+**[Unsakini](https://www.unsakini.com)** is an open source encrypted bulletin board created with the aim of evading global information surveillance and spying, preventing data leaks and promoting information confidentiality and integrity.
+
+Perfect for:
+
+ - group discussions on sensitive issues
+ - confidential conversations
+ - storing passwords, liscenses, credit card details, and other sensitive documents
+
+
+-------------------------
+
+### How it Works
+Upon using the system, you'll be asked to provide your private key. This key is used to encrypt your data before it is sent to the server. If you look at the network traffic in the browser network tab (by pressing F12 and selecting network tab), you'll see that sensitive data sent to the server are gibberesh. This is because they are encrypted using your private key before it leaves your web browser. The key is stored in your computer and is never sent to the server. Only you have access to your private key, thus only you can read your data.
+
+Hackers, surveillance and spy softwares and even the server host cannot read your data, unless they are able to obtain your private key. Your private key is deleted from your computer once you logout.
+
+To increase the security, your data is re-encrypted in the backend before being saved to the database, which adds a second layer of protection.
+
+So to access your data, the hacker needs to know two things - (1) your private key and (2) the server encryption key. That is, if they are able to bypass the server security and gets access to the database. Even so, they won't be able to read the data without these two elements.
+
+The data is ecnrypted using [Advanced Encryption System (AES)](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard), the most widely used and trusted encryption algorithm.
 
-And then execute:
-```bash
-$ bundle
+------
+
+### System Requirements
+ - Node.js
+ - Ruby >= 2.2.2
+ - `rails` and `bundler` gems
+
+### Installation
+Create a new rails application named `my-app` or anything you like.
+```
+$ rails new my-app
+$ cd my-app
+```
+Add `gem 'unsakini'` to your `Gemfile`.
+```
+$ bundle install
+$ rake unsakini:install
 ```
 
-Or install it yourself as:
-```bash
-$ gem install unsakini
+Run local rails server
 ```
+$ rails s
+```
+Now you will be able to see the application at [http://localhost:3000](http://localhost:3000)
+
+------------------------------
+
+### Encryption Specifications
+
+  - server
+    - Algorithm = `AES`
+    - Mode = `CBC`
+    - Key Size = `256`
+    - *Others = autogenerated, random
+  - client
+    - Algorithm = `AES`
+    - Mode = `CBC`
+    - Padding = `Pkcs7`
+    - Key Derivation Function = `PBKDF2`
+    - Key Size = `256`
+    - Initialization Vector Size = `128`
+    - PBKDF2 iterations = `500`
+
+### Security
+  If you find any security flaws, please don't write a github issue. Email me instead at pitogo.adones@gmail.com so we can fix it before the public knows.
 
-## Contributing
-Contribution directions go here.
+### Author
+[Adones Pitogo](http://adonespitogo.com)
 
-## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+### License
+Released under the terms of [MIT](https://opensource.org/licenses/MIT) License.

data/lib/tasks/unsakini_tasks.rake

@@ -1,5 +1,16 @@
 namespace :unsakini do
 
+
+  desc "Runs `rails generate unsakini:config`"
+  task :config do
+    system('bundle exec rails g unsakini:config')
+  end
+
+  desc "Runs `rails generate unsakini:angular`"
+  task :angular do
+    system('bundle exec rails g unsakini:angular')
+  end
+
   desc "Initializes the angular app in ./angular directory."
   task :build do
 
@@ -21,7 +32,7 @@ namespace :unsakini do
       end
     rescue Exception => e
       puts \
-        "
+      "
 
         Please run `rails g unsakini:angular` before you proceed.
 
@@ -30,4 +41,28 @@ namespace :unsakini do
 
   end
 
+  desc "One stop command to install unsakini."
+  task :install => [:config, :angular, :build] do
+    begin
+      system('bundle exec rake unsakini_engine:install:migrations')
+      system('bundle exec rake db:migrate')
+    rescue Exception => e
+      puts e.to_s
+      puts \
+      "
+        
+        An error occured. Please run the following commands in succession:
+
+        "
+      puts "1.) rails g unsakini:config"
+      puts "2.) rails g unsakini:angular"
+      puts "3.) bundle exec rake unsakini_engine:install:migrations"
+      puts "4.) bundle exec rake db:migrate"
+      puts ""
+    end
+  end
+
+
+
+
 end

data/lib/unsakini/version.rb

@@ -1,3 +1,3 @@
 module Unsakini
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

data/spec/dummy/angular/package.json

@@ -8,8 +8,7 @@
     "lint": "tslint \"src/**/*.ts\"",
     "test": "ng test",
     "pree2e": "webdriver-manager update",
-    "e2e": "protractor",
-    "postinstall": "ng build"
+    "e2e": "protractor"
   },
   "private": true,
   "dependencies": {

data/spec/dummy/config/initializers/unsakini.rb

@@ -0,0 +1,4 @@
+Unsakini.setup do |config|
+  # your application encryption key
+  config.unsakini_crypto_key = "change me"
+end

data/spec/dummy/db/migrate/20161123150822_create_boards.unsakini_engine.rb

@@ -0,0 +1,10 @@
+# This migration comes from unsakini_engine (originally 20161116114222)
+class CreateBoards < ActiveRecord::Migration[5.0]
+  def change
+    create_table :boards do |t|
+      t.text :name
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20161123150823_create_user_boards.unsakini_engine.rb

@@ -0,0 +1,12 @@
+# This migration comes from unsakini_engine (originally 20161116200034)
+class CreateUserBoards < ActiveRecord::Migration[5.0]
+  def change
+    create_table :user_boards do |t|
+      t.integer :user_id
+      t.integer :board_id
+      t.boolean :is_admin, :default => false
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20161123150824_create_posts.unsakini_engine.rb

@@ -0,0 +1,13 @@
+# This migration comes from unsakini_engine (originally 20161118031023)
+class CreatePosts < ActiveRecord::Migration[5.0]
+  def change
+    create_table :posts do |t|
+      t.text :title
+      t.text :content
+      t.integer :user_id
+      t.integer :board_id
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20161123150825_create_comments.unsakini_engine.rb

@@ -0,0 +1,12 @@
+# This migration comes from unsakini_engine (originally 20161118100454)
+class CreateComments < ActiveRecord::Migration[5.0]
+  def change
+    create_table :comments do |t|
+      t.text :content
+      t.integer :user_id
+      t.integer :post_id
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20161123150826_add_encrypted_password_to_user_board.unsakini_engine.rb

@@ -0,0 +1,6 @@
+# This migration comes from unsakini_engine (originally 20161118221508)
+class AddEncryptedPasswordToUserBoard < ActiveRecord::Migration[5.0]
+  def change
+    add_column :user_boards, :encrypted_password, :string
+  end
+end

data/spec/dummy/db/migrate/20161123150827_create_users.unsakini_engine.rb

@@ -0,0 +1,13 @@
+# This migration comes from unsakini_engine (originally 20161122211105)
+class CreateUsers < ActiveRecord::Migration[5.0]
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :email
+      t.string :password_digest
+      t.boolean :confirmed
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unsakini
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Adones Pitogo
@@ -361,6 +361,7 @@ files:
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/new_framework_defaults.rb
+- spec/dummy/config/initializers/unsakini.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/puma.rb
@@ -368,6 +369,12 @@ files:
 - spec/dummy/config/secrets.yml
 - spec/dummy/config/spring.rb
 - spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20161123150822_create_boards.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150823_create_user_boards.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150824_create_posts.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150825_create_comments.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150826_add_encrypted_password_to_user_board.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150827_create_users.unsakini_engine.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
 - spec/dummy/public/app/favicon.ico
@@ -492,6 +499,12 @@ test_files:
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/db/test.sqlite3
+- spec/dummy/db/migrate/20161123150823_create_user_boards.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150825_create_comments.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150826_add_encrypted_password_to_user_board.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150824_create_posts.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150827_create_users.unsakini_engine.rb
+- spec/dummy/db/migrate/20161123150822_create_boards.unsakini_engine.rb
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/schema.rb
 - spec/dummy/config/application.rb
@@ -509,6 +522,7 @@ test_files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/initializers/cors.rb
+- spec/dummy/config/initializers/unsakini.rb
 - spec/dummy/config/initializers/application_controller_renderer.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/mime_types.rb