doc: update features and main documentation

Nitrokey · Jul 25, 2023 · 650c7b3 · 650c7b3
1 parent 4d2c1ca
commit 650c7b3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 71 deletions.
diff --git a/README.md b/README.md
@@ -8,75 +8,14 @@ Some features of pkcs11 are not supported, see the feature list here : [features
 
 Download the binary corresponding to your system here : [latest release](https://github.com/Nitrokey/nethsm-pkcs11/releases).
 
-## Configuration
-
-By default the modules searches for configuration files in :
-
-- `/etc/nitrokey/p11nethsm.conf`
-- `/usr/local/etc/nitrokey/p11nethsm.conf`
-- `~/.config/nitrokey/p11nethsm.conf`
-
-If multiple files are present the slots of all the config files will be added.
-
-You can manually set the config file location (only this one will be read) wiht the env variable `P11NETHSM_CONFIG_FILE` (eg. `P11NETHSM_CONFIG_FILE=./p11nethsm.conf`).
-
-### Configuration format
-
-The configuration is yaml-formatted :
-
-```yml
-# you can set the log file location here, if no value is set, the module will output to stderr, if a value is set it will output to the file
-log_file: /tmp/p11nethsm.log
-# optional log level
-log_level: Debug
-
-# each "slot" represents a NetHSM server
-slots:
-  - label: LocalHSM                        # name you NetHSM however you want
-    description: Local HSM (docker)        # optional description
-    url: "https://keyfender:8443/api/v1"   # url to reach the server
-    operator:
-      username: "operator"                       # user connecting to the NetHSM server
-      password: "env:LOCALHSMPASS"    
-    administrator:
-      username: "admin"
-
-    # When the server has a self-signed certificate, you can allow it via two ways :
-
-    # File containing the certificate of the server
-    certificate_file: /etc/cert/localhsm.pem
-    # The string certificate of the server
-    certificate: |
-        -----BEGIN CERTIFICATE-----
-        MIIBHjCBxaADAgECAgkApoJ3bQqnwmcwCgYIKoZIzj0EAwIwFDESMBAGA1UEAwwJ
-        a2V5ZmVuZGVyMCAXDTcwMDEwMTAwMDAwMFoYDzk5OTkxMjMxMjM1OTU5WjAUMRIw
-        EAYDVQQDDAlrZXlmZW5kZXIwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAARzywjh
-        NQM4pBxNBIOrgWvKFcWle5SLGux1caV9rur/fnPptDnekjZ2fajJX2EEACjk9JKw
-        VykkfhbAdR46VGgFMAoGCCqGSM49BAMCA0gAMEUCIQDvm9J5y9S9POsfdlo5lKzg
-        VFYo7UBT3aTavB6b+hUUbQIgMzT1fBhbBFTgCx5LKQMp1V7SuyCby3oxL5RWYqhl
-        /R0=
-        -----END CERTIFICATE-----
-```
-
-The operator and administrator users are both optional but the module won't start if no user is configured. This is so you can configure the module with only an administrator user, only an operator user or both at the same time.
-
-When the two users are set the module will use the operator by default and only use the administrator user when the action needs it.
-
-The regular PKCS11 user is mapped to the NetHSM operator and the PKCS11 SO is mapped to the NetHSM administrator.
+## Documentation
 
-The password can be provided by multiple means :
-
-- in plain text in the configuration `password: "mypassword"`
-- in an environment variable read by the module with the `env:` prefix : `env:ENV_STORING_THE_PASSWORD`
-- via the login function of pkcs11, example for pcks11-tool : `pkcs11-tool --module libnethsm_pkcs11.so -p opPassphrase`
-  To provide the the admin password you need to use `--so-pin` instead : `pkcs11-tool --module libnethsm_pkcs11.so --login --login-type so --so-pin Administrator`
-
-If the password of an user is not set in the configuration file a login will be required to provide the password (3rd method).
-
-A NetHSM that is not operational is considered as a slot with the token not present.
+The documentation is available on [Nitrokey's Website](https://docs.nitrokey.com/nethsm/pkcs11-setup.html)
 
 ## Building
 
+Openssl and a working rust toolchain are required.
+
 ```
 cargo build --release
 ```

diff --git a/features.md b/features.md
@@ -5,14 +5,18 @@
 - 🗓️ : Planned
 - ❌ : Not in the current scope of the project
 
+## Concurrency
+
+As of current version concurrency is not yet implemented.
+
 ## Base features
 
-| Feature           | Status |
-| ----------------- | ------ |
-| C_GetFunctionList | ✔️      |
-| C_Initialize      | ✔️      |
-| C_Finalize        | ✔️      |
-| C_GetInfo         | ✔️      |
+| Feature           | Status | Notes                         |
+| ----------------- | ------ | ----------------------------- |
+| C_GetFunctionList | ✔️      |                               |
+| C_Initialize      | ⚠️      | Concurrency not yet supported |
+| C_Finalize        | ✔️      |                               |
+| C_GetInfo         | ✔️      |                               |
 
 ## Session