From 4d97e15eb0cc47771c966f6d4b7b4020216aa276 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20H=C3=B6ppner?= Date: Fri, 6 Dec 2024 11:16:46 +0100 Subject: [PATCH] s390-tools: Update README.md and rust/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add missing build requirements and dependency information to README.md and rust/README.md. Signed-off-by: Jan Höppner --- README.md | 12 +++++++++++- rust/README.md | 10 ++++++---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 253fbf08..d7ab8a47 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,9 @@ Package contents all s390-tools that are written in rust and require external crates. Disable the compilation of all tools in `rust/` using HAVE_CARGO=0 See the `rust/README.md` for Details + - cpacfinfo: + Command line interface to get information about CP Assist for + Cryptographic Functions (CPACF) - pvattest: Create, perform, and verify IBM Secure Execution attestation measurements. - pvapconfig: @@ -317,7 +320,7 @@ build options: | glibc-static | `HAVE_LIBC_STATIC` | zfcpdump | | openssl | `HAVE_OPENSSL` | zkey, libekmfweb, libkmipclient, | | | | zgetdump, rust/pvattest, rust/pvimg, | -| | | zgetdump/pvsecret | +| | | zgetdump/pvsecret, opticsmon | | cryptsetup | `HAVE_CRYPTSETUP2` | zkey-cryptsetup | | json-c | `HAVE_JSONC` | zkey-cryptsetup, libekmfweb, | | | | libkmipclient | @@ -327,6 +330,7 @@ build options: | libxml2 | `HAVE_LIBXML2` | libkmipclient | | systemd | `HAVE_SYSTEMD` | hsavmcore | | libudev | `HAVE_LIBUDEV` | cpacfstatsd | +| libnl3 | `HAVE_LIBNL3` | opticsmon | This table lists additional build or install options: @@ -374,6 +378,12 @@ the different tools are provided: The runtime requirements are: openssl-libs (>= 1.1.1) and libcurl. +* opticsmon: + For building opticsmon OpenSSL and the Netlink Library Suite (libnl3) are + required. + Tip: you may skip the opticsmon build by adding + `HAVE_OPENSSL=0` or `HAVE_LIBNL3=0` + * osasnmpd: You need at least the NET-SNMP 5.1.x package (net-snmp-devel.rpm) installed, before building the osasnmpd subagent. diff --git a/rust/README.md b/rust/README.md index 5b43754c..d82f312c 100644 --- a/rust/README.md +++ b/rust/README.md @@ -37,10 +37,6 @@ Tip: You can use `make version` to get the version string. * reexports ann symbols from __pv_core__ * if no encryption utilities required, use __pv_core__ -## Tools -* __pvsecret__ _Manage secrets for IBM Secure Execution guests_ -* __pvapconfig__ _automatic configure APQNs within an SE KVM guest_ - ## Writing new tools We encourage to use Rust for new tools. However, for some use cases it makes sense to use C and C is still allowed to be used for a new tool/library. @@ -58,6 +54,8 @@ is a start, but can change over time. * [anyhow](https://crates.io/crates/anyhow) * Flexible concrete Error type built on std::error::Error +* [base64](https://crates.io/crates/base64) + * Encodes and decodes base64 as bytes or utf8 * [byteorder](https://crates.io/crates/byteorder) * Library for reading/writing numbers in big-endian and little-endian. * [cfg-if](https://crates.io/crates/cfg-if) @@ -68,6 +66,8 @@ is a start, but can change over time. * A simple to use, efficient, and full-featured Command Line Argument Parser * [curl](https://crates.io/crates/curl) * Rust bindings to libcurl for making HTTP requests +* [deku](https://crates.io/crates/deku) + * Bit level serialization/deserialization proc-macro for structs * [libc](https://crates.io/crates/libc) * Raw FFI bindings to platform libraries like libc. * [log](https://crates.io/crates/log) @@ -76,6 +76,8 @@ is a start, but can change over time. * OpenSSL bindings * [serde](https://crates.io/crates/serde) * A generic serialization/deserialization framework +* [serde_jsonl](https://crates.io/crates/serde_json) + * A JSON serialization file format * [serde_yaml](https://crates.io/crates/serde_yaml) * YAML data format for Serde * [thiserror](https://crates.io/crates/thiserror)