PHP - Fonction openssl_pkey_export_to_file ()

Définition et utilisation

le openssl_pkey_export_to_file() La fonction exportera la clé dans un fichier.

La description

La fonction openssl_pkey_export_to_file () enregistre la clé au format PEM.PEM signifie Privacy-Enhanced Mail et stocke principalement les clés cryptographiques et les certificats.

Syntaxe

openssl_pkey_export_to_file ( mixed $key , string $outfilename [, string $passphrase [, array $configargs ]] ) : bool

Paramètres

Sr. Non Paramètre La description
1

key

La clé que vous souhaitez exporter vers un fichier.

2

outfilename

Le nom du fichier est le chemin où vous souhaitez enregistrer le fichier .pem.

3

passphrase

Le mot de passe que vous pouvez utiliser pour protéger le fichier.

4

configargs

Le paramètre configargs sont les détails de configuration qui doivent être fournis à la fonction pour générer la paire de clés privée / publique. Les détails sont décrits ci-dessous.

configargs

Par défaut, openssl_pkey_new () utilise les détails de configuration présents dans openssl.cnf. Mais en utilisant les configargs, vous pouvez les écraser.Les détails de configuration sont les suivants:

clé dans configargs type clé utilisée dans openssl.conf la description
digest_alg chaîne default_md Digest les méthodes que vous obtenez de openssl_get_md_methods ().
x509_extensions chaîne x509_extensions Extensions utilisées lors de la création d'un certificat x509.
req_extensions chaîne req_extensions Extensions utilisées lors de la création d'un CSR.
private_key_bits entier default_bits Spécifie le nombre de bits à utiliser lors de la génération d'une clé privée.
private_key_type entier aucun Le type de clé privée à créer. Il peut s'agir de OPENSSL_KEYTYPE_DSA, OPENSSL_KEYTYPE_DH, OPENSSL_KEYTYPE_RSA ou OPENSSL_KEYTYPE_EC. La valeur par défaut est OPENSSL_KEYTYPE_RSA.
encrypt_key booléen encrypt_key La clé exportée est-elle chiffrée?
encrypt_key_cipher entier aucun Constantes de chiffrement comme OPENSSL_CIPHER_RC2_40 (entier), OPENSSL_CIPHER_RC2_128 (entier), OPENSSL_CIPHER_RC2_64 (entier), OPENSSL_CIPHER_DES (entier), OPENSSL_CIPHER_3DES (entier) etc.
nom_courbe chaîne aucun Un des noms de courbe renvoyés par cette fonction openssl_get_curve_names ().
config chaîne N / A Vous pouvez modifier la configuration dans openssl.conf selon vos besoins et en indiquer le chemin ici.

Valeurs de retour

La fonction PHP openssl_pkey_export_to_file () renvoie true en cas de succès et false en cas d'échec.

Version PHP

Cette fonction fonctionnera à partir de la version PHP supérieure à 5.0.0.

Exemple 1

Fonctionnement de openssl_pkey_export_to_file () -

<?php
   //creating private key
   $privkey = openssl_pkey_new();
   openssl_pkey_export_to_file($privkey, 'C:/xampp/htdocs/modules/openssl/keytest.pem');
?>

Les détails stockés dans le fichier keytest.pem sont les suivants -

