From 7d5ea3fecbfb12cdbcfce32cc4ea00b96ee4218d Mon Sep 17 00:00:00 2001 From: "Dr. David von Oheimb" Date: Tue, 22 Sep 2020 08:18:31 +0200 Subject: [PATCH] OCSP_resp_find_status.pod: Replace function arg references B<...> by I<...> Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/12947) --- doc/man3/OCSP_resp_find_status.pod | 102 ++++++++++++++--------------- 1 file changed, 51 insertions(+), 51 deletions(-) diff --git a/doc/man3/OCSP_resp_find_status.pod b/doc/man3/OCSP_resp_find_status.pod index 7dd90837b6..00b14c7052 100644 --- a/doc/man3/OCSP_resp_find_status.pod +++ b/doc/man3/OCSP_resp_find_status.pod @@ -60,12 +60,12 @@ OCSP_basic_verify =head1 DESCRIPTION -OCSP_resp_find_status() searches B for an OCSP response for B. If it is -successful the fields of the response are returned in B<*status>, B<*reason>, -B<*revtime>, B<*thisupd> and B<*nextupd>. The B<*status> value will be one of +OCSP_resp_find_status() searches I for an OCSP response for I. If it is +successful the fields of the response are returned in I<*status>, I<*reason>, +I<*revtime>, I<*thisupd> and I<*nextupd>. The I<*status> value will be one of B, B or -B. The B<*reason> and B<*revtime> fields are only -set if the status is B. If set the B<*reason> field +B. The I<*reason> and I<*revtime> fields are only +set if the status is B. If set the I<*reason> field will be set to the revocation reason which will be one of B, B, B, B, @@ -73,88 +73,88 @@ B, B, B, B or B. -OCSP_resp_count() returns the number of B structures in B. +OCSP_resp_count() returns the number of B structures in I. -OCSP_resp_get0() returns the B structure in B -corresponding to index B. Where B runs from 0 to +OCSP_resp_get0() returns the B structure in I +corresponding to index I. Where I runs from 0 to OCSP_resp_count(bs) - 1. -OCSP_resp_find() searches B for B and returns the index of the first -matching entry after B or starting from the beginning if B is -1. +OCSP_resp_find() searches I for I and returns the index of the first +matching entry after I or starting from the beginning if I is -1. -OCSP_single_get0_status() extracts the fields of B in B<*reason>, -B<*revtime>, B<*thisupd> and B<*nextupd>. +OCSP_single_get0_status() extracts the fields of I in I<*reason>, +I<*revtime>, I<*thisupd> and I<*nextupd>. OCSP_resp_get0_produced_at() extracts the B field from the -single response B. +single response I. -OCSP_resp_get0_signature() returns the signature from B. +OCSP_resp_get0_signature() returns the signature from I. -OCSP_resp_get0_tbs_sigalg() returns the B from B. +OCSP_resp_get0_tbs_sigalg() returns the B from I. -OCSP_resp_get0_respdata() returns the B from B. +OCSP_resp_get0_respdata() returns the B from I. -OCSP_resp_get0_certs() returns any certificates included in B. +OCSP_resp_get0_certs() returns any certificates included in I. OCSP_resp_get0_signer() attempts to retrieve the certificate that directly -signed B. The OCSP protocol does not require that this certificate +signed I. The OCSP protocol does not require that this certificate is included in the B field of the response, so additional certificates -can be supplied in B if the certificates that may have +can be supplied via the I if the certificates that may have signed the response are known via some out-of-band mechanism. -OCSP_resp_get0_id() gets the responder id of B. If the responder ID is -a name then <*pname> is set to the name and B<*pid> is set to NULL. If the -responder ID is by key ID then B<*pid> is set to the key ID and B<*pname> -is set to NULL. OCSP_resp_get1_id() leaves ownership of B<*pid> and B<*pname> +OCSP_resp_get0_id() gets the responder id of I. If the responder ID is +a name then <*pname> is set to the name and I<*pid> is set to NULL. If the +responder ID is by key ID then I<*pid> is set to the key ID and I<*pname> +is set to NULL. OCSP_resp_get1_id() leaves ownership of I<*pid> and I<*pname> with the caller, who is responsible for freeing them. Both functions return 1 in case of success and 0 in case of failure. If OCSP_resp_get1_id() returns 0, no freeing of the results is necessary. -OCSP_check_validity() checks the validity of B and B values -which will be typically obtained from OCSP_resp_find_status() or -OCSP_single_get0_status(). If B is nonzero it indicates how many seconds -leeway should be allowed in the check. If B is positive it indicates -the maximum age of B in seconds. +OCSP_check_validity() checks the validity of its I and I +arguments, which will be typically obtained from OCSP_resp_find_status() or +OCSP_single_get0_status(). If I is nonzero it indicates how many seconds +leeway should be allowed in the check. If I is positive it indicates +the maximum age of I in seconds. -OCSP_basic_verify() checks that the basic response message B is correctly -signed and that the signer certificate can be validated. It takes B as -the trusted store and B as a set of untrusted intermediate certificates. +OCSP_basic_verify() checks that the basic response message I is correctly +signed and that the signer certificate can be validated. It takes I as +the trusted store and I as a set of untrusted intermediate certificates. The function first tries to find the signer certificate of the response -in B. It also searches the certificates the responder may have included -in B unless the B contain B. +in I. It then searches the certificates the responder may have included +in I unless the I contain B. It fails if the signer certificate cannot be found. -Next, the function checks the signature of B and fails on error -unless the B contain B. Then the function already returns -success if the B contain B or if the signer certificate -was found in B and the B contain B. +Next, unless the I contain B, the function checks +the signature of I and fails on error. Then the function already returns +success if the I contain B or if the signer certificate +was found in I and the I contain B. Otherwise the function continues by validating the signer certificate. -If B contains B, intermediate CA certificates -in B are trust-anchors. +If I contains B, intermediate CA certificates +in I are trust anchors. For more details, see the description of B in L. -To this end, all certificates in B and in B are considered as +To this end, all certificates in I and in I are considered as untrusted certificates for the construction of the validation path for the signer certificate unless the B flag is set. After successful path validation the function returns success if the B flag is set. Otherwise it verifies that the signer certificate meets the OCSP issuer criteria including potential delegation. If this does not succeed and the -B do not contain B the function checks for explicit +I do not contain B the function checks for explicit trust for OCSP signing in the root CA certificate. =head1 RETURN VALUES -OCSP_resp_find_status() returns 1 if B is found in B and 0 otherwise. +OCSP_resp_find_status() returns 1 if I is found in I and 0 otherwise. OCSP_resp_count() returns the total number of B fields in -B. +I. OCSP_resp_get0() returns a pointer to an B structure or -B if B is out of range. +NULL if I is out of range. -OCSP_resp_find() returns the index of B in B (which may be 0) or -1 if -B was not found. +OCSP_resp_find() returns the index of I in I (which may be 0) or -1 if +I was not found. -OCSP_single_get0_status() returns the status of B or -1 if an error +OCSP_single_get0_status() returns the status of I or -1 if an error occurred. OCSP_resp_get0_signer() returns 1 if the signing certificate was located, @@ -171,15 +171,15 @@ can then take appropriate action based on the status of the certificate. An OCSP response for a certificate contains B and B fields. Normally the current time should be between these two values. To -account for clock skew the B field can be set to nonzero in +account for clock skew the I field can be set to nonzero in OCSP_check_validity(). Some responders do not set the B field, this would otherwise mean an ancient response would be considered valid: the -B parameter to OCSP_check_validity() can be used to limit the permitted +I parameter to OCSP_check_validity() can be used to limit the permitted age of responses. -The values written to B<*revtime>, B<*thisupd> and B<*nextupd> by +The values written to I<*revtime>, I<*thisupd> and I<*nextupd> by OCSP_resp_find_status() and OCSP_single_get0_status() are internal pointers -which B be freed up by the calling application. Any or all of these +which MUST NOT be freed up by the calling application. Any or all of these parameters can be set to NULL if their value is not required. =head1 SEE ALSO