OCSP_RESP_FIND_STATUS(3ossl)
π OCSP_RESP_FIND_STATUS π
okay bestie, gather round π«Ά this is the OpenSSL manual page for OCSP_resp_find_status(3ossl) β a whole lil family of OCSP response utility functions that live in OpenSSL, and we're gonna go through every single one of them together. no skipping, no skimming, we eat the whole plate π
β¨ NAME β¨
OCSP_resp_find_status, OCSP_resp_count, OCSP_resp_get0, OCSP_resp_find, OCSP_single_get0_status, OCSP_resp_get0_produced_at, OCSP_resp_get0_signature, OCSP_resp_get0_tbs_sigalg, OCSP_resp_get0_respdata, OCSP_resp_get0_certs, OCSP_resp_get0_signer, OCSP_resp_get0_id, OCSP_resp_get1_id, OCSP_check_validity, OCSP_basic_verify β the OCSP response utility functions, aka the whole squad π
π¦ SYNOPSIS π¦
#include <openssl/ocsp.h>
int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status,
int *reason,
ASN1_GENERALIZEDTIME **revtime,
ASN1_GENERALIZEDTIME **thisupd,
ASN1_GENERALIZEDTIME **nextupd);
int OCSP_resp_count(OCSP_BASICRESP *bs);
OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx);
int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last);
int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason,
ASN1_GENERALIZEDTIME **revtime,
ASN1_GENERALIZEDTIME **thisupd,
ASN1_GENERALIZEDTIME **nextupd);
const ASN1_GENERALIZEDTIME *OCSP_resp_get0_produced_at(
const OCSP_BASICRESP* single);
const ASN1_OCTET_STRING *OCSP_resp_get0_signature(const OCSP_BASICRESP *bs);
const X509_ALGOR *OCSP_resp_get0_tbs_sigalg(const OCSP_BASICRESP *bs);
const OCSP_RESPDATA *OCSP_resp_get0_respdata(const OCSP_BASICRESP *bs);
const STACK_OF(X509) *OCSP_resp_get0_certs(const OCSP_BASICRESP *bs);
int OCSP_resp_get0_signer(OCSP_BASICRESP *bs, X509 **signer,
STACK_OF(X509) *extra_certs);
int OCSP_resp_get0_id(const OCSP_BASICRESP *bs,
const ASN1_OCTET_STRING **pid,
const X509_NAME **pname);
int OCSP_resp_get1_id(const OCSP_BASICRESP *bs,
ASN1_OCTET_STRING **pid,
X509_NAME **pname);
int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd,
ASN1_GENERALIZEDTIME *nextupd,
long sec, long maxsec);
int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
X509_STORE *st, unsigned long flags);
πΈ DESCRIPTION πΈ
okay so let's go one by one, no cap, every single function gets its moment π
OCSP_resp_find_status()β searchesbsfor an OCSP response forid. if it hits, the fields of the response come back in*status,*reason,*revtime,*thisupdand*nextupd. the*statusvalue is one ofV_OCSP_CERTSTATUS_GOOD,V_OCSP_CERTSTATUS_REVOKEDorV_OCSP_CERTSTATUS_UNKNOWN. the*reasonand*revtimefields only get set if the status isV_OCSP_CERTSTATUS_REVOKEDβ like, revoked-only info, iykyk π. if set,*reasonbecomes the revocation reason, which is one ofOCSP_REVOKED_STATUS_NOSTATUS,OCSP_REVOKED_STATUS_UNSPECIFIED,OCSP_REVOKED_STATUS_KEYCOMPROMISE,OCSP_REVOKED_STATUS_CACOMPROMISE,OCSP_REVOKED_STATUS_AFFILIATIONCHANGED,OCSP_REVOKED_STATUS_SUPERSEDED,OCSP_REVOKED_STATUS_CESSATIONOFOPERATION,OCSP_REVOKED_STATUS_CERTIFICATEHOLDorOCSP_REVOKED_STATUS_REMOVEFROMCRL.OCSP_resp_count()β returns the number ofOCSP_SINGLERESPstructures inbs. that's it, that's the job πOCSP_resp_get0()β returns theOCSP_SINGLERESPstructure inbsfor indexidx, whereidxruns from0toOCSP_resp_count(bs) - 1. zero-indexed bestie, respect the range πOCSP_resp_find()β searchesbsforidand returns the index of the first matching entry afterlast, or starts from the beginning iflastis-1.OCSP_single_get0_status()β extracts the fields ofsingleinto*reason,*revtime,*thisupdand*nextupd.OCSP_resp_get0_produced_at()β extracts theproducedAtfield from the single responsebs.OCSP_resp_get0_signature()β returns the signature frombs.OCSP_resp_get0_tbs_sigalg()β returns thesignatureAlgorithmfrombs.OCSP_resp_get0_respdata()β returns thetbsResponseDatafrombs.OCSP_resp_get0_certs()β returns any certificates included inbs.OCSP_resp_get0_signer()β tries to retrieve the certificate that directly signedbs. here's the tea: the OCSP protocol does not require that this certificate be included in thecertsfield of the response, so you can supply additional certificates via theextra_certsif you already know (through some out-of-band mechanism) which certificates may have signed the response. giving prepared πOCSP_resp_get0_id()β gets the responder id ofbs. if the responder ID is a name then<*pname>is set to the name and*pidis set toNULL. if the responder ID is by key ID then*pidis set to the key ID and*pnameis set toNULL. one or the other, never both, iconic behavior β¨OCSP_resp_get1_id()β same asOCSP_resp_get0_id()but it leaves ownership of*pidand*pnamewith the caller, who is responsible for freeing them β unless the function returns0. so like, you own it now, congrats, clean up after yourself π§ΉOCSP_check_validity()β checks the validity of itsthisupdandnextupdarguments, which you'd typically get fromOCSP_resp_find_status()orOCSP_single_get0_status(). ifsecis nonzero it says how many seconds of leeway should be allowed in the check. ifmaxsecis positive it indicates the maximum age ofthisupdin seconds. clock skew who? never heard of her πOCSP_basic_verify()β checks that the basic response messagebsis correctly signed and that the signer certificate can be validated. it takesstas the trusted store andcertsas a set of untrusted intermediate certificates. let's walk the whole algorithm because it's a journey, bestie πΆββοΈ- first it tries to find the signer certificate of the response in
certs. - then it searches the certificates the responder may have included in
bsβ unlessflagscontainsOCSP_NOINTERN. - it fails if the signer certificate cannot be found.
- next, unless
flagscontainsOCSP_NOSIGS, the function checks the signature ofbsand fails on error. - then the function already returns success if
flagscontainsOCSP_NOVERIFY, or if the signer certificate was found incertsandflagscontainsOCSP_TRUSTOTHER. early exit, slay π - otherwise the function continues by validating the signer certificate. if
flagscontainsOCSP_PARTIAL_CHAINit takes intermediate CA certificates instas trust anchors. for more details, see the description ofX509_V_FLAG_PARTIAL_CHAINin "VERIFICATION FLAGS" inX509_VERIFY_PARAM_set_flags(3). - if
flagscontainsOCSP_NOCHAINit ignores all certificates incertsand inbs; else it takes them as untrusted intermediate CA certificates and uses them for constructing the validation path for the signer certificate. - certificate revocation status checks using CRLs is disabled during path validation if the signer certificate contains the
id-pkix-ocsp-no-checkextension. - after successful path validation the function returns success if the
OCSP_NOCHECKSflag is set. - otherwise it verifies that the signer certificate meets the OCSP issuer criteria including potential delegation. if this does not succeed and the
OCSP_NOEXPLICITflag is not set, the function checks for explicit trust for OCSP signing in the root CA certificate.
- first it tries to find the signer certificate of the response in
β RETURN VALUES β
OCSP_resp_find_status()β returns1ifidis found inbsand0otherwise.OCSP_resp_count()β returns the total number ofOCSP_SINGLERESPfields inbs, or-1on error.OCSP_resp_get0()β returns a pointer to anOCSP_SINGLERESPstructure orNULLon error, such asidxbeing out of range. πOCSP_resp_find()β returns the index ofidinbs(which may be0) or-1on error, such as whenidwas not found.OCSP_single_get0_status()β returns the status ofsingleor-1if an error occurred.OCSP_resp_get0_produced_at()β returns theproducedAtfield frombs.OCSP_resp_get0_signature()β returns the signature frombs.OCSP_resp_get0_tbs_sigalg()β returns thesignatureAlgorithmfield frombs.OCSP_resp_get0_respdata()β returns thetbsResponseDatafield frombs.OCSP_resp_get0_certs()β returns any certificates included inbs.OCSP_resp_get0_signer()β returns1if the signing certificate was located, or0if not found or on error.OCSP_resp_get0_id()andOCSP_resp_get1_id()β return1on success,0on failure.OCSP_check_validity()β returns1ifthisupdandnextupdare valid time values and the current time +secis not beforethisupdand, ifmaxsec >= 0, the current time -maxsecis not pastnextupd. otherwise it returns0to indicate an error.OCSP_basic_verify()β returns1on success,0on verification not successful, or-1on a fatal error such as malloc failure. three outcomes, main character energy π
π NOTES π
apps will typically call OCSP_resp_find_status() using the certificate ID of interest and then check its validity using OCSP_check_validity(). after that they can take appropriate action based on the status of the certificate. that's the whole flow, periodt π
an OCSP response for a certificate contains thisUpdate and nextUpdate fields. normally the current time should be between these two values. to account for clock skew the maxsec field can be set to nonzero in OCSP_check_validity(). some responders do not set the nextUpdate field, which would otherwise mean an ancient response would be considered valid β so the maxsec parameter to OCSP_check_validity() can be used to limit the permitted age of responses. ancient responses are NOT it π§π
β οΈ important, bestie: the values written to*revtime,*thisupdand*nextupdbyOCSP_resp_find_status()andOCSP_single_get0_status()are internal pointers which MUST NOT be freed up by the calling application. do not free them. do not look at them funny. and any or all of these parameters can be set toNULLif their value is not required β very flexible, very demure π
π₯ SEE ALSO π₯
crypto(7), OCSP_cert_to_id(3), OCSP_request_add1_nonce(3), OCSP_REQUEST_new(3), OCSP_response_status(3), OCSP_sendreq_new(3), X509_VERIFY_PARAM_set_flags(3)
π COPYRIGHT π
Copyright 2015-2022 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.
and that's the whole page bestie, you ate that πβ¨ this was OCSP_RESP_FIND_STATUS(3ossl) from OpenSSL version 3.5.9, dated 2026-09-29. go forth and verify those OCSP responses responsibly, mwah π
π
π¦ where this page comes from
- fedora 43: openssl-devel 1:3.5.9-1.fc43 Β· Apache-2.0
- fedora 43: openssl-devel 1:3.5.9-1.fc43 Β· Apache-2.0
- fedora 44: openssl-devel 1:3.5.9-1.fc44 Β· Apache-2.0
- fedora 44: openssl-devel 1:3.5.9-1.fc44 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms