summaryrefslogtreecommitdiff
path: root/p11p-daemon/README.md
diff options
context:
space:
mode:
authorLinus Nordberg <linus@sunet.se>2019-10-09 08:46:39 +0200
committerLinus Nordberg <linus@sunet.se>2019-10-09 08:46:39 +0200
commitae6ec3c18a59e35ab50a14f10b1e32901585b4c7 (patch)
treec822c4eed067861c7da5491526ee542c5c7f7261 /p11p-daemon/README.md
parent7f593039695486a01ad4b08b01db4937aeb741de (diff)
language and speling
Diffstat (limited to 'p11p-daemon/README.md')
-rw-r--r--p11p-daemon/README.md30
1 files changed, 18 insertions, 12 deletions
diff --git a/p11p-daemon/README.md b/p11p-daemon/README.md
index 8305925..7b7b943 100644
--- a/p11p-daemon/README.md
+++ b/p11p-daemon/README.md
@@ -1,4 +1,4 @@
-# p11p is a PKCS #11 proxy
+# p11p-daemon is a PKCS #11 proxy
## Install dependencies
@@ -15,7 +15,7 @@
### Erlang/OTP 19
-Ideally, your OS distribution has Elrang/OTP 19.x:
+Ideally, your OS distribution has Erlang/OTP 19.x:
$ sudo apt install erlang
@@ -36,7 +36,9 @@ would be:
If you don't have rebar3 installed, install it. See
https://www.rebar3.org/docs/ .
-If you don't have rebar3 in PATH, add it. Example:
+If you don't have rebar3 in PATH, add it.
+
+Example:
$ export PATH=$PATH:~/.cache/rebar3/bin
@@ -47,7 +49,8 @@ Compile:
## Configure
-For now, see config/sys.config.
+For now, see config/sys.config for how to configure virtual tokens,
+each with one or more PKCS #11 modules, i.e. shared libraries.
## Run
@@ -62,12 +65,10 @@ under _build/default/rel/p11p/log:
$ make start
-To stop it:
-
- $ make stop
-
A socket per configured token, /run/user/$EUID/p11p/$TOKEN-$PID, can
-now be used by a client. Example:
+now be used by a client.
+
+Example using p11tool:
$ P11_KIT_SERVER_ADDRESS=unix:path=/run/user/1000/p11p/vtoken0-26585 P11_KIT_DEBUG=none p11tool --provider /usr/lib/pkcs11/p11-kit-client.so --list-tokens
Token 0:
@@ -79,12 +80,17 @@ now be used by a client. Example:
Serial: b4a861d362dbd386
Module: (null)
+To stop the Erlang shell:
+
+ $ make stop
+
## Known bugs and limitations
- Multiple p11 applications using the same vtoken in a given
- p11p-daemon will result in undefined behaviour. We should either
- make this work, or prohibit it by rejecting a second user of the
- same vtoken.
+ p11p-daemon will result in undefined behaviour.
+
+ TODO: Make this work, or prohibit it by rejecting a second user of
+ the same vtoken.
## Bug reports, questions, comments