django-pfx 1.2.dev101__tar.gz → 1.2.dev103__tar.gz

{django-pfx-1.2.dev101 → django-pfx-1.2.dev103}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev101
+Version: 1.2.dev103
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev101 → django-pfx-1.2.dev103}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev101
+Version: 1.2.dev103
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev101 → django-pfx-1.2.dev103}/doc/source/api.views.rst

@@ -1,6 +1,20 @@
 API
 =====================
 
+The ``AuthenticationView`` class
+********************************
+.. autoclass:: pfx.pfxcore.views.AuthenticationView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The ``ForgottenPasswordView`` class
+***********************************
+.. autoclass:: pfx.pfxcore.views.ForgottenPasswordView
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 The ``DetailRestViewMixin`` class
 *********************************
 .. autoclass:: pfx.pfxcore.views.DetailRestViewMixin
@@ -11,21 +25,21 @@ The ``DetailRestViewMixin`` class
 .. :inherited-members:
 
 The ``LocaleMiddleware`` class
-*********************************
+******************************
 .. autoclass:: pfx.pfxcore.middleware.LocaleMiddleware
     :members:
     :undoc-members:
     :show-inheritance:
 
 The ``LocaleRestView`` class
-*********************************
+****************************
 .. autoclass:: pfx.pfxcore.views.LocaleRestView
     :members:
     :undoc-members:
     :show-inheritance:
 
 The ``ModelMixin`` class
-*********************************
+************************
 .. autoclass:: pfx.pfxcore.views.ModelMixin
     :members:
     :undoc-members:

django-pfx-1.2.dev103/doc/source/authentication.md

@@ -0,0 +1,35 @@
+# Authentication
+
+## Modes
+
+There are 2 authentication modes: cookie and bearer token.
+You can activate either or both by adding middleware:
+
+* `'pfx.pfxcore.middleware.AuthenticationMiddleware'` (bearer token)
+* `'pfx.pfxcore.middleware.CookieAuthenticationMiddleware'` (cookie)
+
+To use the `CookieAuthenticationMiddleware`, you have to configure following settings:
+
+* `PFX_COOKIE_DOMAIN`: the cookie domain
+* `PFX_COOKIE_SECURE`: `Secure` attribute of the cookie (`True`/`False`)
+* `PFX_COOKIE_SAMESITE`: `SameSite` attribute of the cookie (`'Strict'`/`'Lax'`/`'None'`)
+* `PFX_TOKEN_SHORT_VALIDITY`: validity for short validity token (optional, default `{'hours': 12}`)
+* `PFX_TOKEN_LONG_VALIDITY`: validity for long validity token (optional, default `{'days': 30}`)
+
+`/auth/login?mode=jwt` will return a token for bearer token authentication.
+`/auth/login?mode=cookie` will set and return the authentication cookie.
+
+## Authentication views
+
+The following views provide standard services:
+
+* `AuthenticationView`
+  * `/auth/login`
+  * `/auth/logout`
+  * `/auth/set-password`
+  * `/auth/change-password`
+  * `/auth/validate-user-token`
+* `ForgottenPasswordView`
+  * `/auth/forgotten-password`
+
+See the API doc for details.

django-pfx-1.2.dev101/doc/source/authentication.md

@@ -1,8 +0,0 @@
-# Authentication
-
-TODO define content
-
-- AuthenticationMiddleware
-- AuthenticationView
-- SignupView
-- ForgotenPasswordView