Release 2.3.0
linter / quality (push) Successful in 1m5s
tests / ci (8.5) (push) Successful in 3m24s
docker / build-and-push (push) Successful in 7m10s
docker / test (8.5) (push) Successful in 3m21s
docker / release (push) Successful in 4s

A share can now hold a private text (a password, a key, a short note)
with its files or on its own. The upload page's new "Private text" card
takes up to 100 KB; the browser encrypts the text and sends it through
the same chunk pipeline as a file, flagged is_text on share_files, so it
gets the share's password, expiry, download limit and cleanup.

The recipient sees the text only after pressing "Show text", which
counts as their download, so a messenger link preview cannot use up a
share limited to one download. The text is left out of the file list,
the ZIP and the file counts; the admin dashboard marks shares that hold
one with "Text".

The website gains a Private text feature card and a fifth phone
screenshot; every screenshot is retaken.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Andreas Reinhold / reini
2026-09-26 07:00:17 +02:00
co-authored by Claude Opus 5.5
parent 202813a1e6
commit f9a7839ad3
73 changed files with 806 additions and 134 deletions
+9 -22
View File
@@ -23,14 +23,17 @@ class DownloadController extends Controller
/**
* Download all files as a ZIP archive, streamed file by file as it is decrypted: stored without
* compression, with ZIP64 for files over 4 GB, and never held in memory or written to disk.
* compression, with ZIP64 for files over 4 GB, and never held in memory or written to disk. The
* private text is left out: it is only ever shown on the page.
*/
public function download(Request $request, Share $share): StreamedResponse
{
abort_if(! $share->isCompleted() || $share->isExpired(), 404);
$share->load('files');
$key = $this->resolveDecryptionKey($share);
$share->load(['files' => fn ($query) => $query->where('is_text', false)]);
abort_if($share->files->isEmpty(), 404);
$key = $this->shareService->sessionDecryptionKey($share, $request->session());
// Counted before the body streams: the session is saved by then.
abort_unless($this->shareService->claimDownload($share, $request->session()), 404);
@@ -73,14 +76,14 @@ class DownloadController extends Controller
}
/**
* Download a single file.
* Download a single file; never the private text, which is only ever shown on the page.
*/
public function downloadFile(Request $request, Share $share, ShareFile $shareFile): StreamedResponse
{
abort_if(! $share->isCompleted() || $share->isExpired(), 404);
abort_if($shareFile->share_id !== $share->id, 404);
abort_if($shareFile->share_id !== $share->id || $shareFile->is_text, 404);
$key = $this->resolveDecryptionKey($share);
$key = $this->shareService->sessionDecryptionKey($share, $request->session());
abort_unless($this->shareService->claimDownload($share, $request->session()), 404);
@@ -122,20 +125,4 @@ class DownloadController extends Controller
return $filename;
}
/**
* Resolve the decryption key from session or share.
*/
private function resolveDecryptionKey(Share $share): string
{
if ($share->isPasswordProtected()) {
$key = session('share_key_'.$share->token);
abort_if(! $key, 403, 'Password required');
return $key;
}
return $this->shareService->getDecryptionKey($share);
}
}
+4 -2
View File
@@ -59,7 +59,9 @@ class AdminDashboard extends Component
// Shares whose files are still being uploaded are not shares yet; their bytes do count as used space.
$shares = Share::query()
->whereNotNull('completed_at')
->withCount('files')
// A share's private text is not one of its files.
->withCount(['files' => fn ($query) => $query->where('is_text', false)])
->withExists('textFile')
// Shares that never expire come after every share that does, whichever way expiry is sorted.
->when($column === 'expires_at', fn ($query) => $query->orderByRaw('expires_at is null'))
->orderBy($column, $direction)
@@ -74,7 +76,7 @@ class AdminDashboard extends Component
})->where(function ($q) {
$q->whereNull('max_downloads')->orWhereColumn('download_count', '<', 'max_downloads');
})->count(),
'totalFiles' => ShareFile::query()->whereHas('share', fn ($query) => $query->whereNotNull('completed_at'))->count(),
'totalFiles' => ShareFile::query()->where('is_text', false)->whereHas('share', fn ($query) => $query->whereNotNull('completed_at'))->count(),
'usedSpace' => $shareService->getTotalUsedSpace(),
'maxQuota' => $shareService->getMaxStorageQuota(),
'version' => config('app.version'),
+73 -17
View File
@@ -4,6 +4,7 @@ namespace App\Livewire;
use App\Models\Setting;
use App\Models\Share;
use App\Models\ShareFile;
use App\Services\PasswordGeneratorService;
use App\Services\ShareService;
use Carbon\CarbonInterval;
@@ -73,26 +74,50 @@ class FileUploader extends Component
continue;
}
if ($this->pendingToken !== $shareFile->share->token) {
$this->pendingToken = $shareFile->share->token;
session()->push('pending_shares', $this->pendingToken);
}
$this->rememberPendingShare($shareFile->share);
$header = $shareService->readHeader($shareFile);
$targets[] = [
'id' => $shareFile->id,
'url' => Str::beforeLast(route('upload.chunk', ['shareFile' => $shareFile, 'index' => 0]), '/'),
'key' => $shareFile->share->encryption_key,
'noncePrefix' => bin2hex($header['noncePrefix']),
'chunkSize' => $header['chunkSize'],
'chunkCount' => $header['chunkCount'],
];
$targets[] = $this->uploadTarget($shareFile, $shareService);
}
return $targets;
}
/**
* Register the private text as the share is created, in place of any text an earlier attempt
* registered, and hand the browser what it encrypts and sends it with. Only its size in UTF-8
* bytes reaches the server here: the text itself arrives encrypted, like a file. Nothing is
* registered for an empty text; a text an admin limit refuses gets `null` and the reason under
* `text`.
*
* @return array{id: int, url: string, key: string, noncePrefix: string, chunkSize: int, chunkCount: int}|null
*/
public function registerText(int $size, ShareService $shareService): ?array
{
$this->resetErrorBag('text');
$existingText = $this->pendingShare()?->textFile()->first();
if ($existingText !== null) {
$shareService->removeFile($existingText);
}
if ($size === 0) {
return null;
}
try {
$shareFile = $shareService->registerFile($this->pendingShare(), 'text.txt', $size, null, isText: true);
} catch (ValidationException $e) {
$this->addError('text', $e->errors()['files'][0]);
return null;
}
$this->rememberPendingShare($shareFile->share);
return $this->uploadTarget($shareFile, $shareService);
}
/**
* Take files out of the pending share, whether or not their upload finished.
*
@@ -153,7 +178,7 @@ class FileUploader extends Component
$pendingShare = $this->pendingShare();
if ($pendingShare === null) {
$this->addError('files', __('Please select at least one file to upload.'));
$this->addError('files', __('Add files or a text to share.'));
return;
}
@@ -183,17 +208,48 @@ class FileUploader extends Component
public function render(): mixed
{
$shareService = app(ShareService::class);
$pendingFiles = $this->pendingShare()?->files()->orderBy('id')->get() ?? collect();
$pendingFiles = $this->pendingShare()?->files()->where('is_text', false)->orderBy('id')->get() ?? collect();
return view('livewire.file-uploader', [
'pendingFiles' => $pendingFiles,
'allFilesUploaded' => $pendingFiles->isNotEmpty() && $pendingFiles->every(fn ($file): bool => $file->completed_at !== null),
'allFilesUploaded' => $pendingFiles->every(fn ($file): bool => $file->completed_at !== null),
'maxTextBytes' => ShareFile::MAX_TEXT_BYTES,
'isStorageFull' => $shareService->isStorageFull(),
'allowNeverExpire' => (bool) Setting::get('allow_never_expire', false),
'passwordGeneratorMode' => app(PasswordGeneratorService::class)->mode(),
]);
}
/**
* Make a share the one this page uploads into, and let this session reach it.
*/
private function rememberPendingShare(Share $share): void
{
if ($this->pendingToken !== $share->token) {
$this->pendingToken = $share->token;
session()->push('pending_shares', $this->pendingToken);
}
}
/**
* What the browser encrypts and sends a registered file with.
*
* @return array{id: int, url: string, key: string, noncePrefix: string, chunkSize: int, chunkCount: int}
*/
private function uploadTarget(ShareFile $shareFile, ShareService $shareService): array
{
$header = $shareService->readHeader($shareFile);
return [
'id' => $shareFile->id,
'url' => Str::beforeLast(route('upload.chunk', ['shareFile' => $shareFile, 'index' => 0]), '/'),
'key' => $shareFile->share->encryption_key,
'noncePrefix' => bin2hex($header['noncePrefix']),
'chunkSize' => $header['chunkSize'],
'chunkCount' => $header['chunkCount'],
];
}
/**
* This page's pending share, while it is still pending and this session started it.
*/
+24
View File
@@ -7,6 +7,7 @@ use App\Services\ShareService;
use Carbon\CarbonInterval;
use Illuminate\Support\Facades\RateLimiter;
use Livewire\Attributes\Layout;
use Livewire\Attributes\Renderless;
use Livewire\Attributes\Validate;
use Livewire\Component;
@@ -60,11 +61,34 @@ class ShareDownload extends Component
$this->authenticated = true;
}
/**
* The share's private text, for the recipient who pressed "Show text": counted as their
* download, as a file would be. Returned to the browser only, never kept in a property, so it
* is not in the component's snapshot. Null when the text is no longer available; no abort(),
* which would open Livewire's error modal. Renderless: a re-render would morph the download
* note Alpine just switched back into the one it hid.
*/
#[Renderless]
public function revealText(ShareService $shareService): ?string
{
$share = $this->share;
if (! $share->isCompleted() || $share->isExpired() || ! $share->hasText()
|| ($share->isPasswordProtected() && ! session('share_key_'.$share->token))
|| ! $shareService->claimDownload($share, session()->driver())) {
return null;
}
return $shareService->readText($share, $shareService->sessionDecryptionKey($share, session()->driver()));
}
public function render(): mixed
{
$shareService = app(ShareService::class);
return view('livewire.share-download', [
'files' => $this->share->files->where('is_text', false)->values(),
'hasText' => $this->share->files->contains('is_text', true),
'downloadWindowEndsAt' => $shareService->downloadWindowEndsAt($this->share, session()->driver()),
'remainingDownloads' => $this->share->max_downloads ? max($this->share->max_downloads - $this->share->download_count, 0) : null,
'downloadWindow' => CarbonInterval::minutes(ShareService::DOWNLOAD_WINDOW_MINUTES)->cascade()->forHumans(),
+16
View File
@@ -5,6 +5,7 @@ namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
class Share extends Model
{
@@ -62,6 +63,21 @@ class Share extends Model
return $this->hasMany(ShareFile::class);
}
/**
* The share's private text, stored as one of its files.
*
* @return HasOne<ShareFile, $this>
*/
public function textFile(): HasOne
{
return $this->hasOne(ShareFile::class)->where('is_text', true);
}
public function hasText(): bool
{
return $this->textFile()->exists();
}
/**
* Whether the share was created: until then its files are still being uploaded and nobody
* but the uploader's page may reach it.
+7
View File
@@ -10,6 +10,11 @@ class ShareFile extends Model
{
use HasFactory;
/**
* The most a share's private text may hold, in UTF-8 bytes: one chunk of the upload pipeline.
*/
public const MAX_TEXT_BYTES = 100 * 1024;
protected $fillable = [
'share_id',
'original_name',
@@ -17,6 +22,7 @@ class ShareFile extends Model
'stored_path',
'file_size',
'mime_type',
'is_text',
'uploaded_chunks',
'completed_at',
];
@@ -28,6 +34,7 @@ class ShareFile extends Model
{
return [
'file_size' => 'integer',
'is_text' => 'boolean',
'uploaded_chunks' => 'integer',
'completed_at' => 'datetime',
];
+91 -25
View File
@@ -17,6 +17,7 @@ use Illuminate\Validation\ValidationException;
use InvalidArgumentException;
use League\MimeTypeDetection\FinfoMimeTypeDetector;
use RuntimeException;
use Symfony\Component\HttpKernel\Exception\HttpException;
/**
* A share's life: files registered into a pending share, their encrypted chunks stored as the
@@ -35,11 +36,13 @@ class ShareService
/**
* Register a file the uploader's browser is about to send, in the given pending share or in a
* new one, and write its encrypted file's header.
* new one, and write its encrypted file's header. The share's private text is registered the
* same way, as `text.txt` with `$isText`: it is capped at ShareFile::MAX_TEXT_BYTES and does not
* count as one of the share's files.
*
* @throws ValidationException when the file breaks an admin limit
*/
public function registerFile(?Share $pendingShare, string $name, int $size, ?string $relativePath): ShareFile
public function registerFile(?Share $pendingShare, string $name, int $size, ?string $relativePath, bool $isText = false): ShareFile
{
$maxFileSize = (int) Setting::get('max_file_size', 100 * 1024 * 1024);
$maxFilesPerShare = (int) Setting::get('max_files_per_share', 50);
@@ -49,7 +52,11 @@ class ShareService
$this->rejectFile(__('The file could not be added.'));
}
if ($size > $maxFileSize) {
if ($isText && ($size < 1 || $size > ShareFile::MAX_TEXT_BYTES)) {
$this->rejectFile(__('The text is too long (maximum 100 KB).'));
}
if (! $isText && $size > $maxFileSize) {
$this->rejectFile(__('":name" is too large (:size MB). Maximum file size is :max MB.', [
'name' => $name,
'size' => round($size / (1024 * 1024), 1),
@@ -57,7 +64,7 @@ class ShareService
]));
}
if ($pendingShare && $pendingShare->files()->count() >= $maxFilesPerShare) {
if (! $isText && $pendingShare && $pendingShare->files()->where('is_text', false)->count() >= $maxFilesPerShare) {
$this->rejectFile(__('Too many files. Maximum :max files allowed per share.', ['max' => $maxFilesPerShare]));
}
@@ -85,6 +92,7 @@ class ShareService
'relative_path' => $this->sanitizeRelativePath($relativePath),
'stored_path' => 'shares/'.$share->token.'/'.$storedName,
'file_size' => $size,
'is_text' => $isText,
]);
$share->increment('total_size', $size);
@@ -192,14 +200,14 @@ class ShareService
$maxSizePerShare = (int) Setting::get('max_size_per_share', 2 * 1024 * 1024 * 1024);
if ($files->isEmpty()) {
$this->rejectFile(__('Please select at least one file to upload.'));
$this->rejectFile(__('Add files or a text to share.'));
}
if ($files->contains(fn (ShareFile $file): bool => $file->completed_at === null)) {
$this->rejectFile(__('Wait until every file has finished uploading, or remove the ones that failed.'));
}
if ($files->count() > $maxFilesPerShare) {
if ($files->where('is_text', false)->count() > $maxFilesPerShare) {
$this->rejectFile(__('Too many files. Maximum :max files allowed per share.', ['max' => $maxFilesPerShare]));
}
@@ -223,13 +231,13 @@ class ShareService
}
/**
* Create a share from files already on the server, through the same steps an upload from the
* browser takes. Used by tests and demo data.
* Create a share from files already on the server, and optionally a private text, through the
* same steps an upload from the browser takes. Used by tests and demo data.
*
* @param array<int, array{file: UploadedFile, relativePath: string|null}> $files
* @param array{password?: string|null, expires_at?: mixed, max_downloads?: int|null} $options
*/
public function createShare(array $files, array $options = []): Share
public function createShare(array $files, array $options = [], ?string $text = null): Share
{
$share = null;
@@ -238,34 +246,92 @@ class ShareService
$shareFile = $this->registerFile($share, $file->getClientOriginalName(), $file->getSize(), $fileData['relativePath'] ?? null);
$share = $shareFile->share;
$header = $this->readHeader($shareFile);
$source = fopen($file->getRealPath(), 'rb');
$this->storeContent($shareFile, $source);
fclose($source);
}
for ($index = 0; $index < $header['chunkCount']; $index++) {
$plaintextLength = min($header['chunkSize'], $shareFile->file_size - $index * $header['chunkSize']);
// A fake upload reports a size its content does not have: zeros make up the rest.
$chunk = $this->encryptionService->encryptChunk(
str_pad($plaintextLength > 0 ? (string) fread($source, $plaintextLength) : '', $plaintextLength, "\0"),
$share->encryption_key,
$header['noncePrefix'],
$index,
$index === $header['chunkCount'] - 1,
);
$this->storeChunk($shareFile->refresh(), $index, $chunk);
}
if ($text !== null && $text !== '') {
$shareFile = $this->registerFile($share, 'text.txt', strlen($text), null, isText: true);
$share = $shareFile->share;
$source = fopen('php://memory', 'r+b');
fwrite($source, $text);
rewind($source);
$this->storeContent($shareFile, $source);
fclose($source);
}
if ($share === null) {
$this->rejectFile(__('Please select at least one file to upload.'));
$this->rejectFile(__('Add files or a text to share.'));
}
return $this->completeShare($share, $options);
}
/**
* Encrypt a registered file's content chunk by chunk from a stream and store the chunks, as the
* uploader's browser would.
*
* @param resource $source
*/
private function storeContent(ShareFile $shareFile, $source): void
{
$share = $shareFile->share;
$header = $this->readHeader($shareFile);
for ($index = 0; $index < $header['chunkCount']; $index++) {
$plaintextLength = min($header['chunkSize'], $shareFile->file_size - $index * $header['chunkSize']);
// A fake upload reports a size its content does not have: zeros make up the rest.
$chunk = $this->encryptionService->encryptChunk(
str_pad($plaintextLength > 0 ? (string) fread($source, $plaintextLength) : '', $plaintextLength, "\0"),
$share->encryption_key,
$header['noncePrefix'],
$index,
$index === $header['chunkCount'] - 1,
);
$this->storeChunk($shareFile->refresh(), $index, $chunk);
}
}
/**
* A share's private text, decrypted in memory with the share's key; null when it has none.
*/
public function readText(Share $share, string $key): ?string
{
$textFile = $share->textFile()->first();
if ($textFile === null) {
return null;
}
return implode('', iterator_to_array(
$this->encryptionService->decryptedChunks($this->storedFilePath($textFile), $key),
false,
));
}
/**
* The key this session decrypts a share with: the one unlocked with the password and kept in
* the session, or the stored one for a share without a password.
*
* @throws HttpException 403 while a password share is still locked for this session
*/
public function sessionDecryptionKey(Share $share, Session $session): string
{
if ($share->isPasswordProtected()) {
$key = $session->get('share_key_'.$share->token);
abort_if(! $key, 403, 'Password required');
return $key;
}
return $this->getDecryptionKey($share);
}
/**
* Generate a unique share token with retry on collision.
*/