pyams_security.plugin package¶
+Submodules¶
+pyams_security.plugin.admin module¶
+-
+
-
+class
pyams_security.plugin.admin.
AdminAuthenticationPlugin
¶
+ Bases:
+persistent.Persistent
,zope.container.contained.Contained
Hard-coded administrator authenticator plug-in
+This plug-in should only be enabled in development mode!!!
+-
+
-
+
authenticate
(credentials, request)¶
+
-
+
-
+
enabled
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
find_principals
(query)¶
+
-
+
-
+
get_all_principals
(principal_id)¶
+
-
+
-
+
get_principal
(principal_id, info=True)¶
+
-
+
-
+
login
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
password
¶
+
-
+
-
+
prefix
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
title
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
pyams_security.plugin.group module¶
+-
+
-
+class
pyams_security.plugin.group.
Group
¶
+ Bases:
+persistent.Persistent
,zope.container.contained.Contained
Local group persistent class
+-
+
-
+
description
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
group_id
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
principals
¶
+
-
+
-
+
title
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
-
+class
pyams_security.plugin.group.
GroupsFolder
¶
+ Bases:
+zope.container.folder.Folder
Principals groups folder
+-
+
-
+
check_group_id
(group_id)¶
+ Check for existence of given group ID
+
-
+
-
+
enabled
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
find_principals
(query)¶
+
-
+
-
+
get_all_principals
(principal_id, seen=None)¶
+
-
+
-
+
get_principal
(principal_id, info=True)¶
+
-
+
-
+
prefix
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
title
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
-
+class
pyams_security.plugin.group.
LocalGroupsVocabulary
(context=None)¶
+ Bases:
+zope.schema.vocabulary.SimpleVocabulary
‘PyAMS local groups vocabulary
+
-
+
-
+
pyams_security.plugin.group.
handle_added_group
(event)¶
+ Handle added group
+
-
+
-
+
pyams_security.plugin.group.
handle_added_principals
(event)¶
+ Handle principals added to group
+
-
+
-
+
pyams_security.plugin.group.
handle_removed_principals
(event)¶
+ Handle principals removed from group
+
pyams_security.plugin.http module¶
+-
+
-
+class
pyams_security.plugin.http.
HttpBasicCredentialsPlugin
¶
+ Bases:
+object
HTTP basic credentials plug-in
+This credential plug-in is mainly used by automation processes using +XML-RPC or JSON-RPC requests launched from batch scripts.
+Copied from pyramid_httpauth package.
+-
+
-
+
enabled
= True¶
+
-
+
-
+
extract_credentials
(request)¶
+
-
+
-
+
prefix
= 'http'¶
+
-
+
-
+
title
= 'HTTP Basic credentials'¶
+
-
+
pyams_security.plugin.social module¶
+-
+
Bases:
+zope.schema.vocabulary.SimpleVocabulary
OAuth providers vocabulary
+
-
+
Bases:
+pyams_utils.adapter.ContextAdapter
++social-configuration++ namespace traverser
+-
+
-
+
Bases:
+zope.container.folder.Folder
Social login configuration
+-
+
-
+
Social login configuration adapter
+
-
+
Bases:
+persistent.Persistent
Social login provider connection
+-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Bases:
+object
Social login provider info
+-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Bases:
+persistent.Persistent
,zope.container.contained.Contained
Social user persistent class
+-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Social user principal info adapter
+
-
+
Bases:
+zope.container.folder.Folder
Social users folder
+-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
-
+
-
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
Bases:
+zope.schema.vocabulary.SimpleVocabulary
‘PyAMS users folders’ vocabulary
+
-
+
Get provider info matching given provider name
+
-
+
Handle authenticated social principal
+
pyams_security.plugin.userfolder module¶
+-
+
-
+class
pyams_security.plugin.userfolder.
User
¶
+ Bases:
+persistent.Persistent
,zope.container.contained.Contained
Local user persistent class
+-
+
-
+
activated
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
activation_date
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
activation_hash
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
activation_secret
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
check_activation
(hash, login, password)¶
+
-
+
-
+
check_password
(password)¶
+
-
+
-
+
company_name
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
email
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
firstname
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
generate_secret
()¶
+
-
+
-
+
lastname
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
login
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
password
¶
+
-
+
-
+
password_manager
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
self_registered
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
title
¶
+
-
+
-
+
wait_confirmation
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
-
+
pyams_security.plugin.userfolder.
UserPrincipalInfoAdapter
(user)¶
+ User principal info adapter
+
-
+
-
+class
pyams_security.plugin.userfolder.
UserPrincipalMailInfoAdapter
(context)¶
+ Bases:
+pyams_utils.adapter.ContextAdapter
User principal mail info adapter
+-
+
-
+
get_addresses
()¶
+
-
+
-
+
-
+class
pyams_security.plugin.userfolder.
UsersFolder
¶
+ Bases:
+zope.container.folder.Folder
Local users folder
+-
+
-
+
authenticate
(credentials, request)¶
+
-
+
-
+
check_login
(login)¶
+
-
+
-
+
enabled
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
find_principals
(query)¶
+
-
+
-
+
get_all_principals
(principal_id)¶
+
-
+
-
+
get_principal
(principal_id, info=True)¶
+
-
+
-
+
get_search_results
(data)¶
+
-
+
-
+
prefix
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
title
¶
+ Computed attributes based on schema fields
+Field properties provide default values, data validation and error messages +based on data found in field meta-data.
+Note that FieldProperties cannot be used with slots. They can only +be used for attributes stored in instance dictionaries.
+
-
+
-
+
-
+class
pyams_security.plugin.userfolder.
UsersFolderVocabulary
(*args, **kwargs)¶
+ Bases:
+zope.schema.vocabulary.SimpleVocabulary
‘PyAMS users folders’ vocabulary
+
-
+
-
+
pyams_security.plugin.userfolder.
handle_new_local_user
(event)¶
+ Send a confirmation message when a new user is recorded
+