Csr Chilkat2 PHP Reference Documentation

Csr

Current Version: 11.7.0

Markdown version of this page for AI tools (v 11.7.0) · all AI docs

Chilkat.Csr

Create, load, inspect, and verify Certificate Signing Requests.

Chilkat.Csr is the Chilkat class for working with Certificate Signing Requests. It can create CSRs from RSA or ECDSA private keys, set common certificate subject fields, add custom subject fields by OID, include Subject Alternative Names, request certificate extensions, export CSRs in PEM or DER format, load existing CSRs, extract the public key, inspect SAN values, and verify the CSR signature.

Create CSRs

Generate certificate signing requests using RSA or ECDSA private keys and the subject fields required by the certificate authority.

Subject fields

Set common X.509 subject fields such as common name, organization, organizational unit, locality, state, country, and email address.

Custom OID fields

Add custom subject attributes by object identifier when a certificate authority or application profile requires nonstandard fields.

Subject Alternative Names

Include DNS names, IP addresses, email addresses, URIs, or other SAN entries needed for modern TLS and identity certificates.

Extension requests

Request certificate extensions that the issuing CA may include in the final certificate.

Inspect and verify

Load an existing CSR, extract its public key, inspect requested names and fields, and verify that the CSR signature is valid.

Common pattern: Create or load a private key, populate the subject and SAN values required by the certificate authority, generate the CSR in PEM or DER format, submit it to the CA, and keep the private key secure because it will be needed when using the issued certificate.

For an extended overview, see Csr Class Overview.

Object Creation

use Chilkat2\Csr;

try {
    $csr = new Csr();
    // ... use $csr ...
} catch (\Chilkat2\Exception $e) {
    echo $e->getClass(), '::', $e->getMethod(), " failed\n";
    echo $e->getMessage(), "\n";              // the LastErrorText of the failed call
}

public function __construct(array $properties = [])

Creates the object. The optional array sets properties in order, as if assigned one by one (new Csr(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.

There is no close(): PHP frees the object when its last reference goes (unset($csr), $csr = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyCsr extends \Chilkat2\Csr); objects cannot be cloned or serialized.

public bool $RaiseError;

When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.

Errors

Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\Csr') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.

Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.

Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.

Properties

CommonName

public string $CommonName;

Introduced in version 9.5.0.65

Gets or sets the subject common name (CN), OID 2.5.4.3, for the CSR. For a TLS server request this has traditionally been a DNS hostname; for other certificate profiles it may identify a person, device, service, or organization.

Chilkat requires this property when generating a CSR. The exact value and validation rules are determined by the certificate authority and certificate profile.

Do not use CN as a substitute for SAN: For modern TLS certificates, add every DNS hostname or IP address through AddSan. Current TLS identity verification uses Subject Alternative Name entries, and the common name is retained primarily for compatibility and display.

`sanType`	Meaning and example
`dnsName`	A DNS hostname, such as `www.example.com` or an allowed wildcard such as `*.example.com`.
`IPAddress`	An IPv4 or IPv6 address, such as `192.0.2.10` or `2001:db8::10`.
`rfc822Name`	An Internet email address, such as `user@example.com`.
`uniformResourceIndicator`	A URI. This is Chilkat's accepted keyword; the X.509 `GeneralName` field is formally named `uniformResourceIdentifier`.
`directoryName`	An X.500 distinguished name.
`registeredID`	A registered object identifier.
`otherName`, `x400Address`, `ediPartyName`	Less common X.509 `GeneralName` forms used by specialized profiles.

ASN.1 type	Typical use
`UTF8String`	General Unicode text and the preferred default for most modern directory attributes.
`IA5String`	ASCII-based attributes whose schema specifically requires IA5String, such as the legacy PKCS #9 `emailAddress` attribute.
`PrintableString`	Attributes constrained to the limited PrintableString character set, such as the X.520 country name.

Csr Chilkat2 PHP Reference Documentation

Csr

Current Version: 11.7.0

Create, load, inspect, and verify Certificate Signing Requests.

Create CSRs

Subject fields

Custom OID fields

Subject Alternative Names

Extension requests

Inspect and verify

Object Creation

Errors

Properties

CommonName

Company

CompanyDivision

Country

DebugLogFilePath

EmailAddress

HashAlgorithm

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Locality

MgfHashAlg

PssPadding

State

VerboseLogging

Version

Methods

AddSan

GenCsrBd

GenCsrPem

GetExtensionRequest

GetPublicKey

GetSans

GetSubjectField

LoadCsrPem

SetExtensionRequest

SetSubjectField

VerifyCsr