openssl_x509_checkpurpose
(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)
Verifies if a certificate can be used for a particular purpose
Description
openssl_x509_checkpurpose() examines a certificate to see if it can be used for the specified purpose.
Parameters
certificateThe examined certificate.
purposeConstant Description X509_PURPOSE_SSL_CLIENT Can the certificate be used for the client side of an SSL connection? X509_PURPOSE_SSL_SERVER Can the certificate be used for the server side of an SSL connection? X509_PURPOSE_NS_SSL_SERVER Can the cert be used for Netscape SSL server? X509_PURPOSE_SMIME_SIGN Can the cert be used to sign S/MIME email? X509_PURPOSE_SMIME_ENCRYPT Can the cert be used to encrypt S/MIME email? X509_PURPOSE_CRL_SIGN Can the cert be used to sign a certificate revocation list (CRL)? X509_PURPOSE_ANY Can the cert be used for Any/All purposes? These options are not bitfields - you may specify one only!
ca_infoca_infoshould be an array of trusted CA files/dirs as described in Certificate Verification.untrusted_certificates_fileIf specified, this should be the name of a PEM encoded file holding certificates that can be used to help verify the certificate, although no trust is placed in the certificates that come from that file.
Return Values
Returns true if the certificate can be used for the intended purpose, false if it cannot, or -1 on error.
Both true and -1 are truthy, so a plain truth test such as if (openssl_x509_checkpurpose(...)) treats an error as a successful verification. The result must be compared strictly against true.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | certificate accepts an OpenSSLCertificate instance now; previously, a Resource of type OpenSSL X.509 was accepted. |
| 8.0.0 | untrusted_certificates_file is nullable now. |