Skip to content

Latest commit

 

History

History
360 lines (241 loc) · 11.6 KB

README.rst

File metadata and controls

360 lines (241 loc) · 11.6 KB
Raw

django-private-storage

https://github.com/edoburu/django-private-storage/actions/workflows/tests.yaml/badge.svg?branch=master

This module offers a private media file storage, so user uploads can be protected behind a login.

It uses the Django storage API's internally, so all form rendering and admin integration work out of the box.

Installation

pip install django-private-storage

Configuration

Add to the settings:

INSTALLED_APPS += (
    'private_storage',
)

PRIVATE_STORAGE_ROOT = '/path/to/private-media/'
PRIVATE_STORAGE_AUTH_FUNCTION = 'private_storage.permissions.allow_staff'

Add to urls.py:

import private_storage.urls

urlpatterns += [
    path('private-media/', include(private_storage.urls)),
]

Usage

In a Django model, add the PrivateFileField:

from django.db import models
from private_storage.fields import PrivateFileField

class MyModel(models.Model):
    title = models.CharField("Title", max_length=200)
    file = PrivateFileField("File")

The PrivateFileField also accepts the following kwargs:

  • upload_to: the optional subfolder in the PRIVATE_STORAGE_ROOT.
  • upload_subfolder: a function that defines the folder, it receives the current model instance.
  • content_types: allowed content types
  • max_file_size: maximum file size in bytes. (1MB is 1024 * 1024)
  • storage: the storage object to use, defaults to private_storage.storage.private_storage

Images

You can also use PrivateImageField which only allows you to upload images:

from django.db import models
from private_storage.fields import PrivateImageField

class MyModel(models.Model):
    title = models.CharField("Title", max_length=200)
    width = models.PositiveSmallIntegerField(default=0)
    height = models.PositiveSmallIntegerField(default=0)
    image = PrivateFileField("Image", width_field='width', height_field='height')

The PrivateImageField also accepts the following kwargs on top of PrivateFileField:

  • width_field: optional field for that stores the width of the image
  • height_field: optional field for that stores the height of the image

Other topics

Storing files on Amazon S3

The PRIVATE_STORAGE_CLASS setting can be redefined to point to a different storage class. The default is private_storage.storage.files.PrivateFileSystemStorage, which uses a private media folder that PRIVATE_STORAGE_ROOT points to.

Define one of these settings instead:

PRIVATE_STORAGE_CLASS = 'private_storage.storage.s3boto3.PrivateS3BotoStorage'

AWS_PRIVATE_STORAGE_BUCKET_NAME = 'private-files'  # bucket name

This uses django-storages settings. Replace the prefix AWS_ with AWS_PRIVATE_. The following settings are reused when they don't have an corresponding AWS_PRIVATE_... setting:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_S3_URL_PROTOCOL
  • AWS_S3_REGION_NAME
  • AWS_IS_GZIPPED

All other settings should be explicitly defined with AWS_PRIVATE_... settings.

By default, all URLs in the admin return the direct S3 bucket URls, with the query parameter authentication enabled. When AWS_PRIVATE_QUERYSTRING_AUTH = False, all file downloads are proxied through our PrivateFileView URL. This behavior can be enabled explicitly using PRIVATE_STORAGE_S3_REVERSE_PROXY = True.

To have encryption either configure AWS_PRIVATE_S3_ENCRYPTION and AWS_PRIVATE_S3_SIGNATURE_VERSION or use:

PRIVATE_STORAGE_CLASS = 'private_storage.storage.s3boto3.PrivateEncryptedS3BotoStorage'

Make sure an encryption key is generated on Amazon.

MinIO storage

Define one of these settings :

PRIVATE_STORAGE_CLASS = 'private_storage.storage.minio.PrivateMinioStorage'

MINIO_PRIVATE_STORAGE_MEDIA_BUCKET_NAME = 'private-files'
MINIO_PRIVATE_STORAGE_MEDIA_URL= '/private-files'

This uses django-minio-storage settings. Replace the prefix MINIO_ with MINIO_PRIVATE_. The all settings are reused when they don't have an corresponding MINIO_PRIVATE_... setting.

  • MINIO_STORAGE_ENDPOINT
  • MINIO_STORAGE_ACCESS_KEY
  • MINIO_STORAGE_SECRET_KEY
  • MINIO_STORAGE_USE_HTTPS
  • MINIO_STORAGE_MEDIA_BUCKET_NAME
  • MINIO_STORAGE_MEDIA_URL
  • MINIO_STORAGE_AUTO_CREATE_MEDIA_BUCKET
  • MINIO_STORAGE_AUTO_CREATE_MEDIA_POLICY
  • MINIO_STORAGE_MEDIA_USE_PRESIGNED
  • MINIO_STORAGE_MEDIA_BACKUP_FORMAT
  • MINIO_STORAGE_ASSUME_MEDIA_BUCKET_EXISTS
  • MINIO_STORAGE_MEDIA_OBJECT_METADATA

