-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprotect-django-media-files-per-user-basis-with-nginx.html
More file actions
325 lines (269 loc) · 17 KB
/
Copy pathprotect-django-media-files-per-user-basis-with-nginx.html
File metadata and controls
325 lines (269 loc) · 17 KB
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="Thomas Loiret">
<meta name="description" content="How can you control access to django media files ?">
<meta name="fediverse:creator" content="@b0uh@mamot.fr">
<meta name="google-site-verification" content="jZBc2U9MHiBnSlgpoFEed-V3PZ16pMNv0GSX4hOh4mg" />
<title>Protect Django media files per user basis with nginx - Thomas Loiret - Random thoughts</title>
<!-- Custom styles for this template -->
<!-- build:css stylesheets/main.css -->
<link rel="stylesheet" href="https://b0uh.github.io/theme/css/main.min.css">
<link rel="stylesheet" href="https://b0uh.github.io/theme/css/custom.min.css">
<link rel="stylesheet" href="https://b0uh.github.io/theme/css/pygments/autumn.min.css">
<!-- endbuild -->
<link href="https://b0uh.github.io/feeds/all.atom.xml" type="application/atom+xml" rel="alternate" title="Thomas Loiret - Random thoughts Atom Feed" />
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<!-- Google Fonts -->
<script type="text/javascript">
WebFontConfig = {
google: { families: [ 'Open+Sans:300,400,700:latin', 'Lato:700,900:latin' ] }
};
(function() {
var wf = document.createElement('script');
wf.src = ('https:' == document.location.protocol ? 'https' : 'http') +
'://ajax.googleapis.com/ajax/libs/webfont/1/webfont.js';
wf.type = 'text/javascript';
wf.async = 'true';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(wf, s);
})();
</script>
</head>
<body>
<!-- header -->
<header class="header push-down-45">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#readable-navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<nav class="navbar navbar-default" role="navigation">
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="readable-navbar-collapse">
<ul class="navigation">
<li>
<a href="https://b0uh.github.io">Home</a>
</li>
<li>
<a href="https://b0uh.github.io/pages/about.html">About</a>
</li>
<li>
<a href="https://b0uh.github.io/pages/bookmarks.html">Bookmarks</a>
</li>
<li>
<a href="https://b0uh.github.io/archives.html">Archives</a>
</li>
</ul>
</div><!-- /.navbar-collapse -->
</nav>
<div class="hidden-xs hidden-sm">
<div class="social">
<a href="#" class="search__container">
<span class="glyphicon glyphicon-flash"></span>
</a>
<ul class="social__dropdown">
<li>
<a href="https://b0uh.github.io/feeds/all.atom.xml" target="_blank" class="social__container">
<span class="zocial-rss"></span>
</a>
</li>
<li>
<a href="https://mamot.fr/@b0uh" rel="me" target="_blank" class="social__container">
<img src="https://b0uh.github.io/theme/images/icons/mastodon-25px.png" />
</a>
</li>
<li>
<a href="https://www.linkedin.com/in/thomasloiret/" target="_blank" class="social__container">
<span class="zocial-linkedin"></span>
</a>
</li>
<li>
<a href="https://www.last.fm/user/b0uh" target="_blank" class="social__container">
<span class="zocial-lastfm"></span>
</a>
</li>
</ul>
</div>
</div>
</div>
</header>
<div class="container">
<div itemscope itemtype="http://schema.org/Article" class="boxed push-down-60">
<!-- Start of the blogpost -->
<div class="row">
<div class="col-xs-10 col-xs-offset-1 col-md-8 col-md-offset-2 push-down-60">
<!-- Start of the content -->
<div class="post-content">
<h1 itemprop="name">Protect Django media files per user basis with nginx</h1>
<div class="meta__container--without-image">
<div class="row">
<div class="col-xs-12 col-sm-8">
<span itemprop="author" itemscope itemtype="http://schema.org/Person">
<div class="meta__info" itemprop="name">
Thomas Loiret
</div>
</span>
</div>
<div class="col-xs-12 col-sm-4">
<div class="meta__comments">
<span class="meta__date" itemprop="datePublished" content="2017-05-30">
<span class="glyphicon glyphicon-calendar"></span> Tue 30 May 2017
</span>
</div>
</div>
</div>
</div>
<span itemprop="articleBody">
<h2>Use case</h2>
<p>A service with Django where user can upload files and you want to be sure that they can only access to their own files and not the files from other users. </p>
<p>In this example, I am using <a href="http://nginx.org/">nginx</a> but this solution can be adapted to other http servers.</p>
<h2>Step 1: All requests for media should go throught a specific view</h2>
<p>Edit file <code>myproject/urls.py</code> and add:</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">myproject.views</span> <span class="kn">import</span> <span class="n">media_access</span>
<span class="n">urlpatterns</span> <span class="o">=</span> <span class="p">[</span>
<span class="o">...</span><span class="p">,</span>
<span class="n">url</span><span class="p">(</span><span class="sa">r</span><span class="s1">'^media/(?P<path>.*)'</span><span class="p">,</span> <span class="n">media_access</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'media'</span><span class="p">),</span>
<span class="p">]</span>
</code></pre></div>
<h2>Step 2: Add the view and check access</h2>
<p>Add the following view in <code>myproject/views.py</code>:</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">django.http</span> <span class="kn">import</span> <span class="n">HttpResponse</span>
<span class="kn">from</span> <span class="nn">django.http</span> <span class="kn">import</span> <span class="n">HttpResponseForbidden</span>
<span class="k">def</span> <span class="nf">media_access</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> When trying to access :</span>
<span class="sd"> myproject.com/media/uploads/passport.png</span>
<span class="sd"> If access is authorized, the request will be redirected to</span>
<span class="sd"> myproject.com/protected/media/uploads/passport.png</span>
<span class="sd"> This special URL will be handle by nginx we the help of X-Accel</span>
<span class="sd"> """</span>
<span class="n">access_granted</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">user</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span>
<span class="k">if</span> <span class="n">user</span><span class="o">.</span><span class="n">is_authenticated</span><span class="p">():</span>
<span class="k">if</span> <span class="n">user</span><span class="o">.</span><span class="n">is_staff</span><span class="p">:</span>
<span class="c1"># If admin, everything is granted</span>
<span class="n">access_granted</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># For simple user, only their documents can be accessed</span>
<span class="n">user_documents</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">user</span><span class="o">.</span><span class="n">identity_document</span><span class="p">,</span>
<span class="c1"># add here more allowed documents</span>
<span class="p">]</span>
<span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">user_documents</span><span class="p">:</span>
<span class="k">if</span> <span class="n">path</span> <span class="o">==</span> <span class="n">doc</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
<span class="n">access_granted</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">if</span> <span class="n">access_granted</span><span class="p">:</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">HttpResponse</span><span class="p">()</span>
<span class="c1"># Content-type will be detected by nginx</span>
<span class="k">del</span> <span class="n">response</span><span class="p">[</span><span class="s1">'Content-Type'</span><span class="p">]</span>
<span class="n">response</span><span class="p">[</span><span class="s1">'X-Accel-Redirect'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'/protected/media/'</span> <span class="o">+</span> <span class="n">path</span>
<span class="k">return</span> <span class="n">response</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">HttpResponseForbidden</span><span class="p">(</span><span class="s1">'Not authorized to access this media.'</span><span class="p">)</span>
</code></pre></div>
<p>Here the important part is about the variable <code>user_documents</code>. It should contain reference to all files the user has access. In my case I extended the <code>User</code> model to add a field <code>identity_document</code> that why I can access it here.</p>
<p>In this <code>media_acces</code> view, you can implement any authorization logic.</p>
<h2>Step 3: Configure nginx</h2>
<p>Here is a full example of nginx configuration. The important part is about <code>location /protected/</code>. We suppose that Django is available with <a href="http://gunicorn.org/">Gunicorn</a> on port 8080 for example.</p>
<div class="highlight"><pre><span></span><code><span class="n">upstream</span> <span class="n">myprojectapp</span> <span class="p">{</span>
<span class="n">server</span> <span class="n">localhost</span><span class="p">:</span><span class="mi">8080</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">server</span> <span class="p">{</span>
<span class="n">listen</span> <span class="mi">80</span><span class="p">;</span>
<span class="n">server_name</span> <span class="n">myproject</span><span class="o">.</span><span class="n">com</span><span class="p">;</span>
<span class="n">server_name_in_redirect</span> <span class="n">on</span><span class="p">;</span>
<span class="n">error_log</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">nginx</span><span class="o">/</span><span class="n">myproject</span><span class="o">-</span><span class="n">error</span><span class="o">.</span><span class="n">log</span> <span class="n">crit</span><span class="p">;</span>
<span class="n">access_log</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">nginx</span><span class="o">/</span><span class="n">myproject</span><span class="o">-</span><span class="n">access</span><span class="o">.</span><span class="n">log</span> <span class="n">custom_combined</span><span class="p">;</span>
<span class="n">root</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">my</span><span class="o">/</span><span class="n">django</span><span class="o">/</span><span class="n">project</span><span class="o">/</span><span class="n">static</span><span class="p">;</span>
<span class="n">location</span> <span class="o">^~</span> <span class="o">/</span><span class="n">static</span><span class="o">/</span> <span class="p">{</span>
<span class="n">alias</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">my</span><span class="o">/</span><span class="n">django</span><span class="o">/</span><span class="n">project</span><span class="o">/</span><span class="n">static</span><span class="o">/</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">location</span> <span class="o">/</span><span class="n">protected</span><span class="o">/</span> <span class="p">{</span>
<span class="n">internal</span><span class="p">;</span>
<span class="n">alias</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">my</span><span class="o">/</span><span class="n">django</span><span class="o">/</span><span class="n">project</span><span class="o">/</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">location</span> <span class="o">/</span> <span class="p">{</span>
<span class="n">include</span> <span class="n">proxy_params</span><span class="p">;</span>
<span class="n">proxy_pass</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">myprojectapp</span><span class="p">;</span>
<span class="n">proxy_buffering</span> <span class="n">off</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<p>You can notice there is no <code>location ^~ /media/</code> that's because this URL is handle by django.</p>
<h2>Conclusion</h2>
<p>You have seen how quickly you can protect your media files taking advantage of Django to handle the authorization and of nginx to serve files :)</p>
<p>You can find more informations about X-accel on nginx website: <a href="https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/">https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/</a></p>
</span>
<div class="meta__container--without-image">
<div class="row">
</div>
</div>
<br>
</div>
</div>
</div>
</div>
</div>
<footer class="copyrights">
<div class="container">
<div class="row">
<div class="col-xs-12 col-sm-6">
Powered by <a href="https://github.com/getpelican/pelican">Pelican</a>.
</div>
<div class="col-xs-12 col-sm-6">
<div class="copyrights--right">
Made with <span class="glyphicon glyphicon-heart"></span> in Nantes.
</div>
</div>
</div>
</div>
</footer>
<script src="https://b0uh.github.io/theme/scripts/jquery.min.js"></script>
<script src="https://b0uh.github.io/theme/scripts/underscore.min.js"></script>
<script src="https://b0uh.github.io/theme/scripts/bootstrap.min.js"></script>
<script src="https://b0uh.github.io/theme/scripts/main.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-98369697-1', 'auto');
ga('send', 'pageview');
</script>
<!-- Chiffre.io - Privacy-first analytics -->
<script id="chiffre:analytics-config" type="application/json">
{
"publicKey": "pk.VvetZOQ0g5XwOL2W6hVvG7gFQTk3xdUMczDkqSCZUxE",
"pushURL": "https://push.chiffre.io/event/ceJKfYgcLN6XkYn8"
}
</script>
<script
src="https://embed.chiffre.io/analytics.js"
crossorigin="anonymous"
async=""
>
</script>
<noscript>
<img
src="https://push.chiffre.io/noscript/ceJKfYgcLN6XkYn8"
alt="Chiffre.io anonymous visit counting for clients without JavaScript"
crossorigin="anonymous"
width="1px"
height="1px"
style="display:none"
/>
</noscript>
</body>
</html>