Skip to content

Commit 4175dc9

Browse files
committed
README.md: update pkeyread documentation
Signed-off-by: Eugene Syromiatnikov <[email protected]>
1 parent 0a28410 commit 4175dc9

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -121,18 +121,27 @@ lock/unlock pairs are reported as a performance measurement
121121

122122
## pkeyread
123123

124-
The `pkeyread` test repeatedly calls the [PEM_read_bio_PrivateKey()](https://docs.openssl.org/master/man3/PEM_read_bio_PrivateKey/) function on a
125-
memory BIO with a private key of desired type, when it is running in pem mode
126-
(-f pem). If test is running in der mode (-f der) it calls to
127-
[d2i_PrivateKey_ex()](https://docs.openssl.org/master/man3/d2i_PrivateKey/) function to repeatedly read private key of desired type.
128-
It does 10000 repetitions divided evenly among each thread. The number of
129-
threads to use is provided by option `-t`. The test reports average time per
130-
call. Use option `-k` to select key type for benchmark. The list of keys for
131-
testing is as follows: dh, dhx, dsa, ec, rsa, xkey. To run benchmark for all
132-
keys and formats using 4 threads run pkeyread as follows:
124+
The `pkeyread` test benchmarks reading of private keys of the specified type
125+
in the specified format. If PEM format is specified (`-f pem`),
126+
the [`PEM_read_bio_PrivateKey()`](https://docs.openssl.org/master/man3/PEM_read_bio_PrivateKey/)
127+
function is called repeatedly on a memory BIO with a private key
128+
of desired type; in case of DER format specification (`-f der`),
129+
[`d2i_PrivateKey_ex()`](https://docs.openssl.org/master/man3/d2i_PrivateKey/)
130+
is called repeatedly to read private key of the desired type.
131+
The calls are performed repeatedly until the timeout (specified in the `-T`
132+
option, 5 seconds by default) is reached.
133+
The number of threads to use is provided by the only positional option.
134+
By default, the test reports average time per call. If `-t` ("terse output")
135+
option is specified, only the number is printed, without key type and format.
136+
If `-v` ("verbose") option is specified, additional information is printed
137+
for each run: median, minimum, maximum time among threads, as well as standard
138+
deviation.
139+
The mandatory option `-k` selects the key type for benchmark. The list of keys
140+
for testing is as follows: dh, dhx, dsa, ec, rsa, x25519. To run benchmark
141+
for all keys and formats using 4 threads, run `pkeyread` as follows:
133142

134143
```sh
135-
./pkeyread -f all -k all -t 4
144+
./pkeyread -f all -k all 4
136145
```
137146

138147
## evp_setpeer

0 commit comments

Comments
 (0)