mkdocs.yml

---
site_name: Key Management System
site_url: https://docs.cosmian.com/
copyright: © Copyright 2018-2026 Eviden. All rights reserved
dev_addr: localhost:8003
theme:
  name: material
  language: en
  font:
    text: Open Sans
  favicon: eviden-favicon.svg
  logo: eviden-logo-orange.svg
  custom_dir: theme_overrides
  features:
    - content.tabs.link
extra:
  homepage: https://docs.cosmian.com/
markdown_extensions:
  - tables
  - smarty
  - abbr
  - admonition
  - toc:
      permalink: true
      baselevel: 1
  - pymdownx.superfences:
      # make exceptions to highlighting of code:
      custom_fences:
        - name: mermaid
          class: mermaid
            # Uncomment the following line to check Mermaid figures
            # format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - attr_list
  - markdown_katex:
      no_inline_svg: true
      insert_fonts_css: true
  - markdown_include.include:
      base_path: docs
      inheritHeadingDepth: true
extra_javascript: #see this for Katex: https://squidfunk.github.io/mkdocs-material/reference/math/#katex
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
  - javascripts/macros.js
  - javascripts/log_filter.js
extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
hooks:
  - hooks.py
plugins:
  - search
  - kroki
  - meta-descriptions
not_in_nav: |
  configuration/log-reference.md
