Skip to content

Commit d069db9

Browse files
committed
Add nsoftware PKI Proxy instructions for NetHSM
1 parent 2423c46 commit d069db9

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
PKI Proxy
2+
---------
3+
4+
This document explains the usage of PKI Proxy with NetHSM.
5+
PKI Proxy enables the usage of NetHSM with the Microsoft Windows CSP and KSP.
6+
Additionally it provides PKCS#11 access to the NetHSM, but this can also be achieved with the NetHSM PKCS#11 driver alone.
7+
8+
The deployment of NetHSM with PKI Proxy looks like this.
9+
10+
NetHSM -- PKI Proxy -- Client (CSP, KSP, PKCS11)
11+
12+
The NetHSM provides the REST API which is used by NetHSM PKCS#11 driver.
13+
PKI Proxy uses this driver to connect to the NetHSM and access its keys and certificates.
14+
Clients to the PKI Proxy use either a CSP or KSP to access the keys and certificates through native Windows APIs or a PKCS#11 driver.
15+
The communication between the NetHSM and PKI Proxy, and PKI Proxy and the clients is encrypted.
16+
17+
Prerequisits
18+
============
19+
20+
- NetHSM (hardware or containerized)
21+
- Provisioned
22+
- IP address of the NetHSM must be known, and the HTTPS port must be reachable.
23+
- Windows machine
24+
- Nitrokey NetHSM PKCS#11 driver installed
25+
26+
Installation
27+
============
28+
29+
1. Download PKI Proxy installer from the nsoftware website.
30+
2. Open the installer and follow the installation wizard.
31+
32+
Configuration
33+
=============
34+
35+
1. Open PKI Proxy by running it from the Start Menu.
36+
If you installed it to the default location you can also run it with the following command from the Run dialog or the PowerShell.
37+
38+
.. code-block:: shell-session
39+
40+
C:\Program Files\PKI Proxy 2024\PKIProxy.exe
41+
42+
2. Configure PKI Proxy in **Settings** tab. TODO
43+
3. Configure NetHSM connection in **Certificates** tab. TODO
44+
45+
1. Open the **Certificates** tab in PKI Proxy.
46+
2. Click on the **New...** button.
47+
3. Click on the **Select Certificate** button.
48+
4. Open the **Security Key** tab.
49+
5. Click the **Browse..** button and select the NetHSM PKCS#11 driver library file.
50+
51+
52+
53+

0 commit comments

Comments
 (0)