Skip to content

Commit

Permalink
PKI: Document intermediate CAs
Browse files Browse the repository at this point in the history
Correct some typos
  • Loading branch information
mrdeep1 committed Nov 20, 2023
1 parent 2e7cb35 commit 6b4fac9
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 8 deletions.
6 changes: 3 additions & 3 deletions examples/coap-server.c
Original file line number Diff line number Diff line change
Expand Up @@ -2260,12 +2260,12 @@ usage(const char *program, const char *version) {
"\t-C cafile\tPEM file or PKCS11 URI that contains a list of one or\n"
"\t \t\tmore CAs that are to be passed to the client for the\n"
"\t \t\tclient to determine what client certificate to use.\n"
"\t \t\tNormally, this list of CAs would be the root CA and and\n"
"\t \t\tNormally, this list of CAs would be the root CA and\n"
"\t \t\tany intermediate CAs. Ideally the server certificate\n"
"\t \t\tshould be signed by the same CA so that mutual\n"
"\t \t\tauthentication can take place. The contents of cafile\n"
"\t \t\tare added to the trusted store of root CAs.\n"
"\t \t\tUsing the -C or -R options will will trigger the\n"
"\t \t\tUsing the -C or -R options will trigger the\n"
"\t \t\tvalidation of the client certificate unless overridden\n"
"\t \t\tby the -n option\n"
"\t-J pkcs11_pin\tThe user pin to unlock access to the PKCS11 token\n"
Expand All @@ -2281,7 +2281,7 @@ usage(const char *program, const char *version) {
"\t \t\tUsing '-R trust_casfile' disables common CA mutual\n"
"\t \t\tauthentication which can only be done by using\n"
"\t \t\t'-C cafile'.\n"
"\t \t\tUsing the -C or -R options will will trigger the\n"
"\t \t\tUsing the -C or -R options will trigger the\n"
"\t \t\tvalidation of the client certificate unless overridden\n"
"\t \t\tby the -n option\n"
"\t-S match_pki_sni_file\n"
Expand Down
3 changes: 2 additions & 1 deletion include/coap3/coap_dtls.h
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,8 @@ typedef enum coap_pki_key_t {
* The structure that holds the PKI PEM definitions.
*/
typedef struct coap_pki_key_pem_t {
const char *ca_file; /**< File location of Common CA in PEM format */
const char *ca_file; /**< File location of Common CA (and any
intermediates) in PEM format */
const char *public_cert; /**< File location of Public Cert */
const char *private_key; /**< File location of Private Key in PEM format */
} coap_pki_key_pem_t;
Expand Down
6 changes: 3 additions & 3 deletions man/coap-server.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -209,11 +209,11 @@ definitions have to be in DER, not PEM, format. Otherwise all of
*-C* cafile::
PEM file or PKCS11 URI that contains a list of one or more CAs that are to
be passed to the client for the client to determine what client certificate
to use. Normally, this list of CAs would be the root CA and and any
to use. Normally, this list of CAs would be the root CA and any
intermediate CAs. Ideally the server certificate should be signed by the
same CA so that mutual authentication can take place. The contents of
*cafile* are added to the trusted store of root CAs. Using the *-C* or *-R*
options will will trigger the validation of the client certificate unless
options will trigger the validation of the client certificate unless
overridden by the *-n* option.

*-J* pkcs11_pin::
Expand All @@ -230,7 +230,7 @@ definitions have to be in DER, not PEM, format. Otherwise all of
directory containing a set of CA PEM files. The *-C cafile* CA does not have
to be in this list and is trusted for the validation. Using
*-R trust_casfile* disables common CA mutual authentication which can only
be done by using *-C cafile*. Using the *-C* or *-R* options will will
be done by using *-C cafile*. Using the *-C* or *-R* options will
trigger the validation of the server certificate unless overridden by the
*-n* option.

Expand Down
3 changes: 2 additions & 1 deletion man/coap_encryption.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,8 @@ COAP_PKI_KEY_PKCS11.
[source, c]
----
typedef struct coap_pki_key_pem_t {
const char *ca_file; /* File location of Common CA in PEM format */
const char *ca_file; /* File location of Common CA (and any
intermediates) in PEM format */
const char *public_cert; /* File location of Public Cert */
const char *private_key; /* File location of Private Key in PEM format */
} coap_pki_key_pem_t;
Expand Down

0 comments on commit 6b4fac9

Please sign in to comment.