Adding small doc for cert renewal #435
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CslBing
reviewed
May 29, 2024
| @@ -57,6 +57,7 @@ The [deployment diagram](./deployment.svg) provides a directional flow diagram t | |||
| ### Certificates diagram | |||
|
|
|||
| Certificates are used to secure the components that make up our API. | |||
| When trying to troubleshoot any issues, it is important to remember that we use **two** types of certificates in our authentication model, which realistically might have different expiration dates, and therefore would require distinct renewal processes. | |||
There was a problem hiding this comment.
Not sure if this is the right place for this paragraph
CslBing
reviewed
May 29, 2024
| @@ -68,13 +69,17 @@ There are two levels of authentication: | |||
| - We store our CA certificate (truststore.pem) in an S3 bucket in order for API Gateway to verify the identity of a consumer application. | |||
| - We store our private key in a Kubernetes secret (api-gateway-certificate-authority) so that we can generate client certificates. | |||
| 2. For the consumer application, we create a client certificate (client.pem), which includes their public key. We also create their private key (client.key). | |||
| 3. We send both the client certificate (client.pem) and the private key (client.key) to the consumer application to be used for mutual TLS. | |||
| 3. We send both the client certificate (client.pem) and the private key (client.key) to the consumer application to be used for mutual TLS. | |||
| 4. To inspect the certificate, retrieve and decode the public key, using this command to get it: `kubectl get secret mutual-tls-auth -n hmpps-integration-api-$environment -o json | jq -r '.data."truststore-public-key"' | base64 --decode`. Then decode the SSL certificate. | |||
There was a problem hiding this comment.
Again, not sure this is the right place. Client certificates won't be in kubernete secret
CslBing
reviewed
May 29, 2024
| - Behind the scenes, API Gateway also creates a private key (apigw_client.key) which we do not have access to. | ||
| 2. We store the client certificate (apigw_client.pem) in a Kubernetes secret. | ||
|
|
||
| - The resource we use to instruct API Gateway to generate a client certificate is "aws_api_gateway_client_certificate". |
There was a problem hiding this comment.
I think you are confused with actual Client certificate( certificate used by MAPPS etc) and certificate between gateway to API service
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.