- -
-

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

-
-
-class pyams_security.plugin.social.OAuthProvidersVocabulary(*args, **kwargs)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

OAuth providers vocabulary

-
- -
-
-class pyams_security.plugin.social.SecurityManagerSocialTraverser(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

++social-configuration++ namespace traverser

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-class pyams_security.plugin.social.SocialLoginConfiguration
-

Bases: zope.container.folder.Folder

-

Social login configuration

-
-
-get_oauth_configuration()
-
- -
- -
-
-pyams_security.plugin.social.SocialLoginConfigurationAdapter(context)
-

Social login configuration adapter

-
- -
-
-class pyams_security.plugin.social.SocialLoginProviderConnection
-

Bases: persistent.Persistent

-

Social login provider connection

-
-
-consumer_key
-

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.

-
- -
-
-consumer_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.

-
- -
-
-get_configuration()
-
- -
-
-provider_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.

-
- -
-
-provider_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.

-
- -
- -
-
-class pyams_security.plugin.social.SocialLoginProviderInfo(name, provider, **kwargs)
-

Bases: object

-

Social login provider info

-
-
-icon_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.

-
- -
-
-icon_filename
-

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.

-
- -
-
-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.

-
- -
-
-provider = None
-
- -
-
-scope
-

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.social.SocialUser
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Social user persistent class

-
-
-birth_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.

-
- -
-
-city
-

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.

-
- -
-
-country
-

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.

-
- -
-
-first_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.

-
- -
-
-last_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.

-
- -
-
-locale
-

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.

-
- -
-
-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.

-
- -
-
-nickname
-

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.

-
- -
-
-picture
-

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.

-
- -
-
-postal_code
-

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.

-
- -
-
-provider_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.

-
- -
-
-registration_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.

-
- -
-
-timezone
-

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
-
- -
-
-title_with_source
-
- -
-
-user_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.

-
- -
-
-username
-

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.social.SocialUserPrincipalInfoAdapter(user)
-

Social user principal info adapter

-
- -
-
-class pyams_security.plugin.social.SocialUsersFolder
-

Bases: zope.container.folder.Folder

-

Social users folder

-
-
-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.social.SocialUsersFolderVocabulary(*args, **kwargs)
-

Bases: zope.schema.vocabulary.SimpleVocabulary

-

‘PyAMS users folders’ vocabulary

-
- -
-
-pyams_security.plugin.social.get_provider_info(provider_name)
-

Get provider info matching given provider name

-
- -
-
-pyams_security.plugin.social.handle_authenticated_principal(event)
-

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

-
- -
-
-

Module contents

-
-
-class pyams_security.plugin.PluginSelector(name, config)
-

Bases: object

-

Plug-in based event selector

-

This selector can be used by subscriber to filter authentication -events based on the name of the plug-in which fired the event.

-
-
-phash()
-
- -
-
-text()
-
- -
- -
-
- - -