Skip to content

Commit

Permalink
Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
sharadregoti committed Jan 20, 2025
1 parent 8ab4439 commit 472ecee
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions tyk-docs/content/api-management/automations.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,8 +293,8 @@ To address this challenge, Tyk Operator allows you to directly reference certifi
| Certificate Type | Supported in ApiDefinition | Supported in TykOasApiDefinition | Supported in TykStreamsApiDefinition |
|------------------|-------------|---------|---------|
| Client certifates |[Client mTLS]({{<ref "api-management/client-authentication#setup-static-mtls-in-tyk-operator-using-the-tyk-classic-api-definition">}}) |[Client mTLS]({{<ref "api-management/client-authentication#setup-static-mtls-in-tyk-operator-using-tyk-oas-api-definition">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
| Custom domain certificates |[TLS and SSL]({{<ref "certificates#dynamically-setting-ssl-certificates-for-custom-domainstyk-operator-classic">}}) |[TLS and SSL]({{<ref "certificates#dynamically-setting-ssl-certificates-for-custom-domainstyk-operator-oas">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
| Public keys pinning |[Certificate pinning]({{<ref "certificates#certificate-pinning">}}) |[Certificate pinning]({{<ref "certificates#certificate-pinning">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
| Custom domain certificates |[TLS and SSL]({{<ref "api-management/certificates#dynamically-setting-ssl-certificates-for-custom-domains">}}) |[TLS and SSL]({{<ref "api-management/certificates#dynamically-setting-ssl-certificates-for-custom-domains">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
| Public keys pinning |[Certificate pinning]({{<ref "api-management/certificates#certificate-pinning">}}) |[Certificate pinning]({{<ref "api-management/certificates#certificate-pinning">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |
| Upstream mTLS |[Upstream mTLS via Operator]({{<ref "api-management/client-authentication#via-tyk-operator-using-the-tyk-classic-api-definition">}}) |[Upstream mTLS via Operator]({{<ref "api-management/client-authentication#tyk-operator-oas">}}) | Certificate ID can be set in the API Definition but configuring certificates from Secrets in CRD is not supported. |


Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/api-management/client-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -1800,7 +1800,7 @@ You can create self-signed client and server certificates with this command:
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes
```
For the server in `common name` specify a domain, or just pass `-subj "/CN=localhost"` to OpenSSL command. Then follow our [TLS and SSL Guide]({{< ref "certificates" >}}).
For the server in `common name` specify a domain, or just pass `-subj "/CN=localhost"` to OpenSSL command. Then follow our [TLS and SSL Guide]({{< ref "api-management/certificates" >}}).
To get certificate SHA256 fingerprint use the following command:
```{.copyWrapper}
Expand Down
16 changes: 8 additions & 8 deletions tyk-docs/content/api-management/security-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Tyk provides the following features and authentication mechanisms:
- [Single Sign-On]({{< ref "advanced-configuration/integrate/sso" >}}) can be used for a centralized and trusted authentication source. API operators can choose from common authentication methods such as OAuth 2.0, LDAP, and SAML.
- [Dynamic Client Registration]({{< ref "tyk-developer-portal/tyk-portal-classic/dynamic-client-registration#oauth-20-dynamic-client-registration-protocol-dcr" >}}), enables third-party authorization servers to issue client credentials via the Tyk Developer Portal. This streamlines Identity Management, eliminating the need to manage credentials across multiple systems.
- Tyk's default authentication setup disallows credentials in URLs, reducing the risk of inadvertent exposure through backend logs.
- Tyk Gateway can be configured to enforce a [minimum TLS version]({{< ref "certificates#supported-tls-versions" >}}), enhancing security by blocking outdated and insecure TLS versions.
- Tyk Gateway can be configured to enforce a [minimum TLS version]({{< ref "api-management/certificates#supported-tls-versions" >}}), enhancing security by blocking outdated and insecure TLS versions.

##### 3 - Broken Object Property Level Authorization (BOPLA)

Expand Down Expand Up @@ -108,7 +108,7 @@ Tyk offers several mechanisms to help protect an API from Security Misconfigurat

- Use [response header manipulation]({{< ref "advanced-configuration/transform-traffic/response-headers" >}}) to remove or modify API sensitive information.
- Use [response body manipulation]({{< ref "advanced-configuration/transform-traffic/response-body" >}}) to remove or modify parts containing sensitive information.
- [TLS]({{< ref "certificates" >}}) to ensure that clients use the right service and encrypt traffic.
- [TLS]({{< ref "api-management/certificates" >}}) to ensure that clients use the right service and encrypt traffic.
- [Mutual TLS]({{< ref "/api-management/client-authentication#use-mutual-tls" >}}) with both the clients and API to ensure that callers with explicitly allowed client certificates can connect to the endpoints.
- [Error Templates]({{< ref "advanced-configuration/error-templates" >}}) can be used to return a response body based on status code and content type. This can help minimize the implementation details returned to the client.
- [CORS functionality]({{< ref "tyk-apis/tyk-gateway-api/api-definition-objects/cors" >}}) allows the Tyk Gateway to limit API access to particular browser-based consumers.
Expand Down Expand Up @@ -143,7 +143,7 @@ Attackers may identify and target the third party APIs/services used by an API.
It is the responsibility of the API to provide protection against these attacks. However, if the organization uses the Gateway as a forwarding proxy to third party APIs, then the following features could be used:

- [JSON Schema validation]({{< ref "product-stack/tyk-gateway/middleware/validate-request-tyk-classic" >}}) to validate that an incoming data payload meets a defined schema. Payloads that do not adhere to the schema are rejected.
- [TLS]({{< ref "certificates" >}}) to ensure that clients use the right service and encrypt traffic.
- [TLS]({{< ref "api-management/certificates" >}}) to ensure that clients use the right service and encrypt traffic.
- [Versioning]({{< ref "getting-started/key-concepts/versioning" >}}) allows newer versions of third party APIs to coexist with the older versions, facilitating deprecation and sunsetting.


Expand All @@ -159,12 +159,12 @@ Choose a suitable authentication approach based on the risk profile of the API.

**Handle Data Securely**

Don’t undermine the authentication process by leaking sensitive authentication data. Use [transport layer security]({{< ref "certificates" >}}) and hashing to prevent credentials from being intercepted and stolen through insecure transmission and storage. These principles also apply to upstream requests made by the gateway and upstream API to other APIs and services.
Don’t undermine the authentication process by leaking sensitive authentication data. Use [transport layer security]({{< ref "api-management/certificates" >}}) and hashing to prevent credentials from being intercepted and stolen through insecure transmission and storage. These principles also apply to upstream requests made by the gateway and upstream API to other APIs and services.

**Enforce Good Practices**


Establish rules that reduce risk and enhance overall system security. Use [password policies]({{< ref "basic-config-and-security/security/password-policy" >}}) to prevent the use of weak passwords, and [TLS policies]({{< ref "certificates#supported-tls-versions" >}}) to prevent the use of older TLS versions that are now deprecated and considered vulnerable.
Establish rules that reduce risk and enhance overall system security. Use [password policies]({{< ref "basic-config-and-security/security/password-policy" >}}) to prevent the use of weak passwords, and [TLS policies]({{< ref "api-management/certificates#supported-tls-versions" >}}) to prevent the use of older TLS versions that are now deprecated and considered vulnerable.

**Protect Sensitive Endpoints**

Expand Down Expand Up @@ -319,7 +319,7 @@ Modern APIs are often backed by large technology stacks composed of numerous com
**Secure Connections**


Use [transport layer security]({{< ref "certificates" >}}) where possible. Most importantly, on inbound connections to the gateway and outbound connection from the gateway to the upstream API and other services. TLS can also be used as a form of authentication, using [Mutual TLS]({{< ref "/api-management/client-authentication#use-mutual-tls" >}}).
Use [transport layer security]({{< ref "api-management/certificates" >}}) where possible. Most importantly, on inbound connections to the gateway and outbound connection from the gateway to the upstream API and other services. TLS can also be used as a form of authentication, using [Mutual TLS]({{< ref "/api-management/client-authentication#use-mutual-tls" >}}).

**Limit Functionality**

Expand Down Expand Up @@ -374,7 +374,7 @@ See [Key Hashing]({{< ref "basic-config-and-security/security/key-hashing" >}})
**TLS and SSL**


Tyk supports TLS connections and Mutual TLS. All TLS connections also support HTTP/2. Tyk also supports Let's Encrypt. See [TLS and SSL]({{< ref "certificates" >}}) for more details.
Tyk supports TLS connections and Mutual TLS. All TLS connections also support HTTP/2. Tyk also supports Let's Encrypt. See [TLS and SSL]({{< ref "api-management/certificates" >}}) for more details.

**Trusted Certificates**

Expand All @@ -384,7 +384,7 @@ As part of using Mutual TLS, you can create a list of [trusted certificates]({{<
**Certificate Pinning**


Introduced in Tyk Gateway 2.6.0, [certificate pinning]({{< ref "certificates#certificate-pinning" >}}) is a feature which allows you to allow only specified public keys used to generate certificates, so you will be protected in case an upstream certificate is compromised.
Introduced in Tyk Gateway 2.6.0, [certificate pinning]({{< ref "api-management/certificates#certificate-pinning" >}}) is a feature which allows you to allow only specified public keys used to generate certificates, so you will be protected in case an upstream certificate is compromised.

**API Security**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -776,7 +776,7 @@ We have added support for specifying allowed SSL ciphers using the following op

`http_server_options - ssl_ciphers`

[Docs]({{< ref "certificates" >}})
[Docs]({{< ref "api-management/certificates" >}})

### <a name="plugins"></a>Plugins Updates

Expand Down

0 comments on commit 472ecee

Please sign in to comment.