(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)
openssl_csr_new — Erzeugt einen CSR
$distinguished_names
,&$private_key
,$options
= null
,$extra_attributes
= null
openssl_csr_new() erzeugt einen neuen
CSR (Certificate Signing Request,
Zertifikats-Signierungsanfrage) basierend auf den Informationen, die mit
dem Parameter distinguished_names
angegeben werden.
Hinweis: Die ordnungsgemäße Ausführung dieser Funktion setzt die Installation einer gültigen openssl.cnf-Datei voraus. Mehr Information hierzu sind im Abschnitt Installation zu finden.
distinguished_names
Der Distinguished Name oder die Subjekt-Felder, die in das Zertifikat
aufgenommen werden sollen. distinguished_names
ist ein assoziatives Array, in dem die Schlüssel die Attributnamen der
Distinguished Names darstellen und die Werte entweder Zeichenketten (für
einen einzelnen Wert) oder Arrays (wenn mehrere Werte festgelegt werden
müssen) sein können.
private_key
private_key
muss auf einen zuvor mit
openssl_pkey_new() erzeugten (oder anderweitig von
der openssl_pkey-Familie erhaltenen) privaten Schlüssel oder auf eine
null
-Variable gesetzt werden. Wenn der Wert null
ist, wird ein neuer
privater Schlüssel basierend auf den übergebenen
options
erzeugt und der übergebenen Variablen
zugewiesen. Der zugehörige öffentliche Teil des Schlüssels wird zum
Signieren des CSR verwendet.
options
In der Standardeinstellung werden die Informationen für die Anfrage aus
der openssl.conf
des Systems verwendet; ein Abschnitt
der Konfigurationsdatei kann durch Setzen des Schlüssels
config_section
in options
angegeben werden. Außerdem kann eine alternative
OpenSSL-Konfigurationsdatei angegeben, indem der Wert des Schlüssels
config
auf den Pfad der zu verwendenden Datei gesetzt
wird. Die unten in der Tabelle aufgeführten Schlüssel, soweit in
options
vorhanden, verhalten sich genau gleich
wie die entsprechenden Werte in der openssl.conf
.
options -Schlüssel |
Typ | openssl.conf -Entsprechung |
Beschreibung |
---|---|---|---|
digest_alg | string | default_md | Digest-Methode oder Signaturhash, üblicherweise eins von openssl_get_md_methods(). |
x509_extensions | string | x509_extensions | Bestimmt, welche Erweiterung verwendet werden soll, wenn ein x509-Zertifikat erzeugt werden soll. |
req_extensions | string | req_extensions | Bestimmt welche Erweiterung verwendet werden soll, wenn eine Zertifikats-Signierungsanfrage (CSR) erzeugt werden soll. |
private_key_bits | int | default_bits | Bestimmt wieviele Bits verwendet werden sollen, um einen privaten Schlüssel zu erzeugen. |
private_key_type | int | keine |
Bestimmt den Typ des privaten Schlüssels, der erzeugt werden soll.
Der Typ kann einer der folgenden sein:
OPENSSL_KEYTYPE_DSA ,
OPENSSL_KEYTYPE_DH ,
OPENSSL_KEYTYPE_RSA oder
OPENSSL_KEYTYPE_EC . Der Standardwert ist
OPENSSL_KEYTYPE_RSA .
|
encrypt_key | bool | encrypt_key | Soll ein exportierter Schlüssel (mit Passphrase) verschlüsselt werden? |
encrypt_key_cipher | int | keine | Eine der Ziffer-Konstanten. |
curve_name | string | none | Einer der openssl_get_curve_names(). |
config | string | N/A | Pfad zur eigenen alternativen openssl.conf-Datei. |
extra_attributes
extra_attributes
wird verwendet, um zusätzliche
Attribute für den CSR anzugeben. Es handelt sich um
ein assoziatives Array, dessen Schlüssel in OIDs umgewandelt und als
CSR-Attribute verwendet werden.
Gibt bei Erfolg den CSR zurück; true
wenn die
CSR-Erstellung erfolgreich war, aber das Signieren
fehlgeschlagen ist. Bei einem Fehler wird false
zurückgegeben.
Version | Beschreibung |
---|---|
8.4.0 |
Das assoziative Array distinguished_names
unterstützt nun Arrays als Werte, sodass mehrere Werte für ein einzelnes
Attribut angegeben werden können.
|
8.4.0 |
Der Parameter extra_attributes setzt nun korrekt
die CSR-Attribute, anstatt wie bisher fälschlicherweise den
Distinguished Name des Subjekts zu ändern.
|
8.0.0 |
Bei Erfolg gibt diese Funktion nun eine
OpenSSLCertificateSigningRequest-Instanz zurück;
vorher wurde eine Ressource vom Typ OpenSSL X.509
CSR zurückgegeben.
|
8.0.0 |
private_key akzeptiert nun eine
OpenSSLAsymmetricKey-Instanz; vorher wurde eine
Ressource vom Typ OpenSSL-Schlüssel akzeptiert.
|
7.1.0 |
options unterstützt nun auch
curve_name .
|
Beispiel #1 Erzeugen eines selbstsignierten Zertifikats
<?php
// bei SSL-Zertifikate ist der commonName der zu sichernde Domain-Name
// bei S/MIME-Zertifikate ist der commonName der Eigentümer der E-Mail-Adresse
// die Felder location und identification beziehen sich auf den Eigentümer der
// zu sichernden Domain oder des E-Mail-Eigentümers
$dn = array(
"countryName" => "GB",
"stateOrProvinceName" => "Somerset",
"localityName" => "Glastonbury",
"organizationName" => "The Brain Room Limited",
"organizationalUnitName" => "PHP Documentation Team",
"commonName" => "Wez Furlong",
"emailAddress" => "wez@example.com"
);
// Erzeugen eines neuen privaten (und öffentlichen) Schlüsselpaars
$privkey = openssl_pkey_new(array(
"private_key_bits" => 2048,
"private_key_type" => OPENSSL_KEYTYPE_RSA,
));
// Erzeugen einer Zertifikats-Signierungsanfrage
$csr = openssl_csr_new($dn, $privkey, array('digest_alg' => 'sha256'));
// Erzeugen eines selbstsignierten Zertifikats, das für die Dauer von 365 Tagen
// gültig ist.
$x509 = openssl_csr_sign($csr, null, $privkey, $days=365, array('digest_alg' => 'sha256'));
// Sichern des privaten Schlüssels, des CSR und des selbstsignierten
// Zertifikats für die spätere Verwendung
openssl_csr_export($csr, $csrout) and var_dump($csrout);
openssl_x509_export($x509, $certout) and var_dump($certout);
openssl_pkey_export($privkey, $pkeyout, "mypassword") and var_dump($pkeyout);
// Anzeigen aller aufgetretenen Fehler
while (($e = openssl_error_string()) !== false) {
echo $e . "\n";
}
?>
Beispiel #2 Erzeugen eines selbstsignierten ECC-Zertifikats (von PHP 7.1.0 an)
<?php
$subject = array(
"commonName" => "docs.php.net",
);
// Erzeugen eines neuen privaten (und öffentlichen) Schlüsselpaars
$private_key = openssl_pkey_new(array(
"private_key_type" => OPENSSL_KEYTYPE_EC,
"curve_name" => 'prime256v1',
));
// Erzeugen einer Zertifikats-Signierungsanfrage
$csr = openssl_csr_new($subject, $private_key, array('digest_alg' => 'sha384'));
// Erzeugen eines selbstsignierten EC-Zertifikats
$x509 = openssl_csr_sign($csr, null, $private_key, $days=365, array('digest_alg' => 'sha384'));
openssl_x509_export_to_file($x509, 'ecc-cert.pem');
openssl_pkey_export_to_file($private_key, 'ecc-private.key');
?>