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
|
#------------------------------------------------------------------------------
# Copyright (c) 2008, Riverbank Computing Limited
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
# Thanks for using Enthought open source!
#
# Author: Riverbank Computing Limited
# Description: <Enthought permissions package component>
#------------------------------------------------------------------------------
# Enthought library imports.
from traits.api import Interface, List, Str
class UserStorageError(Exception):
"""This is the exception raised by an IUserStorage object when an error
occurs accessing the database. Its string representation is displayed as
an error message to the user."""
class IUserStorage(Interface):
"""This defines the interface expected by a UserManager instance to handle
the low level storage of the user data."""
#### 'IUserStorage' interface #############################################
# A list of strings describing the storage capabilities. 'user_password'
# means a user's password can be changed. 'user_add' means a user can be
# added. 'user_modify' means a user can be modified. 'user_delete' means
# a user can be deleted.
capabilities = List(Str)
###########################################################################
# 'IUserStorage' interface.
###########################################################################
def add_user(self, name, description, password):
"""Add a new user with the given name, description and password."""
def authenticate_user(self, name, password):
"""Return a tuple of the name, description, and blob of the user with
the given name if they are successfully authenticated with the given
password. A tuple of empty strings will be returned if the
authentication failed."""
def delete_user(self, name):
"""Delete the user with the given name (which will not be empty)."""
def is_empty(self):
"""Return True if the user database is empty. It will only ever be
called once."""
def matching_users(self, name):
"""Return a list of tuples of the full name and description of all
users, sorted by the full name, that match the given name. How the
name is interpreted (eg. as a regular expression) is determined by the
storage."""
def modify_user(self, name, description, password):
"""Update the description and password for the user with the given name
(which will not be empty)."""
def unauthenticate_user(self, user):
"""Unauthenticate the given user (which is an object implementing
IUser) and return True if it was successful."""
def update_blob(self, name, blob):
"""Update the blob for the user with the given name (which will not be
empty)."""
def update_password(self, name, password):
"""Update the password for the user with the given name (which will not
be empty)."""
|
