-
Notifications
You must be signed in to change notification settings - Fork 343
/
file_pushes_controller.rb
476 lines (413 loc) · 17.3 KB
/
file_pushes_controller.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
# frozen_string_literal: true
require "securerandom"
class FilePushesController < BaseController
helper FilePushesHelper
before_action :set_push, only: %i[show passphrase access preview print_preview preliminary audit destroy]
# Authentication always except for :show
acts_as_token_authentication_handler_for User, except: %i[show new preliminary destroy passphrase access]
resource_description do
name "File Pushes"
short "Interact directly with file pushes. This feature (and corresponding API) is currently in beta."
end
api :GET, "/f/:url_token.json", "Retrieve a file push."
param :url_token, String, desc: "Secret URL token of a previously created push.", required: true
formats ["json"]
example 'curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/fk27vnslkd.json'
description "Retrieves a push including it's payload and details. If the push is still active, " \
"this will burn a view and the transaction will be logged in the push audit log."
def show
# This file_push may have expired since the last view. Validate the file_push
# expiration before doing anything.
@push.validate!
if @push.expired
log_view(@push)
respond_to do |format|
format.html { render template: "file_pushes/show_expired", layout: "naked" }
format.json { render json: @push.to_json(payload: true) }
end
return
else
@payload = @push.payload
end
# Passphrase handling
if [email protected]? && @push.passphrase.present?
# Construct the passphrase cookie name
name = "#{@push.url_token}-f"
# The passphrase can be passed in the params or in the cookie (default)
# JSON requests must pass the passphrase in the params
has_passphrase = params.fetch(:passphrase,
nil) == @push.passphrase || cookies[name] == @push.passphrase_ciphertext
unless has_passphrase
# Passphrase hasn't been provided or is incorrect
# Redirect to the passphrase page
respond_to do |format|
format.html { redirect_to passphrase_file_push_path(@push.url_token) }
format.json { render json: {error: "This push has a passphrase that was incorrect or not provided."} }
end
return
end
# Delete the cookie
cookies.delete name
end
log_view(@push)
expires_now
# Optionally blur the text payload
@blur_css_class = Settings.files.enable_blur ? "spoiler" : ""
respond_to do |format|
format.html { render layout: "bare" }
format.json { render json: @push.to_json(payload: true) }
end
# We can't expire in this case because the attached files would be deleted and
# downloading wouldn't work.
# TODO: ActiveJob delete in 15 minutes after last view is shown.
# # Expire if this is the last view for this push
# @push.expire if [email protected]_remaining.positive?
end
# GET /f/:url_token/passphrase
def passphrase
respond_to do |format|
format.html { render action: "passphrase", layout: "naked" }
end
end
# POST /f/:url_token/access
def access
# Construct the passphrase cookie name
name = "#{@push.url_token}-f"
# Validate the passphrase
if @push.passphrase == params[:passphrase]
# Passphrase is valid
# Set the passphrase cookie
cookies[name] = {value: @push.passphrase_ciphertext, expires: 10.minutes.from_now}
# Redirect to the payload
redirect_to file_push_path(@push.url_token)
else
# Passphrase is invalid
# Redirect to the passphrase page
flash[:alert] =
_("That passphrase is incorrect. Please try again or contact the person or organization that sent you this link.")
redirect_to passphrase_file_push_path(@push.url_token)
end
end
# GET /file_pushes/new
def new
if user_signed_in?
@push = FilePush.new
respond_to(&:html)
else
respond_to do |format|
format.html { render template: "file_pushes/new_anonymous" }
end
end
end
api :POST, "/f.json", "Create a new file push."
param :file_push, Hash, "Push details", required: true do
param :payload, String, desc: "The URL encoded secret text to share.", required: true
param :passphrase, String, desc: "Require recipients to enter this passphrase to view the created push."
param :note, String,
desc: "If authenticated, the URL encoded note for this push. Visible only to the push creator.", allow_blank: true
param :expire_after_days, Integer, desc: "Expire secret link and delete after this many days."
param :expire_after_views, Integer, desc: "Expire secret link and delete after this many views."
param :deletable_by_viewer, %w[true false], desc: "Allow users to delete the push once retrieved."
param :retrieval_step, %w[true false],
desc: "Helps to avoid chat systems and URL scanners from eating up views."
end
formats ["json"]
example 'curl -X POST -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" ' \
'-F "file_push[files][]=@/path/to/file/file1.extension" ' \
'-F "file_push[files][]=@/path/to/file/file2.extension" https://pwpush.com/f.json'
def create
# Require authentication if allow_anonymous is false
# See config/settings.yml
authenticate_user! if Settings.enable_logins && !Settings.allow_anonymous
@push = FilePush.new(file_push_params)
if file_push_params.key?(:files) && file_push_params[:files].count > Settings.files.max_file_uploads
msg = t("pushes.form.upload_limit", count: Settings.files.max_file_uploads)
respond_to do |format|
format.html do
flash.now[:alert] = msg
render :new, status: :unprocessable_entity
end
format.json { render json: {error: msg}, status: :unprocessable_entity }
end
return
end
@push.expire_after_days ||= Settings.files.expire_after_days_default
@push.expire_after_views ||= Settings.files.expire_after_views_default
@push.user_id = current_user.id if user_signed_in?
@push.url_token = SecureRandom.urlsafe_base64(rand(8..14)).downcase
create_detect_deletable_by_viewer(@push, file_push_params)
create_detect_retrieval_step(@push, file_push_params)
@push.validate!
respond_to do |format|
if @push.save
format.html { redirect_to preview_file_push_path(@push) }
format.json { render json: @push, status: :created }
else
format.html { render action: "new", status: :unprocessable_entity }
format.json { render json: @push.errors, status: :unprocessable_entity }
end
end
end
api :GET, "/f/:url_token/preview.json", "Helper endpoint to retrieve the fully qualified secret URL of a push."
param :url_token, String, desc: "Secret URL token of a previously created push.", required: true
formats ["json"]
example 'curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/fk27vnslkd/preview.json'
description ""
def preview
@secret_url = helpers.secret_url(@push)
@qr_code = helpers.qr_code(@secret_url)
respond_to do |format|
format.html { render action: "preview" }
format.json { render json: {url: @secret_url}, status: :ok }
end
end
def print_preview
@secret_url = helpers.secret_url(@push)
@qr_code = helpers.qr_code(@secret_url)
@message = print_preview_params[:message]
@show_expiration = print_preview_params[:show_expiration]
@show_id = print_preview_params[:show_id]
respond_to do |format|
format.html { render action: "print_preview", layout: "naked" }
format.json { render json: {url: @secret_url}, status: :ok }
end
end
def preliminary
# This password may have expired since the last view. Validate the password
# expiration before doing anything.
@push.validate!
if @push.expired
log_view(@push)
respond_to do |format|
format.html { render template: "file_pushes/show_expired", layout: "naked" }
format.json { render json: @push.to_json(payload: true) }
end
return
else
@secret_url = helpers.secret_url(@push, with_retrieval_step: false, locale: params[:locale])
end
respond_to do |format|
format.html { render action: "preliminary", layout: "naked" }
end
end
api :GET, "/f/:url_token/audit.json", "Retrieve the audit log for a push."
param :url_token, String, desc: "Secret URL token of a previously created push.", required: true
formats ["json"]
example 'curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/fk27vnslkd/audit.json'
description "This will return array of views including IP, referrer and other such metadata. The " \
"_successful_ field indicates whether the view was made while the push was still active " \
"(and not expired). Note that you must be the owner of the push to retrieve the audit log " \
"and this call will always return 401 Unauthorized for pushes not owned by the credentials provided."
def audit
if @push.user_id != current_user.id
respond_to do |format|
format.html { redirect_to :root, notice: _("That push doesn't belong to you.") }
format.json { render json: {error: "That push doesn't belong to you."} }
end
return
end
@secret_url = helpers.secret_url(@push)
respond_to do |format|
format.html {}
format.json do
render json: {views: @push.views}.to_json(except: %i[user_id file_push_id id])
end
end
end
api :DELETE, "/f/:url_token.json", "Expire a push: delete the files, payload and expire the secret URL."
param :url_token, String, desc: "Secret URL token of a previously created push.", required: true
formats ["json"]
example 'curl -X DELETE -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/fkwjfvhall92.json'
description "Expires a push immediately. Must be authenticated & owner of the push _or_ the push must " \
"have been created with _deleteable_by_viewer_."
def destroy
is_owner = false
if user_signed_in?
# Check if logged in user owns the file_push to be expired
if @push.user_id == current_user.id
is_owner = true
else
redirect_to :root, notice: _("That push does not belong to you.")
return
end
elsif @push.deletable_by_viewer == false
# Anonymous user - assure deletable_by_viewer enabled
redirect_to :root, notice: _("That push is not deletable by viewers.")
return
end
if @push.expired
respond_to do |format|
format.html { redirect_to @push }
format.json { render json: {error: _("That push is already expired.")}, status: :unprocessable_entity }
end
return
end
log_view(@push, manual_expiration: true)
@push.expired = true
@push.payload = nil
@push.deleted = true
@push.files.purge
@push.expired_on = Time.zone.now
respond_to do |format|
if @push.save
format.html do
if is_owner && !ENV.key?("PWP_PUBLIC_GATEWAY")
redirect_to audit_file_push_path(@push),
notice: _("The push content has been deleted and the secret URL expired.")
else
redirect_to @push,
notice: _("The push content has been deleted and the secret URL expired.")
end
end
format.json { render json: @push, status: :ok }
else
format.html { render action: "new", status: :unprocessable_entity }
format.json { render json: @push.errors, status: :unprocessable_entity }
end
end
end
api :GET, "/f/active.json", "Retrieve your active file pushes."
formats ["json"]
example 'curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/active.json'
description "Returns the list of file pushes that you previously pushed which are still active."
def active
unless Settings.enable_logins
redirect_to :root
return
end
@pushes = FilePush.includes(:views)
.where(user_id: current_user.id, expired: false)
.page(params[:page])
.order(created_at: :desc)
respond_to do |format|
format.html {}
format.json do
json_parts = []
@pushes.each do |push|
json_parts << push.to_json(owner: true, payload: false)
end
render json: "[#{json_parts.join(",")}]"
end
end
end
api :GET, "/f/expired.json", "Retrieve your expired file pushes."
formats ["json"]
example 'curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/expired.json'
description "Returns the list of file pushes that you previously pushed which have expired."
def expired
unless Settings.enable_logins
redirect_to :root
return
end
@pushes = FilePush.includes(:views)
.where(user_id: current_user.id, expired: true)
.page(params[:page])
.order(created_at: :desc)
respond_to do |format|
format.html {}
format.json do
json_parts = []
@pushes.each do |push|
json_parts << push.to_json(owner: true, payload: false)
end
render json: "[#{json_parts.join(",")}]"
end
end
end
private
##
# log_view
#
# Record that a view is being made for a file_push
#
def log_view(file_push, manual_expiration: false)
record = {}
# 0 - standard user view
# 1 - manual expiration
record[:kind] = manual_expiration ? 1 : 0
record[:user_id] = current_user.id if user_signed_in?
record[:ip] =
request.env["HTTP_X_FORWARDED_FOR"].nil? ? request.env["REMOTE_ADDR"] : request.env["HTTP_X_FORWARDED_FOR"]
# Limit retrieved values to 256 characters
record[:user_agent] = request.env["HTTP_USER_AGENT"].to_s[0, 255]
record[:referrer] = request.env["HTTP_REFERER"].to_s[0, 255]
record[:successful] = file_push.expired ? false : true
file_push.views.create(record)
file_push
end
# Since determining this value between and HTML forms and JSON API requests can be a bit
# tricky, we break this out to it's own function.
def create_detect_retrieval_step(file_push, params)
if Settings.files.enable_retrieval_step == true
if params.key?(:retrieval_step)
# User form data or json API request: :deletable_by_viewer can
# be 'on', 'true', 'checked' or 'yes' to indicate a positive
user_rs = params[:retrieval_step].to_s.downcase
file_push.retrieval_step = %w[on yes checked true].include?(user_rs)
else
file_push.retrieval_step = if request.format.html?
# HTML Form Checkboxes: when NOT checked the form attribute isn't submitted
# at all so we set false - NOT deletable by viewers
false
else
# The JSON API is implicit so if it's not specified, use the app
# configured default
Settings.files.retrieval_step_default
end
end
else
# RETRIEVAL_STEP_ENABLED not enabled
file_push.retrieval_step = false
end
end
# Since determining this value between and HTML forms and JSON API requests can be a bit
# tricky, we break this out to it's own function.
def create_detect_deletable_by_viewer(file_push, params)
if Settings.files.enable_deletable_pushes == true
if params.key?(:deletable_by_viewer)
# User form data or json API request: :deletable_by_viewer can
# be 'on', 'true', 'checked' or 'yes' to indicate a positive
user_dvb = params[:deletable_by_viewer].to_s.downcase
file_push.deletable_by_viewer = %w[on yes checked true].include?(user_dvb)
else
file_push.deletable_by_viewer = if request.format.html?
# HTML Form Checkboxes: when NOT checked the form attribute isn't submitted
# at all so we set false - NOT deletable by viewers
false
else
# The JSON API is implicit so if it's not specified, use the app
# configured default
Settings.files.deletable_pushes_default
end
end
else
# DELETABLE_PASSWORDS_ENABLED not enabled
file_push.deletable_by_viewer = false
end
end
def set_push
@push = FilePush.includes(:views).find_by!(url_token: params[:id])
rescue ActiveRecord::RecordNotFound
# Showing a 404 reveals that this Secret URL never existed
# which is an information leak (not a secret anymore)
# We also don't want data in general. We entirely delete old pushes that:
# 1. have expired (payloads already deleted long ago)
# 2. are anonymous/not linked to a user account (audit log not needed)
# Old, expired & anonymous pushes have no value to anybody.
# When not found, show the 'expired' page so even very old secret URLs
# when clicked they will be accurate - this secret URL has expired.
# No easy fix for JSON unfortunately as we don't have a record to show.
respond_to do |format|
format.html { render template: "file_pushes/show_expired", layout: "naked" }
format.json { render json: {error: "not-found"}.to_json, status: :not_found }
format.any { head :not_acceptable }
end
end
def file_push_params
params.require(:file_push).permit(:payload, :expire_after_days, :expire_after_views,
:retrieval_step, :deletable_by_viewer, :note, :passphrase, files: [])
end
def print_preview_params
params.permit(:id, :locale, :message, :show_expiration, :show_id)
end
end