openssl_x509_checkpurpose

(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)

openssl_x509_checkpurpose — 验证是否可以为特定目的使用证书

说明

openssl_x509_checkpurpose(
    OpenSSLCertificate|string $certificate,
    int $purpose,
    array $ca_info = [],
    ?string $untrusted_certificates_file = null
): bool|int

openssl_x509_checkpurpose() 检查证书以查看它是否可用于指定目的 purpose。

参数

certificate

被检查的证书。

purpose

**openssl_x509_checkpurpose()** 目的
常量名	描述
X509_PURPOSE_SSL_CLIENT	证书是否可以用于 SSL 连接的客户端?
X509_PURPOSE_SSL_SERVER	证书是否可以用于 SSL 连接的服务器端?
X509_PURPOSE_NS_SSL_SERVER	证书是否可以用于 Netscape SSL 服务器?
X509_PURPOSE_SMIME_SIGN	证书是否可以用来签名 S/MIME 邮件?
X509_PURPOSE_SMIME_ENCRYPT	正式是否可用用来加密 S/MIME 邮件?
X509_PURPOSE_CRL_SIGN	证书是否可以用来签名证书撤销列表（CRL）?
X509_PURPOSE_ANY	证书是否可以用于任何目的?

这些选项不是位字段——只能指定一个字段!

ca_info

ca_info 应该是一个受信任的 CA 文件/文件夹组成的数组，如 Certificate Verification 所描述的一样。

untrusted_certificates_file

如果指定，这应该是 PEM 编码文件的名称，该文件持有证书，可以用来帮助验证证书,尽管从该文件中获得的证书不受信任。

返回值

如果证书可以用于预期目的，返回 true，如果不行，则返回 false 错误便会返回 -1。

更新日志

版本	说明
8.0.0	`certificate` 现在接受 OpenSSLCertificate 实例；之前接受类型 `OpenSSL X.509` 的 resource。
8.0.0	`untrusted_certificates_file` 现在可为 null。

改进此页面

了解如何改进此页面 • 提交拉取请求 • 报告一个错误

＋添加备注

用户贡献的备注 2 notes

down

dingyuan at tencent dot com ¶

4 years ago

in one word ：if you set $purpose=0, you can use this function to verify certificate chain.

====================================================================

I want to verify a certificate chain. just like this: 
userCert.pem => middleCert.pem => rootCert.pem

I figured that none of these openssl functions provide this function directly. And some friends have same need as me,  "mikey at badpenguins dot com" even write his own code to verify certificate chain(you can see notes below openssl_verify). 

and I notice a note which has '-3' likes below openssl_verify, it says "validating an X509 certificate chain in php seems to be possible with openssl_x509_checkpurpose()", and I read the source code about this function, the given constant var about $purpose (like X509_PURPOSE_SSL_CLIENT ) is 1-7, and if you set $purpose among 1-7, you cannot verify the cert chain. Set $purpose=0 can get the truly result about verify a cert chain.

and I give that '-3' note a thumb-up, now it has -2 , lol.

down

adr at NOSPAM dot entropymatrix dot com ¶

11 years ago

The following is an example usage of openssl_x509_checkpurpose. It is equivalent to the openssl verify command as follows:
openssl verify -CApath $openssl_cadir -purpose sslserver $openssl_crtfile

<?php
$openssl_crtfile='auth.combined.pem';
$openssl_cadir='./ca';

$x509_res = openssl_x509_read(file_get_contents($openssl_crtfile));
if(empty($x509_res)) {
        echo 'x509 cert could not be read'."\n";
}
$valid = openssl_x509_checkpurpose($x509_res,X509_PURPOSE_SSL_SERVER,array($openssl_cadir));
if ($valid === true) {
        echo 'Certificate is valid for use as SSL server'."\n";
} else {
        echo 'Certificate validation returned'.$valid."\n";
}
?>