nav:
  - Why use the Eviden KMS: index.md
  - Quick start: quick_start.md
  - Use cases:
      - Encrypting and decrypting at scale: use_cases/encrypting_and_decrypting_at_scale.md
      - Client-side and application-level encryption: use_cases/client_side_and_application_level_encryption.md
      - Public Key Infrastructure (PKI): use_cases/pki.md
      - Anonymization: use_cases/anonymization.md
  - HSM support:
      - Introduction: hsm_support/introduction/index.md
      - HSM keys & operations: hsm_support/hsm_operations.md
      - Multi-HSM support: hsm_support/multi_hsm.md
      - Trustway Crypt2pay: hsm_support/crypt2pay.md
      - Trustway Proteccio: hsm_support/proteccio.md
      - Utimaco General Purpose: hsm_support/utimaco.md
      - Smart card HSM / Nitrokey HSM 2: hsm_support/sc_hsm.md
      - SoftHSMv2: hsm_support/softhsm2.md
      - Other HSMs: hsm_support/other_hsms.md
  - Integrations:
      - API Endpoints: integrations/api.md
      - JOSE (JWS, JWE, JWKS):
          - JOSE API: integrations/jose/jose_api.md
          - JWE Key Unwrap: integrations/jose/jwe_decryption.md
          - JWKS Endpoint: integrations/jose/jwks_endpoint.md
      - Cloud providers:
          - Amazon Web Services (AWS):
              - ECS Fargate: integrations/cloud_providers/aws/fargate.md
              - External Key Store (XKS):
                  - XKS integration: integrations/cloud_providers/aws/xks.md
                  - XKS migration: integrations/cloud_providers/aws/xks_migration.md
              - BYOK (Bring Your Own Key): integrations/cloud_providers/aws/byok.md
          - Microsoft Azure:
              - BYOK (Bring Your Own Key): integrations/cloud_providers/azure/byok.md
              - EKM (External Key Management): integrations/cloud_providers/azure/ekm.md
              - Microsoft 365 Double Key Encryption (DKE): integrations/cloud_providers/microsoft_365_double_key_encryption_dke/index.md
              - Windows CNG Key Storage Provider (KSP): integrations/cloud_providers/microsoft/windows_cng_ksp.md
          - Google Cloud Platform (GCP):
              - CMEK (Customer Managed Encryption Keys): integrations/cloud_providers/google_gcp/cmek.md
              - CSEK (Customer Supplied Encryption Keys): integrations/cloud_providers/google_gcp/csek.md
          - Google Workspace Client-Side Encryption (CSE):
              - Getting started: integrations/cloud_providers/google_workspace_client_side_encryption_cse/getting_started/index.md
              - Configuring the .well-known file: integrations/cloud_providers/google_workspace_client_side_encryption_cse/configuring-the-well-known-file-and-server.md
              - Generating Gmail keys: integrations/cloud_providers/google_workspace_client_side_encryption_cse/configuring_gmail_cse.md
              - Migrating existing Drive CSE elements: integrations/cloud_providers/google_workspace_client_side_encryption_cse/migrating_drive.md
              - Migrating existing email to Gmail CSE: integrations/cloud_providers/google_workspace_client_side_encryption_cse/migrating_gmail.md
      - Databases:
          - MongoDB: integrations/databases/mongodb.md
          - MySQL Enterprise Edition: integrations/databases/mysql.md
          - PostgreSQL Percona Database: integrations/databases/percona.md
          - Microsoft SQL Server External (EKM): integrations/databases/ms_sql_server.md
          - Oracle Database TDE: integrations/databases/oracle_tde.md
          - EDB Postgres Advanced Server TDE: integrations/databases/edb_postgres_tde.md
          - InterSystems IRIS: integrations/databases/intersystems_iris.md
      - Disk encryption:
          - Veracrypt: integrations/disk_encryption/veracrypt.md
          - LUKS: integrations/disk_encryption/luks.md
          - Cryhod: integrations/disk_encryption/cryhod.md
      - Storage:
          - VMware vCenter: integrations/storage/vcenter.md
          - Synology DSM (NAS volume encryption): integrations/storage/synology_dsm.md
          - VAST Data (Storage encryption EKM): integrations/storage/vast_data.md
          - Veeam Backup & Replication: integrations/storage/veeam.md
      - Big Data:
          - Snowflake Native App: integrations/big_data/snowflake_native_app/index.md
          - User Defined Function for PySpark, Databricks,... in Python: integrations/big_data/user_defined_function_for_pyspark_databricks_in_python/index.md
      - Other:
          - FortiGate / FortiOS: integrations/fortigate.md
          - OpenSSH: integrations/openssh.md
          - PyKMIP: integrations/pykmip.md
          - S/MIME Email encryption: integrations/smime.md
  - Installation:
      - Getting started: installation/installation_getting_started.md
      - Deploying in a Cosmian Confidential VM: installation/marketplace_guide.md
      - High-availability: installation/high_availability_mode.md
  - Configuration:
      - Configuration file: configuration/server_configuration_file.md
      - Configuration examples: configuration/configurations.md
      - Command line arguments: configuration/server_cli.md
      - Databases: configuration/database.md
      - Authenticating users to the server: configuration/authentication.md
      - PKCE Authentication: configuration/pkce_authentication.md
      - Authorizing users with access rights: configuration/authorization.md
      - Enabling TLS: configuration/tls.md
      - Logging and telemetry: configuration/logging.md
      - Monitoring:
          - Setup: configuration/monitoring-setup.md
          - Metrics reference: configuration/otlp-metrics.md
      - User interface: configuration/ui.md
      - UI branding: configuration/ui_branding.md
      - Custom OpenSSL build: configuration/openssl_override.md
      - Secret backends: configuration/secret_backends.md
  - Certifications and compliance:
      - FIPS 140-3: certifications_and_compliance/fips.md
      - Cryptographic algorithms:
          - Algorithms: certifications_and_compliance/cryptographic_algorithms/algorithms.md
          - KMIP algorithm policy: certifications_and_compliance/cryptographic_algorithms/kmip_policy.md
          - Benchmarks:
              - Standard algorithms: certifications_and_compliance/cryptographic_algorithms/benchmarks/benchmarks.md
              - Load tests: certifications_and_compliance/cryptographic_algorithms/benchmarks/benchmarks_load_tests.md
              - DKE and Google CSE: certifications_and_compliance/cryptographic_algorithms/benchmarks/google_dke_benchmarks.md
              - CPU Scaling & Flamegraphs: certifications_and_compliance/cryptographic_algorithms/benchmarks/cpu_scaling.md
      - Zeroization: certifications_and_compliance/zeroization.md
      - Audit:
          - SBOM: certifications_and_compliance/audit/sbom.md
          - CBOM: certifications_and_compliance/audit/cbom.md
          - Cryptographic Inventory (CBOM sensor): certifications_and_compliance/audit/crypto_inventory.md
          - Security Audit (OWASP): certifications_and_compliance/audit/owasp_security_audit.md
          - Multi-Framework Security Audit: certifications_and_compliance/audit/multi_framework_security_audit.md
          - Runtime Security Audit: certifications_and_compliance/audit/runtime_security_audit.md
  - KMIP Support:
      - Introduction: kmip_support/introduction/index.md
      - KMIP support summary: kmip_support/support.md
      - Supported Objects: kmip_support/objects.md
      - Supported Formats: kmip_support/formats.md
      - Objects Tagging: kmip_support/tagging.md
      - Attributes Extensions: kmip_support/attributes.md
      - The JSON TTLV KMIP API: kmip_support/json_ttlv_api.md
      - OpenAPI Specification and Swagger UI: kmip_support/openapi.md
      - Bulk mode with Messages: kmip_support/messages.md
      - Operations: kmip_support/operations.md
      - Attributes:
          - Get: kmip_support/attributes/_get_attributes.md
          - Set: kmip_support/attributes/_set_attributes.md
          - Modify: kmip_support/attributes/_modify_attribute.md
          - Delete: kmip_support/attributes/_delete_attributes.md
      - Certify: kmip_support/_certify.md
      - Create: kmip_support/_create.md
      - Create Key Pair: kmip_support/_create_key_pair.md
      - Decrypt: kmip_support/_decrypt.md
      - Destroy: kmip_support/_destroy.md
      - Encrypt: kmip_support/_encrypt.md
      - Export: kmip_support/_export.md
      - Get: kmip_support/_get.md
      - Hash: kmip_support/_hash.md
      - Import: kmip_support/_import.md
      - Locate: kmip_support/_locate.md
      - Mac: kmip_support/_mac.md
      - Key rotation:
          - Re-Key: kmip_support/key_rotation/_re-key.md
          - Re-Key Key Pair: kmip_support/key_rotation/_re-key_key_pair.md
          - Re-Certify: kmip_support/key_rotation/_re-certify.md
          - Key Rotation: kmip_support/key_rotation/index.md
          - HSM Key Rotation: kmip_support/key_rotation/hsm.md
          - Auto-Rotation Policy: kmip_support/key_rotation/auto_rotation_policy.md
      - Revoke: kmip_support/_revoke.md
      - Sign: kmip_support/_signature.md