Skip to content

Commit

Permalink
Provide manpage for icainfo-cex
Browse files Browse the repository at this point in the history
Also provide libica-cex version info as shown by icainfo-cex.

Signed-off-by: Joerg Schmidbauer <[email protected]>
  • Loading branch information
jschmidb committed May 17, 2021
1 parent 6737dd5 commit 1ee90ac
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -1 +1 @@
dist_man1_MANS = icastats.1 icainfo.1
dist_man1_MANS = icastats.1 icainfo.1 icainfo-cex.1
68 changes: 68 additions & 0 deletions doc/icainfo-cex.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
.\" icainfo-cex man page source
.\"
.\" use
.\" groff -man -Tutf8 icainfo-cex.1
.\" or
.\" nroff -man icainfo-cex.1
.\" to process this source
.\"
.TH ICAINFO-CEX 1 2021-05-12 IBM "icainfo-cex user manual"
.SH NAME
icainfo-cex \- print information about cryptographic functions supported by libica-cex
.SH SYNOPSIS
.B icainfo-cex
[-v | --version] [-h | --help]
.SH DESCRIPTION
.B icainfo-cex
prints a table that shows libica-cex's support for various cryptographic
algorithms and information about FIPS support.

The icainfo-cex output also indicates, whether it is in an error state.
Algorithms that are not FIPS approved are marked as blocked in both table
columns when running in FIPS mode. All algorithms are marked as blocked when
libica is in an error state.

Available hardware support is divided into two columns: dynamic hardware
means crypto cards, static hardware support means CPACF. Software support
is provided via openssl.

If a function is disabled via build option, this is indicated
by a dash '-' in the related column.

A shortened sample output is given below:
.P
.nf
Cryptographic algorithm support
------------------------------------------------------
| hardware |
function | dynamic | static | software
---------------+------------+------------+------------
SHA-1 | no | - | -
SHA-224 | no | - | -
SHA-256 | no | - | -
SHA-384 | no | - | -
SHA-512 | no | - | -
GHASH | no | - | -
P_RNG | blocked | - | -
DRBG-SHA-512 | no | - | -
RSA ME | yes | - | -
RSA CRT | yes | - | -
...
------------------------------------------------------
Built-in FIPS support: FIPS mode active.
Software fallbacks are disabled in libica-cex.
CPACF support (including fallbacks) is disabled in libica-cex.
.fi
.SH OPTIONS
.IP "-v or --version"
show libica-cex version and copyright
.IP "-h or --help"
display this help and exit
.SH RETURN VALUE
.IP 1
unknown or invalid argument on invocation
.IP 0
successful program execution
.SH "SEE ALSO"
.BR icastats (1)

3 changes: 0 additions & 3 deletions doc/icainfo.1
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,6 @@ Available hardware support is divided into two columns: dynamic hardware
means crypto cards, static hardware support means CPACF. Software support
is provided via openssl.

If a function is disabled, e.g. via compile switch, this is indicated
by a dash '-' in the related column.

A shortened sample output is given below:
.P
.nf
Expand Down
11 changes: 10 additions & 1 deletion src/icainfo.c
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,21 @@
#include "ica_api.h"
#include "s390_crypto.h"

#if defined(NO_SW_FALLBACKS) && defined(NO_CPACF)
#define CMD_NAME "icainfo-cex"
#else
#define CMD_NAME "icainfo"
#define COPYRIGHT "Copyright IBM Corp. 2007, 2016."
#endif
#define COPYRIGHT "Copyright IBM Corp. 2007, 2021."


void print_version(void)
{
#if defined(NO_SW_FALLBACKS) && defined(NO_CPACF)
printf(CMD_NAME ": libica-cex version " VERSION "\n" COPYRIGHT "\n");
#else
printf(CMD_NAME ": libica version " VERSION "\n" COPYRIGHT "\n");
#endif
}

void print_help(char *cmd)
Expand Down

0 comments on commit 1ee90ac

Please sign in to comment.