doc/admin/restricting-upload-download.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: Restricting upload or download
   5 ...
   6
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 For some use cases, you may want to limit the ability of users to upload or download data from outside the cluster.  (By "outside" we mean from networks other than the cluster's own private network).  For example, this makes it possible to share restricted data sets with users so that they may run their own data analysis on the cluster, while preventing them from easily downloading the data set to their local workstation.
  14
  15 This feature exists in addition to the existing Arvados permission system.  Users can only download from collections they have @read@ access to, and can only upload to projects and collections they have @write@ access to.
  16
  17 There are two services involved in accessing data from outside the cluster.
  18
  19 h2. Keepproxy Permissions
  20
  21 Permitting @keeproxy@ makes it possible to use @arv-put@ and @arv-get@, and upload from Workbench 1.  It works in terms of individual 64 MiB keep blocks.  It prints a log each time a user uploads or downloads an individual block.
  22
  23 The default policy allows anyone to upload or download.
  24
  25 <pre>
  26     Collections:
  27       KeepproxyPermission:
  28         User:
  29           Download: true
  30           Upload: true
  31         Admin:
  32           Download: true
  33           Upload: true
  34 </pre>
  35
  36 h2. WebDAV and S3 API Permissions
  37
  38 Permitting @WebDAV@ makes it possible to use WebDAV, S3 API, download from Workbench 1, and upload/download with Workbench 2.  It works in terms of individual files.  It prints a log each time a user uploads or downloads a file.  When @WebDAVLogEvents@ (default true) is enabled, it also adds an entry into the API server @logs@ table.
  39
  40 When a user attempts to upload or download from a service without permission, they will receive a @403 Forbidden@ response.  This only applies to file content.
  41
  42 Denying download permission does not deny access to access to XML file listings with PROPFIND, or auto-generated HTML documents containing file listings.
  43
  44 Denying upload permission does not deny other operations that modify collections without directly accessing file content, such as MOVE and COPY.
  45
  46 The default policy allows anyone to upload or download.
  47
  48 <pre>
  49     Collections:
  50       WebDAVPermisison:
  51         User:
  52           Download: true
  53           Upload: true
  54         Admin:
  55           Download: true
  56           Upload: true
  57       WebDAVLogEvents: true
  58 </pre>
  59
  60 h2. Shell node and container permissions
  61
  62 Be aware that even when upload and download from outside the network is not allowed, a user who has access to a shell node or runs a container still has internal access to Keep.  (This is necessary to be able to run workflows).  From the shell node or container, a user could send data outside the network by some other method, although this requires more intent than accidentally clicking on a link and downloading a file.  It is possible to set up a firewall to prevent shell and compute nodes from making connections to hosts outside the private network.  Exactly how to configure firewalls is out of scope for this page, as it depends on the specific network infrastructure of your cluster.
  63
  64 h2. Choosing a policy
  65
  66 This distinction between WebDAV and Keepproxy is important for auditing.  WebDAV records 'upload' and 'download' events on the API server that are included in the "User Activity Report":user-activity.html ,  whereas @keepproxy@ only logs upload and download of individual blocks, which require a reverse lookup to determine the collection(s) and file(s) a block is associated with.
  67
  68 You set separate permissions for @WebDAV@ and @Keepproxy@, with separate policies for regular users and admin users.
  69
  70 These policies apply to only access from outside the cluster, using Workbench or Arvados CLI tools.
  71
  72 The @WebDAVLogEvents@ option should be enabled if you intend to the run the "User Activity Report":user-activity.html .  If you don't need audits, or you are running a site that is mostly serving public data to anonymous downloaders, you can disable in to avoid the extra API server request.
  73
  74 h3. Audited downloads
  75
  76 For ease of access auditing, this policy prevents downloads using @arv-get@.  Downloads through WebDAV and S3 API are permitted, but logged.  Uploads are allowed.
  77
  78 <pre>
  79     Collections:
  80       WebDAVPermisison:
  81         User:
  82           Download: true
  83           Upload: true
  84         Admin:
  85           Download: true
  86           Upload: true
  87
  88       KeepproxyPermission:
  89         User:
  90           Download: false
  91           Upload: true
  92         Admin:
  93           Download: false
  94           Upload: true
  95       WebDAVLogEvents: true
  96 </pre>
  97
  98 h3. Disallow downloads by regular users
  99
 100 This policy prevents regular users (non-admin) from downloading data.  Uploading is allowed.  This supports the case where restricted data sets are shared users so that they may run their own data analysis on the cluster, while preventing them from downloading the data set to their local workstation.  Note that users won't be able to download the results of their analysis, either, requiring an admin in the loop or some other process to release results.
 101
 102 <pre>
 103     Collections:
 104       WebDAVPermisison:
 105         User:
 106           Download: false
 107           Upload: true
 108         Admin:
 109           Download: true
 110           Upload: true
 111
 112       KeepproxyPermission:
 113         User:
 114           Download: false
 115           Upload: true
 116         Admin:
 117           Download: true
 118           Upload: true
 119       WebDAVLogEvents: true
 120 </pre>
 121
 122 h3. Disallow uploads by regular users
 123
 124 This policy is suitable for an installation where data is being shared with a group of users who are allowed to download the data, but not permitted to store their own data on the cluster.
 125
 126 <pre>
 127     Collections:
 128       WebDAVPermisison:
 129         User:
 130           Download: true
 131           Upload: false
 132         Admin:
 133           Download: true
 134           Upload: true
 135
 136       KeepproxyPermission:
 137         User:
 138           Download: true
 139           Upload: false
 140         Admin:
 141           Download: true
 142           Upload: true
 143       WebDAVLogEvents: true
 144 </pre>