As with S3, you can enable proxy through our PrivateFileView URL. Just specify PRIVATE_STORAGE_MINO_REVERSE_PROXY = True.

Defining access rules

The PRIVATE_STORAGE_AUTH_FUNCTION defines which user may access the files. By default, this only includes superusers.

The following options are available out of the box:

  • private_storage.permissions.allow_authenticated
  • private_storage.permissions.allow_staff
  • private_storage.permissions.allow_superuser

You can create a custom function, and use that instead. The function receives a private_storage.models.PrivateFile object, which has the following fields:

  • request: the Django request.
  • storage: the storage engine used to retrieve the file.
  • relative_name: the file name in the storage.
  • full_path: the full file system path.
  • exists(): whether the file exists.
  • content_type: the HTTP content type.
  • parent_object: only set when PrivateStorageDetailView was used.

Retrieving files by object ID

To implement more object-based access permissions, create a custom view that provides the download.

from private_storage.views import PrivateStorageDetailView

class MyDocumentDownloadView(PrivateStorageDetailView):
    model = MyModel
    model_file_field = 'file'

    def get_queryset(self):
        # Make sure only certain objects can be accessed.
        return super().get_queryset().filter(...)

    def can_access_file(self, private_file):
        # When the object can be accessed, the file may be downloaded.
        # This overrides PRIVATE_STORAGE_AUTH_FUNCTION
        return True

The following class-level attributes can be overwritten:

  • model: The model to fetch (including every other attribute of SingleObjectMixin).
  • model_file_field: This should point to the field used to store the file.
  • storage / get_storage(): The storage class to read the file from.
  • server_class: The Python class used to generate the HttpResponse / FileResponse.
  • content_disposition: Can be "inline" (show inside the browser) or "attachment" (saved as download).
  • content_disposition_filename / get_content_disposition_filename(): Overrides the filename for downloading.

Optimizing large file transfers

Sending large files can be inefficient in some configurations.

In the worst case scenario, the whole file needs to be read in chunks and passed as a whole through the WSGI buffers, OS kernel, webserver and proxy server. In effect, the complete file is copied several times through memory buffers.

There are more efficient ways to transfer files, such as the sendfile() system call on UNIX. Django uses such feature when the WSGI server provides wsgi.file_handler support.

In some situations, this effect is nullified, for example by by a local HTTP server sitting in front of the WSGI container. A typical case would be running Gunicorn behind an Nginx or Apache webserver.

For such situation, the native support of the webserver can be enabled with the following settings:

For apache

PRIVATE_STORAGE_SERVER = 'apache'

This requires in addition an installed and activated mod_xsendfile Apache module. Add the following XSendFile configurations to your conf.d config file.

<virtualhost ...>
...
WSGIScriptAlias / ...
XSendFile On
XSendFilePath ... [path to where the files are, same as PRIVATE_STORAGE_ROOT]
...
</virtualhost>

For Nginx

PRIVATE_STORAGE_SERVER = 'nginx'
PRIVATE_STORAGE_INTERNAL_URL = '/private-x-accel-redirect/'

Add the following location block in the server config:

location /private-x-accel-redirect/ {
  internal;
  alias   /path/to/private-media/;
}

For very old Nginx versions, you'll have to configure PRIVATE_STORAGE_NGINX_VERSION, because Nginx versions before 1.5.9 (released in 2014) handle non-ASCII filenames differently.

Other webservers

The PRIVATE_STORAGE_SERVER may also point to a dotted Python class path. Implement a class with a static serve(private_file) method.

Using multiple storages

The PrivateFileField accepts a storage kwarg, hence you can initialize multiple private_storage.storage.PrivateStorage objects, each providing files from a different location and base_url.

For example:

from django.db import models
from private_storage.fields import PrivateFileField
from private_storage.storage.files import PrivateFileSystemStorage

my_storage = PrivateFileSystemStorage(
    location='/path/to/storage2/',
    base_url='/private-documents2/'
)

class MyModel(models.Model):
    file = PrivateFileField(storage=my_storage)

Then create a view to serve those files:

from private_storage.views import PrivateStorageView
from .models import my_storage

class MyStorageView(PrivateStorageView):
    storage = my_storage

    def can_access_file(self, private_file):
        # This overrides PRIVATE_STORAGE_AUTH_FUNCTION
        return self.request.is_superuser

And expose that URL:

urlpatterns += [
    url('^private-documents2/(?P<path>.*)$', views.MyStorageView.as_view()),
]

Contributing

This module is designed to be generic. In case there is anything you didn't like about it, or think it's not flexible enough, please let us know. We'd love to improve it!

Running tests

We use tox to run the test suite on different versions locally (and travis-ci to automate the check for PRs).

To tun the test suite locally, please make sure your python environment has tox and django installed:

python3.6 -m pip install tox django

And then simply execute tox to run the whole test matrix:

tox