Add information on documentation licensing under CC-BY-SA-4.0.
Add information on reuse configuration and that individual contributors
are summarized as "Signstar Contributors" instead of being attributed
individually.

Signed-off-by: David Runge <dvzrv@archlinux.org>

The top-level MIT-only license file is superseded by the more granular
license setup using reuse.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Instead of relying on individual license attribution per file, configure
license attribution in the REUSE.toml file.
Moreover, use the generic "Signstar Contributors" as attribution and
in a comment point out that the license attribution is not tracked
individually, but that interested parties can get to this information
with the help of git.
Set SPDX package supplier to "Arch Linux" as the meaning of the field is
better reflected by an organization than an individual:
https://spdx.github.io/spdx-spec/v2.3/package-information/#75-package-supplier-field



Signed-off-by: David Runge <dvzrv@archlinux.org>

Use a CODEOWNERS file to automatically assign merge requests to current
developers of the project.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Signed-off-by: renovate <renovate@archlinux.org>

Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

`reqwest` depends unconditionally on the `openssl` crate.

See: #22


Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

See: https://docs.renovatebot.com/presets-default/#gitsignoff


Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

Fixes: #17


Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>

renovate authored 8 months ago and David Runge committed 8 months ago

Do not open merge requests for patch level updates of dependencies,
since we are mostly interested in integrating against major and minor
version updates of dependencies in a lib crate.

Adjust reuse configuration to assign CC0-1.0 for the renovate.json file.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Update all dependencies and add a CHANGELOG.md.

Signed-off-by: David Runge <dvzrv@archlinux.org>

The `.reuse/dep5` configuration file already covers the README.md with
the correct CC-BY-SA-4.0 license, so there is no need to add attribution
separately.

Signed-off-by: David Runge <dvzrv@archlinux.org>

List all README.md and CHANGELOG.md files under CC-BY-SA-4.0 and only
auto-generated files such as Cargo.lock under CC0-1.0.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Since we are no longer using the aws-lc-rs feature for rustls, there is
no longer the need to build OpenSSL.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Signed-off-by: David Runge <dvzrv@archlinux.org>

Add the just target `test-readme` to run per project tangler based tests.
This ensures that examples in `bash` code environments are executed and
end-to-end tested.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Tangler is required to execute workflows in the README.md of the crates,
providing essential integration test runs.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Add documentation and examples for the nethsm-cli crate.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Signed-off-by: David Runge <dvzrv@archlinux.org>

As further documentation is going to be licensed under CC-BY-SA-4.0, we
need to reflect this in the available license files.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Update all dependencies, add a CHANGELOG.md entry and raise the version
to 0.3.0.
Also raise the version requirements of rustls (as otherwise issues arise
due to 0.22.0 vs. 0.23.0 incompatibilities), ureq and reqwest to
circumvent duplicate versions as much as possible.

Signed-off-by: David Runge <dvzrv@archlinux.org>

As aws-lc-rs pulls in a boatload of dependencies, we switch to ring.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Signed-off-by: David Runge <dvzrv@archlinux.org>

Explain how the returned data depends on the chosen `SignatureType` and
add links to relevant RFCs and Wikipedia pages.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Per key type specific lists of key mechanisms allow for easier reuse
in user-facing documentation and centralize the access in well-defined
functions, which can be reused when matching key types with key
mechanisms.

Signed-off-by: David Runge <dvzrv@archlinux.org>

As `ConnectionSecurity`'s `ToString` implementation will promote e.g.
"Unsafe" and "Native", the `FromStr` impl should also cover that.

Signed-off-by: David Runge <dvzrv@archlinux.org>

As `BootMode`, `DecryptMode`, `EncryptMode`, `KeyType`, `LogLevel`,
`SignatureType`, `TlsKeyType` and `UserRole` may be constructed from
string, it is useful to represent their variants as static string
references (e.g. for documentation purposes in CLIs).

Signed-off-by: David Runge <dvzrv@archlinux.org>

When using `BootMode`, `DecryptMode`, `EncryptMode`, `KeyMechanism`,
`LogLevel`, `SignatureType` and `TlsKeyType` it is sometimes useful
to iterate over the variants (e.g. when listing available options in
a CLI).

Signed-off-by: David Runge <dvzrv@archlinux.org>

Signed-off-by: David Runge <dvzrv@archlinux.org>

Signed-off-by: David Runge <dvzrv@archlinux.org>

Add recipe to only update cargo index and use it as precondition for
check-dependencies.
This is useful, because cargo-deny should use the latest cargo index.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Since 0.2.154 has been yanked, we now rely on 0.2.155.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Use the `CARGO_PKGNAME` and `CARGO_PKG_VERSION` environment variables to
define the user agent string when creating a connection configuration,
instead of hardcoding the value.

Signed-off-by: David Runge <dvzrv@archlinux.org>

Instead of using stacked fixtures for the containers and accompanying
`NetHsm` instances, use dedicated fixtures.
This prevents containers hanging during tests, as the `NetHsm` reuses
the same connection properties if more than one container is used per
test.

Signed-off-by: David Runge <dvzrv@archlinux.org>