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.7.0
  • 2.2. Changes in version 1.6.1
  • 2.3. Changes in version 1.6.0
  • 2.4. Changes in version 1.5.4
  • 2.5. Changes in version 1.5.3
  • 2.6. Changes in version 1.5.2
  • 2.7. Changes in version 1.5.1
  • 2.8. Changes in version 1.5.0
  • 2.9. Changes in version 1.4.4
  • 2.10. Changes in version 1.4.3
  • 2.11. Changes in version 1.4.2
  • 2.12. Changes in version 1.4.1
  • 2.13. Changes in version 1.4.0
  • 2.14. Changes in version 1.3.1
  • 2.15. Changes in version 1.3.0
  • 2.16. Changes in version 1.2.1
  • 2.17. Changes in version 1.2.0
  • 2.18. Changes in version 1.1.4
  • 2.19. Changes in version 1.1.3
  • 2.20. 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
  • 6.4. Connection information
  • 6.5. AAPlugin
    • 6.5.1. AAPlugin way of working
    • 6.5.2. AAPlugin methods and attributes
• 7. MFA Client
• 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
• 9. Plugin SDK services
  • 9.1. PluginConfiguration
    • 9.1.1. Exceptions
  • 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
  • 9.3. CredentialStore
    • 9.3.1. Configuration example
      • 9.3.1.1. Acquiring a CredentialStore
    • 9.3.2. Exceptions
  • 9.4. LDAPServer
    • 9.4.1. Configuration example
    • 9.4.2. Acquiring a user attribute
    • 9.4.3. Exceptions
  • 9.5. UserList
    • 9.5.1. Configuration example
      • 9.5.1.1. Checking whether a user name matches a User List
    • 9.5.2. Exceptions
  • 9.6. HostResolver
  • 9.7. Base class for exceptions
  • 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
  • 9.10. EndpointExtractor
• 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
  • 11.2. session_cookie_property
  • 11.3. lazy_property
  • 11.4. named_cookie_property
  • 11.5. PluginBase
• 12. About us
• 13. Contacting us
• 14. Technical support resources

Indices and tables

• Index

• Module Index

• Search Page