http binding - updated documentation

Signed-off-by: mdarii <dariimaxim@gmail.com>
This commit is contained in:
mdarii 2023-05-01 20:38:46 +02:00
parent cfc0749aa1
commit f5a512f469
1 changed files with 5 additions and 0 deletions

View File

@ -26,6 +26,8 @@ spec:
value: /Users/somepath/client.pem # OPTIONAL <path to client cert> or <pem encoded string> value: /Users/somepath/client.pem # OPTIONAL <path to client cert> or <pem encoded string>
- name: MTLSClientKey - name: MTLSClientKey
value: /Users/somepath/client.key # OPTIONAL <path to client key> or <pem encoded string> value: /Users/somepath/client.key # OPTIONAL <path to client key> or <pem encoded string>
- name: MTLSRenegotiation
value: RenegotiateOnceAsClient # OPTIONAL one of: RenegotiateNever, RenegotiateOnceAsClient, RenegotiateFreelyAsClient
- name: securityToken # OPTIONAL <token to include as a header on HTTP requests> - name: securityToken # OPTIONAL <token to include as a header on HTTP requests>
secretKeyRef: secretKeyRef:
name: mysecret name: mysecret
@ -42,6 +44,7 @@ spec:
| MTLSRootCA | N | Output |Path to root ca certificate or pem encoded string | | MTLSRootCA | N | Output |Path to root ca certificate or pem encoded string |
| MTLSClientCert | N | Output |Path to client certificate or pem encoded string | | MTLSClientCert | N | Output |Path to client certificate or pem encoded string |
| MTLSClientKey | N | Output |Path client private key or pem encoded string | | MTLSClientKey | N | Output |Path client private key or pem encoded string |
| MTLSRenegotiation | N | Output |Type of TLS renegotiation to be used | `RenegotiateOnceAsClient`
| securityToken | N | Output |The value of a token to be added to an HTTP request as a header. Used together with `securityTokenHeader` | | securityToken | N | Output |The value of a token to be added to an HTTP request as a header. Used together with `securityTokenHeader` |
| securityTokenHeader| N | Output |The name of the header for `securityToken` on an HTTP request that | | securityTokenHeader| N | Output |The name of the header for `securityToken` on an HTTP request that |
@ -317,6 +320,8 @@ These fields can be passed as a file path or as a pem encoded string.
- If the pem encoded string is provided, the string is used as is. - If the pem encoded string is provided, the string is used as is.
When these fields are configured, the Dapr sidecar uses the provided certificate to authenticate itself with the server during the TLS handshake process. When these fields are configured, the Dapr sidecar uses the provided certificate to authenticate itself with the server during the TLS handshake process.
If remote server is enforcing TLS renegotiation you need to set also metadata field `MTLSRenegotiation`, it accepts one of following options: `RenegotiateNever`,`RenegotiateOnceAsClient` or `RenegotiateFreelyAsClient`. For more details check please: https://pkg.go.dev/crypto/tls#RenegotiationSupport
### When to use: ### When to use:
You can use this when the server with which the HTTP binding is configured to communicate requires mTLS or client TLS authentication. You can use this when the server with which the HTTP binding is configured to communicate requires mTLS or client TLS authentication.