move RSpec tests to more idiomatic location
[coquelicot.git] / README
1 Coquelicot
2 ==========
3
4 Coquelicot is a "one-click" file sharing web application with a specific
5 focus on protecting users' privacy.
6
7 Basic principle: users can upload a file to the server, in return they
8 get a unique URL which can be shared with others in order to download
9 the file.
10
11 Coquelicot aims to protect, to some extend, users and system
12 administrators from disclosure of the files exchanged from passive and
13 not so active attackers.
14
15 Features
16 --------
17
18  * Support for different authentication methods
19
20    In order to prevent random Internet users to eat bandwidth and
21    disk space, Coquelicot limits upload to authenticated users.
22    It currently ships with two authentication mechanisms:
23
24     - "simplepass": users will need to provide a global, pre-shared,
25       password;
26     - "imap": users will need to provide a login and a password,
27       those credentials will be used to authenticate against an existing
28       IMAP server.
29
30    It is possible to integrate more authentication mechanisms by
31    implementing a single method, some Javascript, and a template partial
32    to render the common fields. For more information have a look at the
33    notes below.
34
35  * Mandatory expiration
36
37    When uploading, a time limit has to be specified. The file will be
38    unavailable once this limit has been reached.
39
40    During a configurable period of time, trying to download the file
41    will return a page saying "too late" instead of "not found".
42
43  * Support for one-time download
44
45    An user might want to allow exactly _one_ download of a file, to more
46    closely replace an email attachment. The file will be removed after
47    the first complete download and concurrent downloads are prevented.
48
49  * Upload progress bar
50
51    If the web server tracks upload progress, users having javascript
52    enabled will see a nice progress bar during the file upload.
53
54  * Downgrade nicely
55
56    The application works fine without javascript or CSS.
57
58  * Download URL are hand-writing compatible
59
60    URLs generated to download files uses the Base32 character set. This
61    set is specifically designed to overcome misread of 'l', '1', '0' and
62    'O' characters. Coquelicot will automatically convert case and
63    ambiguous characters to facilitate URL exchanges through
64    hand-writing.
65
66  * Files are stored encrypted on the server
67
68    While being uploaded, files are written to the disk using symmetric
69    encryption. The encryption key is _not_ stored directly by
70    Coquelicot. It is either generated randomly and given as part of the
71    download URL, or specified by the uploader.
72
73  * Download can be protected by a password
74
75    When uploading, a password can be specified which will be used as
76    the encryption key. In order to download the file, the password
77    must be entered through in a POST'ed form, preventing the password
78    from appearing in the server logs.
79
80  * Files are stored with a random name
81
82    To prevent disclosure of the shared file name, it is stored encrypted
83    together with the file content. On the server, this encrypted file is
84    stored with a random name.
85
86  * Download URLs do not reflect stored file names
87
88    The random names given in download URLs do not map directly to file
89    names on the server. This prevent server logs from giving a direct
90    mapping to the shared files.
91
92  * File content is zero'ed before removal
93
94    When a file has expired, it is removed from the server. In order
95    to make it harder to retrieve its content through filesystem
96    analysis, it is filled with zeros first.
97
98 Setup
99 -----
100
101 Coquelicot is written in Ruby using the Sinatra web framework.
102
103 On Debian, one can fulfill its dependencies by issuing:
104
105     apt-get install libsinatra-ruby1.8 libopenssl-ruby1.8 \
106                     libhaml-ruby1.8 liblockfile-ruby libgettext-ruby1.8 \
107                     rake
108
109 Then create the translation catalog through:
110
111     rake makemo
112
113 Finally you need to figure out the best way to host a Rack application
114 depending on your setup. *evil grin*
115
116 Coquelicot is intended to be run on a fully encrypted system and accessible
117 only through HTTPS.
118
119 Configuration
120 -------------
121
122 By default Coquelicot is configured to authenticate with the
123 "simplepass" mechanism and some other reasonable defaults.
124
125 It is possible to overwrite these settings from a configuration file
126 named `settings.yml` that will be used if it is present in the `conf`
127 directory of the application.
128
129 All available settings with their default values are documented in
130 `conf/settings-default.yml`.
131
132 Further settings example:
133
134  * `conf/settings-simplepass.yml`: shows how to change the default
135    password for the "simplepass" mechanism.
136
137  * `conf/settings-imap.yml`: necessary configuration for the "imap"
138    authentication mechanism.
139
140 You can copy one of these examples to `conf/settings.yml` and adjust them
141 according to your environment.
142
143 Garbage collection
144 ------------------
145
146 To cleanup files automatically when they expired, coquelicot comes with
147 a cleanup script, that does the garbage collection for you. The easiest
148 way is to add `ext/coquelicot_gc.rb` as a cron job that runs every 5
149 minutes (or so).
150
151 Test suite
152 ----------
153
154 Coquelicot test suite is written using RSpec.
155
156 On Debian, you will need those extra packages:
157
158     apt-get install librspec-ruby1.8 libhpricot-ruby1.8
159
160 You will also need the unpackaged gems "timecop" and "rack-test".
161
162 Then, running the test suite is just a matter of typing:
163
164     spec spec/coquelicot_spec.rb
165
166 Migrate from Jyraphe
167 --------------------
168
169 Jyraphe [1] is another free software web file sharing application.
170 Coquelicot provides a migration script to import Jyraphe 0.5 repositories in
171 `tools/migrate_jyraphe.rb`.
172
173 [1] http://home.gna.org/jyraphe/
174
175 Future
176 ------
177
178  * More flexible expiration
179
180    It might be interesting to also offer a calendar for specifying
181    an exact date after which the file will be unavailable.
182
183  * Hide file size (padding)
184
185    There is currently a real close mapping from original file size to
186    stored file size. Original file size will also be recorded in server
187    logs. Padding could be used to improve this situation.
188
189  * Make a Gem
190
191    Most Ruby stuff is installed using Gem, so Coquelicot should be one.
192
193  * Package for Debian
194
195    A Debian package would be nice to spread Coquelicot setups.
196
197  * Describe more setups
198
199    Describe how to setup Coquelicot with mod_passenger, Mongrel and
200    other webservers.
201
202 Storage details
203 ---------------
204
205 Files are stored in the directory specified by the 'depot_path'
206 setting.
207
208 The format is the following:
209
210     --- 
211     Coquelicot: "1.0"
212     Salt: <8 bytes stored as Base64>
213     Expire-at: <expiration time in seconds since epoch>
214     --- 
215     <encrypted data>
216
217 Encryption is done using OpenSSL. Cipher is AES-256-CBC with key and IV
218 created using the pbkdf2_hmac_sha1() implementation of PKCS5. The later
219 is fed using the former 'Salt' and the given passphrase.
220
221 Once decrypted, content has the following format:
222
223     --- 
224     Created-at: <upload time in seconds since epoch>
225     Filename: "<original file name>"
226     Content-Type: "<MIME type>"
227     Length: <file length is bytes>
228     One-time-only: <true|false>
229     --- 
230     <original bytes forming the file content>
231
232 Headers must be parseable using the YAML standard.
233
234 File are truncated to zero length when they are "expired".
235
236 In order to map download URLs to file name, a simple text file ".links"
237 is used. It contains a line for each file in the form:
238
239     <URL name> <file name>
240
241 Authentication Mechanisms
242 -------------------------
243
244 It is possible to authenticate users against your own common authentication
245 mechanism.
246
247 Such an authentication mechanism needs to provide the following 3 files,
248 with the following responsabilities:
249
250  * `lib/coquelicot/auth/<METHOD>.rb`:
251
252    A module implementing the actual authentication. This module must
253    implement one method called `authenticate` which will get all the
254    parameters as an argument. To simplify your interaction with the
255    field `upload_token`, that might be serialized as json, we
256    deserialize it prior to passing it to the `authenticate` method.
257
258  * `public/javascripts/coquelicot.auth.<METHOD>.js:`
259
260     We expect 2 javascript methods in that file:
261
262     - `authenticationData()`: returns a hash of all the necessary data
263       to authenticate on the app side.
264     - `authenticationFocus()`: set the focus on the first authentication
265       form field.
266
267  * `views/auth/<METHOD>.haml`:
268
269    Render the necessary form fields that will be used for authentication.
270
271    The authentication method can be set in the application settings
272    including mandatory options for this method.
273
274 Authors
275 -------
276
277 Coquelicot © 2010-2012 potager.org <jardiniers@potager.org>
278            © 2011 mh / immerda.ch <mh+coquelicot@immerda.ch>
279
280 Coquelicot is distributed under the GNU Affero General Public License
281 version 3. See LICENSE for details.