Skip to content

Commit 1ee90ac

Browse files
committed
Provide manpage for icainfo-cex
Also provide libica-cex version info as shown by icainfo-cex. Signed-off-by: Joerg Schmidbauer <[email protected]>
1 parent 6737dd5 commit 1ee90ac

File tree

4 files changed

+79
-5
lines changed

4 files changed

+79
-5
lines changed

doc/Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
dist_man1_MANS = icastats.1 icainfo.1
1+
dist_man1_MANS = icastats.1 icainfo.1 icainfo-cex.1

doc/icainfo-cex.1

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
.\" icainfo-cex man page source
2+
.\"
3+
.\" use
4+
.\" groff -man -Tutf8 icainfo-cex.1
5+
.\" or
6+
.\" nroff -man icainfo-cex.1
7+
.\" to process this source
8+
.\"
9+
.TH ICAINFO-CEX 1 2021-05-12 IBM "icainfo-cex user manual"
10+
.SH NAME
11+
icainfo-cex \- print information about cryptographic functions supported by libica-cex
12+
.SH SYNOPSIS
13+
.B icainfo-cex
14+
[-v | --version] [-h | --help]
15+
.SH DESCRIPTION
16+
.B icainfo-cex
17+
prints a table that shows libica-cex's support for various cryptographic
18+
algorithms and information about FIPS support.
19+
20+
The icainfo-cex output also indicates, whether it is in an error state.
21+
Algorithms that are not FIPS approved are marked as blocked in both table
22+
columns when running in FIPS mode. All algorithms are marked as blocked when
23+
libica is in an error state.
24+
25+
Available hardware support is divided into two columns: dynamic hardware
26+
means crypto cards, static hardware support means CPACF. Software support
27+
is provided via openssl.
28+
29+
If a function is disabled via build option, this is indicated
30+
by a dash '-' in the related column.
31+
32+
A shortened sample output is given below:
33+
.P
34+
.nf
35+
Cryptographic algorithm support
36+
------------------------------------------------------
37+
| hardware |
38+
function | dynamic | static | software
39+
---------------+------------+------------+------------
40+
SHA-1 | no | - | -
41+
SHA-224 | no | - | -
42+
SHA-256 | no | - | -
43+
SHA-384 | no | - | -
44+
SHA-512 | no | - | -
45+
GHASH | no | - | -
46+
P_RNG | blocked | - | -
47+
DRBG-SHA-512 | no | - | -
48+
RSA ME | yes | - | -
49+
RSA CRT | yes | - | -
50+
...
51+
------------------------------------------------------
52+
Built-in FIPS support: FIPS mode active.
53+
Software fallbacks are disabled in libica-cex.
54+
CPACF support (including fallbacks) is disabled in libica-cex.
55+
.fi
56+
.SH OPTIONS
57+
.IP "-v or --version"
58+
show libica-cex version and copyright
59+
.IP "-h or --help"
60+
display this help and exit
61+
.SH RETURN VALUE
62+
.IP 1
63+
unknown or invalid argument on invocation
64+
.IP 0
65+
successful program execution
66+
.SH "SEE ALSO"
67+
.BR icastats (1)
68+

doc/icainfo.1

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,6 @@ Available hardware support is divided into two columns: dynamic hardware
2626
means crypto cards, static hardware support means CPACF. Software support
2727
is provided via openssl.
2828

29-
If a function is disabled, e.g. via compile switch, this is indicated
30-
by a dash '-' in the related column.
31-
3229
A shortened sample output is given below:
3330
.P
3431
.nf

src/icainfo.c

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,21 @@
3131
#include "ica_api.h"
3232
#include "s390_crypto.h"
3333

34+
#if defined(NO_SW_FALLBACKS) && defined(NO_CPACF)
35+
#define CMD_NAME "icainfo-cex"
36+
#else
3437
#define CMD_NAME "icainfo"
35-
#define COPYRIGHT "Copyright IBM Corp. 2007, 2016."
38+
#endif
39+
#define COPYRIGHT "Copyright IBM Corp. 2007, 2021."
40+
3641

3742
void print_version(void)
3843
{
44+
#if defined(NO_SW_FALLBACKS) && defined(NO_CPACF)
45+
printf(CMD_NAME ": libica-cex version " VERSION "\n" COPYRIGHT "\n");
46+
#else
3947
printf(CMD_NAME ": libica version " VERSION "\n" COPYRIGHT "\n");
48+
#endif
4049
}
4150

4251
void print_help(char *cmd)

0 commit comments

Comments
 (0)