openssl_x509_checkpurpose

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

    openssl_x509_checkpurpose — Verifies if a certificate can be used for a particular purpose

    Description

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

    openssl_x509_checkpurpose() examines a certificate to see if it can be used for the specified purpose.

    Parameters

    certificate

    The examined certificate.

    purpose

    openssl_x509_checkpurpose() purposes
    ConstantDescription
    X509_PURPOSE_SSL_CLIENTCan the certificate be used for the client side of an SSL connection?
    X509_PURPOSE_SSL_SERVERCan the certificate be used for the server side of an SSL connection?
    X509_PURPOSE_NS_SSL_SERVERCan the cert be used for Netscape SSL server?
    X509_PURPOSE_SMIME_SIGNCan the cert be used to sign S/MIME email?
    X509_PURPOSE_SMIME_ENCRYPTCan the cert be used to encrypt S/MIME email?
    X509_PURPOSE_CRL_SIGNCan the cert be used to sign a certificate revocation list (CRL)?
    X509_PURPOSE_ANYCan the cert be used for Any/All purposes?
    These options are not bitfields - you may specify one only!
    ca_info

    ca_info should be an array of trusted CA files/dirs as described in Certificate Verification.

    untrusted_certificates_file

    If 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.

    Changelog

    VersionDescription
    8.0.0certificate accepts an OpenSSLCertificate instance now; previously, a resource of type OpenSSL X.509 was accepted.
    8.0.0untrusted_certificates_file is nullable now.
    To Top