-----BEGIN PRIVATE KEY-----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDaqNK97A+mL9Xu
IDt3rz9yfFUvrLcDEvsDa9JsjQByJVbdRtaNl6nfg91/LfKO8zAeG8srd292jcYk
9MgBhkpMCHvF/QhWjA4IdPLdWHCbYfjF/LHmo/z022/FqTnjQtFws992/ClhZdo6
kpDlU/H2lmbnCwrsqHlqcQ7bzBgC5U5SW0t3A03PSqxQTIFPOHi1Yx1Il5jH/H11
6UXDKogAWsseRpdwVdsCy6Wj3rkybr1pr7CDkHSS49MAvJ4e6xhs+je12lrtyChR
ZTIYLICzEG7a1n0BPGAI1bQcivHXNipUkAYFn221gKRuB+9SQvC3VKbNXy8Oc7N9
HEahD8S3AgMBAAECggEBAKzEU68og7zlcvzxjsskNtd4kb5Xk0rkhlzPprWKO131
TssLm57IxLoMcMh6P3rff5dqkn9HoVRk9LhiiF1cA/xLf7CSGzJ2+ueHsBVgOaks
IeodnVsFG2tEru3YphqAwwdvuBNFblS8q084WzA3waj6cVgAi6MuArEtn3XfruEp
Yryc4Y1I1SB92x4y85tZ/PcomumPH0djKQeuhzy7f7GloJRfdshNENRbkdLc65N5
j8hy7WxMSa0dpJ3ZJMmgNfek9nALntSZfOsHGMZ/Wog8eV6+HzCwqqrMkR15pZI1
HqvVszU1iwoUJvlGoxInJOqJ2c6lBSBOBBR8DuuQixECgYEA+8RKXcw0U3VU8zJO
NTFzSDEtFYKZ5Bg4IPaYSTSo/ojiL3VrLeocRq3/2zdeCw8wx9eNZbcBW93lWVxK
q2G0X4XgonorEEONBvL9aE/D7wBCMYPWDXd/KQVZW8CPwcy10g2oIi3SqbcTQ/gT
fcmcHAQD2wVgo9XBlg24ESAP01MCgYEA3lYGasOvDweca5GCiP4m1oOH605haIUU
f5CDWXbZ6QjcoUQQB0CoDtTl3QpBd3KGbd+PbqU8xb44+LhrVIsjUyZs6k+eLACe
Dufzq00mIRSl/TZ0R3q17lAMmxId9QramDScpmqqqXonpOpdEoonThynhLyANgX3
eYGLXeqaII0CgYBPVi/JFwx2MEcwy+1xPcACQ9zdJmawRiGJ4atjhkCq1R/RrMK1
mUyHyVUTE4ODIKpSj05zexPmiyo22qp9DzDz2RBMowrm+SJ7yh6ovFoV+pLhX5YY
cEuV9aWPEEM84vF42+zbuGzmJlbf2FDsFpgnC+zbG/q0Jiv2ySPz4ZKbGQKBgQDM
ek9ih1+LshNAts1Xkm5DoSoy1Z4uUx48B7tVX0If2N+YjRE0qlklctWIiXMWGMTb
bdzrBJq0vjKFRI6pbWFqio9mmxy8GUFEMjzekZB8ohHao+cjCg8iAorlXy8f+wB5
NQHQ547XWRn2yPgaIebuJtpF8Fr11Fz6aZK0KBvhzQKBgGRwuxq6IhIROupoDRpU
RHuqICeQQYcf7Cfk7+ZyYJnA1fbOowj4Q5zvbWa6N2Ygyq2KIl0P5YL4Atb7aRKS
e6ol8lIKZM9ysbS+wR0OhhTJs/9CqpgvDbYNQFiaVZtGRpSNCxHkhn0cAR7lzK4P
ROQC7p9zXJhAmzE8/hTD9eaH
-----END PRIVATE KEY-----

Exemple 2

Pour récupérer la clé du fichier .pem -

<?php
   //creating private key
   $privkey = openssl_pkey_new();
   openssl_pkey_export_to_file($privkey, 'C:/xampp/htdocs/modules/openssl/keytest.pem');
	
   //using .pem file with private key.
   $testprivatekey = openssl_get_privatekey(file_get_contents('C:/xampp/htdocs/modules/openssl/keytest.pem'));
   if ($testprivatekey === false) {
      var_dump(openssl_error_string());
   } else {
      //var_dump($testprivatekey);
      $key_details = openssl_pkey_get_details($testprivatekey);
      print_r($key_details["key"]);	
   }
?>

Les détails stockés dans le fichier test-csr1.pem sont les suivants -

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnbGAblUCP6sZvbi2JM4G
PcLmKK9flGQq6EE+yvMWrEUnIPGOLJUEB06dE8inIMQTYDmdmjn7HgUAlIDaViw+
aSv3XBZJqBTm7xtW4488oKuCzdBuJbnomtGttFWOk4cjb8kG+Kza6v0AB+P0eUru
cPkwnJF4F1pGY1pszSMsL3/s7OcIzjiKUKu5vHJxUWO7baVovq+gv9+O24Pd0GhB
t6RC/pgK/42YqZ2YW5V+JiuCFFkTVPusviunAOLLpDwoyPIROvXdML2TKopiowOd
nmOkNRrW81duRF8Z4dcn7jnf2sKExpLBgAtcV05OufZIv3VeeTD0ISbCJhn0zmx/
SQIDAQAB
-----END PUBLIC KEY-----