store_agent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 541cd57d63698ce014940dccfb89492af36d1ecc
+  data.tar.gz: c2db5fb40adedf6cfb80fbc26b55e011ccee8527
+SHA512:
+  metadata.gz: 6849a47f777b73f0a8b77c36e82176b4227725f5df1f7511ada23330fd706a0cbe6aff07334e5664504d01968444925f2fdc1c9fe34701898a6e91e2daad4972
+  data.tar.gz: b40d9481c17f04288f7229f121e7dc4e74b7b82657548ffe4f76ff28c2c68ffe9c44b6b4375524825e0656c76130d026752cb99c9f7c598c313e4fcc811738d4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in store_agent.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: "rspec", failed_mode: :none do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec/" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,433 @@
+# StoreAgent
+
+Simple Access Controllable Storage Interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'store_agent'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install store_agent
+
+## Usage
+
+基本的な使用方法は以下。  
+
+### 1. ユーザー
+
+ストレージのデータにアクセスするユーザー。  
+
+```ruby
+# 一般ユーザー
+user = StoreAgent::User.new("user_xxx")
+user = StoreAgent::User.new(:user_xxx) # シンボルは文字列に変換される
+# ルートユーザー
+root_user = StoreAgent::Superuser.new
+# ゲストユーザー
+guest_user = StoreAgent::Guest.new
+```
+
+一般ユーザーの初期化時には引数としてIDが必要だが、これは可変引数で複数のIDを渡す事もできる。  
+その場合、権限チェック時には受け取った引数の後ろから順に権限をチェックし、最初に見つかった権限が適用される。  
+ユーザー自身のIDとしては最後の引数が使用され、このIDがオブジェクト作成時のオーナーになる。  
+
+```ruby
+# グループに所属する場合など、複数IDを持つユーザー
+group_user = StoreAgent::User.new("group_001", "group_002", ..., "user_xxx")
+group_user.identifier # => "user_xxx"
+```
+
+IDとして文字列ではなく配列を渡すと、権限情報をネームスペースで分ける事ができる。  
+権限情報は配列の要素の順にネストして保存され、権限チェックはネームスペースを順に辿って行う。  
+同じユーザーでもネームスペースが違うと、それぞれ別の権限情報を持つ事になる。  
+ファイルやディレクトリの作成者としては配列の先頭要素が使用される。  
+
+```ruby
+# ネームスペース付きのユーザー
+namespaced_user = StoreAgent::User.new(["user_xxx", "namespace_001", "namespace_002"])
+namespaced_user.identifier # => "user_xxx"
+# 権限チェック時には、permission["user_xxx"]["namespace_001"]["namespace_002"] をチェックする
+```
+
+### 2. ワークスペース
+
+ストレージ、メタデータ、権限情報を管理する名前空間。  
+バージョン管理を使用する場合には、ワークスペースが一つのgitリポジトリになる。  
+
+```ruby
+workspace = user.workspace("workspace_01")
+workspace.exists? # => false
+workspace.create
+workspace.exists? # => true
+```
+
+### 3. ストレージ
+
+ワークスペースの/storage/以下をストレージ領域として使用する。  
+ファイル/ディレクトリ名の命名規則はシステムに準拠するが、それに加えて以下の制限がある。  
+
+* config.reserved_filenamesで設定されている名前は使用できない。
+* gitのバージョン管理を使用する場合は、.gitおよび.keepという名前は使用できない。
+* メタデータや権限情報と名前の衝突が起きないよう、最後が.metaや.permで終わるような名前は使用できない。
+
+```ruby
+# ディレクトリ作成
+directory_01 = workspace.directory("foo")
+directory_01.path # => "/foo/"
+directory_01.exists? # => false
+directory_01.create
+directory_01.exists? # => true
+directory_02 = directory_01.directory("bar")
+directory_02.path # => "/foo/bar/"
+directory_02.create
+workspace.directory("foo/bar").exists? # => true
+
+# ファイル作成
+file_01 = workspace.file("hoge.txt")
+file_01.path # => "/hoge.txt"
+file_01.exists? # => false
+file_01.create("hoge")
+file_01.exists? # => true
+file_01.read # => "hoge"
+file_02 = directory_01.file("fuga.txt")
+file_02.path # => "/foo/fuga.txt"
+file_02.exists? # => false
+file_02.create{|f| f.body = "fuga"}
+file_02.exists? # => true
+file_02.read # => "fuga"
+directory_01.read # => ["bar", "fuga.txt"]
+
+# ファイル更新
+file_01.update("updated") # => true
+file_01.read # => "updated"
+
+# ファイル削除
+file_02.delete # => true
+file_02.exists? # => false
+file_02.update("fuga") # => StoreAgent::PathError
+file_02.delete # => StoreAgent::PathError
+
+# ファイル/ディレクトリの移動
+file_01.move("move.txt")
+directory_01.move("move_dir")
+workspace.root.read # => ["move.txt", "move_dir"]
+
+# ファイル/ディレクトリのコピー
+workspace.file("move.txt").copy("hoge.txt")
+workspace.directory("move_dir").copy("foo")
+workspace.root.read # => ["move.txt", "hoge.txt", "move_dir", "foo"]
+```
+
+### 4. メタデータ
+
+ストレージと同様の構成で /metadata/ 以下にメタデータ用のファイルが作成される。  
+storage/${path} に対応するメタデータは metadata/${path}.meta に保存され、オブジェクトの操作時に更新される。  
+例えば、  
+
+* `/` に対応するメタデータは `/.meta`
+* `/foo/` に対応するメタデータは `/foo/.meta`
+* `/foo/bar.json` に対応するメタデータは `/foo/bar.json.meta`
+
+となる。  
+また metadata/${path}.meta.lock という名前でロックファイルも作成され、オブジェクトの操作時にはこのファイルがロックされる。  
+
+```ruby
+# メタデータ
+workspace.directory("foo").metadata # => {...}
+workspace.file("hoge.txt").metadata # => {...}
+
+# オーナー変更
+workspace.file("hoge.txt").chown(identifier: "user_yyy")
+workspace.file("hoge.txt").metadata # => {...}
+workspace.directory("foo").chown(identifier: "user_zzz", recursive: true)
+workspace.directory("foo/bar").metadata # => {...}
+```
+
+メタデータの形式は以下のようなJSON。  
+
+```json
+# オブジェクトがディレクトリの場合
+{
+  "size": "4.00KB",
+  "bytes": 4096,
+  "owner": "xxx-xxx-xxx-xxx",
+  "is_dir": true,
+  "created_at": "YYYY-mm-dd HH:MM:SS Z",
+  "updated_at": "YYYY-mm-dd HH:MM:SS Z",
+  "created_at_unix_timestamp": 1412345678,
+  "updated_at_unix_timestamp": 1412345678,
+  "directory_size": "8.00KB",
+  "directory_bytes": 8192,
+  "directory_size_limit": "1.00GB",
+  "directory_bytes_limit": 1073741824,
+  "directory_file_count": 1,
+  "tree_file_count": 1
+}
+
+# オブジェクトがファイルの場合
+{
+  "size": "10.4KB",
+  "bytes": 10634,
+  "owner": "xxx-xxx-xxx-xxx",
+  "is_dir": false,
+  "created_at": "YYYY-mm-dd HH:MM:SS Z",
+  "updated_at": "YYYY-mm-dd HH:MM:SS Z",
+  "created_at_unix_timestamp": 1412345678,
+  "updated_at_unix_timestamp": 1412345678
+}
+```
+
+### 5. 権限情報
+
+ストレージと同様の構成で /permission/ 以下に権限情報用のファイルが作成される。  
+storage/${path} に対応する権限情報は permission/${path}.perm に保存する。  
+
+```ruby
+# パーミッション
+workspace.directory("foo").permission # => {...}
+workspace.file("hoge.txt").permission # => {...}
+
+# パーミッション変更
+r_file_01 = root_user.workspace("workspace_01").file("hoge.txt")
+r_directory_01 = root_user.workspace("workspace_01").directory("foo")
+r_directory_02 = r_directory_01.directory("bar")
+r_file_01.set_permission(identifier: "user_yyy", permission_values: {"read" => true, "write" => false})
+r_directory_01.set_permission(identifier: "user_yyy", permission_values: {"read" => true})
+r_directory_02.set_permission(identifier: "user_yyy", permission_values: {"write" => true}, recursive: true)
+
+# パーミッション解除
+r_file_01.unset_permission(identifier: "user_yyy", permission_names: "read")
+r_directory_01.unset_permission(identifier: "user_yyy", permission_names: ["read"])
+r_directory_02.unset_permission(identifier: "user_yyy", permission_names: ["read", "write"], recursive: true)
+```
+
+権限情報の形式は以下のようなJSON。  
+
+```json
+{
+  "users":{
+    "user-xxx-uid":{
+      "read":true,
+      "write":true,
+      "execute":true,
+      "chown":true,
+      "chmod":true
+    },
+    "user-yyy-uid":{
+      "namespace-zzz":{
+        "read":true,
+        "write":false
+      }
+    }
+  },
+  "guest":{
+    "read":true,
+    "execute":true
+  }
+}
+```
+
+権限のチェックは以下の順に処理される。  
+
+1. ルートユーザーは全ての権限を持つ。
+2. 一般ユーザーの場合、上記のJSONの"users"をユーザーIDで検索する。キーが見つかり、値の中に権限と一致するキーがあればその値が使用される。ユーザーIDが配列の場合、配列の順にこの処理が実行される。
+3. ゲストユーザーまたは一般ユーザーだが権限情報が登録されていない場合、上記JSONの"guest"の中に権限と一致するキーがあればその値が使用される。キーが無い場合には権限が無い。
+
+### 6. 設定変更
+
+使用前に、以下のようにして一部の設定を変更する事ができる。  
+
+```ruby
+StoreAgent.configure do |c|
+  c.storage_root = "path/to/storage/directory"
+  c.version_manager = StoreAgent::VersionManager::RuggedGit
+  c.storage_data_encoders = [] <<
+    StoreAgent::DataEncoder::GzipEncoder.new <<
+    StoreAgent::DataEncoder::OpensslAes256CbcEncoder.new
+  c.json_indent_level = 2
+end
+```
+
+変更可能な設定は以下。  
+デフォルト値はlib/store_agent/config.rbを参照。  
+
+```ruby
+storage_root                      # ファイル/メタデータ/権限情報を保存するディレクトリ
+storage_dirname                   # ファイルを保存するディレクトリ名
+metadata_dirname                  # メタデータを保存するディレクトリ名
+permission_dirname                # 権限情報を保存するディレクトリ名
+metadata_extension                # メタデータの拡張子
+permission_extension              # 権限情報の拡張子
+superuser_identifier              # ルートユーザーのID
+guest_identifier                  # ゲストユーザーのID
+version_manager                   # バージョン管理に使用するクラス
+storage_data_encoders             # ファイルのエンコードに使用するオブジェクトのリスト
+attachment_data_encoders          # メタデータおよび権限情報のエンコードに使用するオブジェクトのリスト
+reserved_filenames                # システムが予約しているファイル名
+lock_timeout                      # ファイルのロック時のタイムアウト秒数
+default_directory_bytesize_limit  # 使用していない
+default_owner_permission          # ファイル/ディレクトリ作成時に作成者に付与されるデフォルトの権限
+default_guest_permission          # ファイル/ディレクトリ作成時にゲストユーザーに付与されるデフォルトの権限
+```
+
+### 7. バージョン管理
+
+ワークスペースをgitリポジトリとしてバージョン管理する事ができる。  
+デフォルトでは無効になっているので、有効化する場合は別途gemをインストールし、以下のように設定する必要がある。  
+使用できるgemは[rugged](https://github.com/libgit2/rugged)、あるいは[ruby-git](https://github.com/schacon/ruby-git)のどちらか。  
+
+```ruby
+### ruggedを使用する場合
+# Gemfile
+gem "rugged"
+
+# 設定変更
+StoreAgent.configure do |c|
+  c.version_manager = StoreAgent::VersionManager::RuggedGit
+end
+
+### ruby-gitを使用する場合
+# Gemfile
+gem "git"
+
+# 設定変更
+StoreAgent.configure do |c|
+  c.version_manager = StoreAgent::VersionManager::RubyGit
+end
+```
+
+過去のバージョンのファイルやディレクトリを読み込む場合は以下のように実行する。  
+
+```ruby
+# リビジョン一覧
+file_01.revisions # => ["xxxxxx", "yyyyyy", ...]
+directory_01.revisions # => ["zzzzzz", ...]
+
+# 過去のバージョンのファイルやディレクトリ
+file_01.read # => current version file
+file_01.read(revision: "version") # => old version file
+directory_01.read # => ["file_xxx", "file_yyy", ...]
+directory_01.read # => ["old_file_xxx", "old_file_yyy", ...]
+```
+
+### 8. エンコード
+
+ファイルやメタデータ＋パーミッション情報をgzip圧縮、暗号化して保存しておく事ができる。  
+デフォルトではエンコードしない設定になっているので、圧縮や暗号化をしたい場合には以下のように設定する。  
+圧縮/暗号化は配列の順番通りに実行され、解凍/復号はその逆順に処理される。  
+暗号化方式はOpenSSL AES-256-CBCで、パスワードには環境変数 STORE_AGENT_DATA_ENCODER_PASSWORD を使用する。  
+STORE_AGENT_DATA_ENCODER_PASSWORD が設定されていない場合には空文字列がパスワードとして使用される。  
+
+```ruby
+# set config
+StoreAgent.configure do |c|
+  # ファイルを暗号化する
+  c.storage_data_encoders = [StoreAgent::DataEncoder::OpensslAes256CbcEncoder.new]
+  # メタデータやパーミッション情報をgzip圧縮した上で暗号化する
+  c.attachment_data_encoders = [] <<
+    StoreAgent::DataEncoder::GzipEncoder.new <<
+    StoreAgent::DataEncoder::OpensslAes256CbcEncoder.new
+  # 暗号化してからgzip圧縮する場合は以下の順に指定する
+  # c.attachment_data_encoders = [] <<
+  #   StoreAgent::DataEncoder::OpensslAes256CbcEncoder.new <<
+  #   StoreAgent::DataEncoder::GzipEncoder.new
+end
+```
+
+圧縮/暗号化されたファイルをシェル上から確認する場合は以下のようにする。  
+
+```sh
+### gzip圧縮のみ使用している場合
+$ cat path/to/gzipped/file.txt
+# 圧縮されたファイル
+> ########
+
+$ cat path/to/gzipped/file.txt | gunzip
+# 元のファイル
+> gunzipped file
+
+### 暗号化のみ使用している場合
+$ cat path/to/encrypted/file.txt
+# 暗号化されたファイル
+> Salted__########################
+
+# パスワードは適宜変更する
+$ openssl enc -d -aes-256-cbc -k "" -in path/to/encrypted/file.txt
+# 元のファイル
+> decoded file
+
+### gzip圧縮した後に暗号化している場合
+$ cat path/to/gzipped/and/encrypted/file.txt
+# 圧縮＆暗号化されたファイル
+> Salted__########################
+
+$ openssl enc -d -aes-256-cbc -k "" -in path/to/gzipped/and/encrypted/file.txt | gunzip
+# 元のファイル
+> decoded and gunzipped file
+
+### 暗号化した後にgzip圧縮している場合
+$ cat path/to/encrypted/and/gzipped/file.txt
+# 暗号化＆圧縮されたファイル
+> ########
+
+$ cat path/to/encrypted/and/gzipped/file.txt | gunzip | openssl enc -d -aes-256-cbc -k ""
+# 元のファイル
+> gunzipped and decoded file
+```
+
+### ディレクトリ構造
+
+ストレージ領域のディレクトリ構造は以下のようになる。  
+.git と .keep はバージョン管理を使用している場合にのみ作成される。  
+
+```
+storage_root/
+  ├ ...
+  └ workspace/
+      ├ .git/
+      ├ permission/
+      |   ├ .perm
+      |   ├ ...
+      |   └ directory_x/
+      |       ├ .perm
+      |       ├ file_1.perm
+      |       ├ ...
+      |       └ file_n.perm
+      ├ metadata/
+      |   ├ .meta
+      |   ├ .meta.lock
+      |   ├ ...
+      |   └ directory_x/
+      |       ├ .meta
+      |       ├ .meta.lock
+      |       ├ file_1.meta
+      |       ├ file_1.meta.lock
+      |       ├ ...
+      |       ├ file_n.meta
+      |       └ file_n.meta.lock
+      └ storage/
+          ├ .keep
+          ├ ...
+          └ directory_x/
+              ├ .keep
+              ├ file_1
+              ├ ...
+              └ file_n
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/store_agent/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request