|
1 | 1 | ---
|
2 |
| -title: "Encrypting Backup Jobs with Veeam and OKMS" |
3 |
| -excerpt: "Learn how to configure encrypted backup jobs using Veeam and the OVHcloud KMS (OKMS) service to enhance data protection." |
4 |
| -updated: 2025-03-31 |
| 2 | +title: "Encrypting backup jobs with Veeam and OKMS" |
| 3 | +excerpt: "Learn how to configure encrypted backup jobs using Veeam and the OVHcloud Key Management Service (OKMS) to enhance data protection." |
| 4 | +updated: 2025-04-10 |
5 | 5 | ---
|
6 | 6 |
|
7 | 7 | ## Objective
|
8 |
| - |
9 |
| -This guide explains how to configure encrypted backup jobs using the Veeam backup solution and the OVHcloud KMS (OKMS) service. |
| 8 | +This guide explains how to configure encrypted backup jobs using the Veeam backup solution and the OVHcloud Key Management Service (OKMS). |
10 | 9 |
|
11 | 10 | ## Requirements
|
12 |
| - |
13 | 11 | - Access to the [OVHcloud Control Panel](/links/manager).
|
14 |
| -- A [Hosted Private Cloud VMware vSphere on OVHcloud](/links/hosted-private-cloud/vmware) offer. |
15 |
| -- You must have read the following guides: |
16 |
| - - [KMS integration for VMware on OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_overall_vm-encrypt). |
| 12 | +- A [VMware on OVHcloud](/links/hosted-private-cloud/vmware) offer. |
| 13 | +- Review the following guides: |
| 14 | + - [Integrating a KMS with VMware on OVHcloud](/pages/hosted_private_cloud/hosted_private_cloud_powered_by_vmware/vmware_overall_vm-encrypt). |
17 | 15 | - [Getting started with OKMS](/pages/manage_and_operate/kms/quick-start).
|
18 | 16 |
|
19 | 17 | ## Instructions
|
20 | 18 |
|
21 |
| -### Step 1: Create the Certificate in OKMS Service |
22 |
| - |
23 |
| -You can create the certificate from the dedicated entry from the [OVHcloud Control Panel](/links/manager): |
24 |
| - |
25 |
| -1.\ Click `Hosted Private Cloud`{.action} then `Identity, Security & Operations`{.action} and `Key Management Service`{.action}.Select your KMS. |
| 19 | +### Step 1: Create the certificate using the API |
26 | 20 |
|
27 |
| -{.thumbnail} |
28 |
| - |
29 |
| -2.\ Select your KMS. |
30 |
| - |
31 |
| -{.thumbnail} |
| 21 | +You can create an access certificate directly via the OKMS API, without using the Manager interface. |
32 | 22 |
|
33 |
| -3.\ Then, click on `Generate an access certificate`{.action} button and generate the private key using the following API (without CSR): |
| 23 | +1. Generate the private key using the API (no CSR): |
34 | 24 |
|
35 | 25 | > [!api]
|
36 | 26 | >
|
37 | 27 | > @api {v1} /okms POST / /okms/resource/{okmsId}/credential
|
38 | 28 |
|
39 |
| -{.thumbnail} |
40 |
| - |
41 |
| -4.\ Retrieve the certificate by making a GET request: |
| 29 | +2. Retrieve the certificate using a GET request: |
42 | 30 |
|
43 | 31 | > [!api]
|
44 | 32 | >
|
45 | 33 | > @api {v1} /okms GET /okms/resource/{okmsId}/credential
|
46 | 34 |
|
47 |
| -Fill in the required fields in the Generate an access certificate window and select the option `I don’t have a private key`{.action}. |
| 35 | +> [!note] |
| 36 | +> This method is equivalent to selecting `I don't have a private key`{.action} in the Manager interface. |
| 37 | +> You may also submit a CSR if you already have your own private key. |
| 38 | +
|
| 39 | +3. Download the private key. |
| 40 | + |
| 41 | +4. Download the certificate. |
| 42 | + |
| 43 | +> [!info] |
| 44 | +> The downloaded private key is used to generate the `.pfx` file in the next step. |
| 45 | +> You don't need to import it manually into Veeam, but it is required to convert the certificate into a compatible format. |
| 46 | +> Make sure to store it securely. |
| 47 | +
|
| 48 | +### Step 2: Create the certificate from the Manager |
| 49 | + |
| 50 | +You can also generate a certificate from the [OVHcloud Control Panel](/links/manager): |
| 51 | + |
| 52 | +1. Click `Hosted Private Cloud`{.action} then `Identity, Security & Operations`{.action} and finally `Key Management Service`{.action}. Select your KMS. |
| 53 | + |
| 54 | +{.thumbnail} |
| 55 | + |
| 56 | +2. Select your KMS. |
| 57 | + |
| 58 | +{.thumbnail} |
| 59 | + |
| 60 | +3. Click the `Access certificates` tab. |
| 61 | + |
| 62 | +{.thumbnail} |
| 63 | + |
| 64 | +4. Click `Generate an access certificate`{.action}. |
| 65 | + |
| 66 | +5. Fill in the required fields and select `I don’t have a private key`{.action}. |
48 | 67 |
|
49 | 68 | {.thumbnail}
|
50 | 69 |
|
51 |
| -5.\ Download the private key. |
| 70 | +> [!note] |
| 71 | +> This option corresponds to creating a certificate without a CSR, just like with the API. |
| 72 | +> You can also choose `I already have a private key` to generate a certificate using your own CSR. |
| 73 | +
|
| 74 | +### Add user IDs |
| 75 | + |
| 76 | +Before the certificate can be used, you must associate at least one user ID. |
| 77 | + |
| 78 | +1. In the KMS management interface, click `Add user IDs`{.action}. |
| 79 | +2. Select the users allowed to access the KMS. |
| 80 | +3. Confirm to bind the certificate to these user IDs. |
52 | 81 |
|
53 |
| -6.\ Download the certificate. |
| 82 | +> [!info] |
| 83 | +> This step is required for the certificate to be recognized and usable in Veeam. |
| 84 | +
|
| 85 | +6. Download the private key and the certificate. |
54 | 86 |
|
55 | 87 | {.thumbnail}
|
56 | 88 |
|
57 |
| -### Step 2: Convert PEM to PFX |
| 89 | +### Step 3: Convert the PEM certificate to PFX format |
58 | 90 |
|
59 |
| -To import the certificate into Veeam, you must convert it to `.pfx` format using the following command: |
| 91 | +To import the certificate into Veeam, convert it to `.pfx` format using the command below: |
60 | 92 |
|
61 | 93 | ```bash
|
62 | 94 | openssl pkcs12 -export -out cert.pfx -inkey privatekey.pem -in certificate.pem
|
63 | 95 | ```
|
64 | 96 |
|
65 |
| -### Step 3: Import the Certificate to Veeam Windows Certificate Store |
| 97 | +### Step 4: Import the certificate into the Veeam Windows Certificate Store |
66 | 98 |
|
67 |
| -1. Open the Windows Certificate Store on your Veeam server. |
68 |
| -1. Import the `.pfx` certificate into the Veeam Windows Certificate Store. |
69 |
| -1. Mark the certificate as exportable during import. |
| 99 | +- Open the Windows Certificate Store on your Veeam server. |
| 100 | +- Import the `.pfx` file generated in the previous step. |
| 101 | +- Check the option to make the certificate exportable. |
70 | 102 |
|
71 | 103 | {.thumbnail}
|
72 | 104 |
|
73 |
| -### Step 4: Register the KMS Inside Veeam |
| 105 | +### Step 5: Register the KMS in Veeam |
74 | 106 |
|
75 |
| -1.\ Open Veeam Backup & Replication and go to `Credentials & Passwords`{.action} then click on `Key Management Servers`{.action}. |
| 107 | +- Open Veeam Backup & Replication and go to `Credentials & Passwords`{.action}, then click `Key Management Servers`{.action}. |
76 | 108 |
|
77 | 109 | {.thumbnail}
|
78 | 110 |
|
79 |
| -2.\ Click on `Add`{.action} to a new KMS server. |
| 111 | +- Click `Add`{.action} to add a new KMS server. |
80 | 112 |
|
81 | 113 | {.thumbnail}
|
82 | 114 |
|
83 |
| -3.\ Enter the server address. |
84 |
| - |
85 |
| -For example, for a KMS created in the **eu-west-rbx** region: <https://eu-west-rbx.okms.ovh.net>. |
86 |
| - |
87 |
| -Then, import your certificate from the Windows Key Store (the .`.pfx` file you imported previously). |
| 115 | +- Enter the following details: |
| 116 | + - Server address: `eu-west-rbx.okms.ovh.net` |
| 117 | + - Port: `5696` |
| 118 | + - Server certificate: `*.okms.ovh.net` |
| 119 | + - Client certificate: the `.pfx` file you just imported |
88 | 120 |
|
89 | 121 | {.thumbnail}
|
90 | 122 |
|
91 |
| -### Step 5: Retrieve the Server Certificate |
| 123 | +### Step 6: Retrieve the server certificate |
92 | 124 |
|
93 |
| -To retrieve the certificate from the OKMS server, use this command: |
| 125 | +To retrieve the server certificate from OKMS, run the following command: |
94 | 126 |
|
95 | 127 | ```bash
|
96 |
| -openssl s_client -connect eu-west-rbx.okms.ovh.net:443 2>/dev/null </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' |
| 128 | +openssl s_client -connect eu-west-rbx.okms.ovh.net:443 2>/dev/null </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' |
97 | 129 | ```
|
98 | 130 |
|
99 |
| -### Step 6: Configure Backup Job Encryption |
| 131 | +### Step 7: Configure backup job encryption |
100 | 132 |
|
101 |
| -1.\ Register the KMS server in your Veeam Backup & Replication console. |
102 |
| -2.\ Select the desired backup job and configure encryption using the registered KMS. |
| 133 | +- Register the KMS server in your Veeam Backup & Replication console. |
| 134 | +- Select the desired backup job and enable encryption using the registered KMS. |
103 | 135 |
|
104 | 136 | {.thumbnail}
|
105 | 137 |
|
106 |
| -3.\ Once the backup is complete, you will see a lock icon next to the backup name indicating it is encrypted. |
| 138 | +- Once the backup has run, a padlock icon appears next to its name. |
107 | 139 |
|
108 | 140 | {.thumbnail}
|
109 | 141 |
|
110 |
| -4.\ If you encounter the error **Unsupported attribute: OPERATION_POLICY_NAME**, follow the instructions provided in the documentation to resolve the issue. |
| 142 | +- If you encounter the error `Unsupported attribute: OPERATION_POLICY_NAME`, check the documentation or contact support. |
111 | 143 |
|
112 | 144 | {.thumbnail}
|
113 | 145 |
|
114 | 146 | ## Go further
|
115 | 147 |
|
116 |
| -If you need training or technical assistance to implement our solutions, please contact your Technical Account Manager or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for a custom analysis of your project. |
| 148 | +If you need training or technical assistance to implement our solutions, contact your Technical Account Manager or click [this link](/links/professional-services) to request a quote and get personalized support from our Professional Services team. |
117 | 149 |
|
118 |
| -Ask questions, give your feedback and interact directly with the team building our Hosted Private Cloud services on the dedicated [Discord](https://discord.gg/ovhcloud) channel. |
| 150 | +Ask questions, share feedback, and interact directly with the Hosted Private Cloud team on our [Discord](https://discord.gg/ovhcloud) channel. |
119 | 151 |
|
120 | 152 | Join our [community of users](/links/community).
|
0 commit comments