kms/documentation/mkdocs.yml at develop · Manuthor/kms · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
---
site_name: Key Management System
site_url: https://docs.cosmian.com/
copyright: © Copyright 2018-2024 Cosmian. All rights reserved
dev_addr: localhost:8003
theme:
  name: material
  language: en
  font:
    text: Open Sans
  favicon: favicon.png
  logo: images/docslogo-2x.png
  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
extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
plugins:
  - search
  - kroki
  - meta-descriptions
nav:
  - Why use the Cosmian KMS: index.md
  - Quick start: quick_start.md
  - Use cases:
      - Encrypting and decrypting at scale: encrypting_and_decrypting_at_scale.md
      - Client-side and application-level encryption: client_side_and_application_level_encryption.md
  - HSM support:
      - Introduction: hsms/index.md
      - HSM keys & operations: hsms/hsm_operations.md
      - Trustway Crypt2pay: hsms/crypt2pay.md
      - Trustway Proteccio: hsms/proteccio.md
      - Utimaco General Purpose: hsms/utimaco.md
      - Smart card HSM / Nitrokey HSM 2: hsms/sc_hsm.md
      - SoftHSMv2: hsms/softhsm2.md
      - Other HSMs: hsms/other_hsms.md
  - Integrations:
      - API Endpoints: api.md
      - Azure:
          - BYOK (Bring Your Own Key): azure/byok.md
      - Google GCP:
          - CMEK (Customer Managed Encryption Keys): google_gcp/cmek.md
          - CSEK (Customer Supplied Encryption Keys): google_gcp/csek.md
      - Google Workspace Client-Side Encryption (CSE):
          - Getting started: google_cse/index.md
          - Configuring the .well-known file: google_cse/configuring-the-well-known-file-and-server.md
          - Generating Gmail keys: google_cse/configuring_gmail_cse.md
          - Migrating existing Drive CSE elements: google_cse/migrating_drive.md
          - Migrating existing email to Gmail CSE: google_cse/migrating_gmail.md
      - Microsoft 365 Double Key Encryption (DKE): ms_dke/index.md
      - MongoDB: mongodb.md
      - Postgresql Percona Database: percona.md
      - PyKMIP: pykmip.md
      - S/MIME Email encryption: pki/smime.md
      - Snowflake Native App: snowflake/index.md
      - User Defined Function for PySpark, Databricks,... in Python: python_udf/index.md
      - VMware vCenter: vcenter.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: server_configuration_file.md
      - Configuration examples: configurations.md
      - Command line arguments: server_cli.md
      - Databases: database.md
      - Authenticating users to the server: authentication.md
      - PKCE Authentication: pkce_authentication.md
      - Authorizing users with access rights: authorization.md
      - Enabling TLS: tls.md
      - Logging and telemetry: logging.md
      - User interface: ui.md
  - Certifications and compliance:
      - FIPS 140-3: fips.md
      - Cryptographic algorithms:
          - Algorithms: algorithms.md
          - Benchmarks:
              - Standard algorithms: benchmarks.md
              - DKE and Google CSE: google_dke_benchmarks.md
      - Zeroization: zeroization.md
  - KMIP Support:
      - Introduction: kmip/index.md
      - KMIP support summary: kmip/support.md
      - Supported Objects: kmip/objects.md
      - Supported Formats: kmip/formats.md
      - Objects Tagging: kmip/tagging.md
      - Attributes Extensions: kmip/attributes.md
      - The JSON TTLV KMIP API: kmip/json_ttlv_api.md
      - Bulk mode with Messages: kmip/messages.md
      - Operations: kmip/operations.md
      - Attributes:
          Get: kmip/_get_attributes.md
          Set: kmip/_set_attributes.md
          Delete: kmip/_delete_attributes.md
      - Certify: kmip/_certify.md
      - Create: kmip/_create.md
      - Create Key Pair: kmip/_create_key_pair.md
      - Decrypt: kmip/_decrypt.md
      - Destroy: kmip/_destroy.md
      - Encrypt: kmip/_encrypt.md
      - Export: kmip/_export.md
      - Get: kmip/_get.md
      - Hash: kmip/_hash.md
      - Import: kmip/_import.md
      - Locate: kmip/_locate.md
      - Mac: kmip/_mac.md
      - Re-Key: kmip/_re-key.md
      - Re-Key Key Pair: kmip/_re-key_key_pair.md
      - Revoke: kmip/_revoke.md
      - Sign: kmip/_signature.md