Skip to content

Commit

Permalink
Fixup TLS ci/cd
Browse files Browse the repository at this point in the history
  • Loading branch information
tmiddlet2666 committed May 14, 2024
1 parent 36ddc21 commit 8369116
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 8 deletions.
6 changes: 2 additions & 4 deletions .github/workflows/build-tls.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,14 @@ jobs:
- name: TLS Tests
shell: bash
run: |
export PATH=`pwd`/bin:$PATH
make cohctl
export COHERENCE_TLS_CERTS_PATH=`pwd`/test/test_utils/certs/guardians-ca.crt
export COHERENCE_TLS_CLIENT_CERT=`pwd`/test/test_utils/certs/star-lord.crt
export COHERENCE_TLS_CLIENT_KEY=`pwd`/test/test_utils/certs/star-lord.key
COHERENCE_BASE_IMAGE=gcr.io/distroless/java17 COHERENCE_VERSION=24.03 PROFILES=,secure make clean certs build-test-images test-cluster-startup
echo "Sleeping 30..."
sleep 30
pwd
ls -l bin
export PATH=`pwd`/bin:$PATH
make cohctl
cohctl set ignore-certs true
cohctl add cluster tls -u https://127.0.0.1:30000/management/coherence/cluster
cohctl get clusters
Expand Down
49 changes: 45 additions & 4 deletions docs/security/01_overview.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2021, 2023 Oracle and/or its affiliates.
Copyright (c) 2021, 2024 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
https://oss.oracle.com/licenses/upl.

Expand All @@ -25,13 +25,54 @@ To enable basic authentication for Management over REST, please follow the instr
{commercial-docs-base-url}/secure/securing-oracle-oracle-http-management-rest-server.html#GUID-816E45C4-2F52-4576-BC09-CF0B6E873CBA[basic authentication] section
of the Coherence documentation.
=== Enabling SSL Authentication
=== Enabling TLS For Management over REST Access
To enable SSL to provide authentication for Management over REST, please follow the instructions in the
To enable TLS to provide authentication for Management over REST, please follow the instructions in the
{commercial-docs-base-url}/secure/securing-oracle-oracle-http-management-rest-server.html#GUID-7FC70A65-FC2F-4CBE-8F7D-7CBC3CDAA10A[SSL authentication]
section of the Coherence documentation.
=== Working with secured REST endpoints
=== Connecting to a TLS enabled cluster
Once you have enabled TLS you can configure the following environment variables if you need to add client certificates or additional trust stores.
[source,bash]
----
export COHERENCE_TLS_CLIENT_CERT=/path/to/client/certificate
export COHERENCE_TLS_CLIENT_KEY=/path/path/to/client/key
export COHERENCE_TLS_CERTS_PATH=/path/to/cert/to/be/added/for/trust
----
If you are connecting a cluster with self-signed certificates, you must set the following to ignore invalid certificates:
[source,bash]
----
cohctl set ignore-certs true
----
Output:
[source,bash]
----
Value is now set to true
----
NOTE: This is not recommended and should not be used for production systems.
You can then add your cluster via specifying HTTPS as the protocol:
[source,bash]
----
cohctl add cluster tls -u https://host:30000/management/coherence/cluster
----
You will receive the following message every time you run a command if you ignore certificate errors:
[source,bash]
----
WARNING: SSL Certificate validation has been explicitly disabled
----
=== Working with basic authentication REST endpoints
If you have enabled basic authentication for your Management over REST endpoint, or you are connecting to a WebLogic Server cluster, you must
provide the `-U username` option on all `cohctl` commands.
Expand Down

0 comments on commit 8369116

Please sign in to comment.