Table Of Contents
- 1. History of releases
- 2. Changelog
- 2.1. Changes in version 1.8.1
- 2.2. Changes in version 1.8.0
- 2.3. Changes in version 1.7.0
- 2.4. Changes in version 1.6.1
- 2.5. Changes in version 1.6.0
- 2.6. Changes in version 1.5.4
- 2.7. Changes in version 1.5.3
- 2.8. Changes in version 1.5.2
- 2.9. Changes in version 1.5.1
- 2.10. Changes in version 1.5.0
- 2.11. Changes in version 1.4.4
- 2.12. Changes in version 1.4.3
- 2.13. Changes in version 1.4.2
- 2.14. Changes in version 1.4.1
- 2.15. Changes in version 1.4.0
- 2.16. Changes in version 1.3.1
- 2.17. Changes in version 1.3.0
- 2.18. Changes in version 1.2.1
- 2.19. Changes in version 1.2.0
- 2.20. Changes in version 1.1.4
- 2.21. Changes in version 1.1.3
- 2.22. Changes in version 1.1.2
- 3. Introduction
- 4. Getting started
- 5. pluginv
- 6. AA plugin development
- 6.1. Common configuration options
- 6.2. Plugin development
- 6.2.1. Administrative tasks
- 6.2.2. Basic functionality
- 6.2.3. Pre-defined attributes on self
- 6.2.4. Asking the end-user
- 6.2.5. Using cookies
- 6.2.6. Setting gateway user and groups
- 6.2.7. Setting additional meta data
- 6.2.8. Avoiding costly calculations
- 6.2.9. Adding to the constructor
- 6.2.10. Authentication cache
- 6.2.11. Altering the steps
- 6.3. Plugin response
- 6.4. Connection information
ConnectionInfoConnectionInfo.connection_nameConnectionInfo.client_ipConnectionInfo.client_portConnectionInfo.client_hostnameConnectionInfo.gateway_domainConnectionInfo.gateway_groupsConnectionInfo.gateway_passwordConnectionInfo.gateway_userConnectionInfo.gateway_usernameConnectionInfo.key_value_pairsConnectionInfo.protocolConnectionInfo.session_idConnectionInfo.server_domainConnectionInfo.target_domainConnectionInfo.server_ipConnectionInfo.target_ipConnectionInfo.target_hostConnectionInfo.target_serverConnectionInfo.server_portConnectionInfo.target_portConnectionInfo.server_hostnameConnectionInfo.server_usernameConnectionInfo.target_username
- 6.5. AAPlugin
- 6.5.1. AAPlugin way of working
- 6.5.2. AAPlugin methods and attributes
AAPluginAAPlugin.connectionAAPlugin.cookieAAPlugin.session_cookieAAPlugin.usernameAAPlugin.mfa_identityAAPlugin.mfa_passwordAAPlugin.do_authenticate()AAPlugin.do_authorize()AAPlugin.do_session_ended()AAPlugin._authentication_steps()AAPlugin._post_successful_authentication_steps()AAPlugin._authorization_steps()AAPlugin._session_ended_steps()AAPlugin._extract_username()AAPlugin._map_username_explicit()AAPlugin._map_username_ldap()AAPlugin._transform_username()AAPlugin._check_username()AAPlugin._extract_mfa_password()AAPlugin.authenticate()AAPlugin.authorize()AAPlugin.session_ended()AAPlugin._add_gateway_user()
- 7. MFA Client
- 8. Credential Store plugin development
- 8.1. Common configuration options
- 8.2. Plugin development
- 8.3. CredentialStorePlugin
- 8.3.1. CredentialStorePlugin way of working
- 8.3.2. CredentialStorePlugin methods and attributes
RemoteAppInfoInvalidUsageExceptionCredentialStorePluginCredentialStorePlugin.authentication_usernameCredentialStorePlugin.authentication_passwordCredentialStorePlugin.connectionCredentialStorePlugin.cookieCredentialStorePlugin.session_cookieCredentialStorePlugin.accountCredentialStorePlugin.assetCredentialStorePlugin.remote_app_accountCredentialStorePlugin.remote_app_assetCredentialStorePlugin.do_get_password_list()CredentialStorePlugin.do_get_private_key_list()CredentialStorePlugin.do_authentication_completed()CredentialStorePlugin.do_check_in_credential()CredentialStorePlugin.do_session_ended()CredentialStorePlugin.do_get_remote_app_credentials()CredentialStorePlugin._generate_accounts()CredentialStorePlugin._generate_assets()
- 9. Plugin SDK services
- 9.1. PluginConfiguration
PluginConfigurationPluginConfiguration.get()PluginConfiguration.get_options()PluginConfiguration.get_key()PluginConfiguration.get_certificate()PluginConfiguration.get_ca_certificate()PluginConfiguration.getboolean()PluginConfiguration.getint()PluginConfiguration.getfloat()PluginConfiguration.getienum()PluginConfiguration.getlist()
- 9.1.1. Exceptions
- 9.2. Logging
- 9.3. CredentialStore
- 9.4. LDAPServer
- 9.5. UserList
- 9.6. HostResolver
- 9.7. Base class for exceptions
- 9.8. Requests TLS Session
- 9.9. MemoryCache
- 9.10. EndpointExtractor
- 9.1. PluginConfiguration
- 10. Testing
- 11. Plugin base functions
- 11.1. cookie_property
- 11.2. session_cookie_property
- 11.3. lazy_property
- 11.4. named_cookie_property
- 11.5. PluginBase
PluginBasePluginBase.cookiePluginBase.session_cookiePluginBase.plugin_configurationPluginBase.loggerPluginBase.https_proxy_enabledPluginBase.https_proxy_serverPluginBase.https_proxy_portPluginBase.https_proxy_usernamePluginBase.https_proxy_passwordPluginBase.proxy_settingsPluginBase.box_configuration
- 12. About us
- 13. Contacting us
- 14. Technical support resources
Previous topic
Next topic
3. Introduction¶
The One Identity Safeguard for Privileged Sessions Plugin Software Development Kit (Plugin SDK) provides base classes and services to enable rapid development of Python 3 plugins for the Safeguard for Privileged Sessions product. The Plugin SDK helps implement the requirements stated in the documents
Creating custom Authentication and Authorization plugins developer’s guide,
Creating custom Credential Store plugins developer’s guide.
The documents above are part of the One Identity technical documentation .