|
| 1 | +/////////////////////////////////////////////////////////////////////////////// |
| 2 | + |
| 3 | + Copyright (c) 2020, 2025 Oracle and/or its affiliates. |
| 4 | + Licensed under the Universal Permissive License v 1.0 as shown at |
| 5 | + http://oss.oracle.com/licenses/upl. |
| 6 | + |
| 7 | +/////////////////////////////////////////////////////////////////////////////// |
| 8 | +
|
| 9 | += TLS Cipher Suites |
| 10 | +:description: Coherence Operator Documentation - TLS Cipher Suites |
| 11 | +:keywords: oracle coherence, kubernetes, operator, documentation, TLS, cipher |
| 12 | +
|
| 13 | +== TLS Cipher Suites |
| 14 | +
|
| 15 | +The Coherence Operator uses TLS for various client connections and server sockets. |
| 16 | +TLS can support a number of cipher suites, some of which are deemed legacy and insecure. |
| 17 | +These insecure ciphers are usually only present for backwards compatability. |
| 18 | +
|
| 19 | +The Coherence Operator is written in Go, and the ciphers supported are determined by the version og Go |
| 20 | +used to build the operator. |
| 21 | +Go splits ciphers into two lists a secure list and an insecure list, the insecure ciphers are disabled by default. |
| 22 | +
|
| 23 | +Oracle Global Security has stricter requirements than the default Go cipher list. |
| 24 | +By default, the Coherence Operator enables only ciphers in Go's secure list, except for |
| 25 | +`TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` and `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA`, which are disabled. |
| 26 | +
|
| 27 | +It is possible to enable or disable cipher suites when installing the Coherence Operator. |
| 28 | +The Coherence Operator has two command line flags which can be used to specify ciphers to be allowed or denied. |
| 29 | +
|
| 30 | +
|
| 31 | +* The `--cipher-allow-list` command line flag is used to specify cipher names to add to the allowed list. |
| 32 | +* The `--cipher-deny-list` command line flag is used to specify cipher names to add to the disabled list. |
| 33 | +
|
| 34 | +Multiple ciphers can be enabled and disabled by specifying the relevant command line flag multiple times. |
| 35 | +
|
| 36 | +If a cipher name is added to both the allow list and to the deny list, it will be disabled. |
| 37 | +
|
| 38 | +[NOTE] |
| 39 | +==== |
| 40 | +If either the `--cipher-allow-list` or `--cipher-deny-list` is set to a name that does not match any of the |
| 41 | +supported Go cipher names, the Operator will display an error in its log and will not start. |
| 42 | +See the https://pkg.go.dev/crypto/tls#pkg-constants[Go TLS package documentation] for a lost of valid names. |
| 43 | +==== |
| 44 | +
|
| 45 | +**Only Allow FIPS Ciphers** |
| 46 | +
|
| 47 | +The Coherence Operator can be installed in FIPS mode to only support FIPS compliant ciphers, |
| 48 | +see the <<docs/installation/100_fips.adoc,FIPS modes>> documentation for details. |
| 49 | +
|
| 50 | +How the command line flags are set depends on how the Coherence Operator is installed. |
| 51 | +
|
| 52 | +=== Install Using Yaml Manifests |
| 53 | +
|
| 54 | +If <<docs/installation/011_install_manifests.adoc,installing using the yaml manifests>>, |
| 55 | +the yaml must be edited to add the required flags: |
| 56 | +
|
| 57 | +Find the `args:` section of the operator `Deployment` in the yaml file, it looks like this: |
| 58 | +
|
| 59 | +[source,yaml] |
| 60 | +---- |
| 61 | + args: |
| 62 | + - operator |
| 63 | + - --enable-leader-election |
| 64 | +---- |
| 65 | +
|
| 66 | +then add the required allow or disallow flags. For example to allow `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` |
| 67 | +the args can be edited as shown below: |
| 68 | +
|
| 69 | +[source,yaml] |
| 70 | +---- |
| 71 | + args: |
| 72 | + - operator |
| 73 | + - --enable-leader-election |
| 74 | + - --cipher-allow-list=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA |
| 75 | +---- |
| 76 | +
|
| 77 | +To enable both `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` and `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA` ciphers: |
| 78 | +
|
| 79 | +[source,yaml] |
| 80 | +---- |
| 81 | + args: |
| 82 | + - operator |
| 83 | + - --enable-leader-election |
| 84 | + - --cipher-allow-list=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA |
| 85 | + - --cipher-allow-list=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA |
| 86 | +---- |
| 87 | +
|
| 88 | +
|
| 89 | +
|
| 90 | +=== Install Using Helm |
| 91 | +
|
| 92 | +If <<docs/installation/012_install_helm.adoc,installing the operator using Helm>> |
| 93 | +The Coherence Operator Helm chart has a `cipherAllowList` field and `cipherDenyList` field in its values file. |
| 94 | +These values are Helm arrays and can be set to a list of ciphers to be enabled or disabled. |
| 95 | +
|
| 96 | +The simplest way to set lists on the Helm command line is using the `--set-json` command line flag. |
| 97 | +For example to allow `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` |
| 98 | +
|
| 99 | +[source,bash] |
| 100 | +---- |
| 101 | +helm install \ |
| 102 | + --namespace <namespace> \ |
| 103 | + --set-json='cipherAllowList=["TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"]' |
| 104 | + coherence-operator \ |
| 105 | + coherence/coherence-operator |
| 106 | +---- |
| 107 | +
|
| 108 | +To enable both `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` and `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA` ciphers: |
| 109 | +
|
| 110 | +[source,bash] |
| 111 | +---- |
| 112 | +helm install \ |
| 113 | + --namespace <namespace> \ |
| 114 | + --set-json='cipherAllowList=["TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"]' |
| 115 | + coherence-operator \ |
| 116 | + coherence/coherence-operator |
| 117 | +---- |
| 118 | +
|
| 119 | +To disable `TLS_CHACHA20_POLY1305_SHA256` |
| 120 | +
|
| 121 | +[source,bash] |
| 122 | +---- |
| 123 | +helm install \ |
| 124 | + --namespace <namespace> \ |
| 125 | + --set-json='cipherDenyList=["TLS_CHACHA20_POLY1305_SHA256"]' |
| 126 | + coherence-operator \ |
| 127 | + coherence/coherence-operator |
| 128 | +---- |
| 129 | +
|
0 commit comments