Skip to content

Commit bf2c8e6

Browse files
committed
Update README.md
Align the text with the recent test suite changes (but leave the details for 'make help'). Also add 25 as a known working JDK. Introduce a description of a debug messages' feature otherwise hidden in a src/p11_util.h comment (the ability to quickly search constant names).
1 parent bcc490f commit bf2c8e6

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,14 @@ The Makefile has support for:
2929
* Formatting the C code (with `clang-format`)
3030
* Building, rebuilding and cleaning (RELEASE and DEBUG modes)
3131
* Showing built library information (such as linkage and symbols)
32-
* Running the test suite (with a specified `java` executable)
32+
* Running the test suite (in different modes, including a containerized test)
3333
* This test suite ensures the system is in FIPS mode, and is known to work
34-
with _Temurin_ builds of _OpenJDK_ 8, 11, 17 and 21
34+
with _Temurin_ builds of _OpenJDK_ 8, 11, 17, 21 and 25
3535
* Building a source tarball
3636

3737
To see a help message with all the `make` targets and a brief description invoke
3838
`make help`.
3939

40-
4140
## Debugging traces
4241

4342
This library implements logging functionality for both development and release
@@ -58,6 +57,20 @@ as follows:
5857
* If an error occurs while opening the file, the error is logged to `stderr`
5958
and debug traces are disabled
6059

60+
Some debug messages print PKCS #​11 constants in a format that allows
61+
quickly searching them once the text is copied to the clipboard. For example,
62+
with the clipboard containing `CKA_.*0x00000170`, execute:
63+
64+
```bash
65+
grep -irE "^\s*#define\s+$(xclip -sel clip)" /usr/include
66+
```
67+
68+
This reveals that it was the `CKA_MODIFIABLE` constant:
69+
70+
```
71+
/usr/include/nss3/pkcs11t.h:#define CKA_MODIFIABLE 0x00000170UL
72+
```
73+
6174
When the library is built in DEBUG mode, sensitive PKCS #​11
6275
attribute values are logged, i.e. plain keys! When the library is built in
6376
RELEASE mode, secret and private key material is not logged.

0 commit comments

Comments
 (0)