[Request]: Update the API documentation

[SyedAanif]

Feature Description

Thanks for building this API, but as a request can you please update the docs with examples specifically catering to the mTLS needs.

Use Case

This request is required to have a clear understanding of the certificate based broker connection. Few pointers:

• What should be the format of the certificate file/Keys etc?
• If we are creating certs and keys, what's the need of key-store-password?
• Should we just create a ./trust_store folder with .pem files inside and not mention any file name in trust-path?
• What's the format of trust_store files?
• Should we create a certificate chain or keep all the certificates as individuals?

Proposed Solution

No response

[mvsolace]

Hi @SyedAanif , can you please raise this request with our support team by contacting [email protected]? They will be able to help answer your request or guide you to someone that can.

Thank you,
MV

[solace-brendabutler]

Two-way TLS authentication (or "client-certificate authentication") is documented here:

https://docs.solace.com/API/API-Developer-Guide-Go/Go-API-Messaging-Service.htm#Client

There are examples of it in this codebase in the test code. Please see pubsubplus-go-client/test/messaging_service_test.go, and search for either
"connect to the broker using client certificate authentication via authentication strategies"
or
"connect to the broker configured via properties".

[solace-brendabutler]

I have submitted a request for the documentation to be augmented with extra info about cert/key file format, and what to do in case the key is in the same file as the certificate, and what to do if there is no password for the private key.

I have also raised Issue SolaceSamples/solace-samples-go#14