LIBRESSL-X509_VERIFY_PARAM_SET_FLAGS(3)
π X509_VERIFY_PARAM_SET_FL(3) β X509 verification parameters π
okay so bestie, this whole page comes from the Library Functions Manual, and itβs all libcrypto business. The main character is the X509_VERIFY_PARAM object β the little vibe-check controller attached to a certificate verification operation. These functions name it, flag it, time it, and set up hostname / email / IP checks. Letβs get into it. π«Ά
β¨ NAME β¨
X509_VERIFY_PARAM_get0_nameX509_VERIFY_PARAM_set1_nameX509_VERIFY_PARAM_set_flagsX509_VERIFY_PARAM_clear_flagsX509_VERIFY_PARAM_get_flagsX509_VERIFY_PARAM_set_purposeX509_VERIFY_PARAM_set_trustX509_VERIFY_PARAM_set_timeX509_VERIFY_PARAM_get_timeX509_VERIFY_PARAM_add0_policyX509_VERIFY_PARAM_set1_policiesX509_VERIFY_PARAM_set_depthX509_VERIFY_PARAM_get_depthX509_VERIFY_PARAM_set_auth_levelX509_VERIFY_PARAM_set1_hostX509_VERIFY_PARAM_add1_hostX509_VERIFY_PARAM_get_hostflagsX509_VERIFY_PARAM_set_hostflagsX509_VERIFY_PARAM_get0_peernameX509_VERIFY_PARAM_set1_emailX509_VERIFY_PARAM_set1_ipX509_VERIFY_PARAM_set1_ip_asc
β X509 verification parameters π
πΈ SYNOPSIS πΈ
okay so this is the libcrypto situation, and you literally include this header:
library βlibcryptoβ #include <openssl/x509_vfy.h>
const char *
X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param);
int
X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name);
int
X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param,
unsigned long flags);
int
X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
unsigned long flags);
unsigned long
X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param);
int
X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose);
int
X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust);
void
X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t);
time_t
X509_VERIFY_PARAM_get_time(const, X509_VERIFY_PARAM, *param");
int
X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
ASN1_OBJECT *policy);
int
X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
STACK_OF(ASN1_OBJECT) *policies);
void
X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth);
int
X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param);
void
X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param,
int auth_level);
int
X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param, const char *name,
size_t namelen);
int
X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param, const char *name,
size_t namelen);
unsigned int
X509_VERIFY_PARAM_get_hostflags(const X509_VERIFY_PARAM *param);
void
X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
unsigned int flags);
char *
X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param);
int
X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
const char *email, size_t emaillen);
int
X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
const unsigned char *ip, size_t iplen);
int
X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param,
const char *ipasc);
and yes bestie, that X509_VERIFY_PARAM_get_time prototype is serving exactly the characters printed above β comma, quote, all of it. We copy code exactly here, no edits, no cap. π
π₯ DESCRIPTION π₯
These functions manipulate an X509_VERIFY_PARAM object associated with a certificate verification operation.
X509_VERIFY_PARAM_get0_name()β returns the name of the givenparamobject, usually describing its purpose, for example"default","pkcs7","smime_sign","ssl_client", or"ssl_server". For user-defined objects, the returned pointer may beNULLeven if the object is otherwise valid.X509_VERIFY_PARAM_set1_name()β sets the name ofparamto a copy ofname, or toNULLifnameisNULL.X509_VERIFY_PARAM_set_flags()β sets the flags inparamby OR'ing it withflags. See the βVERIFICATION FLAGSβ section for a complete description of values theflagsparameter can take.- If the
flagsargument includes any of the flags contained inX509_V_FLAG_POLICY_MASK, that is, any ofX509_V_FLAG_POLICY_CHECK,X509_V_FLAG_EXPLICIT_POLICY,X509_V_FLAG_INHIBIT_ANY, andX509_V_FLAG_INHIBIT_MAP, thenX509_V_FLAG_POLICY_CHECKis set in addition to the flags contained in theflagsargument. X509_VERIFY_PARAM_get_flags()β returns the flags inparam.X509_VERIFY_PARAM_clear_flags()β clears the specifiedflagsinparam.- Calling this function can result in unusual internal states of the
paramobject, for example having a verification time configured but havingX509_V_FLAG_USE_CHECK_TIMEunset, or havingX509_V_FLAG_EXPLICIT_POLICYset butX509_V_FLAG_POLICY_CHECKunset, which may have surprising effects. lowkey chaotic, but thatβs what the page says. π X509_VERIFY_PARAM_set_purpose()β sets the verification purpose identifier inparam. This determines the acceptable purpose of the certificate chain, for exampleX509_PURPOSE_SSL_CLIENTorX509_PURPOSE_SSL_SERVER. Standard purposes are listed inX509_check_purpose(3), and additional purposes can be defined withX509_PURPOSE_add(3).X509_VERIFY_PARAM_set_trust()β sets the trust setting inparamtotrust.X509_VERIFY_PARAM_set_time()β sets the flagX509_V_FLAG_USE_CHECK_TIMEinparamin addition to the flags already set and sets the verification time tot. If this function is not called, the current time is used instead, or the UNIX Epoch (January 1, 1970) ifX509_V_FLAG_USE_CHECK_TIMEis manually set usingX509_VERIFY_PARAM_set_flags().X509_VERIFY_PARAM_add0_policy()β enables policy checking (it is disabled by default) and addspolicyto the acceptable policy set.X509_VERIFY_PARAM_set1_policies()β enables policy checking (it is disabled by default) and sets the acceptable policy set topolicies. Any existing policy set is cleared. Thepoliciesparameter can beNULLto clear an existing policy set.X509_VERIFY_PARAM_set_depth()β sets the maximum verification depth todepth. That is the maximum number of untrusted CA certificates that can appear in a chain.X509_VERIFY_PARAM_set_auth_level()β sets the security level as defined inSSL_CTX_set_security_level(3)for certificate chain validation. For a certificate chain to validate, the public keys of all the certificates must meet the specified security level. The signature algorithm security level is not enforced for the chain's trust anchor certificate, which is either directly trusted or validated by means other than its signature.- From the point of view of the X.509 library, the default security level is 0. However, the SSL library uses a different default security level of 1 and calls
X509_VERIFY_PARAM_set_auth_level()with its own level before validating a certificate chain. X509_VERIFY_PARAM_set1_host()β sets the expected DNS hostname tonameclearing any previously specified hostname or names. IfnameisNULLor empty, the list of hostnames is cleared, and name checks are not performed on the peer certificate.namelenshould be set to the length ofname. For historical compatibility, ifnameis NUL-terminated,namelenmay be specified as zero. When a hostname is specified, certificate verification automatically invokesX509_check_host(3)with flags equal to theflagsargument given toX509_VERIFY_PARAM_set_hostflags()(default zero).X509_VERIFY_PARAM_set1_host()will fail ifnamecontains any embedded 0 bytes.X509_VERIFY_PARAM_add1_host()β addsnameas an additional reference identifier that can match the peer's certificate. Any previous names set viaX509_VERIFY_PARAM_set1_host()andX509_VERIFY_PARAM_add1_host()are retained. No change is made ifnameisNULLor empty.namelenshould be set to the length ofname. For historical compatibility, ifnameis NUL-terminated,namelenmay be specified as zero.X509_VERIFY_PARAM_add1_host()will fail ifnamecontains any embedded 0 bytes. When multiple names are configured, the peer is considered verified when any name matches.X509_VERIFY_PARAM_get0_peername()β returns the DNS hostname or subject CommonName from the peer certificate that matched one of the reference identifiers. When wildcard matching is not disabled, or when a reference identifier specifies a parent domain (starts with".") rather than a hostname, the peer name may be a wildcard name or a sub-domain of the reference identifier respectively.X509_VERIFY_PARAM_set1_email()β sets the expected RFC 822 email address toemail.emaillenshould be set to the length ofemail. For historical compatibility, ifemailis NUL-terminated,emaillenmay be specified as zero,X509_VERIFY_PARAM_set1_email()will fail ifemailisNULL, an empty string, or contains embedded 0 bytes. When an email address is specified, certificate verification automatically invokesX509_check_email(3).X509_VERIFY_PARAM_set1_ip()β sets the expected IP address toip. Theipargument is in binary format, in network byte-order, andiplenmust be set to 4 for IPv4 and 16 for IPv6.X509_VERIFY_PARAM_set1_ip()will fail ifipisNULLor ifiplenis not 4 or 16. When an IP address is specified, certificate verification automatically invokesX509_check_ip(3).X509_VERIFY_PARAM_set1_ip_asc()β sets the expected IP address toipasc. Theipascargument is a NUL-terminal ASCII string: dotted decimal quad for IPv4 and colon-separated hexadecimal for IPv6. The condensed"::"notation is supported for IPv6 addresses.X509_VERIFY_PARAM_set1_ip_asc()will fail ifipascis unparsable.
π RETURN VALUES π
X509_VERIFY_PARAM_set1_name(),X509_VERIFY_PARAM_set_flags(),X509_VERIFY_PARAM_clear_flags(),X509_VERIFY_PARAM_set_purpose(),X509_VERIFY_PARAM_set_trust(),X509_VERIFY_PARAM_add0_policy(), andX509_VERIFY_PARAM_set1_policies()return 1 for success or 0 for failure.X509_VERIFY_PARAM_set1_host(),X509_VERIFY_PARAM_add1_host(),X509_VERIFY_PARAM_set1_email(),X509_VERIFY_PARAM_set1_ip(), andX509_VERIFY_PARAM_set1_ip_asc()return 1 for success or 0 for failure. A failure from these routines will poison theX509_VERIFY_PARAMobject so that future calls toX509_verify_cert(3)using the poisoned object will fail.
β οΈ bestie, the poisoning thing is real: if one of those host / email / IP setters fails, the object is poisoned and later X509_verify_cert(3) calls using it will fail. π
X509_VERIFY_PARAM_get_flags()β returns the current verification flags.X509_VERIFY_PARAM_get_time()β always returns the configured verification time. It does so even if the returned time will not be used because the flagX509_V_FLAG_USE_CHECK_TIMEis unset.X509_VERIFY_PARAM_get_depth()β returns the current verification depth.X509_VERIFY_PARAM_get_hostflags()β returns the host flags previously set by a call toX509_VERIFY_PARAM_set_hostflags()or 0 by default.X509_VERIFY_PARAM_get0_name()andX509_VERIFY_PARAM_get0_peername()return pointers to strings that are only valid during the lifetime of the givenparamobject and that must not be freed by the application program. π«Ά
β¨ VERIFICATION FLAGS β¨
Okay bestie, this is the good part β the flags themselves. The verification flags are basically a little squad of zero or more of these bad boys OR'ed together. Pick your faves, stack 'em up, go off π
X509_V_FLAG_CRL_CHECKβ turns on CRL checking for the leaf certificate of the certificate chain. If a suitable CRL can't be found, boom, that's an error. πX509_V_FLAG_CRL_CHECK_ALLβ same energy but for the entire certificate chain. Not just the leaf, the whole fam π«ΆX509_V_FLAG_IGNORE_CRITICALβ disables critical extension checking. By default, any unhandled critical extensions in certificates (or in CRLs, if those are being checked) is a fatal error. Set this flag and those unhandled critical extensions just get ignored. WARNING: setting this for literally anything other than debugging purposes can be a security risk π¬ If you want finer control over which extensions are supported, do that in the verification callback instead, no cap.X509_V_FLAG_X509_STRICTβ disables workarounds for some broken certificates and makes verification strictly apply X509 rules. No more being nice about it, periodt πX509_V_FLAG_ALLOW_PROXY_CERTSβ a deprecated flag that used to enable proxy certificate verification. In LibreSSL, this flag has no effect. It's giving "I'm here but I'm not doing anything" πX509_V_FLAG_POLICY_CHECKβ enables certificate policy checking; by default no policy checking is performed. When it is, additional info gets sent to the verification callback about the policy checking. β¨X509_V_FLAG_EXPLICIT_POLICY,X509_V_FLAG_INHIBIT_ANY, andX509_V_FLAG_INHIBIT_MAPβ these three set the βrequire explicit policyβ, βinhibit any policyβ, and βinhibit policy mappingβ flags, respectively, exactly as defined in RFC 3280. Big caveat: these three are ignored unlessX509_V_FLAG_POLICY_CHECKis also set. So don't be out here setting them alone and expecting a vibe πX509_V_FLAG_NOTIFY_POLICYβ if this is set and policy checking succeeds, a special status code gets sent to the verification callback. Little notification, lowkey cute πX509_V_FLAG_EXTENDED_CRL_SUPPORTβ by default some extra features like indirect CRLs and CRLs signed by different keys are disabled. Set this and they're enabled. Unlocked πX509_V_FLAG_USE_DELTASβ if set, delta CRLs (if present) are used to determine certificate status. If not set, deltas are simply ignored. πX509_V_FLAG_CHECK_SS_SIGNATUREβ enables checking of the root CA self signed certificate signature. By default this check is disabled because it doesn't add any additional security β but in some cases applications might want to check the signature anyway. A side effect of not checking the root CA signature is that disabled or unsupported message digests on the root CA are not treated as fatal errors. iykyk π₯X509_V_FLAG_CB_ISSUER_CHECKβ deprecated flag that used to enable debugging of certificate issuer checks. It's provided for binary backwards compatibility and has no effect. Respectfully, it's retired πX509_V_FLAG_TRUSTED_FIRSTβ when set, construction of the certificate chain inX509_verify_cert(3)will search the trust store for issuer certificates before searching the provided untrusted certificates. Local issuer certificates are often more likely to satisfy local security requirements and lead to a locally trusted root. This is especially important when some certificates in the trust store have explicit trust settings β see the trust settings options of thex509command inopenssl(1). πX509_V_FLAG_NO_ALT_CHAINSβ suppresses checking for alternative chains. By default, unlessX509_V_FLAG_TRUSTED_FIRSTis set, when building a certificate chain, if the first certificate chain found is not trusted, then OpenSSL will attempt to replace untrusted certificates supplied by the peer with certificates from the trust store to see if an alternative chain can be found that is trusted. This flag says "no thank you, we're not doing the alternates today" π«X509_V_FLAG_PARTIAL_CHAINβ causes intermediate certificates in the trust store to be treated as trust-anchors, in the same way as the self-signed root CA certificates. This makes it possible to trust certificates issued by an intermediate CA without having to trust its ancestor root CA. Honestly iconic behavior πX509_V_FLAG_USE_CHECK_TIMEβ if set, the validity period of certificates and CRLs is checked. In this case,X509_V_FLAG_NO_CHECK_TIMEis ignored. If the validation time was set withX509_VERIFY_PARAM_set_time(), that time is used. IfX509_VERIFY_PARAM_set_time()was not called, the UNIX Epoch (January 1, 1970) is used. Like, ancient times π°οΈ- If neither
X509_V_FLAG_USE_CHECK_TIMEnorX509_V_FLAG_NO_CHECK_TIMEis set, the validity period of certificates and CRLs is checked using the current time. This is the default behaviour. In this case, if a validation time was set withX509_VERIFY_PARAM_set_time()butX509_V_FLAG_USE_CHECK_TIMEwas later cleared withX509_VERIFY_PARAM_clear_flags(), the configured validation time is ignored and the current time is used anyway. Rude but factual π - If
X509_V_FLAG_USE_CHECK_TIMEis not set butX509_V_FLAG_NO_CHECK_TIMEis set, the validity period of certificates and CRLs is not checked at all, and like in the previous case, any configured validation time is ignored. We're just not looking at the clock, bestie π
πΈ EXAMPLES πΈ
Wanna enable CRL checking when performing certificate verification during SSL connections associated with an SSL_CTX structure ctx? Say less. Do this:
X509_VERIFY_PARAM *param;
param = X509_VERIFY_PARAM_new();
X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK);
SSL_CTX_set1_param(ctx, param);
X509_VERIFY_PARAM_free(param);
π¦ SEE ALSO π¦
SSL_set1_host(3), SSL_set1_param(3), X509_check_host(3), X509_STORE_CTX_new(3), X509_STORE_new(3), X509_verify_cert(3), X509_VERIFY_PARAM_new(3)
π HISTORY π
Okay so, storytime π
X509_VERIFY_PARAM_set1_name(), X509_VERIFY_PARAM_set_flags(), X509_VERIFY_PARAM_set_purpose(), X509_VERIFY_PARAM_set_trust(), X509_VERIFY_PARAM_set_time(), X509_VERIFY_PARAM_add0_policy(), X509_VERIFY_PARAM_set1_policies(), X509_VERIFY_PARAM_set_depth(), and X509_VERIFY_PARAM_get_depth() first appeared in OpenSSL 0.9.8. Then X509_VERIFY_PARAM_clear_flags() and X509_VERIFY_PARAM_get_flags() first appeared in OpenSSL 0.9.8a. All these functions have been available since OpenBSD 4.5. Old money πΈ
Next batch: X509_VERIFY_PARAM_get0_name(), X509_VERIFY_PARAM_set1_host(), X509_VERIFY_PARAM_add1_host(), X509_VERIFY_PARAM_set_hostflags(), X509_VERIFY_PARAM_get0_peername(), X509_VERIFY_PARAM_set1_email(), X509_VERIFY_PARAM_set1_ip(), and X509_VERIFY_PARAM_set1_ip_asc() first appeared in OpenSSL 1.0.2 and have been available since OpenBSD 6.3. Glow up β¨
Then X509_VERIFY_PARAM_set_auth_level() first appeared in OpenSSL 1.1.0 and X509_VERIFY_PARAM_get_time() in OpenSSL 1.1.0d. Both functions have been available since OpenBSD 7.2.
And X509_VERIFY_PARAM_get_hostflags() first appeared in OpenSSL 1.1.0i and has been available since OpenBSD 7.9. Fresh out the oven π₯
π BUGS π
Bestie, some things are still a work in progress:
- Delta CRL checking is currently primitive. Only a single delta can be used, and (partly due to limitations of
X509_STORE) constructed CRLs are not maintained. It's giving "we're trying our best" π - If CRL checking is enabled, CRLs are expected to be available in the corresponding
X509_STOREstructure. No attempt is made to download CRLs from the CRL distribution points extension. So don't come for it β it literally won't go fetch them for you π
And that's the whole page, bestie! π«Ά This one came from the Debian edition, dated November 7, 2025, for X509_VERIFY_PARAM_SET_FLAGS(3) β go forth and verify those params responsibly πβ¨π
π¦ where this page comes from
- alpine 3.24: libressl-doc 4.3.1-r0 Β· custom
- arch rolling: libressl 4.4.0-1 Β· ISC AND custom:OpenSSL
- Copyright (c) 2018, 2021, 2022 Ingo Schwarze <schwarze@openbsd.org>
- Copyright (c) 2009, 2013, 2014, 2015, 2016, 2017 The OpenSSL Project
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms