icfs 0.1.0

data/bin/icfs_demo_create.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+require 'yaml'
+require 'json'
+require 'faraday'
+require 'fileutils'
+
+require_relative '../lib/icfs'
+require_relative '../lib/icfs/cache_elastic'
+require_relative '../lib/icfs/store_fs'
+require_relative '../lib/icfs/users_fs'
+
+# load the config file
+cfg = YAML.load_file(ARGV[0])
+map = {}
+cfg['cache']['map'].each do |key, val|
+  map[key.to_sym] = val
+end
+
+es = Faraday.new(cfg['elastic']['base'])
+cache = ICFS::CacheElastic.new(map, es)
+store = ICFS::StoreFs.new(cfg['store']['dir'])
+users = ICFS::UsersFs.new(cfg['users']['dir'])
+
+# clear out the store
+if File.exists?(cfg['store']['dir'])
+  FileUtils.rm_rf(cfg['store']['dir'])
+  puts "Deleted store directory"
+end
+FileUtils.mkdir_p(cfg['store']['dir'])
+puts "Created store directory: %s" % cfg['store']['dir']
+
+# clear out the users
+if File.exists?(cfg['users']['dir'])
+  FileUtils.rm_rf(cfg['users']['dir'])
+  puts "Deleted users directory"
+end
+FileUtils.mkdir_p(cfg['users']['dir'])
+puts "Created users directory: %s" % cfg['users']['dir']
+
+# delete the indexes
+map.each do |sym, name|
+  resp = es.run_request(:delete, name, '', {})
+  if resp.success?
+    puts 'Deleted index: %s' % name
+  else
+    puts 'Failed to delete index: %s' % name
+  end
+end
+
+# add the users
+cfg['init']['urg'].each do |usr|
+  users.write(usr)
+  puts "Added user/role/group: %s" % usr['name']
+end
+
+# create the indexes
+cache.create(ICFS::CacheElastic::Maps)
+puts "Indexes created"
+
+api = ICFS::Api.new([], users, cache, store)
+api.user = cfg['init']['user']
+
+# add the templates
+cfg['init']['templates'].each do |tmpl|
+  tp = {
+    'template' => true,
+    'status' => true,
+    'title' => tmpl['template'],
+    'access' => tmpl['access'],
+  }
+  ent = {
+    'caseid' => tmpl['caseid'],
+    'title' => tmpl['entry'],
+    'content' => tmpl['content']
+  }
+  api.case_create(ent, tp)
+  puts "Created template: %s" % tmpl['caseid']
+end

data/bin/icfs_demo_fcgi.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+require 'yaml'
+require 'faraday'
+
+require_relative '../lib/icfs'
+require_relative '../lib/icfs/cache_elastic'
+require_relative '../lib/icfs/store_fs'
+require_relative '../lib/icfs/users_fs'
+require_relative '../lib/icfs/web/client'
+require_relative '../lib/icfs/web/auth_ssl'
+require_relative '../lib/icfs/demo/timezone'
+
+# load the config file
+cfg = YAML.load_file(ARGV[0])
+map = {}
+cfg['cache']['map'].each do |key, val|
+  map[key.to_sym] = val
+end
+
+es = Faraday.new(cfg['elastic']['base'])
+cache = ICFS::CacheElastic.new(map, es)
+store = ICFS::StoreFs.new(cfg['store']['dir'])
+users = ICFS::UsersFs.new(cfg['users']['dir'])
+api = ICFS::Api.new([], users, cache, store)
+web = ICFS::Web::Client.new(cfg['web']['css'], cfg['web']['script'])
+
+user_map = {
+  'CN=client 1,OU=Test Client,OU=example,OU=org' => 'user1',
+  'CN=client 2,OU=Test Client,OU=example,OU=org' => 'user2',
+  'CN=client 3,OU=Test Client,OU=example,OU=org' => 'user3'
+}
+
+app = Rack::Builder.new do
+  use(ICFS::Web::AuthSsl, user_map, api)
+  use(ICFS::Demo::Timezone, cfg['web']['tz'])
+  run web
+end
+
+puts 'try to run'
+Rack::Handler::FastCGI.run(app, {Host: '127.0.0.1', Port: 9000} )

data/bin/icfs_demo_ssl_gen.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+require 'openssl'
+
+
+# make a CA key
+ca_key = OpenSSL::PKey::RSA.new 2048
+ca_cert = OpenSSL::X509::Certificate.new
+ca_cert.version = 2
+ca_cert.serial = 1
+ca_cert.subject = OpenSSL::X509::Name.parse('/OU=org/OU=example/CN=Test Root CA')
+ca_cert.issuer = ca_cert.subject
+ca_cert.public_key = ca_key.public_key
+ca_cert.not_before = Time.now
+ca_cert.not_after = ca_cert.not_before + (30 * 24 * 60 * 60) # 30 days
+ef = OpenSSL::X509::ExtensionFactory.new
+ef.subject_certificate = ca_cert
+ef.issuer_certificate = ca_cert
+ca_cert.add_extension(ef.create_extension("basicConstraints","CA:TRUE",true))
+ca_cert.add_extension(ef.create_extension("keyUsage","keyCertSign, cRLSign", true))
+ca_cert.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
+ca_cert.add_extension(ef.create_extension("authorityKeyIdentifier","keyid:always",false))
+ca_cert.sign(ca_key, OpenSSL::Digest::SHA256.new)
+
+# save CA cert
+File.open("ca_cert.pem", "wb"){|fi| fi.write ca_cert.to_pem }
+
+
+# make a server key
+srv_key = OpenSSL::PKey::RSA.new 2048
+srv_cert = OpenSSL::X509::Certificate.new
+srv_cert.version = 2
+srv_cert.serial = 2
+srv_cert.subject = OpenSSL::X509::Name.parse('/OU=org/OU=example/OU=Test Server/CN=localhost')
+srv_cert.issuer = ca_cert.subject
+srv_cert.public_key = srv_key.public_key
+srv_cert.not_before = Time.now
+srv_cert.not_after = srv_cert.not_before + (30 * 24 * 60 * 60) # 30 days
+ef = OpenSSL::X509::ExtensionFactory.new
+ef.subject_certificate = srv_cert
+ef.issuer_certificate = ca_cert
+srv_cert.add_extension(ef.create_extension("basicConstraints", "CA:FALSE"))
+srv_cert.add_extension(ef.create_extension("keyUsage", "keyEncipherment,dataEncipherment,digitalSignature"))
+srv_cert.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
+srv_cert.sign(ca_key, OpenSSL::Digest::SHA256.new)
+
+# save server key
+File.open("srv_cert.pem", "wb"){|fi| fi.write srv_cert.to_pem }
+File.open("srv_key.pem", "wb"){|fi| fi.write srv_key.to_pem }
+
+# make client certs
+5.times do |ix|
+  clt_key = OpenSSL::PKey::RSA.new 2048
+  clt_cert = OpenSSL::X509::Certificate.new
+  clt_cert.version = 2
+  clt_cert.serial = ix+3
+  clt_cert.subject = OpenSSL::X509::Name.parse('/OU=org/OU=example/OU=Test Client/CN=client %d' % ix)
+  clt_cert.issuer = ca_cert.subject
+  clt_cert.public_key = clt_key.public_key
+  clt_cert.not_before = Time.now
+  clt_cert.not_after = clt_cert.not_before + (30 * 24 * 60 * 60) # 30 days
+  ef = OpenSSL::X509::ExtensionFactory.new
+  ef.subject_certificate = clt_cert
+  ef.issuer_certificate = ca_cert
+  clt_cert.add_extension(ef.create_extension("basicConstraints", "CA:FALSE"))
+  clt_cert.add_extension(ef.create_extension("keyUsage", "keyEncipherment,dataEncipherment,digitalSignature"))
+  clt_cert.sign(ca_key, OpenSSL::Digest::SHA256.new)
+
+  # pkcs12
+  clt_pkcs12 = OpenSSL::PKCS12.create('demo', 'client-%d' % ix, clt_key, clt_cert)
+
+  # save cert
+  File.open('clt_%d.pfx' % ix, 'wb'){|fi| fi.write clt_pkcs12.to_der }
+end

data/bin/icfs_demo_web.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+require 'yaml'
+require 'faraday'
+
+require_relative '../lib/icfs'
+require_relative '../lib/icfs/cache_elastic'
+require_relative '../lib/icfs/store_fs'
+require_relative '../lib/icfs/users_fs'
+require_relative '../lib/icfs/web/client'
+require_relative '../lib/icfs/demo/auth'
+require_relative '../lib/icfs/demo/static'
+require_relative '../lib/icfs/demo/timezone'
+
+# load the config file
+cfg = YAML.load_file(ARGV[0])
+map = {}
+cfg['cache']['map'].each do |key, val|
+  map[key.to_sym] = val
+end
+
+es = Faraday.new(cfg['elastic']['base'])
+cache = ICFS::CacheElastic.new(map, es)
+store = ICFS::StoreFs.new(cfg['store']['dir'])
+users = ICFS::UsersFs.new(cfg['users']['dir'])
+api = ICFS::Api.new([], users, cache, store)
+web = ICFS::Web::Client.new(cfg['web']['css'], cfg['web']['script'])
+
+app = Rack::Builder.new do
+  use(ICFS::Demo::Auth, api)
+  use(ICFS::Demo::Static, cfg['web']['static'])
+  use(ICFS::Demo::Timezone, cfg['web']['tz'])
+  run web
+end
+
+opts = {}
+opts[:Host] = cfg['web']['host'] if cfg['web']['host']
+opts[:Port] = cfg['web']['port'] if cfg['web']['port']
+
+Rack::Handler::WEBrick.run(app, opts)

data/bin/icfs_dev_todo.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+
+require 'yard'
+
+YARD::Registry.load!.all.each do |o|
+  todo = o.tags(:todo)
+  next if todo.empty?
+  todo.each{|tg| puts "%s\n  %s\n\n" % [o.path, tg.text] }
+end

data/data/demo_config.yml

@@ -0,0 +1,94 @@
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+cache:
+  map:
+    entry: entry
+    case: case
+    action: action
+    index: index
+    log: log
+    lock: lock
+    current: current
+
+elastic:
+  base: "http://localhost:9200"
+
+store:
+  dir: work/store
+
+users:
+  dir: work/users
+
+init:
+  user: user1
+  urg:
+    - name: role1
+      type: role
+
+    - name: role2
+      type: role
+
+    - name: role3
+      type: role
+
+    - name: group1
+      type: group
+
+    - name: group2
+      type: group
+
+    - name: user1
+      type: user
+      roles:
+        - role2
+        - role3
+      groups:
+        - group2
+      perms:
+        - "{perm_a}"
+        - "{perm_b}"
+
+    - name: user2
+      type: user
+      roles:
+        - role1
+        - role2
+      groups:
+        - group1
+      perms:
+        - "{perm_b}"
+
+  templates:
+    - caseid: template1
+      template: "New Template"
+      access:
+        - perm: "[manage]"
+          grant:
+            - user1
+        - perm: "[write]"
+          grant:
+            - group1
+      entry: "Create new template"
+      content: "New template being created"
+
+
+web:
+  css: "/static/icfs.css"
+  script: "/static/icfs.js"
+  tz: "-04:00"
+  static:
+    "/static/icfs.css":
+      path: "data/icfs.css"
+      mime: "text/css; charset=utf-8"
+    "/static/icfs.js":
+      path: "data/icfs.js"
+      mime: "application/javascript; charset=utf-8"

data/data/icfs.css

@@ -0,0 +1,475 @@
+/*************************************************************************
+#
+# Investigative Case File System
+#
+# Copyright 2019 by Graham A. Field
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+**************************************************************************/
+
+/*************************************************************************
+  General
+*/
+
+a {
+  color: black;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+
+input {
+  border: 1px solid black;
+  border-radius: 3px;
+  font-family: serif;
+  font-size: 12pt;
+  margin: 0.1em;
+  padding: 0.2em;
+}
+
+textarea {
+  border: 1px solid black;
+  border-radius: 3px;
+  font-family: serif;
+  font-size: 12pt;
+  margin: 0.1em;
+  padding: 0.2em;
+}
+
+
+/*************************************************************************
+  Navbar
+*/
+
+div.nav {
+  border-width: 3px;
+  border-style: none none solid none;
+  border-color: green;
+  display: flex;
+}
+
+div.nav-icfs {
+  color: green;
+  width: 3em;
+}
+
+div.nav-icfs a {
+  color: green;
+}
+
+div.nav-case {
+  color: blue;
+  width: 15em;
+}
+
+div.nav-case a {
+  color: blue;
+}
+
+div.nav-tab {
+  text-align: center;
+  border: 1px;
+  width: 7em;
+  border-style: solid solid none solid;
+}
+
+
+/*************************************************************************
+ Sidebar layout
+*/
+
+div.sbar {
+  border-bottom: thin solid;
+  display: flex;
+  align-content: stretch;
+}
+
+div.sbar-main {
+  flex: 1 0 0;
+  vertical-align: top;
+}
+
+div.sbar-side {
+  flex: 0 0 20em;
+  border-right: thin solid;
+  vertical-align: top;
+}
+
+div.sbar-side-head {
+  text-align: center;
+  border-bottom: thin solid;
+  color: darkblue;
+}
+
+div.sbar-main-head {
+  font-size: 120%;
+  padding: 0.25em;
+}
+
+div.sbar-main-sub {
+  font-weight: bold;
+  font-size: 75%;
+}
+
+pre.sbar-main-content {
+  font-family: serif;
+  font-size: 12pt;
+  border-top: thin solid;
+  border-bottom: thin solid;
+  margin: 0px;
+  padding: 0.25em;
+  white-space: pre-wrap;
+}
+
+
+/*************************************************************************
+  Sections
+*/
+
+div.sect {
+  padding: 0.25em;
+}
+
+div.sect-head {
+  display: flex;
+  flex-direction: row;
+  justify-content: space-between;
+  padding: 0.2em;
+  background: #d8d8d8;
+}
+
+div.sect-main {
+  display: flex;
+  flex-direction: row;
+  justify-content: space-between;
+  padding: 0.2em;
+  background: #99bbff;
+}
+
+
+div.sect-label {
+  flex: 0 1 auto;
+}
+
+
+div.sect-fill {
+  flex: 1 1 auto;
+}
+
+
+div.sect-head-right {
+  flex: 0 1 auto;
+}
+
+
+/*************************************************************************
+  List
+*/
+
+div.list-head {
+  display: flex;
+  flex-direction: row;
+  border-bottom: solid;
+  border-width: 1px;
+  font-style: italic;
+}
+
+
+div.list-row {
+  display: flex;
+  flex-direction: row;
+  flex-wrap: wrap;
+  border-bottom: dotted;
+  border-width: 1px;
+  align-items: flex-start;
+}
+
+
+div.list-int {
+  width: 4em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+
+div.list-perm {
+  width: 15em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+
+div.list-usergrp {
+  width: 15em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+
+div.list-label {
+  width: 7em;
+  padding: 0 0.15em 0 0.15em;
+  text-align: right;
+}
+
+
+div.list-caseid {
+  width: 10em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+
+div.list-text-s {
+  width: 8em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+
+div.list-text-m {
+  width: 12em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+
+div.list-time {
+  width: 12em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+
+div.list-tag {
+  width: 12em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+div.list-hash {
+  font-family: monospace;
+  font-size: 12pt;
+  padding: 0 0.15em 0 0.15em;
+}
+
+div.list-stat {
+  width: 12em;
+  padding: 0 0.15em 0 0.15em;
+}
+
+div.list-snip {
+  flex: 0 1 100%;
+  padding: 0.1em;
+  margin: 0.1em 1em 0.1em 1em;
+  background: #f0f0f0;
+}
+
+/*************************************************************************
+  Tasks
+*/
+
+div.task {
+  border-bottom: thin solid;
+}
+
+
+div.task-ed {
+  background: #99b3ff;
+}
+
+
+div.task-ro {
+  background: #ff6666;
+}
+
+
+/*************************************************************************
+  Forms
+*/
+
+div.form-row {
+  min-height: 2em;
+  display: flex;
+  flex-direction: row;
+  align-items: baseline;
+}
+
+
+input.form-index {
+  width: 20em;
+}
+
+
+input.form-stat {
+  width: 15em;
+}
+
+
+input.form-usergrp {
+  width: 10em;
+}
+
+
+input.form-caseid {
+  width: 12em;
+}
+
+
+input.form-sort {
+  width: 10em;
+}
+
+
+input.form-content {
+  width: 50em;
+}
+
+
+input.form-title {
+  width: 40em;
+}
+
+
+input.form-file-name {
+  width: 30em;
+}
+
+
+input.form-file-upl {
+}
+
+
+input.form-float {
+  width: 5em;
+}
+
+
+input.form-check {
+}
+
+
+input.form-time {
+  width: 15em;
+}
+
+
+input.form-perm {
+  width: 15em;
+}
+
+
+input.form-int {
+  width: 5em;
+}
+
+
+input.form-tag {
+  width: 20em;
+}
+
+
+input.form-boolean {
+  width: 5em;
+}
+
+
+textarea.form-content {
+  width: 50em;
+  height: 20em;
+}
+
+
+/*************************************************************************
+ Other divs
+*/
+
+div.desc {
+  padding: 0.25em;
+  background: #fff5e6;
+  margin-bottom: 1em;
+}
+
+div.desc-head {
+  font-size: 120%;
+  text-align: center;
+}
+
+span.desc-query {
+  text-decoration: underline;
+
+}
+
+div.query-form {
+  border-bottom: solid;
+  border-width: 1px;
+  padding: 0.5em;
+}
+
+
+
+div.hidden {
+  display: none;
+}
+
+div.invisible {
+  visibility: hidden;
+}
+
+
+/*************************************************************************
+  Tooltips
+*/
+
+div.tip {
+  display: inline-block;
+}
+
+div.tip div.tip-disp {
+  border: thin solid;
+  border-radius: 50%;
+  font-size: 60%;
+  text-align: center;
+  width: 1.1em;
+  height: 1.1em;
+  margin: 0 0.1em;
+}
+
+
+div.tip div.tip-disp::before {
+  content: "?";
+}
+
+
+/* status bar tooltips */
+div.tip div.tip-info {
+  visibility: hidden;
+  background-color: black;
+  color: #fff;
+  position: fixed;
+  padding: 0.5em;
+  bottom: 0;
+  left: 0;
+  width: 100vw;
+}
+
+
+/* floating tooltips
+div.tip div.tip-info {
+  visibility: hidden;
+  background-color: black;
+  color: #fff;
+  border-radius: 0.5em;
+  padding: 0.5em;
+  margin: 0.25em;
+  width: 25em;
+  margin-left: 0em;
+  position: absolute;
+  z-index: 1;
+}
+*/
+
+
+div.tip:hover div.tip-info {
+  visibility: visible;
+}