python-django-session-security 2.3.1+dfsg-1 / usr / share / doc / python-django-session-security / html / full.html

This file is indexed.

/usr/share/doc/python-django-session-security/html/full.html is in python-django-session-security 2.3.1+dfsg-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Full documentation &mdash; django-session-security 2.3.1 documentation</title>
    
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '2.3.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="django-session-security 2.3.1 documentation" href="index.html" />
    <link rel="next" title="How to trigger activity programaticaly in JS ?" href="faq.html" />
    <link rel="prev" title="Quick setup" href="quick.html" /> 
  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="faq.html" title="How to trigger activity programaticaly in JS ?"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="quick.html" title="Quick setup"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">django-session-security 2.3.1 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="full-documentation">
<h1>Full documentation<a class="headerlink" href="#full-documentation" title="Permalink to this headline"></a></h1>
<div class="section" id="module-session_security.settings">
<span id="settings"></span><h2>Settings<a class="headerlink" href="#module-session_security.settings" title="Permalink to this headline"></a></h2>
<p>Settings for django-session-security.</p>
<dl class="docutils">
<dt>WARN_AFTER</dt>
<dd>Time (in seconds) before the user should be warned that is session will
expire because of inactivity. Default 540. Overridable in
<code class="docutils literal"><span class="pre">settings.SESSION_SECURITY_WARN_AFTER</span></code>.</dd>
<dt>EXPIRE_AFTER</dt>
<dd>Time (in seconds) before the user should be logged out if inactive. Default
is 600. Overridable in <code class="docutils literal"><span class="pre">settings.SESSION_SECURITY_EXPIRE_AFTER</span></code>.</dd>
<dt>PASSIVE_URLS</dt>
<dd>List of urls that should be ignored by the middleware. For example the ping
ajax request of session_security is made without user intervention, as such
it should not be used to update the user&#8217;s last activity datetime.
Overridable in <code class="docutils literal"><span class="pre">settings.SESSION_SECURITY_PASSIVE_URLS</span></code>.</dd>
</dl>
<p>Note that this module will raise a warning if
<code class="docutils literal"><span class="pre">settings.SESSION_EXPIRE_AT_BROWSER_CLOSE</span></code> is not True, because it makes no
sense to use this app with <code class="docutils literal"><span class="pre">SESSION_EXPIRE_AT_BROWSER_CLOSE</span></code> to False.</p>
</div>
<div class="section" id="module-session_security.middleware">
<span id="middleware"></span><h2>Middleware<a class="headerlink" href="#module-session_security.middleware" title="Permalink to this headline"></a></h2>
<p>SessionSecurityMiddleware is the heart of the security that this application
attemps to provide.</p>
<p>To install this middleware, add to your <code class="docutils literal"><span class="pre">settings.MIDDLEWARE_CLASSES</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="s">&#39;session_security.middleware.SessionSecurityMiddleware&#39;</span>
</pre></div>
</div>
<p>Make sure that it is placed <strong>after</strong> authentication middlewares.</p>
<dl class="class">
<dt id="session_security.middleware.SessionSecurityMiddleware">
<em class="property">class </em><code class="descclassname">session_security.middleware.</code><code class="descname">SessionSecurityMiddleware</code><a class="reference internal" href="_modules/session_security/middleware.html#SessionSecurityMiddleware"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#session_security.middleware.SessionSecurityMiddleware" title="Permalink to this definition"></a></dt>
<dd><p>In charge of maintaining the real &#8216;last activity&#8217; time, and log out the
user if appropriate.</p>
<dl class="method">
<dt id="session_security.middleware.SessionSecurityMiddleware.process_request">
<code class="descname">process_request</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/session_security/middleware.html#SessionSecurityMiddleware.process_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#session_security.middleware.SessionSecurityMiddleware.process_request" title="Permalink to this definition"></a></dt>
<dd><p>Update last activity time or logout.</p>
</dd></dl>

