Skip to content

docs: clarify multiple client certificate support #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −3
Open

docs: clarify multiple client certificate support #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,12 @@ Run the following command twice, once with server filenames (e.g., ``server.key`
.. note::
The ``-subj "/"`` parameter bypasses the interactive prompts for certificate information (country, organization, etc.) that OpenSSL normally requires.

A single client certificate must be shared among multiple clients. This reduces certificate management overhead, as the server only needs to trust one client certificate. SiPyCo's SSL implementation is configured to authenticate based on certificates directly, rather than hostname verification, making this approach secure for trusted environments where certificate distribution is controlled.
The server can trust either single or multiple client certificates. For multiple clients, simply concatenate their certificates into a single peer certificate file (e.g., using ``cat client1.pem client2.pem > trusted_clients.pem``). SiPyCo's SSL implementation is configured to authenticate based on certificates directly, rather than hostname verification, making this approach secure for trusted environments where certificate distribution is controlled.

Enabling SSL
------------

To start with SSL enabled, the server requires its own key and certificate, as well as the certificate of a client to trust. Similarly, the client requires its own key and certificate, as well as the certificate of a server to trust.
To start with SSL enabled, the server requires its own key and certificate, as well as the certificate(s) of client(s) to trust. Similarly, the client requires its own key and certificate, as well as the certificate of a server to trust.

**For servers:**

Expand Down
2 changes: 1 addition & 1 deletion sipyco/common_args.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def simple_network_args(parser, default_port, ssl=False):
help="Enable SSL authentication: "
"CERT: server certificate file, "
"KEY: server private key, "
"PEER: client certificate to trust "
"PEER: client certificate(s) to trust "
"(default: %(default)s)")


Expand Down