Browse Source

Updated the documentation of the lodel.auth package

Roland Haroutiounian 7 years ago
parent
commit
8a7ac08c9d
1 changed files with 5 additions and 13 deletions
  1. 5
    13
      lodel/auth/__init__.py

+ 5
- 13
lodel/auth/__init__.py View File

@@ -1,27 +1,19 @@
1 1
 ##@package lodel.auth Package handling authentication on Lodel2
2 2
 #
3
-#The authentication mechanism are divided in multiple peaces : 
3
+#The authentication mechanism is divided in multiple pieces :
4 4
 #- The client ( @ref lodel.auth.auth.Client ) singleton class that stores
5
-#clients infos
6
-#- The @ref lodel.auth.Auth class handles authentication, sessions
7
-#creation/load/deletion
8
-#- The session handler implement as a plugin
5
+# clients' informations
6
+#- The session handler, implemented as a plugin
9 7
 #
10 8
 #@par Client class
11 9
 #
12 10
 #The @ref lodel.auth.auth.Client class is an abstract singleton. It is designed
13 11
 #to be implemented by UI plugins. In fact we don't have the same client
14 12
 #informations on a web UI, on a CLI or with UDP communications. The main goal
15
-#of this class is to provide an API to interface plugins to stores client
13
+#of this class is then to provide an API to interface plugins to stores client
16 14
 #informations allowing lodel2 to produce security log messages containing 
17 15
 #client informations.
18 16
 #
19
-#@par Auth class
20
-#
21
-#The auth class is a singleton designed to actually do authentication.
22
-#This class fetch from settings the Emclass and it's field that contains
23
-#login and password. It's also an API between Client class and session handler
24
-#
25 17
 #@par Session handler
26 18
 #
27
-#Implemented as a plugin, called with hooks.
19
+# The session handler is implemented as a plugin, called by hooks.

Loading…
Cancel
Save