Welcome to AuthzForce’s official documentation

This project is part of FIWARE. You will find more information about this FIWARE GE at the Catalogue.

Table of Contents

• 1. Introduction
• 2. Release Notes
• 3. Features
• 4. Installation and Administration Guide
  • 4.1. Installation via Docker (container image)
  • 4.2. Manual installation via tar.gz
  • 4.3. Installation via APT (Ubuntu .deb package)
    • 4.3.1. System Requirements
    • 4.3.2. Installation
      • 4.3.2.1. Minimal setup
      • 4.3.2.2. Upgrade
      • 4.3.2.3. Advanced setup
  • 4.4. Administration
    • 4.4.1. Tomcat
    • 4.4.2. AuthzForce webapp
    • 4.4.3. Fast Infoset mode
    • 4.4.4. Policy Domain Administration
      • 4.4.4.1. The Concept of Policy Domain
      • 4.4.4.2. Default Domain Settings
      • 4.4.4.3. Domain Creation
      • 4.4.4.4. Domain Removal
  • 4.5. High Availability
  • 4.6. Sanity check procedures
    • 4.6.1. End-to-End testing
    • 4.6.2. List of Running Processes
    • 4.6.3. Network interfaces Up & Open
    • 4.6.4. Databases
  • 4.7. Diagnosis Procedures
  • 4.8. Resource availability
    • 4.8.1. Remote Service Access
    • 4.8.2. Resource consumption
    • 4.8.3. I/O flows
  • 4.9. Appendix
    • 4.9.1. Security setup for production
      • 4.9.1.1. Server Security Setup
      • 4.9.1.2. Certificate Authority Setup
      • 4.9.1.3. Server SSL Certificate Setup
      • 4.9.1.4. Web Application Secutity
        • 4.9.1.4.1. XML and JSON Security
        • 4.9.1.4.2. Disabling unused features
        • 4.9.1.4.3. User and Role Management Setup
    • 4.9.2. Performance Tuning
• 5. User and Programmers Guide
  • 5.1. Background and Detail
  • 5.2. User Guide
  • 5.3. Programmer Guide
    • 5.3.1. General recommendations for developers
    • 5.3.2. Attribute-Based Access Control
    • 5.3.3. Product info API
    • 5.3.4. Domain Management API
    • 5.3.5. Policy Administration API
      • 5.3.5.1. Adding and updating Policies
      • 5.3.5.2. Getting Policies and Policy Versions
      • 5.3.5.3. Removing Policies and Policy Versions
      • 5.3.5.4. Re-usable Policies (e.g. for Hierarchical RBAC)
      • 5.3.5.5. Policy Repository (PRP) Properties
      • 5.3.5.6. Policy Decision (PDP) Properties
      • 5.3.5.7. PDP Extensions
        • 5.3.5.7.1. Attribute Datatype extensions
          • 5.3.5.7.1.1. Making an Attribute Datatype extension
          • 5.3.5.7.1.2. Integrating an Attribute Datatype extension into AuthzForce Server
          • 5.3.5.7.1.3. Enabling an Attribute Datatype extension on a domain
        • 5.3.5.7.2. Function Extensions
          • 5.3.5.7.2.1. Making a Function extension
          • 5.3.5.7.2.2. Integrating a Function extension into AuthzForce Server
          • 5.3.5.7.2.3. Enabling a Function extension on a domain
        • 5.3.5.7.3. Combining Algorithm Extensions
          • 5.3.5.7.3.1. Making a Combining Algorithm extension
          • 5.3.5.7.3.2. Integrating a Combining Algorithm extension into AuthzForce Server
          • 5.3.5.7.3.3. Enabling a Combining Algorithm extension on a domain
        • 5.3.5.7.4. Request Preprocessor Extensions
          • 5.3.5.7.4.1. Making a Request Preprocessor extension
          • 5.3.5.7.4.2. Integrating a Request Preprocessor extension into AuthzForce Server
          • 5.3.5.7.4.3. Enabling a Request Preprocessor extension on a domain
        • 5.3.5.7.5. Result Postprocessor Extensions
          • 5.3.5.7.5.1. Making a Result Postprocessors extension
          • 5.3.5.7.5.2. Integrating a Result Postprocessor extension into AuthzForce Server
          • 5.3.5.7.5.3. Enabling a Result Postprocessor extension on a domain
        • 5.3.5.7.6. Attribute Providers
          • 5.3.5.7.6.1. Making an Attribute Provider
          • 5.3.5.7.6.2. Integrating an Attribute Provider into AuthzForce Server
          • 5.3.5.7.6.3. Managing attribute providers configuration
    • 5.3.6. Policy Decision API
    • 5.3.7. Fast Infoset
    • 5.3.8. Integration with the IdM and PEP Proxy GEs (e.g. for OAuth)
    • 5.3.9. Software Libraries for clients of AuthzForce or other Authorization PDP GEis