OpenXPKI

An open, enterprise-grade PKI/Trustcenter

Table of Contents:

Basics

• Introduction
  • Key features
• Quickstart guide
  • Support
  • Docker
  • Configuration
  • Debian Builds
  • System Setup
  • Adding the Webclient
  • Enabling the SCEP service
  • Support for Java Keystore
• Upgrading OpenXPKI
  • Release v3.12
  • Release v3.x
  • Release v2.3
  • Release v2.x
  • Release v1.19
  • Release v1.18
  • Release v1.13
  • Release v1.11
  • Release v1.10

Setup and Configuration

Setup and Configuration

• Overview
  • Main configuration
  • Config versioning
  • Config Caching and Signing
  • Logging
• Global
  • Database
  • System
  • Server Type (Fork vs. PreFork)
  • Watchdog
  • Crypto layer (global)
  • PKI Realms
• Realm
  • Authentication
  • Crypto layer
  • Profiles
  • Publishing
  • Notification
  • Workflow
• Workflow Definition
  • Workflow Head
  • States
  • Actions
  • Fields
  • Global Entities
  • Creating Macros (not implemented yet!)
• Workflow UI Rendering
  • Action Switch Page
  • Form Input Page
  • Markup of Final States
• Workflow Output Formatting
  • Buttons
  • Key/Value Grid
• WebUI components
  • Format Result List
  • Certificate search mask
  • Workflow search mask
  • Tasklist
• Certificate profiles
  • Naming
  • Validity
  • Styles
  • Subject and Process Information
  • Extensions
• Enrollment Workflow
  • Operational Modes
  • Workflow Logic
  • Sample Configuration
  • Workflow Configuration
  • Certificate Configuration
• WebUI Page API Reference
  • Top-Level Structure
  • Page Level
  • Item Level
  • Customization

Automation / External APIs

Automation / External APIs

• Subsystems providing External APIs
  • Wrapper Configuration
    • Global Default Config
    • Config Path Expansion
    • custom base directory
    • custom service directory
    • fixed file
  • Log4perl Config
  • Webserver Config
    • Config Path Expansion
    • TLS Client Authentication
  • Endpoint Configuration
    • TLS Client Authorization
• RPC Server API
  • Server-Side Configuration
    • Wrapper Configuration
    • TLS Authentication
  • Input Handling
    • allow_raw_post
    • parse_depth
  • Parameter Handling
    • Example: Revoke Certificate by Certificate Identifier
  • Response
  • Workflow Pickup
  • Examples
    • Retrieving the OpenAPI spec
  • See Also
• OpenAPI (aka Swagger)
• EST Endpoint / RFC 7030
  • Default Configuration
    • Smoke Test
    • Authenticated Test
• SCEP Server
  • Decommission and Upgrade Notice
  • Wrapper Configuration
    • Config Path Expansion
  • Caveats
• SOAP Server
  • Wrapper Configuration
  • Endpoint Configuration
  • SOAP Methods
    • RevokeCertificateByIssuerSerial
    • RevokeCertificateByIdentifier

Operation

Operation

• Audit Log
  • Categories
    • CA Key Usage (cakey)
    • Entity Key Usage (key)
    • Certificate (entity)
    • Approval (approval)
    • ACL (acl)
    • System (system)
    • Application
  • Parameters
• Crypto Token Configuration
  • Overview
  • Initial Setup
    • Root Certificate
    • Issuing Certificate
    • Datasafe Token
  • Token Rollover

Architecture

Developer

Developer

• Tests
  • Running tests
  • Writing tests

• Glossary

Indices and tables

• Index
• Search Page