<dl class="method">
<dt id="session_security.middleware.SessionSecurityMiddleware.update_last_activity">
<code class="descname">update_last_activity</code><span class="sig-paren">(</span><em>request</em>, <em>now</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/session_security/middleware.html#SessionSecurityMiddleware.update_last_activity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#session_security.middleware.SessionSecurityMiddleware.update_last_activity" title="Permalink to this definition"></a></dt>
<dd><p>If <code class="docutils literal"><span class="pre">request.GET['idleFor']</span></code> is set, check if it refers to a more
recent activity than <code class="docutils literal"><span class="pre">request.session['_session_security']</span></code> and
update it in this case.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-session_security.utils">
<span id="utils"></span><h2>Utils<a class="headerlink" href="#module-session_security.utils" title="Permalink to this headline"></a></h2>
<p>Helpers to support json encoding of session data</p>
<dl class="function">
<dt id="session_security.utils.get_last_activity">
<code class="descclassname">session_security.utils.</code><code class="descname">get_last_activity</code><span class="sig-paren">(</span><em>session</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/session_security/utils.html#get_last_activity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#session_security.utils.get_last_activity" title="Permalink to this definition"></a></dt>
<dd><p>Get the last activity datetime string from the session and return the
python datetime object.</p>
</dd></dl>

<dl class="function">
<dt id="session_security.utils.set_last_activity">
<code class="descclassname">session_security.utils.</code><code class="descname">set_last_activity</code><span class="sig-paren">(</span><em>session</em>, <em>dt</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/session_security/utils.html#set_last_activity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#session_security.utils.set_last_activity" title="Permalink to this definition"></a></dt>
<dd><p>Set the last activity datetime as a string in the session.</p>
</dd></dl>

</div>
<div class="section" id="module-session_security.urls">
<span id="urls"></span><h2>Urls<a class="headerlink" href="#module-session_security.urls" title="Permalink to this headline"></a></h2>
<p>One url meant to be used by JavaScript.</p>
<dl class="docutils">
<dt>session_security_ping</dt>
<dd>Connects the PingView.</dd>
</dl>
<p>To install this url, include it in <code class="docutils literal"><span class="pre">urlpatterns</span></code> definition in <code class="docutils literal"><span class="pre">urls.py</span></code>,
ie:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">urlpatterns</span> <span class="o">=</span> <span class="n">patterns</span><span class="p">(</span><span class="s">&#39;&#39;</span><span class="p">,</span>
    <span class="c"># ....</span>
    <span class="n">url</span><span class="p">(</span><span class="s">r&#39;session_security/&#39;</span><span class="p">,</span> <span class="n">include</span><span class="p">(</span><span class="s">&#39;session_security.urls&#39;</span><span class="p">)),</span>
    <span class="c"># ....</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="module-session_security.views">
<span id="views"></span><h2>Views<a class="headerlink" href="#module-session_security.views" title="Permalink to this headline"></a></h2>
<p>One view method for AJAX requests by SessionSecurity objects.</p>
<dl class="class">
<dt id="session_security.views.PingView">
<em class="property">class </em><code class="descclassname">session_security.views.</code><code class="descname">PingView</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/session_security/views.html#PingView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#session_security.views.PingView" title="Permalink to this definition"></a></dt>
<dd><p>This view is just in charge of returning the number of seconds since the
&#8216;real last activity&#8217; that is maintained in the session by the middleware.</p>
<p>Constructor. Called in the URLconf; can contain helpful extra
keyword arguments, and other things.</p>
</dd></dl>

</div>
<div class="section" id="templates">
<h2>Templates<a class="headerlink" href="#templates" title="Permalink to this headline"></a></h2>
<div class="section" id="session-security-dialog-html">
<h3>session_security/dialog.html<a class="headerlink" href="#session-security-dialog-html" title="Permalink to this headline"></a></h3>
<div class="highlight-html"><div class="highlight"><pre>{% load i18n %}

<span class="nt">&lt;div</span> <span class="na">id=</span><span class="s">&quot;session_security_warning&quot;</span> <span class="na">class=</span><span class="s">&quot;session_security&quot;</span> <span class="na">style=</span><span class="s">&quot;display:none&quot;</span><span class="nt">&gt;</span>
    <span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;session_security_overlay&quot;</span><span class="nt">&gt;&lt;/div&gt;</span>
    <span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;session_security_modal&quot;</span><span class="nt">&gt;</span>
        <span class="nt">&lt;h3&gt;</span>{% trans &#39;Your session is about to expire&#39; %}<span class="nt">&lt;/h3&gt;</span>
        <span class="nt">&lt;p&gt;</span>{% trans &#39;Click to extend your session.&#39; %}<span class="nt">&lt;/p&gt;</span>
    <span class="nt">&lt;/div&gt;</span>
<span class="nt">&lt;/div&gt;</span>
</pre></div>
</div>
</div>
<div class="section" id="session-security-all-html">
<h3>session_security/all.html<a class="headerlink" href="#session-security-all-html" title="Permalink to this headline"></a></h3>
<div class="highlight-django"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">comment</span> <span class="cp">%}</span><span class="c"></span>
<span class="c">This demonstrates how to setup session security client side stuff on your own.</span>
<span class="c">It provides sensible defaults so you could start with just::</span>

<span class="c">    {% include &#39;session_security/all.html&#39; %}</span>

<span class="cp">{%</span> <span class="k">endcomment</span> <span class="cp">%}</span><span class="x"></span>

<span class="cp">{%</span> <span class="k">load</span> <span class="nv">session_security_tags</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">load</span> <span class="nv">i18n</span> <span class="nv">l10n</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">load</span> <span class="nv">static</span> <span class="nv">from</span> <span class="nv">staticfiles</span> <span class="cp">%}</span><span class="x"></span>

<span class="c">{# If the user is not authenticated then there is no session to secure ! #}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">if</span> <span class="nv">request.user.is_authenticated</span> <span class="cp">%}</span><span class="x"></span>

<span class="x">    </span><span class="c">{# The modal dialog stylesheet, it&#39;s pretty light so it should be easy to hack #}</span><span class="x"></span>
<span class="x">    &lt;link rel=&quot;stylesheet&quot; type=&quot;text/css&quot; href=&quot;</span><span class="cp">{%</span> <span class="k">static</span> <span class="s1">&#39;session_security/style.css&#39;</span> <span class="cp">%}</span><span class="x">&quot;&gt;</span>

<span class="x">    </span><span class="c">{# Include the template that actually contains the modal dialog #}</span><span class="x"></span>
<span class="x">    </span><span class="cp">{%</span> <span class="k">include</span> <span class="s1">&#39;session_security/dialog.html&#39;</span> <span class="cp">%}</span><span class="x"></span>

<span class="x">    </span><span class="c">{# Load SessionSecurity javascript &#39;class&#39;, jquery should be loaded - by you - at this point #}</span><span class="x"></span>
<span class="x">    &lt;script type=&quot;text/javascript&quot; src=&quot;</span><span class="cp">{%</span> <span class="k">static</span> <span class="s1">&#39;session_security/script.js&#39;</span> <span class="cp">%}</span><span class="x">&quot;&gt;&lt;/script&gt;</span>

<span class="x">    </span><span class="c">{# Bootstrap a SessionSecurity instance as the sessionSecurity global variable #}</span><span class="x"></span>
<span class="x">    </span><span class="cp">{%</span> <span class="k">localize</span> <span class="nv">off</span> <span class="cp">%}</span><span class="x"></span>
<span class="x">        &lt;script type=&quot;text/javascript&quot;&gt;</span>
<span class="x">            var sessionSecurity = new yourlabs.SessionSecurity({</span>
<span class="x">                pingUrl: &#39;</span><span class="cp">{%</span> <span class="k">url</span> <span class="s1">&#39;session_security_ping&#39;</span> <span class="cp">%}</span><span class="x">&#39;,</span>
<span class="x">                warnAfter: </span><span class="cp">{{</span> <span class="nv">request</span><span class="o">|</span><span class="nf">warn_after</span><span class="o">|</span><span class="nf">unlocalize</span> <span class="cp">}}</span><span class="x">,</span>
<span class="x">                expireAfter: </span><span class="cp">{{</span> <span class="nv">request</span><span class="o">|</span><span class="nf">expire_after</span><span class="o">|</span><span class="nf">unlocalize</span> <span class="cp">}}</span><span class="x">,</span>
<span class="x">                confirmFormDiscard: &quot;</span><span class="cp">{%</span> <span class="k">trans</span> <span class="s1">&#39;You have unsaved changes in a form of this page.&#39;</span> <span class="cp">%}</span><span class="x">&quot;</span>
<span class="x">            });</span>
<span class="x">        &lt;/script&gt;</span>
<span class="x">    </span><span class="cp">{%</span> <span class="k">endlocalize</span> <span class="cp">%}</span><span class="x">    </span>
<span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="static-files">
<h2>Static files<a class="headerlink" href="#static-files" title="Permalink to this headline"></a></h2>
<div class="section" id="session-security-script-js">
<h3>session_security/script.js<a class="headerlink" href="#session-security-script-js" title="Permalink to this headline"></a></h3>
<p>Read the <a class="reference external" href="_static/script.html">script documentation</a></p>
</div>
<div class="section" id="session-security-style-css">
<h3>session_security/style.css<a class="headerlink" href="#session-security-style-css" title="Permalink to this headline"></a></h3>
<div class="highlight-css"><div class="highlight"><pre><span class="c">/* credit: http://www.csslab.cl/2008/01/30/ventana-modal-solo-con-css/ */</span>
<span class="nc">.session_security_overlay</span> <span class="p">{</span>
    <span class="k">position</span><span class="o">:</span> <span class="k">fixed</span><span class="p">;</span>
    <span class="k">top</span><span class="o">:</span> <span class="m">0</span><span class="p">;</span>
    <span class="k">left</span><span class="o">:</span> <span class="m">0</span><span class="p">;</span>
    <span class="k">width</span><span class="o">:</span> <span class="m">100%</span><span class="p">;</span>
    <span class="k">height</span><span class="o">:</span> <span class="m">100%</span><span class="p">;</span>
    <span class="k">background</span><span class="o">:</span> <span class="m">#000</span><span class="p">;</span>
    <span class="k">z-index</span><span class="o">:</span><span class="m">1001</span><span class="p">;</span>
    <span class="k">opacity</span><span class="o">:.</span><span class="m">75</span><span class="p">;</span>
    <span class="o">-</span><span class="n">moz</span><span class="o">-</span><span class="k">opacity</span><span class="o">:</span> <span class="m">0</span><span class="o">.</span><span class="m">75</span><span class="p">;</span>
    <span class="n">filter</span><span class="o">:</span> <span class="n">alpha</span><span class="p">(</span><span class="k">opacity</span><span class="o">=</span><span class="m">75</span><span class="p">);</span>
<span class="p">}</span>

<span class="nc">.session_security_modal</span> <span class="p">{</span>
    <span class="k">position</span><span class="o">:</span> <span class="k">fixed</span><span class="p">;</span>
    <span class="k">top</span><span class="o">:</span> <span class="m">25%</span><span class="p">;</span>
    <span class="k">left</span><span class="o">:</span> <span class="m">25%</span><span class="p">;</span>
    <span class="k">width</span><span class="o">:</span> <span class="m">50%</span><span class="p">;</span>
    <span class="k">padding</span><span class="o">:</span> <span class="m">16px</span><span class="p">;</span>
    <span class="k">background</span><span class="o">:</span> <span class="m">#fff</span><span class="p">;</span>
    <span class="k">color</span><span class="o">:</span> <span class="m">#333</span><span class="p">;</span>
    <span class="k">z-index</span><span class="o">:</span><span class="m">1002</span><span class="p">;</span>
    <span class="k">overflow</span><span class="o">:</span> <span class="k">auto</span><span class="p">;</span>
    <span class="k">text-align</span><span class="o">:</span> <span class="k">center</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Full documentation</a><ul>
<li><a class="reference internal" href="#module-session_security.settings">Settings</a></li>
<li><a class="reference internal" href="#module-session_security.middleware">Middleware</a></li>
<li><a class="reference internal" href="#module-session_security.utils">Utils</a></li>
<li><a class="reference internal" href="#module-session_security.urls">Urls</a></li>
<li><a class="reference internal" href="#module-session_security.views">Views</a></li>
<li><a class="reference internal" href="#templates">Templates</a><ul>
<li><a class="reference internal" href="#session-security-dialog-html">session_security/dialog.html</a></li>
<li><a class="reference internal" href="#session-security-all-html">session_security/all.html</a></li>
</ul>
</li>
<li><a class="reference internal" href="#static-files">Static files</a><ul>
<li><a class="reference internal" href="#session-security-script-js">session_security/script.js</a></li>
<li><a class="reference internal" href="#session-security-style-css">session_security/style.css</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="quick.html"
                        title="previous chapter">Quick setup</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="faq.html"
                        title="next chapter">How to trigger activity programaticaly in JS ?</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/full.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="faq.html" title="How to trigger activity programaticaly in JS ?"
             >next</a> |</li>
        <li class="right" >
          <a href="quick.html" title="Quick setup"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">django-session-security 2.3.1 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &copy; Copyright 2012-2015, James Pic and contributors.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.4.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.