Skip to content

docs: Add warnings that KMIP client/server cert arguments are stubs #985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thgoebel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add warnings that KMIP client/server cert arguments are stubs #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions doc/manual/build/man/cascade-hsm.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,14 @@ password set here will be used as the PKCS#11 PIN to login with.
.B \-\-client\-cert <CLIENT_CERT_PATH>
Optional path to a TLS certificate to authenticate to the KMIP server
with. The file will be read and sent to the server.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This argument \X'tty: link https://github.com/NLnetLabs/cascade/issues/982'\fI\%is not yet used\fP\X'tty: link'
by Cascade.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
Expand All @@ -149,6 +157,14 @@ THe file will be read and sent to the server.
.sp
The private key is needed to be able to prove to the KMIP server that
you are the owner of the provided TLS client certificate.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This argument \X'tty: link https://github.com/NLnetLabs/cascade/issues/982'\fI\%is not yet used\fP\X'tty: link'
by Cascade.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Server Certificate Verification:
.INDENT 0.0
Expand All @@ -164,11 +180,27 @@ certificate, e.g. in a test environment.
.TP
.B \-\-server\-cert <SERVER_CERT_PATH>
Optional path to a TLS PEM certificate for the server.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This argument \X'tty: link https://github.com/NLnetLabs/cascade/issues/982'\fI\%is not yet used\fP\X'tty: link'
by Cascade.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ca\-cert <CA_CERT_PATH>
Optional path to a TLS PEM certificate for a Certificate Authority.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This argument \X'tty: link https://github.com/NLnetLabs/cascade/issues/982'\fI\%is not yet used\fP\X'tty: link'
by Cascade.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Client Limits:
.INDENT 0.0
Expand Down
16 changes: 16 additions & 0 deletions doc/manual/source/man/cascade-hsm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ Client Certificate Authentication:
Optional path to a TLS certificate to authenticate to the KMIP server
with. The file will be read and sent to the server.

.. warning::
This argument `is not yet used <https://github.com/NLnetLabs/cascade/issues/982>`_
by Cascade.

.. option:: --client-key <CLIENT_KEY_PATH>

Optional path to a private key for client certificate authentication.
Expand All @@ -132,6 +136,10 @@ Client Certificate Authentication:
The private key is needed to be able to prove to the KMIP server that
you are the owner of the provided TLS client certificate.

.. warning::
This argument `is not yet used <https://github.com/NLnetLabs/cascade/issues/982>`_
by Cascade.

Server Certificate Verification:
++++++++++++++++++++++++++++++++

Expand All @@ -147,10 +155,18 @@ Server Certificate Verification:

Optional path to a TLS PEM certificate for the server.

.. warning::
This argument `is not yet used <https://github.com/NLnetLabs/cascade/issues/982>`_
by Cascade.

.. option:: --ca-cert <CA_CERT_PATH>

Optional path to a TLS PEM certificate for a Certificate Authority.

.. warning::
This argument `is not yet used <https://github.com/NLnetLabs/cascade/issues/982>`_
by Cascade.

Client Limits:
++++++++++++++

Expand Down