Welcome to Safeguard for Privileged Sessions Plugin SDK’s documentation!

• 1. History of releases
  • 1.1. Latest release
  • 1.2. Previous 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
  • 4.1. Starting from a plugin skeleton
  • 4.2. Starting from scratch
  • 4.3. Preparing the python environment
  • 4.4. Using the python environment
• 5. pluginv
  • 5.1. Version information
  • 5.2. Snapshot build
  • 5.3. Release build
  • 5.4. Run unit and integration tests
  • 5.5. Run test scenarios
• 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
    • DenyReasons
      • DenyReasons.authentication_failure
      • DenyReasons.communication_error
      • DenyReasons.backend_service_error
    • AAResponse
      • AAResponse.accept()
      • AAResponse.deny()
      • AAResponse.need_info()
      • AAResponse.with_additional_metadata()
      • AAResponse.with_cookie()
      • AAResponse.with_gateway_user()
      • AAResponse.with_session_cookie()
      • AAResponse.with_reason()
  • 6.4. Connection information
    • ConnectionInfo
      • ConnectionInfo.connection_name
      • ConnectionInfo.client_ip
      • ConnectionInfo.client_port
      • ConnectionInfo.client_hostname
      • ConnectionInfo.gateway_domain
      • ConnectionInfo.gateway_groups
      • ConnectionInfo.gateway_password
      • ConnectionInfo.gateway_user
      • ConnectionInfo.gateway_username
      • ConnectionInfo.key_value_pairs
      • ConnectionInfo.protocol
      • ConnectionInfo.session_id
      • ConnectionInfo.server_domain
      • ConnectionInfo.target_domain
      • ConnectionInfo.server_ip
      • ConnectionInfo.target_ip
      • ConnectionInfo.target_host
      • ConnectionInfo.target_server
      • ConnectionInfo.server_port
      • ConnectionInfo.target_port
      • ConnectionInfo.server_hostname
      • ConnectionInfo.server_username
      • ConnectionInfo.target_username
  • 6.5. AAPlugin
    • 6.5.1. AAPlugin way of working
    • 6.5.2. AAPlugin methods and attributes
    • AAPlugin
      • AAPlugin.connection
      • AAPlugin.cookie
      • AAPlugin.session_cookie
      • AAPlugin.username
      • AAPlugin.mfa_identity
      • AAPlugin.mfa_password
      • AAPlugin.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
  • MFAClient
    • MFAClient.push_authenticate()
    • MFAClient.otp_authenticate()
    • MFAClient.execute_authenticate()
  • MFAAuthenticationFailure
  • MFACommunicationError
  • MFAServiceUnreachable
• 8. Credential Store plugin development
  • 8.1. Common configuration options
  • 8.2. Plugin development
    • 8.2.1. Administrative tasks
    • 8.2.2. Basic functionality
    • 8.2.3. Pre-defined attributes on self
    • 8.2.4. Adding to the constructor
  • 8.3. CredentialStorePlugin
    • 8.3.1. CredentialStorePlugin way of working
    • 8.3.2. CredentialStorePlugin methods and attributes
    • RemoteAppInfo
    • InvalidUsageException
    • CredentialStorePlugin
      • CredentialStorePlugin.authentication_username
      • CredentialStorePlugin.authentication_password
      • CredentialStorePlugin.connection
      • CredentialStorePlugin.cookie
      • CredentialStorePlugin.session_cookie
      • CredentialStorePlugin.account
      • CredentialStorePlugin.asset
      • CredentialStorePlugin.remote_app_account
      • CredentialStorePlugin.remote_app_asset
      • CredentialStorePlugin.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
    • PluginConfiguration
      • PluginConfiguration.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
      • RequiredConfigurationSettingNotFound
  • 9.2. Logging
    • 9.2.1. Configuration example
    • 9.2.2. Configuring the logger service
    • 9.2.3. Acquiring a logger
    • 9.2.4. Usage example
    • get_logger()
    • configure()
  • 9.3. CredentialStore
    • 9.3.1. Configuration example
      • 9.3.1.1. Acquiring a CredentialStore
    • CredentialStore
      • CredentialStore.from_config()
      • CredentialStore.get_all()
      • CredentialStore.get_credentials()
      • CredentialStore.get_passwords()
      • CredentialStore.get_keys()
      • CredentialStore.get_certificates()
    • 9.3.2. Exceptions
      • LocalCredentialStoreNotFound
  • 9.4. LDAPServer
    • 9.4.1. Configuration example
    • 9.4.2. Acquiring a user attribute
    • LDAPServer
      • LDAPServer.from_config()
      • LDAPServer.get_user_string_attribute()
      • LDAPServer.get_user_string_attributes()
      • LDAPServer.filter_user_groups()
    • 9.4.3. Exceptions
      • LDAPOperationError
      • LDAPUserNotFound
  • 9.5. UserList
    • 9.5.1. Configuration example
      • 9.5.1.1. Checking whether a user name matches a User List
    • UserList
      • UserList.from_config()
      • UserList.check_user()
    • 9.5.2. Exceptions
      • LocalUserListNotFound
  • 9.6. HostResolver
    • HostResolver
      • HostResolver.from_config()
      • HostResolver.resolve_hosts_by_ip()
  • 9.7. Base class for exceptions
    • PluginSDKExceptionFormatter
      • PluginSDKExceptionFormatter.append_variables()
    • PluginSDKRuntimeError
    • PluginSDKRuntimeWarning
    • PluginSDKValueError
  • 9.8. Requests TLS Session
    • 9.8.1. Configuration example
    • 9.8.2. Getting a Session object
  • 9.9. MemoryCache
    • 9.9.1. Configuration example
    • 9.9.2. Setting and getting values
    • MemoryCache
      • MemoryCache.from_config()
      • MemoryCache.set()
      • MemoryCache.get()
  • 9.10. EndpointExtractor
    • EndpointException
    • EndpointExtractor
      • EndpointExtractor.base_url
      • EndpointExtractor.extract_data_from_endpoint()
      • EndpointExtractor.invoke_http_method()
• 10. Testing
  • 10.1. Unit tests
    • 10.1.1. Fake services for testing
      • 10.1.1.1. CredentialStore data injection
        • 10.1.1.1.1. Example usage with pytest and monkeypatch
      • 10.1.1.2. LDAPServer data injection
        • 10.1.1.2.1. Example usage with pytest and monkeypatch
      • 10.1.1.3. UserList data injection
        • 10.1.1.3.1. Example usage with pytest and monkeypatch
  • 10.2. Integration tests
• 11. Plugin base functions
  • 11.1. cookie_property
    • plugin_base.cookie_property()
  • 11.2. session_cookie_property
    • plugin_base.session_cookie_property()
  • 11.3. lazy_property
    • plugin_base.lazy_property()
  • 11.4. named_cookie_property
    • plugin_base.named_cookie_property()
  • 11.5. PluginBase
    • PluginBase
      • PluginBase.cookie
      • PluginBase.session_cookie
      • PluginBase.plugin_configuration
      • PluginBase.logger
      • PluginBase.https_proxy_enabled
      • PluginBase.https_proxy_server
      • PluginBase.https_proxy_port
      • PluginBase.https_proxy_username
      • PluginBase.https_proxy_password
      • PluginBase.proxy_settings
      • PluginBase.box_configuration
• 12. About us
• 13. Contacting us
• 14. Technical support resources

Indices and tables

• Index

• Module Index

• Search Page