openssl_csr_get_subject

    (PHP 5 >= 5.2.0, PHP 7, PHP 8)

    openssl_csr_get_subject — Returns the subject of a CSR

    Description

    openssl_csr_get_subject(OpenSSLCertificateSigningRequest|string $csr, bool $short_names = true): array|false

    openssl_csr_get_subject() returns subject distinguished name information encoded in the csr including fields commonName (CN), organizationName (O), countryName (C) etc.

    Parameters

    csr

    See CSR parameters for a list of valid values.

    short_names

    short_names controls how the data is indexed in the array - if short_names is true (the default) then fields will be indexed with the short name form, otherwise, the long name form will be used - e.g.: CN is the shortname form of commonName.

    Return Values

    Returns an associative array with subject description, or false on failure.

    Changelog

    Version Description
    8.0.0 csr accepts an OpenSSLCertificateSigningRequest instance now; previously, a resource of type OpenSSL X.509 CSR was accepted.

    Examples

    Example #1 openssl_csr_get_subject() example

    <?php
    $subject     = array(
    "countryName" => "CA",
    "stateOrProvinceName" => "Alberta",
    "localityName" => "Calgary",
    "organizationName" => "XYZ Widgets Inc",
    "organizationalUnitName" => "PHP Documentation Team",
    "commonName" => "Wez Furlong",
    "emailAddress" => "wez@example.com",
    );
    $private_key = openssl_pkey_new(array(
    "private_key_bits" => 2048,
    "private_key_type" => OPENSSL_KEYTYPE_RSA,
    ));
    $configargs = array(
    'digest_alg' => 'sha512WithRSAEncryption'
    );
    $csr = openssl_csr_new($subject, $privkey, $configargs);
    print_r(openssl_csr_get_subject($csr));
    ?>

    The above example will output something similar to:

    Array
(
    [C] => CA
    [ST] => Alberta
    [L] => Calgary
    [O] => XYZ Widgets Inc
    [OU] => PHP Documentation Team
    [CN] => Wez Furlong
    [emailAddress] => wez@example.com
)

    See Also

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 4 notes

    up
    1
    pdm at wp dot pl
    9 years ago
    openssl_csr_get_subject('somedomain.com',false);returnarray(7) {  ["countryName"]=> string "XX"  ["stateOrProvinceName"]=> string "xxxxxxxxx"  ["localityName"]=> string "xxxxxxxx"  ["organizationName"]=> string "xxxxxxxxx"  ["organizationalUnitName"]=>string "xxxx"  ["commonName"]=>string "xxx"  ["emailAddress"]=>string "xxx"} openssl_csr_get_subject('somedomain.com',true);returnarray(7) {  ["C"]=> string "XX"  ["ST"]=> string "xxxxxxxxx"  ["L"]=> string "xxxxxxxx"  ["O"]=> string "xxxxxxxxx"  ["OU"]=>string "xxxx"  ["CN"]=>string "xxx"  ["emailAddress"]=>string "xxx"}
    up
    0
    Steve
    9 years ago
    This function may not return name fields in the order they appear in the certificate.  For example, this CSR:-----BEGIN CERTIFICATE REQUEST-----MIHsMIGUAgEAMDIxEDAOBgNVBAsMB3VuaXQgIzExDDAKBgNVBAoMA29yZzEQMA4GA1UECwwHdW5pdCAjMjBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABGvZnFxGuVzJhOKPs5RNxZBS4vY6ERaqm5tKMGOhxLSfv/dpjDtNNdSHkIGNjYxclHYhxG0ku7BYPA5uPIjng1SgADAKBggqhkjOPQQDAgNHADBEAiB4GXhhbEU1UFTCe0dwJnKHTQuIxzYL5FnyhmKdixN/0gIgBXSm9S8L/oJ6rBxemin/V/xKv5jy4TEZuz84nnshxQQ=-----END CERTIFICATE REQUEST-----When processed by 'openssl -noout -subject' gives this:subject=/OU=unit #1/O=org/OU=unit #2On the other hand, 'var_dump( openssl_csr_get_subject( "..." ) )' will produce this:csr = array(2) {  ["OU"]=>  array(2) {    [0]=>    string(7) "unit #1"    [1]=>    string(7) "unit #2"  }  ["O"]=>  string(3) "org"}As you can see, ordering information (which may be important for some applications) is lost.
    up
    0
    mikko koivu
    15 years ago
    this function does not yet return SANs (subject alternative names) fields for UC certificates like those used in exchange 2007.
    up
    -1
    stephan[at]strato-rz[dot]de
    16 years ago
    The returning assoziative array is indexed with the fieldsin the subject so you should have a array key named CN,OU and so on.
    ＋add a note
    To Top