X509_STORE_CTX_GET_ERROR(3ossl)
π NAME π
okay bestie, welcome to the OpenSSL manual page for X509_STORE_CTX_GET_ERROR(3ossl) β and the whole vibe here is get or set certificate verification status information. The squad is: X509_STORE_CTX_get_error, X509_STORE_CTX_set_error, X509_STORE_CTX_get_error_depth, X509_STORE_CTX_set_error_depth, X509_STORE_CTX_get_current_cert, X509_STORE_CTX_set_current_cert, X509_STORE_CTX_get0_cert, X509_STORE_CTX_get1_chain, and X509_verify_cert_error_string. iconic little status-info crew, fr fr. π
β¨ SYNOPSIS β¨
#include <openssl/x509.h>
int X509_STORE_CTX_get_error(const X509_STORE_CTX *ctx);
void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx, int s);
int X509_STORE_CTX_get_error_depth(const X509_STORE_CTX *ctx);
void X509_STORE_CTX_set_error_depth(X509_STORE_CTX *ctx, int depth);
X509 *X509_STORE_CTX_get_current_cert(const X509_STORE_CTX *ctx);
void X509_STORE_CTX_set_current_cert(X509_STORE_CTX *ctx, X509 *x);
X509 *X509_STORE_CTX_get0_cert(const X509_STORE_CTX *ctx);
STACK_OF(X509) *X509_STORE_CTX_get1_chain(const X509_STORE_CTX *ctx);
const char *X509_verify_cert_error_string(long n);
π¦ DESCRIPTION π¦
So these functions are typically called after certificate or chain verification using X509_verify_cert(3) or X509_STORE_CTX_verify(3) has indicated an error β or inside a verification callback, to determine the nature of an error. Like the group chat after something goes slightly unhinged, but for certs. β¨
X509_STORE_CTX_get_error()β returns the error code ofctx.ctxMUST NOT beNULL. See the βERROR CODESβ section for a full description of all error codes. Heads up: it may return a code !=X509_V_OKeven ifX509_verify_cert()did not indicate an error, likely because a verification callback function has waived the error. the plot thickens, iykyk.X509_STORE_CTX_set_error()β sets the error code ofctxtos. For example it might be used in a verification callback to set an error based on additional checks.ctxMUST NOT beNULL.X509_STORE_CTX_get_error_depth()β returns the depth of the error. This is a nonnegative integer representing where in the certificate chain the error occurred. If it is zero it occurred in the end entity certificate, one if it is the certificate which signed the end entity certificate and so on.ctxMUST NOT beNULL. depth zero is giving end-entity main character energy.X509_STORE_CTX_set_error_depth()β sets the error depth. This can be used in combination withX509_STORE_CTX_set_error()to set the depth at which an error condition was detected.X509_STORE_CTX_get_current_cert()β returns the current certificate inctx. If an error occurred, the current certificate will be the one that is most closely related to the error, or possiblyNULLif no such certificate is relevant. sometimes the answer is βno thoughts, justNULL.βX509_STORE_CTX_set_current_cert()β sets the certificatexinctxwhich caused the error. This value is not intended to remain valid for very long, and remains owned by the caller. It may be examined by a verification callback invoked to handle each error encountered during chain verification and is no longer required after such a callback. If a callback wishes to save the certificate for use after it returns, it needs to increment its reference count viaX509_up_ref(3). Once such a saved certificate is no longer needed it can be freed withX509_free(3). borrowed, not gifted β periodt.X509_STORE_CTX_get0_cert()β retrieves an internal pointer to the certificate being verified by thectx. It may beNULLif a raw public key is being verified.X509_STORE_CTX_get1_chain()β returns a complete validate chain if a previous verification is successful. Otherwise the returned chain may be incomplete or invalid. The returned chain persists after thectxstructure is freed. When it is no longer needed it should be free up using:
OSSL_STACK_OF_X509_free(chain);
X509_verify_cert_error_string()β returns a human readable error string for verification errorn. literally the translator for error-code chaos.
π RETURN VALUES π
X509_STORE_CTX_get_error()returnsX509_V_OKor an error code.X509_STORE_CTX_get_error_depth()returns a nonnegative error depth.X509_STORE_CTX_get_current_cert()returns the certificate which caused the error orNULLif no certificate is relevant to the error.X509_verify_cert_error_string()returns a human readable error string for verification errorn.
π₯ ERROR CODES π₯
A list of error codes and messages is shown below. Some of the error codes are defined but currently never returned: these are described as βunusedβ. vibe check: a few are marked unused, so donβt come for them. π
X509_V_OK: ok β The operation was successful.X509_V_ERR_UNSPECIFIED: unspecified certificate verification error β Unspecified error; should not happen.X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT: unable to get issuer certificate β The issuer certificate of a locally looked up certificate could not be found. This normally means the list of trusted certificates is not complete. To allow any certificate (not only a self-signed one) in the trust store to terminate the chain theX509_V_FLAG_PARTIAL_CHAINflag may be set.X509_V_ERR_UNABLE_TO_GET_CRL: unable to get certificate CRL β The CRL of a certificate could not be found.X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE: unable to decrypt certificate's signature β The certificate signature could not be decrypted. This means that the actual signature value could not be determined rather than it not matching the expected value, this is only meaningful for RSA keys.X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE: unable to decrypt CRL's signature β The CRL signature could not be decrypted: this means that the actual signature value could not be determined rather than it not matching the expected value. Unused.X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY: unable to decode issuer public key β The public key in the certificate"SubjectPublicKeyInfo"field could not be read.X509_V_ERR_CERT_SIGNATURE_FAILURE: certificate signature failure β The signature of the certificate is invalid.X509_V_ERR_CRL_SIGNATURE_FAILURE: CRL signature failure β The signature of the CRL is invalid.X509_V_ERR_CERT_NOT_YET_VALID: certificate is not yet valid β The certificate is not yet valid: the"notBefore"date is after the current time.X509_V_ERR_CERT_HAS_EXPIRED: certificate has expired β The certificate has expired: that is the"notAfter"date is before the current time.X509_V_ERR_CRL_NOT_YET_VALID: CRL is not yet valid β The CRL is not yet valid.X509_V_ERR_CRL_HAS_EXPIRED: CRL has expired β The CRL has expired.X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD: format error in certificate's notBefore field β The certificate"notBefore"field contains an invalid time.X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD: format error in certificate's notAfter field β The certificate"notAfter"field contains an invalid time.X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD: format error in CRL's lastUpdate field β The CRLlastUpdatefield contains an invalid time.X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD: format error in CRL's nextUpdate field β The CRL"nextUpdate"field contains an invalid time.X509_V_ERR_OUT_OF_MEM: out of memory β An error occurred trying to allocate memory.X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT: self-signed certificate β The passed certificate is self-signed and the same certificate cannot be found in the list of trusted certificates.X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN: self-signed certificate in certificate chain β The certificate chain could be built up using the untrusted certificates but no suitable trust anchor (which typically is a self-signed root certificate) could be found in the trust store.X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY: unable to get local issuer certificate β The issuer certificate could not be found: this occurs if the issuer certificate of an untrusted certificate cannot be found.X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE: unable to verify the first certificate β No signatures could be verified because the chain contains only one certificate and it is not self-signed and theX509_V_FLAG_PARTIAL_CHAINflag is not set.X509_V_ERR_CERT_CHAIN_TOO_LONG: certificate chain too long β The certificate chain length is greater than the supplied maximum depth.X509_V_ERR_CERT_REVOKED: certificate revoked β The certificate has been revoked.X509_V_ERR_NO_ISSUER_PUBLIC_KEY: issuer certificate doesn't have a public key β The issuer certificate does not have a public key.X509_V_ERR_PATH_LENGTH_EXCEEDED: path length constraint exceeded β ThebasicConstraintspath-length parameter has been exceeded.X509_V_ERR_INVALID_PURPOSE: unsuitable certificate purpose β The target certificate cannot be used for the specified purpose.X509_V_ERR_CERT_UNTRUSTED: certificate not trusted β The root CA is not marked as trusted for the specified purpose.X509_V_ERR_CERT_REJECTED: certificate rejected β The root CA is marked to reject the specified purpose.X509_V_ERR_SUBJECT_ISSUER_MISMATCH: subject issuer mismatch β The current candidate issuer certificate was rejected because its subject name did not match the issuer name of the current certificate.X509_V_ERR_AKID_SKID_MISMATCH: authority and subject key identifier mismatch β The current candidate issuer certificate was rejected because its subject key identifier was present and did not match the authority key identifier current certificate.X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH: authority and issuer serial number mismatch β The current candidate issuer certificate was rejected because its issuer name and serial number was present and did not match the authority key identifier of the current certificate.X509_V_ERR_KEYUSAGE_NO_CERTSIGN: key usage does not include certificate signing β The current candidate issuer certificate was rejected because its"keyUsage"extension does not permit certificate signing.X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER: unable to get CRL issuer certificate β Unable to get CRL issuer certificate.X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION: unhandled critical extension β Unhandled critical extension.X509_V_ERR_KEYUSAGE_NO_CRL_SIGN: key usage does not include CRL signing β Key usage does not include CRL signing.X509_V_ERR_UNHANDLED_CRITICAL_CRL_EXTENSION: unhandled critical CRL extension β Unhandled critical CRL extension.X509_V_ERR_INVALID_NON_CA: invalid non-CA certificate (has CA markings) β Invalid non-CA certificate has CA markings.X509_V_ERR_PROXY_PATH_LENGTH_EXCEEDED: proxy path length constraint exceeded β Proxy path length constraint exceeded.X509_V_ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE: key usage does not include digital signature β Key usage does not include digital signature, and therefore cannot sign certificates.X509_V_ERR_PROXY_CERTIFICATES_NOT_ALLOWEDβ proxy certificates not allowed, please set the appropriate flag. Bestie, proxy certs are a whole no unless you explicitly turn onX509_V_FLAG_ALLOW_PROXY_CERTS. Flip that flag or they simply will not pass. πX509_V_ERR_INVALID_EXTENSIONβ invalid or inconsistent certificate extension. A cert extension had a bad value (like, wrong encoding bad) or some value that just doesn't vibe with the other extensions. π«X509_V_ERR_INVALID_POLICY_EXTENSIONβ invalid or inconsistent certificate policy extension. Same deal but for the certificate policies extension: invalid value (e.g. an incorrect encoding) or a value inconsistent with other extensions. Heads up β this one only shows up if policy processing is enabled. πX509_V_ERR_NO_EXPLICIT_POLICYβ no explicit policy. The verification flags were set to require an explicit policy and there was literally none present. Ma'am, you asked for a policy and there is no policy. πX509_V_ERR_DIFFERENT_CRL_SCOPEβ different CRL scope. The only CRLs that could be found did not match the scope of the certificate. Rude, honestly.X509_V_ERR_UNSUPPORTED_EXTENSION_FEATUREβ unsupported extension feature. Some feature of a certificate extension is not supported. It's marked unused btw, so don't come for it. π¦X509_V_ERR_UNNESTED_RESOURCEβ RFC 3779 resource not subset of parent's resources. See RFC 3779 for the details, that's the whole story, iykyk.X509_V_ERR_PERMITTED_VIOLATIONβ permitted subtree violation. A name constraint violation happened in the permitted subtrees.X509_V_ERR_EXCLUDED_VIOLATIONβ excluded subtree violation. A name constraint violation happened in the excluded subtrees. Flip side, same energy.X509_V_ERR_SUBTREE_MINMAXβ name constraints minimum and maximum not supported. A certificate name constraints extension included a minimum or maximum field, and that is just not supported, periodt.X509_V_ERR_APPLICATION_VERIFICATIONβ application verification failure. This is an application specific error and it will never be returned unless an application callback explicitly sets it. It's yours to summon. β¨X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPEβ unsupported name constraint type. You hit a name constraint type that isn't supported. OpenSSL currently only supports directory name, DNS name, email and URI types β that's the whole roster. πX509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAXβ unsupported or invalid name constraint syntax. The format of the name constraint isn't recognised β think an email address format of a form not mentioned in RFC3280. Could be caused by a garbage extension or some shiny new feature that isn't currently supported yet. πX509_V_ERR_UNSUPPORTED_NAME_SYNTAXβ unsupported or invalid name syntax. That's it, that's the error.X509_V_ERR_CRL_PATH_VALIDATION_ERRORβ CRL path validation error. Something went wrong when attempting to verify the CRL path. This one can only happen if extended CRL checking is enabled. β οΈX509_V_ERR_PATH_LOOPβ path loop. Path loop. (Yes, that's the entire description. Iconic minimalism.)X509_V_ERR_HOSTNAME_MISMATCHβ hostname mismatch. Hostname mismatch.X509_V_ERR_EMAIL_MISMATCHβ email address mismatch. Email address mismatch.X509_V_ERR_IP_ADDRESS_MISMATCHβ IP address mismatch. IP address mismatch.X509_V_ERR_DANE_NO_MATCHβ no matching DANE TLSA records. DANE TLSA authentication is enabled but no TLSA records matched the certificate chain. This error is only possible inopenssl-s_client(1)β nowhere else, babe. π₯X509_V_ERR_EE_KEY_TOO_SMALLβ EE certificate key too weak. EE certificate key too weak. πX509_V_ERR_CA_KEY_TOO_SMALLβ CA certificate key too weak. CA certificate key too weak.X509_V_ERR_CA_MD_TOO_WEAKβ CA signature digest algorithm too weak. The CA's signature digest algorithm is too weak, no cap.X509_V_ERR_INVALID_CALLβ invalid certificate verification context. Invalid certificate verification context.X509_V_ERR_STORE_LOOKUPβ issuer certificate lookup error. Issuer certificate lookup error.X509_V_ERR_NO_VALID_SCTSβ certificate transparency required, but no valid SCTs found. Certificate Transparency was required, but no valid SCTs were found. π§X509_V_ERR_PROXY_SUBJECT_NAME_VIOLATIONβ proxy subject name violation. Proxy subject name violation.X509_V_ERR_OCSP_VERIFY_NEEDEDβ OCSP verification needed. Returned by the verify callback to indicate an OCSP verification is needed.X509_V_ERR_OCSP_VERIFY_FAILEDβ OCSP verification failed. Returned by the verify callback to indicate OCSP verification failed.X509_V_ERR_OCSP_CERT_UNKNOWNβ OCSP unknown cert. Returned by the verify callback to indicate that the certificate is not recognized by the OCSP responder.X509_V_ERR_UNSUPPORTED_SIGNATURE_ALGORITHMβ unsupported signature algorithm. Cannot find the certificate signature algorithm. Lost in the sauce.X509_V_ERR_SIGNATURE_ALGORITHM_MISMATCHβ subject signature algorithm and issuer public key algorithm mismatch. The issuer's public key is not of the type required by the signature in the subject's certificate. They're not compatible, bestie, it's not gonna work out. πX509_V_ERR_SIGNATURE_ALGORITHM_INCONSISTENCYβ cert info signature and signature algorithm mismatch. The algorithm given in the certificate info is inconsistent with the one used for the certificate signature.X509_V_ERR_INVALID_CAβ invalid CA certificate. A CA certificate is invalid. Either it's not a CA at all or its extensions are not consistent with the supplied purpose. π©X509_V_ERR_RPK_UNTRUSTEDβ raw public key untrusted, no trusted keys configured. No TLS records were configured to validate the raw public key, or DANE was not enabled on the connection.
πΈ NOTES πΈ
Okay so, use the above functions instead of directly referencing the fields in the X509_VERIFY_CTX structure. Like, don't reach into the guts, use the API, it's giving respect. π
In versions of OpenSSL before 1.0, the current certificate returned by X509_STORE_CTX_get_current_cert() was never NULL. So if you're supporting ancient stuff β applications should check the return value before printing out any debugging information relating to the current certificate. Check it, bestie, always check it. π«Ά
And if an unrecognised error code gets passed to X509_verify_cert_error_string(), the numerical value of the unknown code is returned in a static buffer. That is not thread safe β but fr fr it will never happen unless an invalid code is passed, so like, don't stress. π
π BUGS π
Previous versions of this documentation swapped the meaning of the X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT and X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY error codes. Imagine. So if you're reading old docs, just know they had those two mixed up. π
π¦ SEE ALSO π¦
X509_verify_cert(3), X509_STORE_CTX_verify(3), X509_up_ref(3), X509_free(3).
π COPYRIGHT π
Copyright 2009-2023 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 a wrap, bestie! π This one's from OpenSSL version 3.5.0, dated 2026-09-25, and it's the X509_STORE_CTX_GET_ERROR(3ossl) page β go forth and verify those certs like the main character you are. Slay. β¨π
π¦ where this page comes from
- opensuse-leap 16.0: openssl-3-doc 3.5.0-160000.11.1 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms